chimesdkmessaging

package module
v0.0.0-...-68f2935 Latest Latest
Warning

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

 Go to latest Published: May 24, 2024 License: Apache-2.0 Imports: 41 Imported by: 0

Documentation

Overview

Package chimesdkmessaging provides the API client, operations, and parameter types for Amazon Chime SDK Messaging.

The Amazon Chime SDK messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK identity APIs. For more information about the messaging APIs, see Amazon Chime SDK messaging.

Index

Constants

View Source 
const ServiceAPIVersion = "2021-05-15"
View Source 
const ServiceID = "Chime SDK Messaging"

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 deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AssociateChannelFlowInput 

type AssociateChannelFlowInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the channel flow.
	//
	// This member is required.
	ChannelFlowArn *string

	// The AppInstanceUserArn of the user making the API call.
	//
	// This member is required.
	ChimeBearer *string
	// contains filtered or unexported fields
}

type AssociateChannelFlowOutput 

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

type AuthResolverParameters 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchCreateChannelMembershipInput 

type BatchCreateChannelMembershipInput struct {

	// The ARN of the channel to which you're adding users or bots.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

	// The ARNs of the members you want to add to the channel. Only AppInstanceUsers
	// and AppInstanceBots can be added as a channel member.
	//
	// This member is required.
	MemberArns []string

	// The ID of the SubChannel in the request.
	//
	// Only required when creating membership in a SubChannel for a moderator in an
	// elastic channel.
	SubChannelId *string

	// The membership type of a user, DEFAULT or HIDDEN . Default members are always
	// returned as part of ListChannelMemberships . Hidden members are only returned if
	// the type filter in ListChannelMemberships equals HIDDEN . Otherwise hidden
	// members are not returned. This is only supported by moderators.
	Type types.ChannelMembershipType
	// contains filtered or unexported fields
}

type BatchCreateChannelMembershipOutput 

type BatchCreateChannelMembershipOutput struct {

	// The list of channel memberships in the response.
	BatchChannelMemberships *types.BatchChannelMemberships

	// If the action fails for one or more of the memberships in the request, a list
	// of the memberships is returned, along with error codes and error messages.
	Errors []types.BatchCreateChannelMembershipError

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

type ChannelFlowCallbackInput 

type ChannelFlowCallbackInput struct {

	// The identifier passed to the processor by the service when invoked. Use the
	// identifier to call back the service.
	//
	// This member is required.
	CallbackId *string

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// Stores information about the processed message.
	//
	// This member is required.
	ChannelMessage *types.ChannelMessageCallback

	// When a processor determines that a message needs to be DENIED , pass this
	// parameter with a value of true.
	DeleteResource bool
	// contains filtered or unexported fields
}

type ChannelFlowCallbackOutput 

type ChannelFlowCallbackOutput struct {

	// The call back ID passed in the request.
	CallbackId *string

	// The ARN of the channel.
	ChannelArn *string

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

type Client 

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

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

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) AssociateChannelFlow 

func (c *Client) AssociateChannelFlow(ctx context.Context, params *AssociateChannelFlowInput, optFns ...func(*Options)) (*AssociateChannelFlowOutput, error)

Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the DisassociateChannelFlow API.

Only administrators or channel moderators can associate a channel flow. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) BatchCreateChannelMembership 

func (c *Client) BatchCreateChannelMembership(ctx context.Context, params *BatchCreateChannelMembershipInput, optFns ...func(*Options)) (*BatchCreateChannelMembershipOutput, error)

Adds a specified number of users and bots to a channel.

func (*Client) ChannelFlowCallback 

func (c *Client) ChannelFlowCallback(ctx context.Context, params *ChannelFlowCallbackInput, optFns ...func(*Options)) (*ChannelFlowCallbackOutput, error)

Calls back Amazon Chime SDK messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.

You can return one of the following processing responses:

  • Update message content or metadata

  • Deny a message

  • Make no changes to the message

func (*Client) CreateChannel 

func (c *Client) CreateChannel(ctx context.Context, params *CreateChannelInput, optFns ...func(*Options)) (*CreateChannelOutput, error)

Creates a channel to which you can add users and send messages.

Restriction: You can't change a channel's privacy.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) CreateChannelBan 

func (c *Client) CreateChannelBan(ctx context.Context, params *CreateChannelBanInput, optFns ...func(*Options)) (*CreateChannelBanOutput, error)

Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan , and then CreateChannelMembership . Bans are cleaned up when you delete users or channels.

If you ban a user who is already part of a channel, that user is automatically kicked from the channel.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) CreateChannelFlow 

func (c *Client) CreateChannelFlow(ctx context.Context, params *CreateChannelFlowInput, optFns ...func(*Options)) (*CreateChannelFlowOutput, error)

Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API.

Channel flows process the following items:

  • New and updated messages

  • Persistent and non-persistent messages

  • The Standard message type

Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to Message typesin the Amazon Chime developer guide.

func (*Client) CreateChannelMembership 

func (c *Client) CreateChannelMembership(ctx context.Context, params *CreateChannelMembershipInput, optFns ...func(*Options)) (*CreateChannelMembershipOutput, error)

Adds a member to a channel. The InvitedBy field in ChannelMembership is derived from the request header. A channel member can:

  • List messages

  • Send messages

  • Receive messages

  • Edit their own messages

  • Leave the channel

Privacy settings impact this action as follows:

  • Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.

  • Private Channels: You must be a member to list or send messages.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in the header.

func (*Client) CreateChannelModerator 

func (c *Client) CreateChannelModerator(ctx context.Context, params *CreateChannelModeratorInput, optFns ...func(*Options)) (*CreateChannelModeratorOutput, error)

Creates a new ChannelModerator . A channel moderator can:

  • Add and remove other members of the channel.

  • Add and remove other moderators of the channel.

  • Add and remove user bans for the channel.

  • Redact messages in the channel.

  • List messages in the channel.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot of the user that makes the API call as the value in the header.

func (*Client) DeleteChannel 

func (c *Client) DeleteChannel(ctx context.Context, params *DeleteChannelInput, optFns ...func(*Options)) (*DeleteChannelOutput, error)

Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in the header.

func (*Client) DeleteChannelBan 

func (c *Client) DeleteChannelBan(ctx context.Context, params *DeleteChannelBanInput, optFns ...func(*Options)) (*DeleteChannelBanOutput, error)

Removes a member from a channel's ban list.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) DeleteChannelFlow 

func (c *Client) DeleteChannelFlow(ctx context.Context, params *DeleteChannelFlowInput, optFns ...func(*Options)) (*DeleteChannelFlowOutput, error)

Deletes a channel flow, an irreversible process. This is a developer API.

This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the ListChannelsAssociatedWithChannelFlow API. Use the DisassociateChannelFlow API to disassociate a channel flow from all channels.

func (*Client) DeleteChannelMembership 

func (c *Client) DeleteChannelMembership(ctx context.Context, params *DeleteChannelMembershipInput, optFns ...func(*Options)) (*DeleteChannelMembershipOutput, error)

Removes a member from a channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) DeleteChannelMessage 

func (c *Client) DeleteChannelMessage(ctx context.Context, params *DeleteChannelMessageInput, optFns ...func(*Options)) (*DeleteChannelMessageOutput, error)

Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage .

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) DeleteChannelModerator 

func (c *Client) DeleteChannelModerator(ctx context.Context, params *DeleteChannelModeratorInput, optFns ...func(*Options)) (*DeleteChannelModeratorOutput, error)

Deletes a channel moderator.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) DeleteMessagingStreamingConfigurations 

func (c *Client) DeleteMessagingStreamingConfigurations(ctx context.Context, params *DeleteMessagingStreamingConfigurationsInput, optFns ...func(*Options)) (*DeleteMessagingStreamingConfigurationsOutput, error)

Deletes the streaming configurations for an AppInstance . For more information, see Streaming messaging datain the Amazon Chime SDK Developer Guide.

func (*Client) DescribeChannel 

func (c *Client) DescribeChannel(ctx context.Context, params *DescribeChannelInput, optFns ...func(*Options)) (*DescribeChannelOutput, error)

Returns the full details of a channel in an Amazon Chime AppInstance .

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) DescribeChannelBan 

func (c *Client) DescribeChannelBan(ctx context.Context, params *DescribeChannelBanInput, optFns ...func(*Options)) (*DescribeChannelBanOutput, error)

Returns the full details of a channel ban.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) DescribeChannelFlow 

func (c *Client) DescribeChannelFlow(ctx context.Context, params *DescribeChannelFlowInput, optFns ...func(*Options)) (*DescribeChannelFlowOutput, error)

Returns the full details of a channel flow in an Amazon Chime AppInstance . This is a developer API.

func (*Client) DescribeChannelMembership 

func (c *Client) DescribeChannelMembership(ctx context.Context, params *DescribeChannelMembershipInput, optFns ...func(*Options)) (*DescribeChannelMembershipOutput, error)

Returns the full details of a user's channel membership.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) DescribeChannelMembershipForAppInstanceUser 

func (c *Client) DescribeChannelMembershipForAppInstanceUser(ctx context.Context, params *DescribeChannelMembershipForAppInstanceUserInput, optFns ...func(*Options)) (*DescribeChannelMembershipForAppInstanceUserOutput, error)
Returns the details of a channel based on the membership of the specified

AppInstanceUser or AppInstanceBot .

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) DescribeChannelModeratedByAppInstanceUser 

func (c *Client) DescribeChannelModeratedByAppInstanceUser(ctx context.Context, params *DescribeChannelModeratedByAppInstanceUserInput, optFns ...func(*Options)) (*DescribeChannelModeratedByAppInstanceUserOutput, error)

Returns the full details of a channel moderated by the specified AppInstanceUser or AppInstanceBot .

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) DescribeChannelModerator 

func (c *Client) DescribeChannelModerator(ctx context.Context, params *DescribeChannelModeratorInput, optFns ...func(*Options)) (*DescribeChannelModeratorOutput, error)

Returns the full details of a single ChannelModerator.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) DisassociateChannelFlow 

func (c *Client) DisassociateChannelFlow(ctx context.Context, params *DisassociateChannelFlowInput, optFns ...func(*Options)) (*DisassociateChannelFlowOutput, error)

Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor.

Only administrators or channel moderators can disassociate a channel flow.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) GetChannelMembershipPreferences 

func (c *Client) GetChannelMembershipPreferences(ctx context.Context, params *GetChannelMembershipPreferencesInput, optFns ...func(*Options)) (*GetChannelMembershipPreferencesOutput, error)

Gets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. A user or a bot must be a member of the channel and own the membership in order to retrieve membership preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the channel from which they are banned.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) GetChannelMessage 

func (c *Client) GetChannelMessage(ctx context.Context, params *GetChannelMessageInput, optFns ...func(*Options)) (*GetChannelMessageOutput, error)

Gets the full details of a channel message.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) GetChannelMessageStatus 

func (c *Client) GetChannelMessageStatus(ctx context.Context, params *GetChannelMessageStatusInput, optFns ...func(*Options)) (*GetChannelMessageStatusOutput, error)

Gets message status for a specified messageId . Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket.

Messages can have any one of these statuses.

SENT Message processed successfully

PENDING Ongoing processing

FAILED Processing failed

DENIED Message denied by the processor

  • This API does not return statuses for denied messages, because we don't store them once the processor denies them.

  • Only the message sender can invoke this API.

  • The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) GetMessagingSessionEndpoint 

func (c *Client) GetMessagingSessionEndpoint(ctx context.Context, params *GetMessagingSessionEndpointInput, optFns ...func(*Options)) (*GetMessagingSessionEndpointOutput, error)

The details of the endpoint for the messaging session.

func (*Client) GetMessagingStreamingConfigurations 

func (c *Client) GetMessagingStreamingConfigurations(ctx context.Context, params *GetMessagingStreamingConfigurationsInput, optFns ...func(*Options)) (*GetMessagingStreamingConfigurationsOutput, error)

Retrieves the data streaming configuration for an AppInstance . For more information, see Streaming messaging datain the Amazon Chime SDK Developer Guide.

func (*Client) ListChannelBans 

func (c *Client) ListChannelBans(ctx context.Context, params *ListChannelBansInput, optFns ...func(*Options)) (*ListChannelBansOutput, error)

Lists all the users and bots banned from a particular channel.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) ListChannelFlows 

func (c *Client) ListChannelFlows(ctx context.Context, params *ListChannelFlowsInput, optFns ...func(*Options)) (*ListChannelFlowsOutput, error)

Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.

func (*Client) ListChannelMemberships 

func (c *Client) ListChannelMemberships(ctx context.Context, params *ListChannelMembershipsInput, optFns ...func(*Options)) (*ListChannelMembershipsOutput, error)

Lists all channel memberships in a channel.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUserAPI.

func (*Client) ListChannelMembershipsForAppInstanceUser 

func (c *Client) ListChannelMembershipsForAppInstanceUser(ctx context.Context, params *ListChannelMembershipsForAppInstanceUserInput, optFns ...func(*Options)) (*ListChannelMembershipsForAppInstanceUserOutput, error)
Lists all channels that an AppInstanceUser or AppInstanceBot is a part of.

Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) ListChannelMessages 

func (c *Client) ListChannelMessages(ctx context.Context, params *ListChannelMessagesInput, optFns ...func(*Options)) (*ListChannelMessagesOutput, error)

List all the messages in a channel. Returns a paginated list of ChannelMessages . By default, sorted by creation timestamp in descending order.

Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.

Also, the x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) ListChannelModerators 

func (c *Client) ListChannelModerators(ctx context.Context, params *ListChannelModeratorsInput, optFns ...func(*Options)) (*ListChannelModeratorsOutput, error)

Lists all the moderators for a channel.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) ListChannels 

func (c *Client) ListChannels(ctx context.Context, params *ListChannelsInput, optFns ...func(*Options)) (*ListChannelsOutput, error)

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

Functionality & restrictions

  • Use privacy = PUBLIC to retrieve all public channels in the account.

  • Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) ListChannelsAssociatedWithChannelFlow 

func (c *Client) ListChannelsAssociatedWithChannelFlow(ctx context.Context, params *ListChannelsAssociatedWithChannelFlowInput, optFns ...func(*Options)) (*ListChannelsAssociatedWithChannelFlowOutput, error)

Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.

func (*Client) ListChannelsModeratedByAppInstanceUser 

func (c *Client) ListChannelsModeratedByAppInstanceUser(ctx context.Context, params *ListChannelsModeratedByAppInstanceUserInput, optFns ...func(*Options)) (*ListChannelsModeratedByAppInstanceUserOutput, error)

A list of the channels moderated by an AppInstanceUser .

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) ListSubChannels 

func (c *Client) ListSubChannels(ctx context.Context, params *ListSubChannelsInput, optFns ...func(*Options)) (*ListSubChannelsOutput, error)

Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.

func (*Client) ListTagsForResource 

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

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

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutChannelExpirationSettings 

func (c *Client) PutChannelExpirationSettings(ctx context.Context, params *PutChannelExpirationSettingsInput, optFns ...func(*Options)) (*PutChannelExpirationSettingsOutput, error)

Sets the number of days before the channel is automatically deleted.

  • A background process deletes expired channels within 6 hours of expiration. Actual deletion times may vary.

  • Expired channels that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.

  • The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) PutChannelMembershipPreferences 

func (c *Client) PutChannelMembershipPreferences(ctx context.Context, params *PutChannelMembershipPreferencesInput, optFns ...func(*Options)) (*PutChannelMembershipPreferencesOutput, error)

Sets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership can set preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't set preferences for other users. Banned users or bots can't set membership preferences for the channel from which they are banned.

The x-amz-chime-bearer request header is mandatory. Use the ARN of an AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) PutMessagingStreamingConfigurations 

func (c *Client) PutMessagingStreamingConfigurations(ctx context.Context, params *PutMessagingStreamingConfigurationsInput, optFns ...func(*Options)) (*PutMessagingStreamingConfigurationsOutput, error)

Sets the data streaming configuration for an AppInstance . For more information, see Streaming messaging datain the Amazon Chime SDK Developer Guide.

func (*Client) RedactChannelMessage 

func (c *Client) RedactChannelMessage(ctx context.Context, params *RedactChannelMessageInput, optFns ...func(*Options)) (*RedactChannelMessageOutput, error)

Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) SearchChannels 

func (c *Client) SearchChannels(ctx context.Context, params *SearchChannelsInput, optFns ...func(*Options)) (*SearchChannelsOutput, error)

Allows the ChimeBearer to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the AppInstanceAdmin role can search across all channels.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) SendChannelMessage 

func (c *Client) SendChannelMessage(ctx context.Context, params *SendChannelMessageInput, optFns ...func(*Options)) (*SendChannelMessageOutput, error)

Sends a message to a particular channel that the member is a part of.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Also, STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.

CONTROL messages are limited to 30 bytes and do not contain metadata.

func (*Client) TagResource 

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

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

func (*Client) UntagResource 

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

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

func (*Client) UpdateChannel 

func (c *Client) UpdateChannel(ctx context.Context, params *UpdateChannelInput, optFns ...func(*Options)) (*UpdateChannelOutput, error)

Update a channel's attributes.

Restriction: You can't change a channel's privacy.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) UpdateChannelFlow 

func (c *Client) UpdateChannelFlow(ctx context.Context, params *UpdateChannelFlowInput, optFns ...func(*Options)) (*UpdateChannelFlowOutput, error)

Updates channel flow attributes. This is a developer API.

func (*Client) UpdateChannelMessage 

func (c *Client) UpdateChannelMessage(ctx context.Context, params *UpdateChannelMessageInput, optFns ...func(*Options)) (*UpdateChannelMessageOutput, error)

Updates the content of a message.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

func (*Client) UpdateChannelReadMarker 

func (c *Client) UpdateChannelReadMarker(ctx context.Context, params *UpdateChannelReadMarkerInput, optFns ...func(*Options)) (*UpdateChannelReadMarkerOutput, error)

The details of the time when a user last read messages in a channel.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

type CreateChannelBanInput 

type CreateChannelBanInput struct {

	// The ARN of the ban request.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

	// The AppInstanceUserArn of the member being banned.
	//
	// This member is required.
	MemberArn *string
	// contains filtered or unexported fields
}

type CreateChannelBanOutput 

type CreateChannelBanOutput struct {

	// The ARN of the response to the ban request.
	ChannelArn *string

	// The ChannelArn and BannedIdentity of the member in the ban response.
	Member *types.Identity

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

type CreateChannelFlowInput 

type CreateChannelFlowInput struct {

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

	// The client token for the request. An Idempotency token.
	//
	// This member is required.
	ClientRequestToken *string

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

	// Information about the processor Lambda functions.
	//
	// This member is required.
	Processors []types.Processor

	// The tags for the creation request.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateChannelFlowOutput 

type CreateChannelFlowOutput struct {

	// The ARN of the channel flow.
	ChannelFlowArn *string

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

type CreateChannelInput 

type CreateChannelInput struct {

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

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

	// The client token for the request. An Idempotency token.
	//
	// This member is required.
	ClientRequestToken *string

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

	// The ID of the channel in the request.
	ChannelId *string

	// The attributes required to configure and create an elastic channel. An elastic
	// channel can support a maximum of 1-million users, excluding moderators.
	ElasticChannelConfiguration *types.ElasticChannelConfiguration

	// Settings that control the interval after which the channel is automatically
	// deleted.
	ExpirationSettings *types.ExpirationSettings

	// The ARNs of the channel members in the request.
	MemberArns []string

	// The metadata of the creation request. Limited to 1KB and UTF-8.
	Metadata *string

	// The channel mode: UNRESTRICTED or RESTRICTED . Administrators, moderators, and
	// channel members can add themselves and other members to unrestricted channels.
	// Only administrators and moderators can add members to restricted channels.
	Mode types.ChannelMode

	// The ARNs of the channel moderators in the request.
	ModeratorArns []string

	// The channel's privacy level: PUBLIC or PRIVATE . Private channels aren't
	// discoverable by users outside the channel. Public channels are discoverable by
	// anyone in the AppInstance .
	Privacy types.ChannelPrivacy

	// The tags for the creation request.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateChannelMembershipInput 

type CreateChannelMembershipInput struct {

	// The ARN of the channel to which you're adding users.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

	// The AppInstanceUserArn of the member you want to add to the channel.
	//
	// This member is required.
	MemberArn *string

	// The membership type of a user, DEFAULT or HIDDEN . Default members are always
	// returned as part of ListChannelMemberships . Hidden members are only returned if
	// the type filter in ListChannelMemberships equals HIDDEN . Otherwise hidden
	// members are not returned. This is only supported by moderators.
	//
	// This member is required.
	Type types.ChannelMembershipType

	// The ID of the SubChannel in the request.
	//
	// Only required when creating membership in a SubChannel for a moderator in an
	// elastic channel.
	SubChannelId *string
	// contains filtered or unexported fields
}

type CreateChannelMembershipOutput 

type CreateChannelMembershipOutput struct {

	// The ARN of the channel.
	ChannelArn *string

	// The ARN and metadata of the member being added.
	Member *types.Identity

	// The ID of the SubChannel in the response.
	SubChannelId *string

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

type CreateChannelModeratorInput 

type CreateChannelModeratorInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The AppInstanceUserArn of the moderator.
	//
	// This member is required.
	ChannelModeratorArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string
	// contains filtered or unexported fields
}

type CreateChannelModeratorOutput 

type CreateChannelModeratorOutput struct {

	// The ARN of the channel.
	ChannelArn *string

	// The ARNs of the channel and the moderator.
	ChannelModerator *types.Identity

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

type CreateChannelOutput 

type CreateChannelOutput struct {

	// The ARN of the channel.
	ChannelArn *string

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

type DeleteChannelBanInput 

type DeleteChannelBanInput struct {

	// The ARN of the channel from which the AppInstanceUser was banned.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

	// The ARN of the AppInstanceUser that you want to reinstate.
	//
	// This member is required.
	MemberArn *string
	// contains filtered or unexported fields
}

type DeleteChannelBanOutput 

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

type DeleteChannelFlowInput 

type DeleteChannelFlowInput struct {

	// The ARN of the channel flow.
	//
	// This member is required.
	ChannelFlowArn *string
	// contains filtered or unexported fields
}

type DeleteChannelFlowOutput 

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

type DeleteChannelInput 

type DeleteChannelInput struct {

	// The ARN of the channel being deleted.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string
	// contains filtered or unexported fields
}

type DeleteChannelMembershipInput 

type DeleteChannelMembershipInput struct {

	// The ARN of the channel from which you want to remove the user.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

	// The AppInstanceUserArn of the member that you're removing from the channel.
	//
	// This member is required.
	MemberArn *string

	// The ID of the SubChannel in the request.
	//
	// Only for use by moderators.
	SubChannelId *string
	// contains filtered or unexported fields
}

type DeleteChannelMembershipOutput 

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

type DeleteChannelMessageInput 

type DeleteChannelMessageInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

	// The ID of the message being deleted.
	//
	// This member is required.
	MessageId *string

	// The ID of the SubChannel in the request.
	//
	// Only required when deleting messages in a SubChannel that the user belongs to.
	SubChannelId *string
	// contains filtered or unexported fields
}

type DeleteChannelMessageOutput 

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

type DeleteChannelModeratorInput 

type DeleteChannelModeratorInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The AppInstanceUserArn of the moderator being deleted.
	//
	// This member is required.
	ChannelModeratorArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string
	// contains filtered or unexported fields
}

type DeleteChannelModeratorOutput 

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

type DeleteChannelOutput 

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

type DeleteMessagingStreamingConfigurationsInput 

type DeleteMessagingStreamingConfigurationsInput struct {

	// The ARN of the streaming configurations being deleted.
	//
	// This member is required.
	AppInstanceArn *string
	// contains filtered or unexported fields
}

type DeleteMessagingStreamingConfigurationsOutput 

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

type DescribeChannelBanInput 

type DescribeChannelBanInput struct {

	// The ARN of the channel from which the user is banned.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

	// The AppInstanceUserArn of the member being banned.
	//
	// This member is required.
	MemberArn *string
	// contains filtered or unexported fields
}

type DescribeChannelBanOutput 

type DescribeChannelBanOutput struct {

	// The details of the ban.
	ChannelBan *types.ChannelBan

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

type DescribeChannelFlowInput 

type DescribeChannelFlowInput struct {

	// The ARN of the channel flow.
	//
	// This member is required.
	ChannelFlowArn *string
	// contains filtered or unexported fields
}

type DescribeChannelFlowOutput 

type DescribeChannelFlowOutput struct {

	// The channel flow details.
	ChannelFlow *types.ChannelFlow

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

type DescribeChannelInput 

type DescribeChannelInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string
	// contains filtered or unexported fields
}

type DescribeChannelMembershipForAppInstanceUserInput 

type DescribeChannelMembershipForAppInstanceUserInput struct {

	// The ARN of the user or bot in a channel.
	//
	// This member is required.
	AppInstanceUserArn *string

	// The ARN of the channel to which the user belongs.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string
	// contains filtered or unexported fields
}

type DescribeChannelMembershipForAppInstanceUserOutput 

type DescribeChannelMembershipForAppInstanceUserOutput struct {

	// The channel to which a user belongs.
	ChannelMembership *types.ChannelMembershipForAppInstanceUserSummary

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

type DescribeChannelMembershipInput 

type DescribeChannelMembershipInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

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

	// The ID of the SubChannel in the request. The response contains an
	// ElasticChannelConfiguration object.
	//
	// Only required to get a user’s SubChannel membership details.
	SubChannelId *string
	// contains filtered or unexported fields
}

type DescribeChannelMembershipOutput 

type DescribeChannelMembershipOutput struct {

	// The details of the membership.
	ChannelMembership *types.ChannelMembership

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

type DescribeChannelModeratedByAppInstanceUserInput 

type DescribeChannelModeratedByAppInstanceUserInput struct {

	// The ARN of the user or bot in the moderated channel.
	//
	// This member is required.
	AppInstanceUserArn *string

	// The ARN of the moderated channel.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string
	// contains filtered or unexported fields
}

type DescribeChannelModeratedByAppInstanceUserOutput 

type DescribeChannelModeratedByAppInstanceUserOutput struct {

	// The moderated channel.
	Channel *types.ChannelModeratedByAppInstanceUserSummary

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

type DescribeChannelModeratorInput 

type DescribeChannelModeratorInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The AppInstanceUserArn of the channel moderator.
	//
	// This member is required.
	ChannelModeratorArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string
	// contains filtered or unexported fields
}

type DescribeChannelModeratorOutput 

type DescribeChannelModeratorOutput struct {

	// The details of the channel moderator.
	ChannelModerator *types.ChannelModerator

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

type DescribeChannelOutput 

type DescribeChannelOutput struct {

	// The channel details.
	Channel *types.Channel

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

type DisassociateChannelFlowInput 

type DisassociateChannelFlowInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the channel flow.
	//
	// This member is required.
	ChannelFlowArn *string

	// The AppInstanceUserArn of the user making the API call.
	//
	// This member is required.
	ChimeBearer *string
	// contains filtered or unexported fields
}

type DisassociateChannelFlowOutput 

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

type EndpointParameters 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

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 EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetChannelMembershipPreferencesInput 

type GetChannelMembershipPreferencesInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

	// The AppInstanceUserArn of the member retrieving the preferences.
	//
	// This member is required.
	MemberArn *string
	// contains filtered or unexported fields
}

type GetChannelMembershipPreferencesOutput 

type GetChannelMembershipPreferencesOutput struct {

	// The ARN of the channel.
	ChannelArn *string

	// The details of a user.
	Member *types.Identity

	// The channel membership preferences for an AppInstanceUser .
	Preferences *types.ChannelMembershipPreferences

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

type GetChannelMessageInput 

type GetChannelMessageInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

	// The ID of the message.
	//
	// This member is required.
	MessageId *string

	// The ID of the SubChannel in the request.
	//
	// Only required when getting messages in a SubChannel that the user belongs to.
	SubChannelId *string
	// contains filtered or unexported fields
}

type GetChannelMessageOutput 

type GetChannelMessageOutput struct {

	// The details of and content in the message.
	ChannelMessage *types.ChannelMessage

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

type GetChannelMessageStatusInput 

type GetChannelMessageStatusInput struct {

	// The ARN of the channel
	//
	// This member is required.
	ChannelArn *string

	// The AppInstanceUserArn of the user making the API call.
	//
	// This member is required.
	ChimeBearer *string

	// The ID of the message.
	//
	// This member is required.
	MessageId *string

	// The ID of the SubChannel in the request.
	//
	// Only required when getting message status in a SubChannel that the user belongs
	// to.
	SubChannelId *string
	// contains filtered or unexported fields
}

type GetChannelMessageStatusOutput 

type GetChannelMessageStatusOutput struct {

	// The message status and details.
	Status *types.ChannelMessageStatusStructure

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

type GetMessagingSessionEndpointInput 

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

type GetMessagingSessionEndpointOutput 

type GetMessagingSessionEndpointOutput struct {

	// The endpoint returned in the response.
	Endpoint *types.MessagingSessionEndpoint

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

type GetMessagingStreamingConfigurationsInput 

type GetMessagingStreamingConfigurationsInput struct {

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

type GetMessagingStreamingConfigurationsOutput 

type GetMessagingStreamingConfigurationsOutput struct {

	// The streaming settings.
	StreamingConfigurations []types.StreamingConfiguration

	// 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 ListChannelBansAPIClient 

type ListChannelBansAPIClient interface {
	ListChannelBans(context.Context, *ListChannelBansInput, ...func(*Options)) (*ListChannelBansOutput, error)
}

ListChannelBansAPIClient is a client that implements the ListChannelBans operation.

type ListChannelBansInput 

type ListChannelBansInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

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

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

type ListChannelBansOutput 

type ListChannelBansOutput struct {

	// The ARN of the channel.
	ChannelArn *string

	// The information for each requested ban.
	ChannelBans []types.ChannelBanSummary

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

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

type ListChannelBansPaginator 

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

ListChannelBansPaginator is a paginator for ListChannelBans

func NewListChannelBansPaginator 

func NewListChannelBansPaginator(client ListChannelBansAPIClient, params *ListChannelBansInput, optFns ...func(*ListChannelBansPaginatorOptions)) *ListChannelBansPaginator

NewListChannelBansPaginator returns a new ListChannelBansPaginator

func (*ListChannelBansPaginator) HasMorePages 

func (p *ListChannelBansPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChannelBansPaginator) NextPage 

func (p *ListChannelBansPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChannelBansOutput, error)

NextPage retrieves the next ListChannelBans page.

type ListChannelBansPaginatorOptions 

type ListChannelBansPaginatorOptions struct {
	// The maximum number of bans 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
}

ListChannelBansPaginatorOptions is the paginator options for ListChannelBans

type ListChannelFlowsAPIClient 

type ListChannelFlowsAPIClient interface {
	ListChannelFlows(context.Context, *ListChannelFlowsInput, ...func(*Options)) (*ListChannelFlowsOutput, error)
}

ListChannelFlowsAPIClient is a client that implements the ListChannelFlows operation.

type ListChannelFlowsInput 

type ListChannelFlowsInput struct {

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

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

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

type ListChannelFlowsOutput 

type ListChannelFlowsOutput struct {

	// The information about each channel flow.
	ChannelFlows []types.ChannelFlowSummary

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

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

type ListChannelFlowsPaginator 

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

ListChannelFlowsPaginator is a paginator for ListChannelFlows

func NewListChannelFlowsPaginator 

func NewListChannelFlowsPaginator(client ListChannelFlowsAPIClient, params *ListChannelFlowsInput, optFns ...func(*ListChannelFlowsPaginatorOptions)) *ListChannelFlowsPaginator

NewListChannelFlowsPaginator returns a new ListChannelFlowsPaginator

func (*ListChannelFlowsPaginator) HasMorePages 

func (p *ListChannelFlowsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChannelFlowsPaginator) NextPage 

func (p *ListChannelFlowsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChannelFlowsOutput, error)

NextPage retrieves the next ListChannelFlows page.

type ListChannelFlowsPaginatorOptions 

type ListChannelFlowsPaginatorOptions struct {
	// The maximum number of channel flows 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
}

ListChannelFlowsPaginatorOptions is the paginator options for ListChannelFlows

type ListChannelMembershipsAPIClient 

type ListChannelMembershipsAPIClient interface {
	ListChannelMemberships(context.Context, *ListChannelMembershipsInput, ...func(*Options)) (*ListChannelMembershipsOutput, error)
}

ListChannelMembershipsAPIClient is a client that implements the ListChannelMemberships operation.

type ListChannelMembershipsForAppInstanceUserAPIClient 

type ListChannelMembershipsForAppInstanceUserAPIClient interface {
	ListChannelMembershipsForAppInstanceUser(context.Context, *ListChannelMembershipsForAppInstanceUserInput, ...func(*Options)) (*ListChannelMembershipsForAppInstanceUserOutput, error)
}

ListChannelMembershipsForAppInstanceUserAPIClient is a client that implements the ListChannelMembershipsForAppInstanceUser operation.

type ListChannelMembershipsForAppInstanceUserInput 

type ListChannelMembershipsForAppInstanceUserInput struct {

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

	// The ARN of the user or bot.
	AppInstanceUserArn *string

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

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

type ListChannelMembershipsForAppInstanceUserOutput 

type ListChannelMembershipsForAppInstanceUserOutput struct {

	// The information for the requested channel memberships.
	ChannelMemberships []types.ChannelMembershipForAppInstanceUserSummary

	// 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 ListChannelMembershipsForAppInstanceUserPaginator 

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

ListChannelMembershipsForAppInstanceUserPaginator is a paginator for ListChannelMembershipsForAppInstanceUser

func NewListChannelMembershipsForAppInstanceUserPaginator 

func NewListChannelMembershipsForAppInstanceUserPaginator(client ListChannelMembershipsForAppInstanceUserAPIClient, params *ListChannelMembershipsForAppInstanceUserInput, optFns ...func(*ListChannelMembershipsForAppInstanceUserPaginatorOptions)) *ListChannelMembershipsForAppInstanceUserPaginator

NewListChannelMembershipsForAppInstanceUserPaginator returns a new ListChannelMembershipsForAppInstanceUserPaginator

func (*ListChannelMembershipsForAppInstanceUserPaginator) HasMorePages 

func (p *ListChannelMembershipsForAppInstanceUserPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChannelMembershipsForAppInstanceUserPaginator) NextPage 

func (p *ListChannelMembershipsForAppInstanceUserPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChannelMembershipsForAppInstanceUserOutput, error)

NextPage retrieves the next ListChannelMembershipsForAppInstanceUser page.

type ListChannelMembershipsForAppInstanceUserPaginatorOptions 

type ListChannelMembershipsForAppInstanceUserPaginatorOptions struct {
	// The maximum number of users 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
}

ListChannelMembershipsForAppInstanceUserPaginatorOptions is the paginator options for ListChannelMembershipsForAppInstanceUser

type ListChannelMembershipsInput 

type ListChannelMembershipsInput struct {

	// The maximum number of channel memberships that you want returned.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

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

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

	// The ID of the SubChannel in the request.
	//
	// Only required when listing a user's memberships in a particular sub-channel of
	// an elastic channel.
	SubChannelId *string

	// The membership type of a user, DEFAULT or HIDDEN . Default members are returned
	// as part of ListChannelMemberships if no type is specified. Hidden members are
	// only returned if the type filter in ListChannelMemberships equals HIDDEN .
	Type types.ChannelMembershipType
	// contains filtered or unexported fields
}

type ListChannelMembershipsOutput 

type ListChannelMembershipsOutput struct {

	// The ARN of the channel.
	ChannelArn *string

	// The information for the requested channel memberships.
	ChannelMemberships []types.ChannelMembershipSummary

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

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

type ListChannelMembershipsPaginator 

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

ListChannelMembershipsPaginator is a paginator for ListChannelMemberships

func NewListChannelMembershipsPaginator 

func NewListChannelMembershipsPaginator(client ListChannelMembershipsAPIClient, params *ListChannelMembershipsInput, optFns ...func(*ListChannelMembershipsPaginatorOptions)) *ListChannelMembershipsPaginator

NewListChannelMembershipsPaginator returns a new ListChannelMembershipsPaginator

func (*ListChannelMembershipsPaginator) HasMorePages 

func (p *ListChannelMembershipsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChannelMembershipsPaginator) NextPage 

func (p *ListChannelMembershipsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChannelMembershipsOutput, error)

NextPage retrieves the next ListChannelMemberships page.

type ListChannelMembershipsPaginatorOptions 

type ListChannelMembershipsPaginatorOptions struct {
	// The maximum number of channel memberships 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
}

ListChannelMembershipsPaginatorOptions is the paginator options for ListChannelMemberships

type ListChannelMessagesAPIClient 

type ListChannelMessagesAPIClient interface {
	ListChannelMessages(context.Context, *ListChannelMessagesInput, ...func(*Options)) (*ListChannelMessagesOutput, error)
}

ListChannelMessagesAPIClient is a client that implements the ListChannelMessages operation.

type ListChannelMessagesInput 

type ListChannelMessagesInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

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

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

	// The final or ending time stamp for your requested messages.
	NotAfter *time.Time

	// The initial or starting time stamp for your requested messages.
	NotBefore *time.Time

	// The order in which you want messages sorted. Default is Descending, based on
	// time created.
	SortOrder types.SortOrder

	// The ID of the SubChannel in the request.
	//
	// Only required when listing the messages in a SubChannel that the user belongs
	// to.
	SubChannelId *string
	// contains filtered or unexported fields
}

type ListChannelMessagesOutput 

type ListChannelMessagesOutput struct {

	// The ARN of the channel containing the requested messages.
	ChannelArn *string

	// The information about, and content of, each requested message.
	ChannelMessages []types.ChannelMessageSummary

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

	// The ID of the SubChannel in the response.
	SubChannelId *string

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

type ListChannelMessagesPaginator 

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

ListChannelMessagesPaginator is a paginator for ListChannelMessages

func NewListChannelMessagesPaginator 

func NewListChannelMessagesPaginator(client ListChannelMessagesAPIClient, params *ListChannelMessagesInput, optFns ...func(*ListChannelMessagesPaginatorOptions)) *ListChannelMessagesPaginator

NewListChannelMessagesPaginator returns a new ListChannelMessagesPaginator

func (*ListChannelMessagesPaginator) HasMorePages 

func (p *ListChannelMessagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChannelMessagesPaginator) NextPage 

func (p *ListChannelMessagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChannelMessagesOutput, error)

NextPage retrieves the next ListChannelMessages page.

type ListChannelMessagesPaginatorOptions 

type ListChannelMessagesPaginatorOptions struct {
	// The maximum number of messages 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
}

ListChannelMessagesPaginatorOptions is the paginator options for ListChannelMessages

type ListChannelModeratorsAPIClient 

type ListChannelModeratorsAPIClient interface {
	ListChannelModerators(context.Context, *ListChannelModeratorsInput, ...func(*Options)) (*ListChannelModeratorsOutput, error)
}

ListChannelModeratorsAPIClient is a client that implements the ListChannelModerators operation.

type ListChannelModeratorsInput 

type ListChannelModeratorsInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

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

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

type ListChannelModeratorsOutput 

type ListChannelModeratorsOutput struct {

	// The ARN of the channel.
	ChannelArn *string

	// The information about and names of each moderator.
	ChannelModerators []types.ChannelModeratorSummary

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

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

type ListChannelModeratorsPaginator 

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

ListChannelModeratorsPaginator is a paginator for ListChannelModerators

func NewListChannelModeratorsPaginator 

func NewListChannelModeratorsPaginator(client ListChannelModeratorsAPIClient, params *ListChannelModeratorsInput, optFns ...func(*ListChannelModeratorsPaginatorOptions)) *ListChannelModeratorsPaginator

NewListChannelModeratorsPaginator returns a new ListChannelModeratorsPaginator

func (*ListChannelModeratorsPaginator) HasMorePages 

func (p *ListChannelModeratorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChannelModeratorsPaginator) NextPage 

func (p *ListChannelModeratorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChannelModeratorsOutput, error)

NextPage retrieves the next ListChannelModerators page.

type ListChannelModeratorsPaginatorOptions 

type ListChannelModeratorsPaginatorOptions struct {
	// The maximum number of moderators 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
}

ListChannelModeratorsPaginatorOptions is the paginator options for ListChannelModerators

type ListChannelsAPIClient 

type ListChannelsAPIClient interface {
	ListChannels(context.Context, *ListChannelsInput, ...func(*Options)) (*ListChannelsOutput, error)
}

ListChannelsAPIClient is a client that implements the ListChannels operation.

type ListChannelsAssociatedWithChannelFlowAPIClient 

type ListChannelsAssociatedWithChannelFlowAPIClient interface {
	ListChannelsAssociatedWithChannelFlow(context.Context, *ListChannelsAssociatedWithChannelFlowInput, ...func(*Options)) (*ListChannelsAssociatedWithChannelFlowOutput, error)
}

ListChannelsAssociatedWithChannelFlowAPIClient is a client that implements the ListChannelsAssociatedWithChannelFlow operation.

type ListChannelsAssociatedWithChannelFlowInput 

type ListChannelsAssociatedWithChannelFlowInput struct {

	// The ARN of the channel flow.
	//
	// This member is required.
	ChannelFlowArn *string

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

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

type ListChannelsAssociatedWithChannelFlowOutput 

type ListChannelsAssociatedWithChannelFlowOutput struct {

	// The information about each channel.
	Channels []types.ChannelAssociatedWithFlowSummary

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

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

type ListChannelsAssociatedWithChannelFlowPaginator 

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

ListChannelsAssociatedWithChannelFlowPaginator is a paginator for ListChannelsAssociatedWithChannelFlow

func NewListChannelsAssociatedWithChannelFlowPaginator 

func NewListChannelsAssociatedWithChannelFlowPaginator(client ListChannelsAssociatedWithChannelFlowAPIClient, params *ListChannelsAssociatedWithChannelFlowInput, optFns ...func(*ListChannelsAssociatedWithChannelFlowPaginatorOptions)) *ListChannelsAssociatedWithChannelFlowPaginator

NewListChannelsAssociatedWithChannelFlowPaginator returns a new ListChannelsAssociatedWithChannelFlowPaginator

func (*ListChannelsAssociatedWithChannelFlowPaginator) HasMorePages 

func (p *ListChannelsAssociatedWithChannelFlowPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChannelsAssociatedWithChannelFlowPaginator) NextPage 

func (p *ListChannelsAssociatedWithChannelFlowPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChannelsAssociatedWithChannelFlowOutput, error)

NextPage retrieves the next ListChannelsAssociatedWithChannelFlow page.

type ListChannelsAssociatedWithChannelFlowPaginatorOptions 

type ListChannelsAssociatedWithChannelFlowPaginatorOptions struct {
	// The maximum number of channels 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
}

ListChannelsAssociatedWithChannelFlowPaginatorOptions is the paginator options for ListChannelsAssociatedWithChannelFlow

type ListChannelsInput 

type ListChannelsInput struct {

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

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

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

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

	// The privacy setting. PUBLIC retrieves all the public channels. PRIVATE
	// retrieves private channels. Only an AppInstanceAdmin can retrieve private
	// channels.
	Privacy types.ChannelPrivacy
	// contains filtered or unexported fields
}

type ListChannelsModeratedByAppInstanceUserAPIClient 

type ListChannelsModeratedByAppInstanceUserAPIClient interface {
	ListChannelsModeratedByAppInstanceUser(context.Context, *ListChannelsModeratedByAppInstanceUserInput, ...func(*Options)) (*ListChannelsModeratedByAppInstanceUserOutput, error)
}

ListChannelsModeratedByAppInstanceUserAPIClient is a client that implements the ListChannelsModeratedByAppInstanceUser operation.

type ListChannelsModeratedByAppInstanceUserInput 

type ListChannelsModeratedByAppInstanceUserInput struct {

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

	// The ARN of the user or bot in the moderated channel.
	AppInstanceUserArn *string

	// The maximum number of channels in the request.
	MaxResults *int32

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

type ListChannelsModeratedByAppInstanceUserOutput 

type ListChannelsModeratedByAppInstanceUserOutput struct {

	// The moderated channels in the request.
	Channels []types.ChannelModeratedByAppInstanceUserSummary

	// The token returned from previous API requests until the number of channels
	// moderated by the user is reached.
	NextToken *string

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

type ListChannelsModeratedByAppInstanceUserPaginator 

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

ListChannelsModeratedByAppInstanceUserPaginator is a paginator for ListChannelsModeratedByAppInstanceUser

func NewListChannelsModeratedByAppInstanceUserPaginator 

func NewListChannelsModeratedByAppInstanceUserPaginator(client ListChannelsModeratedByAppInstanceUserAPIClient, params *ListChannelsModeratedByAppInstanceUserInput, optFns ...func(*ListChannelsModeratedByAppInstanceUserPaginatorOptions)) *ListChannelsModeratedByAppInstanceUserPaginator

NewListChannelsModeratedByAppInstanceUserPaginator returns a new ListChannelsModeratedByAppInstanceUserPaginator

func (*ListChannelsModeratedByAppInstanceUserPaginator) HasMorePages 

func (p *ListChannelsModeratedByAppInstanceUserPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChannelsModeratedByAppInstanceUserPaginator) NextPage 

func (p *ListChannelsModeratedByAppInstanceUserPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChannelsModeratedByAppInstanceUserOutput, error)

NextPage retrieves the next ListChannelsModeratedByAppInstanceUser page.

type ListChannelsModeratedByAppInstanceUserPaginatorOptions 

type ListChannelsModeratedByAppInstanceUserPaginatorOptions struct {
	// The maximum number of channels in the request.
	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
}

ListChannelsModeratedByAppInstanceUserPaginatorOptions is the paginator options for ListChannelsModeratedByAppInstanceUser

type ListChannelsOutput 

type ListChannelsOutput struct {

	// The information about each channel.
	Channels []types.ChannelSummary

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

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

type ListChannelsPaginator 

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

ListChannelsPaginator is a paginator for ListChannels

func NewListChannelsPaginator 

func NewListChannelsPaginator(client ListChannelsAPIClient, params *ListChannelsInput, optFns ...func(*ListChannelsPaginatorOptions)) *ListChannelsPaginator

NewListChannelsPaginator returns a new ListChannelsPaginator

func (*ListChannelsPaginator) HasMorePages 

func (p *ListChannelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChannelsPaginator) NextPage 

func (p *ListChannelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChannelsOutput, error)

NextPage retrieves the next ListChannels page.

type ListChannelsPaginatorOptions 

type ListChannelsPaginatorOptions struct {
	// The maximum number of channels 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
}

ListChannelsPaginatorOptions is the paginator options for ListChannels

type ListSubChannelsAPIClient 

type ListSubChannelsAPIClient interface {
	ListSubChannels(context.Context, *ListSubChannelsInput, ...func(*Options)) (*ListSubChannelsOutput, error)
}

ListSubChannelsAPIClient is a client that implements the ListSubChannels operation.

type ListSubChannelsInput 

type ListSubChannelsInput struct {

	// The ARN of elastic channel.
	//
	// This member is required.
	ChannelArn *string

	// The AppInstanceUserArn of the user making the API call.
	//
	// This member is required.
	ChimeBearer *string

	// The maximum number of sub-channels that you want to return.
	MaxResults *int32

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

type ListSubChannelsOutput 

type ListSubChannelsOutput struct {

	// The ARN of elastic channel.
	ChannelArn *string

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

	// The information about each sub-channel.
	SubChannels []types.SubChannelSummary

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

type ListSubChannelsPaginator 

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

ListSubChannelsPaginator is a paginator for ListSubChannels

func NewListSubChannelsPaginator 

func NewListSubChannelsPaginator(client ListSubChannelsAPIClient, params *ListSubChannelsInput, optFns ...func(*ListSubChannelsPaginatorOptions)) *ListSubChannelsPaginator

NewListSubChannelsPaginator returns a new ListSubChannelsPaginator

func (*ListSubChannelsPaginator) HasMorePages 

func (p *ListSubChannelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSubChannelsPaginator) NextPage 

func (p *ListSubChannelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSubChannelsOutput, error)

NextPage retrieves the next ListSubChannels page.

type ListSubChannelsPaginatorOptions 

type ListSubChannelsPaginatorOptions struct {
	// The maximum number of sub-channels 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
}

ListSubChannelsPaginatorOptions is the paginator options for ListSubChannels

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

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

type ListTagsForResourceOutput 

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

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// 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.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// 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.
	//
	// 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

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutChannelExpirationSettingsInput 

type PutChannelExpirationSettingsInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	ChimeBearer *string

	// Settings that control the interval after which a channel is deleted.
	ExpirationSettings *types.ExpirationSettings
	// contains filtered or unexported fields
}

type PutChannelExpirationSettingsOutput 

type PutChannelExpirationSettingsOutput struct {

	// The channel ARN.
	ChannelArn *string

	// Settings that control the interval after which a channel is deleted.
	ExpirationSettings *types.ExpirationSettings

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

type PutChannelMembershipPreferencesInput 

type PutChannelMembershipPreferencesInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

	// The ARN of the member setting the preferences.
	//
	// This member is required.
	MemberArn *string

	// The channel membership preferences of an AppInstanceUser .
	//
	// This member is required.
	Preferences *types.ChannelMembershipPreferences
	// contains filtered or unexported fields
}

type PutChannelMembershipPreferencesOutput 

type PutChannelMembershipPreferencesOutput struct {

	// The ARN of the channel.
	ChannelArn *string

	// The details of a user.
	Member *types.Identity

	// The ARN and metadata of the member being added.
	Preferences *types.ChannelMembershipPreferences

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

type PutMessagingStreamingConfigurationsInput 

type PutMessagingStreamingConfigurationsInput struct {

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

	// The streaming configurations.
	//
	// This member is required.
	StreamingConfigurations []types.StreamingConfiguration
	// contains filtered or unexported fields
}

type PutMessagingStreamingConfigurationsOutput 

type PutMessagingStreamingConfigurationsOutput struct {

	// The requested streaming configurations.
	StreamingConfigurations []types.StreamingConfiguration

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

type RedactChannelMessageInput 

type RedactChannelMessageInput struct {

	// The ARN of the channel containing the messages that you want to redact.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

	// The ID of the message being redacted.
	//
	// This member is required.
	MessageId *string

	// The ID of the SubChannel in the request.
	SubChannelId *string
	// contains filtered or unexported fields
}

type RedactChannelMessageOutput 

type RedactChannelMessageOutput struct {

	// The ARN of the channel containing the messages that you want to redact.
	ChannelArn *string

	// The ID of the message being redacted.
	MessageId *string

	// The ID of the SubChannel in the response.
	//
	// Only required when redacting messages in a SubChannel that the user belongs to.
	SubChannelId *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 SearchChannelsAPIClient 

type SearchChannelsAPIClient interface {
	SearchChannels(context.Context, *SearchChannelsInput, ...func(*Options)) (*SearchChannelsOutput, error)
}

SearchChannelsAPIClient is a client that implements the SearchChannels operation.

type SearchChannelsInput 

type SearchChannelsInput struct {

	// A list of the Field objects in the channel being searched.
	//
	// This member is required.
	Fields []types.SearchField

	// The AppInstanceUserArn of the user making the API call.
	ChimeBearer *string

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

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

type SearchChannelsOutput 

type SearchChannelsOutput struct {

	// A list of the channels in the request.
	Channels []types.ChannelSummary

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

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

type SearchChannelsPaginator 

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

SearchChannelsPaginator is a paginator for SearchChannels

func NewSearchChannelsPaginator 

func NewSearchChannelsPaginator(client SearchChannelsAPIClient, params *SearchChannelsInput, optFns ...func(*SearchChannelsPaginatorOptions)) *SearchChannelsPaginator

NewSearchChannelsPaginator returns a new SearchChannelsPaginator

func (*SearchChannelsPaginator) HasMorePages 

func (p *SearchChannelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchChannelsPaginator) NextPage 

func (p *SearchChannelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchChannelsOutput, error)

NextPage retrieves the next SearchChannels page.

type SearchChannelsPaginatorOptions 

type SearchChannelsPaginatorOptions struct {
	// The maximum number of channels 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
}

SearchChannelsPaginatorOptions is the paginator options for SearchChannels

type SendChannelMessageInput 

type SendChannelMessageInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

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

	// The content of the channel message.
	//
	// This member is required.
	Content *string

	// Boolean that controls whether the message is persisted on the back end.
	// Required.
	//
	// This member is required.
	Persistence types.ChannelMessagePersistenceType

	// The type of message, STANDARD or CONTROL .
	//
	// STANDARD messages can be up to 4KB in size and contain metadata. Metadata is
	// arbitrary, and you can use it in a variety of ways, such as containing a link to
	// an attachment.
	//
	// CONTROL messages are limited to 30 bytes and do not contain metadata.
	//
	// This member is required.
	Type types.ChannelMessageType

	// The content type of the channel message.
	ContentType *string

	// The attributes for the message, used for message filtering along with a
	// FilterRule defined in the PushNotificationPreferences .
	MessageAttributes map[string]types.MessageAttributeValue

	// The optional metadata for each message.
	Metadata *string

	// The push notification configuration of the message.
	PushNotification *types.PushNotificationConfiguration

	// The ID of the SubChannel in the request.
	SubChannelId *string

	// The target of a message. Must be a member of the channel, such as another user,
	// a bot, or the sender. Only the target and the sender can view targeted messages.
	// Only users who can see targeted messages can take actions on them. However,
	// administrators can delete targeted messages that they can’t see.
	Target []types.Target
	// contains filtered or unexported fields
}

type SendChannelMessageOutput 

type SendChannelMessageOutput struct {

	// The ARN of the channel.
	ChannelArn *string

	// The ID string assigned to each message.
	MessageId *string

	// The status of the channel message.
	Status *types.ChannelMessageStatusStructure

	// The ID of the SubChannel in the response.
	SubChannelId *string

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

type TagResourceInput 

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 

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

type UntagResourceInput 

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 

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

type UpdateChannelFlowInput 

type UpdateChannelFlowInput struct {

	// The ARN of the channel flow.
	//
	// This member is required.
	ChannelFlowArn *string

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

	// Information about the processor Lambda functions
	//
	// This member is required.
	Processors []types.Processor
	// contains filtered or unexported fields
}

type UpdateChannelFlowOutput 

type UpdateChannelFlowOutput struct {

	// The ARN of the channel flow.
	ChannelFlowArn *string

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

type UpdateChannelInput 

type UpdateChannelInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

	// The metadata for the update request.
	Metadata *string

	// The mode of the update request.
	Mode types.ChannelMode

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

type UpdateChannelMessageInput 

type UpdateChannelMessageInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string

	// The content of the channel message.
	//
	// This member is required.
	Content *string

	// The ID string of the message being updated.
	//
	// This member is required.
	MessageId *string

	// The content type of the channel message.
	ContentType *string

	// The metadata of the message being updated.
	Metadata *string

	// The ID of the SubChannel in the request.
	//
	// Only required when updating messages in a SubChannel that the user belongs to.
	SubChannelId *string
	// contains filtered or unexported fields
}

type UpdateChannelMessageOutput 

type UpdateChannelMessageOutput struct {

	// The ARN of the channel.
	ChannelArn *string

	// The ID string of the message being updated.
	MessageId *string

	// The status of the message update.
	Status *types.ChannelMessageStatusStructure

	// The ID of the SubChannel in the response.
	SubChannelId *string

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

type UpdateChannelOutput 

type UpdateChannelOutput struct {

	// The ARN of the channel.
	ChannelArn *string

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

type UpdateChannelReadMarkerInput 

type UpdateChannelReadMarkerInput struct {

	// The ARN of the channel.
	//
	// This member is required.
	ChannelArn *string

	// The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
	//
	// This member is required.
	ChimeBearer *string
	// contains filtered or unexported fields
}

type UpdateChannelReadMarkerOutput 

type UpdateChannelReadMarkerOutput struct {

	// The ARN of the channel.
	ChannelArn *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.