chimesdkidentity

package module
v1.9.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 23, 2022 License: Apache-2.0 Imports: 34 Imported by: 7

Documentation

Overview

Package chimesdkidentity provides the API client, operations, and parameter types for Amazon Chime SDK Identity.

The Amazon Chime SDK Identity APIs in this section allow software developers to create and manage unique instances of their messaging applications. These APIs provide the overarching framework for creating and sending messages. For more information about the identity APIs, refer to Amazon Chime SDK identity (https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Identity.html).

Index

Constants

View Source 
const ServiceAPIVersion = "2021-04-20"
View Source 
const ServiceID = "Chime SDK Identity"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon Chime SDK Identity.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateAppInstance 

func (c *Client) CreateAppInstance(ctx context.Context, params *CreateAppInstanceInput, optFns ...func(*Options)) (*CreateAppInstanceOutput, error)

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard. identity

func (*Client) CreateAppInstanceAdmin 

func (c *Client) CreateAppInstanceAdmin(ctx context.Context, params *CreateAppInstanceAdminInput, optFns ...func(*Options)) (*CreateAppInstanceAdminOutput, error)

Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions.

* ChannelModerator actions across all channels in the AppInstance.

* DeleteChannelMessage actions.

Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

func (*Client) CreateAppInstanceUser 

func (c *Client) CreateAppInstanceUser(ctx context.Context, params *CreateAppInstanceUserInput, optFns ...func(*Options)) (*CreateAppInstanceUserOutput, error)

Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

func (*Client) DeleteAppInstance 

func (c *Client) DeleteAppInstance(ctx context.Context, params *DeleteAppInstanceInput, optFns ...func(*Options)) (*DeleteAppInstanceOutput, error)

Deletes an AppInstance and all associated data asynchronously.

func (*Client) DeleteAppInstanceAdmin 

func (c *Client) DeleteAppInstanceAdmin(ctx context.Context, params *DeleteAppInstanceAdminInput, optFns ...func(*Options)) (*DeleteAppInstanceAdminOutput, error)

Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.

func (*Client) DeleteAppInstanceUser 

func (c *Client) DeleteAppInstanceUser(ctx context.Context, params *DeleteAppInstanceUserInput, optFns ...func(*Options)) (*DeleteAppInstanceUserOutput, error)

Deletes an AppInstanceUser.

func (*Client) DeregisterAppInstanceUserEndpoint added in v1.4.0 

func (c *Client) DeregisterAppInstanceUserEndpoint(ctx context.Context, params *DeregisterAppInstanceUserEndpointInput, optFns ...func(*Options)) (*DeregisterAppInstanceUserEndpointOutput, error)

Deregisters an AppInstanceUserEndpoint.

func (*Client) DescribeAppInstance 

func (c *Client) DescribeAppInstance(ctx context.Context, params *DescribeAppInstanceInput, optFns ...func(*Options)) (*DescribeAppInstanceOutput, error)

Returns the full details of an AppInstance.

func (*Client) DescribeAppInstanceAdmin 

func (c *Client) DescribeAppInstanceAdmin(ctx context.Context, params *DescribeAppInstanceAdminInput, optFns ...func(*Options)) (*DescribeAppInstanceAdminOutput, error)

Returns the full details of an AppInstanceAdmin.

func (*Client) DescribeAppInstanceUser 

func (c *Client) DescribeAppInstanceUser(ctx context.Context, params *DescribeAppInstanceUserInput, optFns ...func(*Options)) (*DescribeAppInstanceUserOutput, error)

Returns the full details of an AppInstanceUser.

func (*Client) DescribeAppInstanceUserEndpoint added in v1.4.0 

func (c *Client) DescribeAppInstanceUserEndpoint(ctx context.Context, params *DescribeAppInstanceUserEndpointInput, optFns ...func(*Options)) (*DescribeAppInstanceUserEndpointOutput, error)

Returns the full details of an AppInstanceUserEndpoint.

func (*Client) GetAppInstanceRetentionSettings 

func (c *Client) GetAppInstanceRetentionSettings(ctx context.Context, params *GetAppInstanceRetentionSettingsInput, optFns ...func(*Options)) (*GetAppInstanceRetentionSettingsOutput, error)

Gets the retention settings for an AppInstance.

func (*Client) ListAppInstanceAdmins 

func (c *Client) ListAppInstanceAdmins(ctx context.Context, params *ListAppInstanceAdminsInput, optFns ...func(*Options)) (*ListAppInstanceAdminsOutput, error)

Returns a list of the administrators in the AppInstance.

func (*Client) ListAppInstanceUserEndpoints added in v1.4.0 

func (c *Client) ListAppInstanceUserEndpoints(ctx context.Context, params *ListAppInstanceUserEndpointsInput, optFns ...func(*Options)) (*ListAppInstanceUserEndpointsOutput, error)

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.

func (*Client) ListAppInstanceUsers 

func (c *Client) ListAppInstanceUsers(ctx context.Context, params *ListAppInstanceUsersInput, optFns ...func(*Options)) (*ListAppInstanceUsersOutput, error)

List all AppInstanceUsers created under a single AppInstance.

func (*Client) ListAppInstances 

func (c *Client) ListAppInstances(ctx context.Context, params *ListAppInstancesInput, optFns ...func(*Options)) (*ListAppInstancesOutput, error)

Lists all Amazon Chime AppInstances created under a single AWS account.

func (*Client) ListTagsForResource added in v1.4.0 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags applied to an Amazon Chime SDK identity resource.

func (*Client) PutAppInstanceRetentionSettings 

func (c *Client) PutAppInstanceRetentionSettings(ctx context.Context, params *PutAppInstanceRetentionSettingsInput, optFns ...func(*Options)) (*PutAppInstanceRetentionSettingsOutput, error)

Sets the amount of time in days that a given AppInstance retains data.

func (*Client) RegisterAppInstanceUserEndpoint added in v1.4.0 

func (c *Client) RegisterAppInstanceUserEndpoint(ctx context.Context, params *RegisterAppInstanceUserEndpointInput, optFns ...func(*Options)) (*RegisterAppInstanceUserEndpointOutput, error)

Registers an endpoint under an Amazon Chime AppInstanceUser. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

func (*Client) TagResource added in v1.4.0 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Applies the specified tags to the specified Amazon Chime SDK identity resource.

func (*Client) UntagResource added in v1.4.0 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes the specified tags from the specified Amazon Chime SDK identity resource.

func (*Client) UpdateAppInstance 

func (c *Client) UpdateAppInstance(ctx context.Context, params *UpdateAppInstanceInput, optFns ...func(*Options)) (*UpdateAppInstanceOutput, error)

Updates AppInstance metadata.

func (*Client) UpdateAppInstanceUser 

func (c *Client) UpdateAppInstanceUser(ctx context.Context, params *UpdateAppInstanceUserInput, optFns ...func(*Options)) (*UpdateAppInstanceUserOutput, error)

Updates the details of an AppInstanceUser. You can update names and metadata.

func (*Client) UpdateAppInstanceUserEndpoint added in v1.4.0 

func (c *Client) UpdateAppInstanceUserEndpoint(ctx context.Context, params *UpdateAppInstanceUserEndpointInput, optFns ...func(*Options)) (*UpdateAppInstanceUserEndpointOutput, error)

Updates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage values.

type CreateAppInstanceAdminInput 

type CreateAppInstanceAdminInput struct {

	// The ARN of the administrator of the current AppInstance.
	//
	// This member is required.
	AppInstanceAdminArn *string

	// The ARN of the AppInstance.
	//
	// This member is required.
	AppInstanceArn *string
	// contains filtered or unexported fields
}

type CreateAppInstanceAdminOutput 

type CreateAppInstanceAdminOutput struct {

	// The name and ARN of the admin for the AppInstance.
	AppInstanceAdmin *types.Identity

	// The ARN of the of the admin for the AppInstance.
	AppInstanceArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateAppInstanceInput 

type CreateAppInstanceInput struct {

	// The ClientRequestToken of the AppInstance.
	//
	// This member is required.
	ClientRequestToken *string

	// The name of the AppInstance.
	//
	// This member is required.
	Name *string

	// The metadata of the AppInstance. Limited to a 1KB string in UTF-8.
	Metadata *string

	// Tags assigned to the AppInstanceUser.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateAppInstanceOutput 

type CreateAppInstanceOutput struct {

	// The Amazon Resource Number (ARN) of the AppInstance.
	AppInstanceArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateAppInstanceUserInput 

type CreateAppInstanceUserInput struct {

	// The ARN of the AppInstance request.
	//
	// This member is required.
	AppInstanceArn *string

	// The user ID of the AppInstance.
	//
	// This member is required.
	AppInstanceUserId *string

	// The token assigned to the user requesting an AppInstance.
	//
	// This member is required.
	ClientRequestToken *string

	// The user's name.
	//
	// This member is required.
	Name *string

	// The request's metadata. Limited to a 1KB string in UTF-8.
	Metadata *string

	// Tags assigned to the AppInstanceUser.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateAppInstanceUserOutput 

type CreateAppInstanceUserOutput struct {

	// The user's ARN.
	AppInstanceUserArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAppInstanceAdminInput 

type DeleteAppInstanceAdminInput struct {

	// The ARN of the AppInstance's administrator.
	//
	// This member is required.
	AppInstanceAdminArn *string

	// The ARN of the AppInstance.
	//
	// This member is required.
	AppInstanceArn *string
	// contains filtered or unexported fields
}

type DeleteAppInstanceAdminOutput 

type DeleteAppInstanceAdminOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAppInstanceInput 

type DeleteAppInstanceInput struct {

	// The ARN of the AppInstance.
	//
	// This member is required.
	AppInstanceArn *string
	// contains filtered or unexported fields
}

type DeleteAppInstanceOutput 

type DeleteAppInstanceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAppInstanceUserInput 

type DeleteAppInstanceUserInput struct {

	// The ARN of the user request being deleted.
	//
	// This member is required.
	AppInstanceUserArn *string
	// contains filtered or unexported fields
}

type DeleteAppInstanceUserOutput 

type DeleteAppInstanceUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeregisterAppInstanceUserEndpointInput added in v1.4.0 

type DeregisterAppInstanceUserEndpointInput struct {

	// The ARN of the AppInstanceUser.
	//
	// This member is required.
	AppInstanceUserArn *string

	// The unique identifier of the AppInstanceUserEndpoint.
	//
	// This member is required.
	EndpointId *string
	// contains filtered or unexported fields
}

type DeregisterAppInstanceUserEndpointOutput added in v1.4.0 

type DeregisterAppInstanceUserEndpointOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAppInstanceAdminInput 

type DescribeAppInstanceAdminInput struct {

	// The ARN of the AppInstanceAdmin.
	//
	// This member is required.
	AppInstanceAdminArn *string

	// The ARN of the AppInstance.
	//
	// This member is required.
	AppInstanceArn *string
	// contains filtered or unexported fields
}

type DescribeAppInstanceAdminOutput 

type DescribeAppInstanceAdminOutput struct {

	// The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the
	// created and last-updated timestamps. All timestamps use epoch milliseconds.
	AppInstanceAdmin *types.AppInstanceAdmin

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAppInstanceInput 

type DescribeAppInstanceInput struct {

	// The ARN of the AppInstance.
	//
	// This member is required.
	AppInstanceArn *string
	// contains filtered or unexported fields
}

type DescribeAppInstanceOutput 

type DescribeAppInstanceOutput struct {

	// The ARN, metadata, created and last-updated timestamps, and the name of the
	// AppInstance. All timestamps use epoch milliseconds.
	AppInstance *types.AppInstance

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAppInstanceUserEndpointInput added in v1.4.0 

type DescribeAppInstanceUserEndpointInput struct {

	// The ARN of the AppInstanceUser.
	//
	// This member is required.
	AppInstanceUserArn *string

	// The unique identifier of the AppInstanceUserEndpoint.
	//
	// This member is required.
	EndpointId *string
	// contains filtered or unexported fields
}

type DescribeAppInstanceUserEndpointOutput added in v1.4.0 

type DescribeAppInstanceUserEndpointOutput struct {

	// The full details of an AppInstanceUserEndpoint: the AppInstanceUserArn, ID,
	// name, type, resource ARN, attributes, allow messages, state, and created and
	// last updated timestamps. All timestamps use epoch milliseconds.
	AppInstanceUserEndpoint *types.AppInstanceUserEndpoint

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAppInstanceUserInput 

type DescribeAppInstanceUserInput struct {

	// The ARN of the AppInstanceUser.
	//
	// This member is required.
	AppInstanceUserArn *string
	// contains filtered or unexported fields
}

type DescribeAppInstanceUserOutput 

type DescribeAppInstanceUserOutput struct {

	// The name of the AppInstanceUser.
	AppInstanceUser *types.AppInstanceUser

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetAppInstanceRetentionSettingsInput 

type GetAppInstanceRetentionSettingsInput struct {

	// The ARN of the AppInstance.
	//
	// This member is required.
	AppInstanceArn *string
	// contains filtered or unexported fields
}

type GetAppInstanceRetentionSettingsOutput 

type GetAppInstanceRetentionSettingsOutput struct {

	// The retention settings for the AppInstance.
	AppInstanceRetentionSettings *types.AppInstanceRetentionSettings

	// The timestamp representing the time at which the specified items are retained,
	// in Epoch Seconds.
	InitiateDeletionTimestamp *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListAppInstanceAdminsAPIClient 

type ListAppInstanceAdminsAPIClient interface {
	ListAppInstanceAdmins(context.Context, *ListAppInstanceAdminsInput, ...func(*Options)) (*ListAppInstanceAdminsOutput, error)
}

ListAppInstanceAdminsAPIClient is a client that implements the ListAppInstanceAdmins operation.

type ListAppInstanceAdminsInput 

type ListAppInstanceAdminsInput struct {

	// The ARN of the AppInstance.
	//
	// This member is required.
	AppInstanceArn *string

	// The maximum number of administrators that you want to return.
	MaxResults *int32

	// The token returned from previous API requests until the number of administrators
	// is reached.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAppInstanceAdminsOutput 

type ListAppInstanceAdminsOutput struct {

	// The information for each administrator.
	AppInstanceAdmins []types.AppInstanceAdminSummary

	// The ARN of the AppInstance.
	AppInstanceArn *string

	// The token returned from previous API requests until the number of administrators
	// is reached.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAppInstanceAdminsPaginator 

type ListAppInstanceAdminsPaginator struct {
	// contains filtered or unexported fields
}

ListAppInstanceAdminsPaginator is a paginator for ListAppInstanceAdmins

func NewListAppInstanceAdminsPaginator 

func NewListAppInstanceAdminsPaginator(client ListAppInstanceAdminsAPIClient, params *ListAppInstanceAdminsInput, optFns ...func(*ListAppInstanceAdminsPaginatorOptions)) *ListAppInstanceAdminsPaginator

NewListAppInstanceAdminsPaginator returns a new ListAppInstanceAdminsPaginator

func (*ListAppInstanceAdminsPaginator) HasMorePages 

func (p *ListAppInstanceAdminsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAppInstanceAdminsPaginator) NextPage 

func (p *ListAppInstanceAdminsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppInstanceAdminsOutput, error)

NextPage retrieves the next ListAppInstanceAdmins page.

type ListAppInstanceAdminsPaginatorOptions 

type ListAppInstanceAdminsPaginatorOptions struct {
	// The maximum number of administrators that you want to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAppInstanceAdminsPaginatorOptions is the paginator options for ListAppInstanceAdmins

type ListAppInstanceUserEndpointsAPIClient added in v1.4.0 

type ListAppInstanceUserEndpointsAPIClient interface {
	ListAppInstanceUserEndpoints(context.Context, *ListAppInstanceUserEndpointsInput, ...func(*Options)) (*ListAppInstanceUserEndpointsOutput, error)
}

ListAppInstanceUserEndpointsAPIClient is a client that implements the ListAppInstanceUserEndpoints operation.

type ListAppInstanceUserEndpointsInput added in v1.4.0 

type ListAppInstanceUserEndpointsInput struct {

	// The ARN of the AppInstanceUser.
	//
	// This member is required.
	AppInstanceUserArn *string

	// The maximum number of endpoints that you want to return.
	MaxResults *int32

	// The token passed by previous API calls until all requested endpoints are
	// returned.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAppInstanceUserEndpointsOutput added in v1.4.0 

type ListAppInstanceUserEndpointsOutput struct {

	// The information for each requested AppInstanceUserEndpoint.
	AppInstanceUserEndpoints []types.AppInstanceUserEndpointSummary

	// The token passed by previous API calls until all requested endpoints are
	// returned.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAppInstanceUserEndpointsPaginator added in v1.4.0 

type ListAppInstanceUserEndpointsPaginator struct {
	// contains filtered or unexported fields
}

ListAppInstanceUserEndpointsPaginator is a paginator for ListAppInstanceUserEndpoints

func NewListAppInstanceUserEndpointsPaginator added in v1.4.0 

func NewListAppInstanceUserEndpointsPaginator(client ListAppInstanceUserEndpointsAPIClient, params *ListAppInstanceUserEndpointsInput, optFns ...func(*ListAppInstanceUserEndpointsPaginatorOptions)) *ListAppInstanceUserEndpointsPaginator

NewListAppInstanceUserEndpointsPaginator returns a new ListAppInstanceUserEndpointsPaginator

func (*ListAppInstanceUserEndpointsPaginator) HasMorePages added in v1.4.0 

func (p *ListAppInstanceUserEndpointsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAppInstanceUserEndpointsPaginator) NextPage added in v1.4.0 

func (p *ListAppInstanceUserEndpointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppInstanceUserEndpointsOutput, error)

NextPage retrieves the next ListAppInstanceUserEndpoints page.

type ListAppInstanceUserEndpointsPaginatorOptions added in v1.4.0 

type ListAppInstanceUserEndpointsPaginatorOptions struct {
	// The maximum number of endpoints that you want to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAppInstanceUserEndpointsPaginatorOptions is the paginator options for ListAppInstanceUserEndpoints

type ListAppInstanceUsersAPIClient 

type ListAppInstanceUsersAPIClient interface {
	ListAppInstanceUsers(context.Context, *ListAppInstanceUsersInput, ...func(*Options)) (*ListAppInstanceUsersOutput, error)
}

ListAppInstanceUsersAPIClient is a client that implements the ListAppInstanceUsers operation.

type ListAppInstanceUsersInput 

type ListAppInstanceUsersInput struct {

	// The ARN of the AppInstance.
	//
	// This member is required.
	AppInstanceArn *string

	// The maximum number of requests that you want returned.
	MaxResults *int32

	// The token passed by previous API calls until all requested users are returned.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAppInstanceUsersOutput 

type ListAppInstanceUsersOutput struct {

	// The ARN of the AppInstance.
	AppInstanceArn *string

	// The information for each requested AppInstanceUser.
	AppInstanceUsers []types.AppInstanceUserSummary

	// The token passed by previous API calls until all requested users are returned.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAppInstanceUsersPaginator 

type ListAppInstanceUsersPaginator struct {
	// contains filtered or unexported fields
}

ListAppInstanceUsersPaginator is a paginator for ListAppInstanceUsers

func NewListAppInstanceUsersPaginator 

func NewListAppInstanceUsersPaginator(client ListAppInstanceUsersAPIClient, params *ListAppInstanceUsersInput, optFns ...func(*ListAppInstanceUsersPaginatorOptions)) *ListAppInstanceUsersPaginator

NewListAppInstanceUsersPaginator returns a new ListAppInstanceUsersPaginator

func (*ListAppInstanceUsersPaginator) HasMorePages 

func (p *ListAppInstanceUsersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAppInstanceUsersPaginator) NextPage 

func (p *ListAppInstanceUsersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppInstanceUsersOutput, error)

NextPage retrieves the next ListAppInstanceUsers page.

type ListAppInstanceUsersPaginatorOptions 

type ListAppInstanceUsersPaginatorOptions struct {
	// The maximum number of requests that you want returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAppInstanceUsersPaginatorOptions is the paginator options for ListAppInstanceUsers

type ListAppInstancesAPIClient 

type ListAppInstancesAPIClient interface {
	ListAppInstances(context.Context, *ListAppInstancesInput, ...func(*Options)) (*ListAppInstancesOutput, error)
}

ListAppInstancesAPIClient is a client that implements the ListAppInstances operation.

type ListAppInstancesInput 

type ListAppInstancesInput struct {

	// The maximum number of AppInstances that you want to return.
	MaxResults *int32

	// The token passed by previous API requests until you reach the maximum number of
	// AppInstances.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAppInstancesOutput 

type ListAppInstancesOutput struct {

	// The information for each AppInstance.
	AppInstances []types.AppInstanceSummary

	// The token passed by previous API requests until the maximum number of
	// AppInstances is reached.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAppInstancesPaginator 

type ListAppInstancesPaginator struct {
	// contains filtered or unexported fields
}

ListAppInstancesPaginator is a paginator for ListAppInstances

func NewListAppInstancesPaginator 

func NewListAppInstancesPaginator(client ListAppInstancesAPIClient, params *ListAppInstancesInput, optFns ...func(*ListAppInstancesPaginatorOptions)) *ListAppInstancesPaginator

NewListAppInstancesPaginator returns a new ListAppInstancesPaginator

func (*ListAppInstancesPaginator) HasMorePages 

func (p *ListAppInstancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAppInstancesPaginator) NextPage 

func (p *ListAppInstancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppInstancesOutput, error)

NextPage retrieves the next ListAppInstances page.

type ListAppInstancesPaginatorOptions 

type ListAppInstancesPaginatorOptions struct {
	// The maximum number of AppInstances that you want to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAppInstancesPaginatorOptions is the paginator options for ListAppInstances

type ListTagsForResourceInput added in v1.4.0 

type ListTagsForResourceInput struct {

	// The ARN of the resource.
	//
	// This member is required.
	ResourceARN *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput added in v1.4.0 

type ListTagsForResourceOutput struct {

	// The tag key-value pairs.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. If specified in an operation call's functional
	// options with a value that is different than the constructed client's Options,
	// the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type PutAppInstanceRetentionSettingsInput 

type PutAppInstanceRetentionSettingsInput struct {

	// The ARN of the AppInstance.
	//
	// This member is required.
	AppInstanceArn *string

	// The time in days to retain data. Data type: number.
	//
	// This member is required.
	AppInstanceRetentionSettings *types.AppInstanceRetentionSettings
	// contains filtered or unexported fields
}

type PutAppInstanceRetentionSettingsOutput 

type PutAppInstanceRetentionSettingsOutput struct {

	// The time in days to retain data. Data type: number.
	AppInstanceRetentionSettings *types.AppInstanceRetentionSettings

	// The time at which the API deletes data.
	InitiateDeletionTimestamp *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RegisterAppInstanceUserEndpointInput added in v1.4.0 

type RegisterAppInstanceUserEndpointInput struct {

	// The ARN of the AppInstanceUser.
	//
	// This member is required.
	AppInstanceUserArn *string

	// The idempotency token for each client request.
	//
	// This member is required.
	ClientRequestToken *string

	// The attributes of an Endpoint.
	//
	// This member is required.
	EndpointAttributes *types.EndpointAttributes

	// The ARN of the resource to which the endpoint belongs.
	//
	// This member is required.
	ResourceArn *string

	// The type of the AppInstanceUserEndpoint. Supported types:
	//
	// * APNS: The mobile
	// notification service for an Apple device.
	//
	// * APNS_SANDBOX: The sandbox
	// environment of the mobile notification service for an Apple device.
	//
	// * GCM: The
	// mobile notification service for an Android device.
	//
	// Populate the ResourceArn
	// value of each type as PinpointAppArn.
	//
	// This member is required.
	Type types.AppInstanceUserEndpointType

	// Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive
	// messages. ALL indicates the endpoint receives all messages. NONE indicates the
	// endpoint receives no messages.
	AllowMessages types.AllowMessages

	// The name of the AppInstanceUserEndpoint.
	Name *string
	// contains filtered or unexported fields
}

type RegisterAppInstanceUserEndpointOutput added in v1.4.0 

type RegisterAppInstanceUserEndpointOutput struct {

	// The ARN of the AppInstanceUser.
	AppInstanceUserArn *string

	// The unique identifier of the AppInstanceUserEndpoint.
	EndpointId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type TagResourceInput added in v1.4.0 

type TagResourceInput struct {

	// The resource ARN.
	//
	// This member is required.
	ResourceARN *string

	// The tag key-value pairs.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput added in v1.4.0 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput added in v1.4.0 

type UntagResourceInput struct {

	// The resource ARN.
	//
	// This member is required.
	ResourceARN *string

	// The tag keys.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput added in v1.4.0 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAppInstanceInput 

type UpdateAppInstanceInput struct {

	// The ARN of the AppInstance.
	//
	// This member is required.
	AppInstanceArn *string

	// The metadata that you want to change.
	//
	// This member is required.
	Metadata *string

	// The name that you want to change.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type UpdateAppInstanceOutput 

type UpdateAppInstanceOutput struct {

	// The ARN of the AppInstance.
	AppInstanceArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAppInstanceUserEndpointInput added in v1.4.0 

type UpdateAppInstanceUserEndpointInput struct {

	// The ARN of the AppInstanceUser.
	//
	// This member is required.
	AppInstanceUserArn *string

	// The unique identifier of the AppInstanceUserEndpoint.
	//
	// This member is required.
	EndpointId *string

	// Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive
	// messages. ALL indicates the endpoint will receive all messages. NONE indicates
	// the endpoint will receive no messages.
	AllowMessages types.AllowMessages

	// The name of the AppInstanceUserEndpoint.
	Name *string
	// contains filtered or unexported fields
}

type UpdateAppInstanceUserEndpointOutput added in v1.4.0 

type UpdateAppInstanceUserEndpointOutput struct {

	// The ARN of the AppInstanceUser.
	AppInstanceUserArn *string

	// The unique identifier of the AppInstanceUserEndpoint.
	EndpointId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAppInstanceUserInput 

type UpdateAppInstanceUserInput struct {

	// The ARN of the AppInstanceUser.
	//
	// This member is required.
	AppInstanceUserArn *string

	// The metadata of the AppInstanceUser.
	//
	// This member is required.
	Metadata *string

	// The name of the AppInstanceUser.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type UpdateAppInstanceUserOutput 

type UpdateAppInstanceUserOutput struct {

	// The ARN of the AppInstanceUser.
	AppInstanceUserArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.