chime

package module
v1.2.0 Latest Latest
Warning

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

Go to latest
Published: Mar 18, 2021 License: Apache-2.0 Imports: 30 Imported by: 5

Documentation

Overview

Package chime provides the API client, operations, and parameter types for Amazon Chime.

The Amazon Chime API (application programming interface) is designed for developers to perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes. It also includes some server-side API actions to use with the Amazon Chime SDK. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide. You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI. Using an AWS SDK You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center (http://aws.amazon.com/developer/). Using the AWS CLI Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface (https://docs.aws.amazon.com/cli/latest/userguide/installing.html) in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands (https://docs.aws.amazon.com/cli/latest/reference/chime/index.html) in the AWS CLI Command Reference. Using REST APIs If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the Amazon Web Services General Reference. When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com. Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime (https://docs.aws.amazon.com/chime/latest/ag/security-iam.html) in the Amazon Chime Administration Guide.

Index

Constants

View Source
const ServiceAPIVersion = "2018-05-01"
View Source
const ServiceID = "Chime"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0

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

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

func WithEndpointResolver

func WithEndpointResolver(v EndpointResolver) func(*Options)

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

Types

type AssociatePhoneNumberWithUserInput

type AssociatePhoneNumberWithUserInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The phone number, in E.164 format.
	//
	// This member is required.
	E164PhoneNumber *string

	// The user ID.
	//
	// This member is required.
	UserId *string
}

type AssociatePhoneNumberWithUserOutput

type AssociatePhoneNumberWithUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociatePhoneNumbersWithVoiceConnectorGroupInput

type AssociatePhoneNumbersWithVoiceConnectorGroupInput struct {

	// List of phone numbers, in E.164 format.
	//
	// This member is required.
	E164PhoneNumbers []string

	// The Amazon Chime Voice Connector group ID.
	//
	// This member is required.
	VoiceConnectorGroupId *string

	// If true, associates the provided phone numbers with the provided Amazon Chime
	// Voice Connector Group and removes any previously existing associations. If
	// false, does not associate any phone numbers that have previously existing
	// associations.
	ForceAssociate *bool
}

type AssociatePhoneNumbersWithVoiceConnectorGroupOutput

type AssociatePhoneNumbersWithVoiceConnectorGroupOutput struct {

	// If the action fails for one or more of the phone numbers in the request, a list
	// of the phone numbers is returned, along with error codes and error messages.
	PhoneNumberErrors []types.PhoneNumberError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociatePhoneNumbersWithVoiceConnectorInput

type AssociatePhoneNumbersWithVoiceConnectorInput struct {

	// List of phone numbers, in E.164 format.
	//
	// This member is required.
	E164PhoneNumbers []string

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string

	// If true, associates the provided phone numbers with the provided Amazon Chime
	// Voice Connector and removes any previously existing associations. If false, does
	// not associate any phone numbers that have previously existing associations.
	ForceAssociate *bool
}

type AssociatePhoneNumbersWithVoiceConnectorOutput

type AssociatePhoneNumbersWithVoiceConnectorOutput struct {

	// If the action fails for one or more of the phone numbers in the request, a list
	// of the phone numbers is returned, along with error codes and error messages.
	PhoneNumberErrors []types.PhoneNumberError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociateSigninDelegateGroupsWithAccountInput

type AssociateSigninDelegateGroupsWithAccountInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The sign-in delegate groups.
	//
	// This member is required.
	SigninDelegateGroups []types.SigninDelegateGroup
}

type AssociateSigninDelegateGroupsWithAccountOutput

type AssociateSigninDelegateGroupsWithAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type BatchCreateAttendeeInput

type BatchCreateAttendeeInput struct {

	// The request containing the attendees to create.
	//
	// This member is required.
	Attendees []types.CreateAttendeeRequestItem

	// The Amazon Chime SDK meeting ID.
	//
	// This member is required.
	MeetingId *string
}

type BatchCreateAttendeeOutput

type BatchCreateAttendeeOutput struct {

	// The attendee information, including attendees IDs and join tokens.
	Attendees []types.Attendee

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type BatchCreateRoomMembershipInput

type BatchCreateRoomMembershipInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The list of membership items.
	//
	// This member is required.
	MembershipItemList []types.MembershipItem

	// The room ID.
	//
	// This member is required.
	RoomId *string
}

type BatchCreateRoomMembershipOutput

type BatchCreateRoomMembershipOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type BatchDeletePhoneNumberInput

type BatchDeletePhoneNumberInput struct {

	// List of phone number IDs.
	//
	// This member is required.
	PhoneNumberIds []string
}

type BatchDeletePhoneNumberOutput

type BatchDeletePhoneNumberOutput struct {

	// If the action fails for one or more of the phone numbers in the request, a list
	// of the phone numbers is returned, along with error codes and error messages.
	PhoneNumberErrors []types.PhoneNumberError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type BatchSuspendUserInput

type BatchSuspendUserInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The request containing the user IDs to suspend.
	//
	// This member is required.
	UserIdList []string
}

type BatchSuspendUserOutput

type BatchSuspendUserOutput struct {

	// If the BatchSuspendUser action fails for one or more of the user IDs in the
	// request, a list of the user IDs is returned, along with error codes and error
	// messages.
	UserErrors []types.UserError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type BatchUnsuspendUserInput

type BatchUnsuspendUserInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The request containing the user IDs to unsuspend.
	//
	// This member is required.
	UserIdList []string
}

type BatchUnsuspendUserOutput

type BatchUnsuspendUserOutput struct {

	// If the BatchUnsuspendUser action fails for one or more of the user IDs in the
	// request, a list of the user IDs is returned, along with error codes and error
	// messages.
	UserErrors []types.UserError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type BatchUpdatePhoneNumberInput

type BatchUpdatePhoneNumberInput struct {

	// The request containing the phone number IDs and product types or calling names
	// to update.
	//
	// This member is required.
	UpdatePhoneNumberRequestItems []types.UpdatePhoneNumberRequestItem
}

type BatchUpdatePhoneNumberOutput

type BatchUpdatePhoneNumberOutput struct {

	// If the action fails for one or more of the phone numbers in the request, a list
	// of the phone numbers is returned, along with error codes and error messages.
	PhoneNumberErrors []types.PhoneNumberError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type BatchUpdateUserInput

type BatchUpdateUserInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The request containing the user IDs and details to update.
	//
	// This member is required.
	UpdateUserRequestItems []types.UpdateUserRequestItem
}

type BatchUpdateUserOutput

type BatchUpdateUserOutput struct {

	// If the BatchUpdateUser action fails for one or more of the user IDs in the
	// request, a list of the user IDs is returned, along with error codes and error
	// messages.
	UserErrors []types.UserError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Client

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

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

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

func (c *Client) AssociatePhoneNumberWithUser(ctx context.Context, params *AssociatePhoneNumberWithUserInput, optFns ...func(*Options)) (*AssociatePhoneNumberWithUserOutput, error)

Associates a phone number with the specified Amazon Chime user.

func (*Client) AssociatePhoneNumbersWithVoiceConnector

func (c *Client) AssociatePhoneNumbersWithVoiceConnector(ctx context.Context, params *AssociatePhoneNumbersWithVoiceConnectorInput, optFns ...func(*Options)) (*AssociatePhoneNumbersWithVoiceConnectorOutput, error)

Associates phone numbers with the specified Amazon Chime Voice Connector.

func (*Client) AssociatePhoneNumbersWithVoiceConnectorGroup

func (c *Client) AssociatePhoneNumbersWithVoiceConnectorGroup(ctx context.Context, params *AssociatePhoneNumbersWithVoiceConnectorGroupInput, optFns ...func(*Options)) (*AssociatePhoneNumbersWithVoiceConnectorGroupOutput, error)

Associates phone numbers with the specified Amazon Chime Voice Connector group.

func (*Client) AssociateSigninDelegateGroupsWithAccount

func (c *Client) AssociateSigninDelegateGroupsWithAccount(ctx context.Context, params *AssociateSigninDelegateGroupsWithAccountInput, optFns ...func(*Options)) (*AssociateSigninDelegateGroupsWithAccountOutput, error)

Associates the specified sign-in delegate groups with the specified Amazon Chime account.

func (*Client) BatchCreateAttendee

func (c *Client) BatchCreateAttendee(ctx context.Context, params *BatchCreateAttendeeInput, optFns ...func(*Options)) (*BatchCreateAttendeeOutput, error)

Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide.

func (*Client) BatchCreateRoomMembership

func (c *Client) BatchCreateRoomMembership(ctx context.Context, params *BatchCreateRoomMembershipInput, optFns ...func(*Options)) (*BatchCreateRoomMembershipOutput, error)

Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.

func (*Client) BatchDeletePhoneNumber

func (c *Client) BatchDeletePhoneNumber(ctx context.Context, params *BatchDeletePhoneNumberInput, optFns ...func(*Options)) (*BatchDeletePhoneNumberOutput, error)

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted. Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

func (*Client) BatchSuspendUser

func (c *Client) BatchSuspendUser(ctx context.Context, params *BatchSuspendUserInput, optFns ...func(*Options)) (*BatchSuspendUserOutput, error)

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the Amazon Chime Administration Guide. Users suspended from a Team account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so. Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action. To sign out users without suspending them, use the LogoutUser action.

func (*Client) BatchUnsuspendUser

func (c *Client) BatchUnsuspendUser(ctx context.Context, params *BatchUnsuspendUserInput, optFns ...func(*Options)) (*BatchUnsuspendUserOutput, error)

Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the Amazon Chime Administration Guide. Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.

func (*Client) BatchUpdatePhoneNumber

func (c *Client) BatchUpdatePhoneNumber(ctx context.Context, params *BatchUpdatePhoneNumberInput, optFns ...func(*Options)) (*BatchUpdatePhoneNumberOutput, error)

Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem . For example, you can update either the product type or the calling name. For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. For toll-free numbers, you must use the Amazon Chime Voice Connector product type. Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

func (*Client) BatchUpdateUser

func (c *Client) BatchUpdateUser(ctx context.Context, params *BatchUpdateUserInput, optFns ...func(*Options)) (*BatchUpdateUserOutput, error)

Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.

func (*Client) CreateAccount

func (c *Client) CreateAccount(ctx context.Context, params *CreateAccountInput, optFns ...func(*Options)) (*CreateAccountOutput, error)

Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the Amazon Chime Administration Guide.

func (*Client) CreateAppInstance added in v0.30.0

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

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

func (*Client) CreateAppInstanceAdmin added in v0.30.0

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

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

* ChannelModerator actions across all channels in the AppInstance.

* DeleteChannelMessage actions.

Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

func (*Client) CreateAppInstanceUser added in v0.30.0

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

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

func (*Client) CreateAttendee

func (c *Client) CreateAttendee(ctx context.Context, params *CreateAttendeeInput, optFns ...func(*Options)) (*CreateAttendeeOutput, error)

Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide.

func (*Client) CreateBot

func (c *Client) CreateBot(ctx context.Context, params *CreateBotInput, optFns ...func(*Options)) (*CreateBotOutput, error)

Creates a bot for an Amazon Chime Enterprise account.

func (*Client) CreateChannel added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) CreateChannelBan added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) CreateChannelMembership added in v0.30.0

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

Adds a user to a channel. The InvitedBy response field 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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) CreateChannelModerator added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) CreateMeeting

func (c *Client) CreateMeeting(ctx context.Context, params *CreateMeetingInput, optFns ...func(*Options)) (*CreateMeetingOutput, error)

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions (https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html) in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide .

func (*Client) CreateMeetingDialOut added in v0.30.0

func (c *Client) CreateMeetingDialOut(ctx context.Context, params *CreateMeetingDialOutInput, optFns ...func(*Options)) (*CreateMeetingDialOutOutput, error)

Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer. To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall action with the corresponding SIP media application ID.

func (*Client) CreateMeetingWithAttendees

func (c *Client) CreateMeetingWithAttendees(ctx context.Context, params *CreateMeetingWithAttendeesInput, optFns ...func(*Options)) (*CreateMeetingWithAttendeesOutput, error)

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions (https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html) in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide .

func (*Client) CreatePhoneNumberOrder

func (c *Client) CreatePhoneNumberOrder(ctx context.Context, params *CreatePhoneNumberOrderInput, optFns ...func(*Options)) (*CreatePhoneNumberOrderOutput, error)

Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.

func (*Client) CreateProxySession

func (c *Client) CreateProxySession(ctx context.Context, params *CreateProxySessionInput, optFns ...func(*Options)) (*CreateProxySessionOutput, error)

Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

func (*Client) CreateRoom

func (c *Client) CreateRoom(ctx context.Context, params *CreateRoomInput, optFns ...func(*Options)) (*CreateRoomOutput, error)

Creates a chat room for the specified Amazon Chime Enterprise account.

func (*Client) CreateRoomMembership

func (c *Client) CreateRoomMembership(ctx context.Context, params *CreateRoomMembershipInput, optFns ...func(*Options)) (*CreateRoomMembershipOutput, error)

Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.

func (*Client) CreateSipMediaApplication added in v0.30.0

func (c *Client) CreateSipMediaApplication(ctx context.Context, params *CreateSipMediaApplicationInput, optFns ...func(*Options)) (*CreateSipMediaApplicationOutput, error)

Creates a SIP media application.

func (*Client) CreateSipMediaApplicationCall added in v0.30.0

func (c *Client) CreateSipMediaApplicationCall(ctx context.Context, params *CreateSipMediaApplicationCallInput, optFns ...func(*Options)) (*CreateSipMediaApplicationCallOutput, error)

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

func (*Client) CreateSipRule added in v0.30.0

func (c *Client) CreateSipRule(ctx context.Context, params *CreateSipRuleInput, optFns ...func(*Options)) (*CreateSipRuleOutput, error)

Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

func (*Client) CreateUser

func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error)

Creates a user under the specified Amazon Chime account.

func (*Client) CreateVoiceConnector

func (c *Client) CreateVoiceConnector(ctx context.Context, params *CreateVoiceConnectorInput, optFns ...func(*Options)) (*CreateVoiceConnectorOutput, error)

Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region. Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.

func (*Client) CreateVoiceConnectorGroup

func (c *Client) CreateVoiceConnectorGroup(ctx context.Context, params *CreateVoiceConnectorGroupInput, optFns ...func(*Options)) (*CreateVoiceConnectorGroupOutput, error)

Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request. You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

func (*Client) DeleteAccount

func (c *Client) DeleteAccount(ctx context.Context, params *DeleteAccountInput, optFns ...func(*Options)) (*DeleteAccountOutput, error)

Deletes the specified Amazon Chime account. You must suspend all users before deleting Team account. You can use the BatchSuspendUser action to dodo. For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended. Deleted accounts appear in your Disabled accounts list for 90 days. To restore deleted account from your Disabled accounts list, you must contact AWS Support. After 90 days, deleted accounts are permanently removed from your Disabled accounts list.

func (*Client) DeleteAppInstance added in v0.30.0

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

Deletes an AppInstance and all associated data asynchronously.

func (*Client) DeleteAppInstanceAdmin added in v0.30.0

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

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

func (*Client) DeleteAppInstanceStreamingConfigurations added in v0.30.0

func (c *Client) DeleteAppInstanceStreamingConfigurations(ctx context.Context, params *DeleteAppInstanceStreamingConfigurationsInput, optFns ...func(*Options)) (*DeleteAppInstanceStreamingConfigurationsOutput, error)

Deletes the streaming configurations of an AppInstance.

func (*Client) DeleteAppInstanceUser added in v0.30.0

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

Deletes an AppInstanceUser.

func (*Client) DeleteAttendee

func (c *Client) DeleteAttendee(ctx context.Context, params *DeleteAttendeeInput, optFns ...func(*Options)) (*DeleteAttendeeOutput, error)

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken . Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide .

func (*Client) DeleteChannel added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) DeleteChannelBan added in v0.30.0

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

Removes a user from a channel's ban list. 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) DeleteChannelMembership added in v0.30.0

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 added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) DeleteChannelModerator added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) DeleteEventsConfiguration

func (c *Client) DeleteEventsConfiguration(ctx context.Context, params *DeleteEventsConfigurationInput, optFns ...func(*Options)) (*DeleteEventsConfigurationOutput, error)

Deletes the events configuration that allows a bot to receive outgoing events.

func (*Client) DeleteMeeting

func (c *Client) DeleteMeeting(ctx context.Context, params *DeleteMeetingInput, optFns ...func(*Options)) (*DeleteMeetingOutput, error)

Deletes the specified Amazon Chime SDK meeting. When a meeting is deleted, its attendees are also deleted, clients connected to the meeting are disconnected, and clients can no longer join the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide.

func (*Client) DeletePhoneNumber

func (c *Client) DeletePhoneNumber(ctx context.Context, params *DeletePhoneNumberInput, optFns ...func(*Options)) (*DeletePhoneNumberOutput, error)

Moves the specified phone number into the Deletionqueue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted. Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

func (*Client) DeleteProxySession

func (c *Client) DeleteProxySession(ctx context.Context, params *DeleteProxySessionInput, optFns ...func(*Options)) (*DeleteProxySessionOutput, error)

Deletes the specified proxy session from the specified Amazon Chime Voice Connector.

func (*Client) DeleteRoom

func (c *Client) DeleteRoom(ctx context.Context, params *DeleteRoomInput, optFns ...func(*Options)) (*DeleteRoomOutput, error)

Deletes a chat room in an Amazon Chime Enterprise account.

func (*Client) DeleteRoomMembership

func (c *Client) DeleteRoomMembership(ctx context.Context, params *DeleteRoomMembershipInput, optFns ...func(*Options)) (*DeleteRoomMembershipOutput, error)

Removes a member from a chat room in an Amazon Chime Enterprise account.

func (*Client) DeleteSipMediaApplication added in v0.30.0

func (c *Client) DeleteSipMediaApplication(ctx context.Context, params *DeleteSipMediaApplicationInput, optFns ...func(*Options)) (*DeleteSipMediaApplicationOutput, error)

Deletes a SIP media application.

func (*Client) DeleteSipRule added in v0.30.0

func (c *Client) DeleteSipRule(ctx context.Context, params *DeleteSipRuleInput, optFns ...func(*Options)) (*DeleteSipRuleOutput, error)

Deletes a SIP rule. You must disable a SIP rule before you can delete it.

func (*Client) DeleteVoiceConnector

func (c *Client) DeleteVoiceConnector(ctx context.Context, params *DeleteVoiceConnectorInput, optFns ...func(*Options)) (*DeleteVoiceConnectorOutput, error)

Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.

func (*Client) DeleteVoiceConnectorEmergencyCallingConfiguration

func (c *Client) DeleteVoiceConnectorEmergencyCallingConfiguration(ctx context.Context, params *DeleteVoiceConnectorEmergencyCallingConfigurationInput, optFns ...func(*Options)) (*DeleteVoiceConnectorEmergencyCallingConfigurationOutput, error)

Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.

func (*Client) DeleteVoiceConnectorGroup

func (c *Client) DeleteVoiceConnectorGroup(ctx context.Context, params *DeleteVoiceConnectorGroupInput, optFns ...func(*Options)) (*DeleteVoiceConnectorGroupOutput, error)

Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.

func (*Client) DeleteVoiceConnectorOrigination

func (c *Client) DeleteVoiceConnectorOrigination(ctx context.Context, params *DeleteVoiceConnectorOriginationInput, optFns ...func(*Options)) (*DeleteVoiceConnectorOriginationOutput, error)

Deletes the origination settings for the specified Amazon Chime Voice Connector. If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.

func (*Client) DeleteVoiceConnectorProxy

func (c *Client) DeleteVoiceConnectorProxy(ctx context.Context, params *DeleteVoiceConnectorProxyInput, optFns ...func(*Options)) (*DeleteVoiceConnectorProxyOutput, error)

Deletes the proxy configuration from the specified Amazon Chime Voice Connector.

func (*Client) DeleteVoiceConnectorStreamingConfiguration

func (c *Client) DeleteVoiceConnectorStreamingConfiguration(ctx context.Context, params *DeleteVoiceConnectorStreamingConfigurationInput, optFns ...func(*Options)) (*DeleteVoiceConnectorStreamingConfigurationOutput, error)

Deletes the streaming configuration for the specified Amazon Chime Voice Connector.

func (*Client) DeleteVoiceConnectorTermination

func (c *Client) DeleteVoiceConnectorTermination(ctx context.Context, params *DeleteVoiceConnectorTerminationInput, optFns ...func(*Options)) (*DeleteVoiceConnectorTerminationOutput, error)

Deletes the termination settings for the specified Amazon Chime Voice Connector. If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.

func (*Client) DeleteVoiceConnectorTerminationCredentials

func (c *Client) DeleteVoiceConnectorTerminationCredentials(ctx context.Context, params *DeleteVoiceConnectorTerminationCredentialsInput, optFns ...func(*Options)) (*DeleteVoiceConnectorTerminationCredentialsOutput, error)

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

func (*Client) DescribeAppInstance added in v0.30.0

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

Returns the full details of an AppInstance.

func (*Client) DescribeAppInstanceAdmin added in v0.30.0

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

Returns the full details of an AppInstanceAdmin.

func (*Client) DescribeAppInstanceUser added in v0.30.0

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

Returns the full details of an AppInstanceUser .

func (*Client) DescribeChannel added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) DescribeChannelBan added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) DescribeChannelMembership added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) DescribeChannelMembershipForAppInstanceUser added in v0.30.0

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. 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) DescribeChannelModeratedByAppInstanceUser added in v0.30.0

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. 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) DescribeChannelModerator added in v0.30.0

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

func (c *Client) DisassociatePhoneNumberFromUser(ctx context.Context, params *DisassociatePhoneNumberFromUserInput, optFns ...func(*Options)) (*DisassociatePhoneNumberFromUserOutput, error)

Disassociates the primary provisioned phone number from the specified Amazon Chime user.

func (*Client) DisassociatePhoneNumbersFromVoiceConnector

func (c *Client) DisassociatePhoneNumbersFromVoiceConnector(ctx context.Context, params *DisassociatePhoneNumbersFromVoiceConnectorInput, optFns ...func(*Options)) (*DisassociatePhoneNumbersFromVoiceConnectorOutput, error)

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.

func (*Client) DisassociatePhoneNumbersFromVoiceConnectorGroup

func (c *Client) DisassociatePhoneNumbersFromVoiceConnectorGroup(ctx context.Context, params *DisassociatePhoneNumbersFromVoiceConnectorGroupInput, optFns ...func(*Options)) (*DisassociatePhoneNumbersFromVoiceConnectorGroupOutput, error)

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.

func (*Client) DisassociateSigninDelegateGroupsFromAccount

func (c *Client) DisassociateSigninDelegateGroupsFromAccount(ctx context.Context, params *DisassociateSigninDelegateGroupsFromAccountInput, optFns ...func(*Options)) (*DisassociateSigninDelegateGroupsFromAccountOutput, error)

Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.

func (*Client) GetAccount

func (c *Client) GetAccount(ctx context.Context, params *GetAccountInput, optFns ...func(*Options)) (*GetAccountOutput, error)

Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

func (*Client) GetAccountSettings

func (c *Client) GetAccountSettings(ctx context.Context, params *GetAccountSettingsInput, optFns ...func(*Options)) (*GetAccountSettingsOutput, error)

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page (https://docs.aws.amazon.com/chime/latest/ag/policies.html) in the Amazon Chime Administration Guide.

func (*Client) GetAppInstanceRetentionSettings added in v0.30.0

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

Gets the retention settings for an AppInstance.

func (*Client) GetAppInstanceStreamingConfigurations added in v0.30.0

func (c *Client) GetAppInstanceStreamingConfigurations(ctx context.Context, params *GetAppInstanceStreamingConfigurationsInput, optFns ...func(*Options)) (*GetAppInstanceStreamingConfigurationsOutput, error)

Gets the streaming settings for an AppInstance.

func (*Client) GetAttendee

func (c *Client) GetAttendee(ctx context.Context, params *GetAttendeeInput, optFns ...func(*Options)) (*GetAttendeeOutput, error)

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide .

func (*Client) GetBot

func (c *Client) GetBot(ctx context.Context, params *GetBotInput, optFns ...func(*Options)) (*GetBotOutput, error)

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

func (*Client) GetChannelMessage added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) GetEventsConfiguration

func (c *Client) GetEventsConfiguration(ctx context.Context, params *GetEventsConfigurationInput, optFns ...func(*Options)) (*GetEventsConfigurationOutput, error)

Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

func (*Client) GetGlobalSettings

func (c *Client) GetGlobalSettings(ctx context.Context, params *GetGlobalSettingsInput, optFns ...func(*Options)) (*GetGlobalSettingsOutput, error)

Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

func (*Client) GetMeeting

func (c *Client) GetMeeting(ctx context.Context, params *GetMeetingInput, optFns ...func(*Options)) (*GetMeetingOutput, error)

Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide .

func (*Client) GetMessagingSessionEndpoint added in v0.30.0

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

func (c *Client) GetPhoneNumber(ctx context.Context, params *GetPhoneNumberInput, optFns ...func(*Options)) (*GetPhoneNumberOutput, error)

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

func (*Client) GetPhoneNumberOrder

func (c *Client) GetPhoneNumberOrder(ctx context.Context, params *GetPhoneNumberOrderInput, optFns ...func(*Options)) (*GetPhoneNumberOrderOutput, error)

Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.

func (*Client) GetPhoneNumberSettings

func (c *Client) GetPhoneNumberSettings(ctx context.Context, params *GetPhoneNumberSettingsInput, optFns ...func(*Options)) (*GetPhoneNumberSettingsOutput, error)

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

func (*Client) GetProxySession

func (c *Client) GetProxySession(ctx context.Context, params *GetProxySessionInput, optFns ...func(*Options)) (*GetProxySessionOutput, error)

Gets the specified proxy session details for the specified Amazon Chime Voice Connector.

func (*Client) GetRetentionSettings

func (c *Client) GetRetentionSettings(ctx context.Context, params *GetRetentionSettingsInput, optFns ...func(*Options)) (*GetRetentionSettingsOutput, error)

Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies (https://docs.aws.amazon.com/chime/latest/ag/chat-retention.html) in the Amazon Chime Administration Guide .

func (*Client) GetRoom

func (c *Client) GetRoom(ctx context.Context, params *GetRoomInput, optFns ...func(*Options)) (*GetRoomOutput, error)

Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

func (*Client) GetSipMediaApplication added in v0.30.0

func (c *Client) GetSipMediaApplication(ctx context.Context, params *GetSipMediaApplicationInput, optFns ...func(*Options)) (*GetSipMediaApplicationOutput, error)

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

func (*Client) GetSipMediaApplicationLoggingConfiguration added in v0.30.0

func (c *Client) GetSipMediaApplicationLoggingConfiguration(ctx context.Context, params *GetSipMediaApplicationLoggingConfigurationInput, optFns ...func(*Options)) (*GetSipMediaApplicationLoggingConfigurationOutput, error)

Returns the logging configuration for the specified SIP media application.

func (*Client) GetSipRule added in v0.30.0

func (c *Client) GetSipRule(ctx context.Context, params *GetSipRuleInput, optFns ...func(*Options)) (*GetSipRuleOutput, error)

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

func (*Client) GetUser

func (c *Client) GetUser(ctx context.Context, params *GetUserInput, optFns ...func(*Options)) (*GetUserOutput, error)

Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN. To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.

func (*Client) GetUserSettings

func (c *Client) GetUserSettings(ctx context.Context, params *GetUserSettingsInput, optFns ...func(*Options)) (*GetUserSettingsOutput, error)

Retrieves settings for the specified user ID, such as any associated phone number settings.

func (*Client) GetVoiceConnector

func (c *Client) GetVoiceConnector(ctx context.Context, params *GetVoiceConnectorInput, optFns ...func(*Options)) (*GetVoiceConnectorOutput, error)

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

func (*Client) GetVoiceConnectorEmergencyCallingConfiguration

func (c *Client) GetVoiceConnectorEmergencyCallingConfiguration(ctx context.Context, params *GetVoiceConnectorEmergencyCallingConfigurationInput, optFns ...func(*Options)) (*GetVoiceConnectorEmergencyCallingConfigurationOutput, error)

Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.

func (*Client) GetVoiceConnectorGroup

func (c *Client) GetVoiceConnectorGroup(ctx context.Context, params *GetVoiceConnectorGroupInput, optFns ...func(*Options)) (*GetVoiceConnectorGroupOutput, error)

Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems .

func (*Client) GetVoiceConnectorLoggingConfiguration

func (c *Client) GetVoiceConnectorLoggingConfiguration(ctx context.Context, params *GetVoiceConnectorLoggingConfigurationInput, optFns ...func(*Options)) (*GetVoiceConnectorLoggingConfigurationOutput, error)

Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

func (*Client) GetVoiceConnectorOrigination

func (c *Client) GetVoiceConnectorOrigination(ctx context.Context, params *GetVoiceConnectorOriginationInput, optFns ...func(*Options)) (*GetVoiceConnectorOriginationOutput, error)

Retrieves origination setting details for the specified Amazon Chime Voice Connector.

func (*Client) GetVoiceConnectorProxy

func (c *Client) GetVoiceConnectorProxy(ctx context.Context, params *GetVoiceConnectorProxyInput, optFns ...func(*Options)) (*GetVoiceConnectorProxyOutput, error)

Gets the proxy configuration details for the specified Amazon Chime Voice Connector.

func (*Client) GetVoiceConnectorStreamingConfiguration

func (c *Client) GetVoiceConnectorStreamingConfiguration(ctx context.Context, params *GetVoiceConnectorStreamingConfigurationInput, optFns ...func(*Options)) (*GetVoiceConnectorStreamingConfigurationOutput, error)

Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

func (*Client) GetVoiceConnectorTermination

func (c *Client) GetVoiceConnectorTermination(ctx context.Context, params *GetVoiceConnectorTerminationInput, optFns ...func(*Options)) (*GetVoiceConnectorTerminationOutput, error)

Retrieves termination setting details for the specified Amazon Chime Voice Connector.

func (*Client) GetVoiceConnectorTerminationHealth

func (c *Client) GetVoiceConnectorTerminationHealth(ctx context.Context, params *GetVoiceConnectorTerminationHealthInput, optFns ...func(*Options)) (*GetVoiceConnectorTerminationHealthOutput, error)

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.

func (*Client) InviteUsers

func (c *Client) InviteUsers(ctx context.Context, params *InviteUsersInput, optFns ...func(*Options)) (*InviteUsersOutput, error)

Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.

func (*Client) ListAccounts

func (c *Client) ListAccounts(ctx context.Context, params *ListAccountsInput, optFns ...func(*Options)) (*ListAccountsOutput, error)

Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, toucan filter by the user's email address, which returns one account result.

func (*Client) ListAppInstanceAdmins added in v0.30.0

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

Returns a list of the administrators in the AppInstance.

func (*Client) ListAppInstanceUsers added in v0.30.0

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

List all AppInstanceUsers created under a single AppInstance.

func (*Client) ListAppInstances added in v0.30.0

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

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

func (*Client) ListAttendeeTags

func (c *Client) ListAttendeeTags(ctx context.Context, params *ListAttendeeTagsInput, optFns ...func(*Options)) (*ListAttendeeTagsOutput, error)

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

func (*Client) ListAttendees

func (c *Client) ListAttendees(ctx context.Context, params *ListAttendeesInput, optFns ...func(*Options)) (*ListAttendeesOutput, error)

Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide .

func (*Client) ListBots

func (c *Client) ListBots(ctx context.Context, params *ListBotsInput, optFns ...func(*Options)) (*ListBotsOutput, error)

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

func (*Client) ListChannelBans added in v0.30.0

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

Lists all the users banned from a particular 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) ListChannelMemberships added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) ListChannelMembershipsForAppInstanceUser added in v0.30.0

func (c *Client) ListChannelMembershipsForAppInstanceUser(ctx context.Context, params *ListChannelMembershipsForAppInstanceUserInput, optFns ...func(*Options)) (*ListChannelMembershipsForAppInstanceUserOutput, error)

Lists all channels that a particular AppInstanceUser 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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) ListChannelMessages added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) ListChannelModerators added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) ListChannels added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) ListChannelsModeratedByAppInstanceUser added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) ListMeetingTags

func (c *Client) ListMeetingTags(ctx context.Context, params *ListMeetingTagsInput, optFns ...func(*Options)) (*ListMeetingTagsOutput, error)

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

func (*Client) ListMeetings

func (c *Client) ListMeetings(ctx context.Context, params *ListMeetingsInput, optFns ...func(*Options)) (*ListMeetingsOutput, error)

Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon Chime Developer Guide .

func (*Client) ListPhoneNumberOrders

func (c *Client) ListPhoneNumberOrders(ctx context.Context, params *ListPhoneNumberOrdersInput, optFns ...func(*Options)) (*ListPhoneNumberOrdersOutput, error)

Lists the phone number orders for the administrator's Amazon Chime account.

func (*Client) ListPhoneNumbers

func (c *Client) ListPhoneNumbers(ctx context.Context, params *ListPhoneNumbersInput, optFns ...func(*Options)) (*ListPhoneNumbersOutput, error)

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

func (*Client) ListProxySessions

func (c *Client) ListProxySessions(ctx context.Context, params *ListProxySessionsInput, optFns ...func(*Options)) (*ListProxySessionsOutput, error)

Lists the proxy sessions for the specified Amazon Chime Voice Connector.

func (*Client) ListRoomMemberships

func (c *Client) ListRoomMemberships(ctx context.Context, params *ListRoomMembershipsInput, optFns ...func(*Options)) (*ListRoomMembershipsOutput, error)

Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.

func (*Client) ListRooms

func (c *Client) ListRooms(ctx context.Context, params *ListRoomsInput, optFns ...func(*Options)) (*ListRoomsOutput, error)

Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.

func (*Client) ListSipMediaApplications added in v0.30.0

func (c *Client) ListSipMediaApplications(ctx context.Context, params *ListSipMediaApplicationsInput, optFns ...func(*Options)) (*ListSipMediaApplicationsOutput, error)

Lists the SIP media applications under the administrator's AWS account.

func (*Client) ListSipRules added in v0.30.0

func (c *Client) ListSipRules(ctx context.Context, params *ListSipRulesInput, optFns ...func(*Options)) (*ListSipRulesOutput, error)

Lists the SIP rules under the administrator's AWS account.

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 meeting resource.

func (*Client) ListUsers

func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error)

Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.

func (*Client) ListVoiceConnectorGroups

func (c *Client) ListVoiceConnectorGroups(ctx context.Context, params *ListVoiceConnectorGroupsInput, optFns ...func(*Options)) (*ListVoiceConnectorGroupsOutput, error)

Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.

func (*Client) ListVoiceConnectorTerminationCredentials

func (c *Client) ListVoiceConnectorTerminationCredentials(ctx context.Context, params *ListVoiceConnectorTerminationCredentialsInput, optFns ...func(*Options)) (*ListVoiceConnectorTerminationCredentialsOutput, error)

Lists the SIP credentials for the specified Amazon Chime Voice Connector.

func (*Client) ListVoiceConnectors

func (c *Client) ListVoiceConnectors(ctx context.Context, params *ListVoiceConnectorsInput, optFns ...func(*Options)) (*ListVoiceConnectorsOutput, error)

Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

func (*Client) LogoutUser

func (c *Client) LogoutUser(ctx context.Context, params *LogoutUserInput, optFns ...func(*Options)) (*LogoutUserOutput, error)

Logs out the specified user from all of the devices they are currently logged into.

func (*Client) PutAppInstanceRetentionSettings added in v0.30.0

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

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

func (*Client) PutAppInstanceStreamingConfigurations added in v0.30.0

func (c *Client) PutAppInstanceStreamingConfigurations(ctx context.Context, params *PutAppInstanceStreamingConfigurationsInput, optFns ...func(*Options)) (*PutAppInstanceStreamingConfigurationsOutput, error)

The data streaming configurations of an AppInstance.

func (*Client) PutEventsConfiguration

func (c *Client) PutEventsConfiguration(ctx context.Context, params *PutEventsConfigurationInput, optFns ...func(*Options)) (*PutEventsConfigurationOutput, error)

Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.

func (*Client) PutRetentionSettings

func (c *Client) PutRetentionSettings(ctx context.Context, params *PutRetentionSettingsInput, optFns ...func(*Options)) (*PutRetentionSettingsOutput, error)

Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail (https://docs.aws.amazon.com/chime/latest/ag/cloudtrail.html) in the Amazon Chime Administration Guide . To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies (https://docs.aws.amazon.com/chime/latest/ag/chat-retention.html) in the Amazon Chime Administration Guide .

func (*Client) PutSipMediaApplicationLoggingConfiguration added in v0.30.0

func (c *Client) PutSipMediaApplicationLoggingConfiguration(ctx context.Context, params *PutSipMediaApplicationLoggingConfigurationInput, optFns ...func(*Options)) (*PutSipMediaApplicationLoggingConfigurationOutput, error)

Updates the logging configuration for the specified SIP media application.

func (*Client) PutVoiceConnectorEmergencyCallingConfiguration

func (c *Client) PutVoiceConnectorEmergencyCallingConfiguration(ctx context.Context, params *PutVoiceConnectorEmergencyCallingConfigurationInput, optFns ...func(*Options)) (*PutVoiceConnectorEmergencyCallingConfigurationOutput, error)

Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.

func (*Client) PutVoiceConnectorLoggingConfiguration

func (c *Client) PutVoiceConnectorLoggingConfiguration(ctx context.Context, params *PutVoiceConnectorLoggingConfigurationInput, optFns ...func(*Options)) (*PutVoiceConnectorLoggingConfigurationOutput, error)

Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

func (*Client) PutVoiceConnectorOrigination

func (c *Client) PutVoiceConnectorOrigination(ctx context.Context, params *PutVoiceConnectorOriginationInput, optFns ...func(*Options)) (*PutVoiceConnectorOriginationOutput, error)

Adds origination settings for the specified Amazon Chime Voice Connector. If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.

func (*Client) PutVoiceConnectorProxy

func (c *Client) PutVoiceConnectorProxy(ctx context.Context, params *PutVoiceConnectorProxyInput, optFns ...func(*Options)) (*PutVoiceConnectorProxyOutput, error)

Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.

func (*Client) PutVoiceConnectorStreamingConfiguration

func (c *Client) PutVoiceConnectorStreamingConfiguration(ctx context.Context, params *PutVoiceConnectorStreamingConfigurationInput, optFns ...func(*Options)) (*PutVoiceConnectorStreamingConfigurationOutput, error)

Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Indonesians. It also sets the retention period, in hours, for the Amazon Kinesis data.

func (*Client) PutVoiceConnectorTermination

func (c *Client) PutVoiceConnectorTermination(ctx context.Context, params *PutVoiceConnectorTerminationInput, optFns ...func(*Options)) (*PutVoiceConnectorTerminationOutput, error)

Adds termination settings for the specified Amazon Chime Voice Connector. If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.

func (*Client) PutVoiceConnectorTerminationCredentials

func (c *Client) PutVoiceConnectorTerminationCredentials(ctx context.Context, params *PutVoiceConnectorTerminationCredentialsInput, optFns ...func(*Options)) (*PutVoiceConnectorTerminationCredentialsOutput, error)

Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

func (*Client) RedactChannelMessage added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) RedactConversationMessage

func (c *Client) RedactConversationMessage(ctx context.Context, params *RedactConversationMessageInput, optFns ...func(*Options)) (*RedactConversationMessageOutput, error)

Redacts the specified message from the specified Amazon Chime conversation.

func (*Client) RedactRoomMessage

func (c *Client) RedactRoomMessage(ctx context.Context, params *RedactRoomMessageInput, optFns ...func(*Options)) (*RedactRoomMessageOutput, error)

Redacts the specified message from the specified Amazon Chime channel.

func (*Client) RegenerateSecurityToken

func (c *Client) RegenerateSecurityToken(ctx context.Context, params *RegenerateSecurityTokenInput, optFns ...func(*Options)) (*RegenerateSecurityTokenOutput, error)

Regenerates the security token for a bot.

func (*Client) ResetPersonalPIN

func (c *Client) ResetPersonalPIN(ctx context.Context, params *ResetPersonalPINInput, optFns ...func(*Options)) (*ResetPersonalPINOutput, error)

Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.

func (*Client) RestorePhoneNumber

func (c *Client) RestorePhoneNumber(ctx context.Context, params *RestorePhoneNumberInput, optFns ...func(*Options)) (*RestorePhoneNumberOutput, error)

Moves a phone number from the Deletion queue back into the phone number Inventory.

func (*Client) SearchAvailablePhoneNumbers

func (c *Client) SearchAvailablePhoneNumbers(ctx context.Context, params *SearchAvailablePhoneNumbersInput, optFns ...func(*Options)) (*SearchAvailablePhoneNumbersOutput, error)

Searches phone numbers that can be ordered.

func (*Client) SendChannelMessage added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header. Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.

func (*Client) TagAttendee

func (c *Client) TagAttendee(ctx context.Context, params *TagAttendeeInput, optFns ...func(*Options)) (*TagAttendeeOutput, error)

Applies the specified tags to the specified Amazon Chime SDK attendee.

func (*Client) TagMeeting

func (c *Client) TagMeeting(ctx context.Context, params *TagMeetingInput, optFns ...func(*Options)) (*TagMeetingOutput, error)

Applies the specified tags to the specified Amazon Chime SDK meeting.

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 meeting resource.

func (*Client) UntagAttendee

func (c *Client) UntagAttendee(ctx context.Context, params *UntagAttendeeInput, optFns ...func(*Options)) (*UntagAttendeeOutput, error)

Untags the specified tags from the specified Amazon Chime SDK attendee.

func (*Client) UntagMeeting

func (c *Client) UntagMeeting(ctx context.Context, params *UntagMeetingInput, optFns ...func(*Options)) (*UntagMeetingOutput, error)

Untags the specified tags from the specified Amazon Chime SDK meeting.

func (*Client) UntagResource

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

Untags the specified tags from the specified Amazon Chime SDK meeting resource.

func (*Client) UpdateAccount

func (c *Client) UpdateAccount(ctx context.Context, params *UpdateAccountInput, optFns ...func(*Options)) (*UpdateAccountOutput, error)

Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.

func (*Client) UpdateAccountSettings

func (c *Client) UpdateAccountSettings(ctx context.Context, params *UpdateAccountSettingsInput, optFns ...func(*Options)) (*UpdateAccountSettingsOutput, error)

Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page (https://docs.aws.amazon.com/chime/latest/ag/policies.html) in the Amazon Chime Administration Guide.

func (*Client) UpdateAppInstance added in v0.30.0

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

Updates AppInstance metadata.

func (*Client) UpdateAppInstanceUser added in v0.30.0

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

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

func (*Client) UpdateBot

func (c *Client) UpdateBot(ctx context.Context, params *UpdateBotInput, optFns ...func(*Options)) (*UpdateBotOutput, error)

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

func (*Client) UpdateChannel added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) UpdateChannelMessage added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) UpdateChannelReadMarker added in v0.30.0

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 AppInstanceUserArn of the user that makes the API call as the value in the header.

func (*Client) UpdateGlobalSettings

func (c *Client) UpdateGlobalSettings(ctx context.Context, params *UpdateGlobalSettingsInput, optFns ...func(*Options)) (*UpdateGlobalSettingsOutput, error)

Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

func (*Client) UpdatePhoneNumber

func (c *Client) UpdatePhoneNumber(ctx context.Context, params *UpdatePhoneNumberInput, optFns ...func(*Options)) (*UpdatePhoneNumberOutput, error)

Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action. For toll-free numbers, you must use the Amazon Chime Voice Connector product type. Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

func (*Client) UpdatePhoneNumberSettings

func (c *Client) UpdatePhoneNumberSettings(ctx context.Context, params *UpdatePhoneNumberSettingsInput, optFns ...func(*Options)) (*UpdatePhoneNumberSettingsOutput, error)

Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.

func (*Client) UpdateProxySession

func (c *Client) UpdateProxySession(ctx context.Context, params *UpdateProxySessionInput, optFns ...func(*Options)) (*UpdateProxySessionOutput, error)

Updates the specified proxy session details, such as voice or SMS capabilities.

func (*Client) UpdateRoom

func (c *Client) UpdateRoom(ctx context.Context, params *UpdateRoomInput, optFns ...func(*Options)) (*UpdateRoomOutput, error)

Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.

func (*Client) UpdateRoomMembership

func (c *Client) UpdateRoomMembership(ctx context.Context, params *UpdateRoomMembershipInput, optFns ...func(*Options)) (*UpdateRoomMembershipOutput, error)

Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.

func (*Client) UpdateSipMediaApplication added in v0.30.0

func (c *Client) UpdateSipMediaApplication(ctx context.Context, params *UpdateSipMediaApplicationInput, optFns ...func(*Options)) (*UpdateSipMediaApplicationOutput, error)

Updates the details of the specified SIP media application.

func (*Client) UpdateSipRule added in v0.30.0

func (c *Client) UpdateSipRule(ctx context.Context, params *UpdateSipRuleInput, optFns ...func(*Options)) (*UpdateSipRuleOutput, error)

Updates the details of the specified SIP rule.

func (*Client) UpdateUser

func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error)

Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

func (*Client) UpdateUserSettings

func (c *Client) UpdateUserSettings(ctx context.Context, params *UpdateUserSettingsInput, optFns ...func(*Options)) (*UpdateUserSettingsOutput, error)

Updates the settings for the specified user, such as phone number settings.

func (*Client) UpdateVoiceConnector

func (c *Client) UpdateVoiceConnector(ctx context.Context, params *UpdateVoiceConnectorInput, optFns ...func(*Options)) (*UpdateVoiceConnectorOutput, error)

Updates details for the specified Amazon Chime Voice Connector.

func (*Client) UpdateVoiceConnectorGroup

func (c *Client) UpdateVoiceConnectorGroup(ctx context.Context, params *UpdateVoiceConnectorGroupInput, optFns ...func(*Options)) (*UpdateVoiceConnectorGroupOutput, error)

Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.

type CreateAccountInput

type CreateAccountInput struct {

	// The name of the Amazon Chime account.
	//
	// This member is required.
	Name *string
}

type CreateAccountOutput

type CreateAccountOutput struct {

	// The Amazon Chime account details.
	Account *types.Account

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateAppInstanceAdminInput added in v0.30.0

type CreateAppInstanceAdminInput struct {

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

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

type CreateAppInstanceAdminOutput added in v0.30.0

type CreateAppInstanceAdminOutput struct {

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateAppInstanceInput added in v0.30.0

type CreateAppInstanceInput struct {

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

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

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

	// Tags assigned to the AppInstanceUser.
	Tags []types.Tag
}

type CreateAppInstanceOutput added in v0.30.0

type CreateAppInstanceOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateAppInstanceUserInput added in v0.30.0

type CreateAppInstanceUserInput struct {

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

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

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

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

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

	// Tags assigned to the AppInstanceUser.
	Tags []types.Tag
}

type CreateAppInstanceUserOutput added in v0.30.0

type CreateAppInstanceUserOutput struct {

	// The user's ARN.
	AppInstanceUserArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateAttendeeInput

type CreateAttendeeInput struct {

	// The Amazon Chime SDK external user ID. An idempotency token. Links the attendee
	// to an identity managed by a builder application.
	//
	// This member is required.
	ExternalUserId *string

	// The Amazon Chime SDK meeting ID.
	//
	// This member is required.
	MeetingId *string

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

type CreateAttendeeOutput

type CreateAttendeeOutput struct {

	// The attendee information, including attendee ID and join token.
	Attendee *types.Attendee

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateBotInput

type CreateBotInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The bot display name.
	//
	// This member is required.
	DisplayName *string

	// The domain of the Amazon Chime Enterprise account.
	Domain *string
}

type CreateBotOutput

type CreateBotOutput struct {

	// The bot details.
	Bot *types.Bot

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateChannelBanInput added in v0.30.0

type CreateChannelBanInput struct {

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

	// The ARN of the member being banned.
	//
	// This member is required.
	MemberArn *string

	// The AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *string
}

type CreateChannelBanOutput added in v0.30.0

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
}

type CreateChannelInput added in v0.30.0

type CreateChannelInput struct {

	// The ARN of the channel 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.
	//
	// This member is required.
	Name *string

	// The AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *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 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
}

type CreateChannelMembershipInput added in v0.30.0

type CreateChannelMembershipInput struct {

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

	// The ARN 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 AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *string
}

type CreateChannelMembershipOutput added in v0.30.0

type CreateChannelMembershipOutput struct {

	// The ARN of the channel.
	ChannelArn *string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateChannelModeratorInput added in v0.30.0

type CreateChannelModeratorInput struct {

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

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

	// The AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *string
}

type CreateChannelModeratorOutput added in v0.30.0

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
}

type CreateChannelOutput added in v0.30.0

type CreateChannelOutput struct {

	// The ARN of the channel.
	ChannelArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateMeetingDialOutInput added in v0.30.0

type CreateMeetingDialOutInput struct {

	// Phone number used as the caller ID when the remote party receives a call.
	//
	// This member is required.
	FromPhoneNumber *string

	// Token used by the Amazon Chime SDK attendee. Call the CreateAttendee
	// (https://docs.aws.amazon.com/chime/latest/APIReference/API_Attendee.htmlCreateAttendee)
	// action to get a join token.
	//
	// This member is required.
	JoinToken *string

	// The Amazon Chime SDK meeting ID.
	//
	// This member is required.
	MeetingId *string

	// Phone number called when inviting someone to a meeting.
	//
	// This member is required.
	ToPhoneNumber *string
}

type CreateMeetingDialOutOutput added in v0.30.0

type CreateMeetingDialOutOutput struct {

	// Unique ID that tracks API calls.
	TransactionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateMeetingInput

type CreateMeetingInput struct {

	// The unique identifier for the client request. Use a different token for
	// different meetings.
	//
	// This member is required.
	ClientRequestToken *string

	// The external meeting ID.
	ExternalMeetingId *string

	// The Region in which to create the meeting. Default: us-east-1. Available values:
	// af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 ,
	// ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 ,
	// eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 ,
	// us-west-1 , us-west-2 .
	MediaRegion *string

	// Reserved.
	MeetingHostId *string

	// The configuration for resource targets to receive notifications when meeting and
	// attendee events occur.
	NotificationsConfiguration *types.MeetingNotificationConfiguration

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

type CreateMeetingOutput

type CreateMeetingOutput struct {

	// The meeting information, including the meeting ID and MediaPlacement .
	Meeting *types.Meeting

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateMeetingWithAttendeesInput

type CreateMeetingWithAttendeesInput struct {

	// The unique identifier for the client request. Use a different token for
	// different meetings.
	//
	// This member is required.
	ClientRequestToken *string

	// The request containing the attendees to create.
	Attendees []types.CreateAttendeeRequestItem

	// The external meeting ID.
	ExternalMeetingId *string

	// The Region in which to create the meeting. Default: us-east-1 . Available
	// values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 ,
	// ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 ,
	// eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 ,
	// us-east-2 , us-west-1 , us-west-2 .
	MediaRegion *string

	// Reserved.
	MeetingHostId *string

	// The resource target configurations for receiving Amazon Chime SDK meeting and
	// attendee event notifications. The Amazon Chime SDK supports resource targets
	// located in the US East (N. Virginia) AWS Region (us-east-1).
	NotificationsConfiguration *types.MeetingNotificationConfiguration

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

type CreateMeetingWithAttendeesOutput

type CreateMeetingWithAttendeesOutput struct {

	// The attendee information, including attendees IDs and join tokens.
	Attendees []types.Attendee

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

	// A meeting created using the Amazon Chime SDK.
	Meeting *types.Meeting

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreatePhoneNumberOrderInput

type CreatePhoneNumberOrderInput struct {

	// List of phone numbers, in E.164 format.
	//
	// This member is required.
	E164PhoneNumbers []string

	// The phone number product type.
	//
	// This member is required.
	ProductType types.PhoneNumberProductType
}

type CreatePhoneNumberOrderOutput

type CreatePhoneNumberOrderOutput struct {

	// The phone number order details.
	PhoneNumberOrder *types.PhoneNumberOrder

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateProxySessionInput

type CreateProxySessionInput struct {

	// The proxy session capabilities.
	//
	// This member is required.
	Capabilities []types.Capability

	// The participant phone numbers.
	//
	// This member is required.
	ParticipantPhoneNumbers []string

	// The Amazon Chime voice connector ID.
	//
	// This member is required.
	VoiceConnectorId *string

	// The number of minutes allowed for the proxy session.
	ExpiryMinutes *int32

	// The preference for matching the country or area code of the proxy phone number
	// with that of the first participant.
	GeoMatchLevel types.GeoMatchLevel

	// The country and area code for the proxy phone number.
	GeoMatchParams *types.GeoMatchParams

	// The name of the proxy session.
	Name *string

	// The preference for proxy phone number reuse, or stickiness, between the same
	// participants across sessions.
	NumberSelectionBehavior types.NumberSelectionBehavior
}

type CreateProxySessionOutput

type CreateProxySessionOutput struct {

	// The proxy session details.
	ProxySession *types.ProxySession

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateRoomInput

type CreateRoomInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The room name.
	//
	// This member is required.
	Name *string

	// The idempotency token for the request.
	ClientRequestToken *string
}

type CreateRoomMembershipInput

type CreateRoomMembershipInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The Amazon Chime member ID (user ID or bot ID).
	//
	// This member is required.
	MemberId *string

	// The room ID.
	//
	// This member is required.
	RoomId *string

	// The role of the member.
	Role types.RoomMembershipRole
}

type CreateRoomMembershipOutput

type CreateRoomMembershipOutput struct {

	// The room membership details.
	RoomMembership *types.RoomMembership

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateRoomOutput

type CreateRoomOutput struct {

	// The room details.
	Room *types.Room

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateSipMediaApplicationCallInput added in v0.30.0

type CreateSipMediaApplicationCallInput struct {

	// The phone number that a user calls from.
	//
	// This member is required.
	FromPhoneNumber *string

	// The ID of the SIP media application.
	//
	// This member is required.
	SipMediaApplicationId *string

	// The phone number that the user dials in order to connect to a meeting.
	//
	// This member is required.
	ToPhoneNumber *string
}

type CreateSipMediaApplicationCallOutput added in v0.30.0

type CreateSipMediaApplicationCallOutput struct {

	// The actual call.
	SipMediaApplicationCall *types.SipMediaApplicationCall

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateSipMediaApplicationInput added in v0.30.0

type CreateSipMediaApplicationInput struct {

	// The AWS Region assigned to the SIP media application.
	//
	// This member is required.
	AwsRegion *string

	// List of endpoints (Lambda Amazon Resource Names) specified for the SIP media
	// application. Currently, only one endpoint is supported.
	//
	// This member is required.
	Endpoints []types.SipMediaApplicationEndpoint

	// The SIP media application name.
	//
	// This member is required.
	Name *string
}

type CreateSipMediaApplicationOutput added in v0.30.0

type CreateSipMediaApplicationOutput struct {

	// The SIP media application details.
	SipMediaApplication *types.SipMediaApplication

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateSipRuleInput added in v0.30.0

type CreateSipRuleInput struct {

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

	// List of SIP media applications with priority and AWS Region. Only one SIP
	// application per AWS Region can be used.
	//
	// This member is required.
	TargetApplications []types.SipRuleTargetApplication

	// The type of trigger assigned to the SIP rule in TriggerValue, currently
	// RequestUriHostname or ToPhoneNumber.
	//
	// This member is required.
	TriggerType types.SipRuleTriggerType

	// If TriggerType is RequestUriHostname, the value can be the outbound host name of
	// an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, the value can
	// be a customer-owned phone number in the E164 format. The SipMediaApplication
	// specified in the SipRule is triggered if the request URI in an incoming SIP
	// request matches the RequestUriHostname, or if the To header in the incoming SIP
	// request matches the ToPhoneNumber value.
	//
	// This member is required.
	TriggerValue *string

	// Enables or disables a rule. You must disable rules before you can delete them.
	Disabled *bool
}

type CreateSipRuleOutput added in v0.30.0

type CreateSipRuleOutput struct {

	// Returns the SIP rule information, including the rule ID, triggers, and target
	// applications.
	SipRule *types.SipRule

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateUserInput

type CreateUserInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The user's email address.
	Email *string

	// The user type.
	UserType types.UserType

	// The user name.
	Username *string
}

type CreateUserOutput

type CreateUserOutput struct {

	// The user on the Amazon Chime account.
	User *types.User

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateVoiceConnectorGroupInput

type CreateVoiceConnectorGroupInput struct {

	// The name of the Amazon Chime Voice Connector group.
	//
	// This member is required.
	Name *string

	// The Amazon Chime Voice Connectors to route inbound calls to.
	VoiceConnectorItems []types.VoiceConnectorItem
}

type CreateVoiceConnectorGroupOutput

type CreateVoiceConnectorGroupOutput struct {

	// The Amazon Chime Voice Connector group details.
	VoiceConnectorGroup *types.VoiceConnectorGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateVoiceConnectorInput

type CreateVoiceConnectorInput struct {

	// The name of the Amazon Chime Voice Connector.
	//
	// This member is required.
	Name *string

	// When enabled, requires encryption for the Amazon Chime Voice Connector.
	//
	// This member is required.
	RequireEncryption *bool

	// The AWS Region in which the Amazon Chime Voice Connector is created. Default
	// value: us-east-1 .
	AwsRegion types.VoiceConnectorAwsRegion
}

type CreateVoiceConnectorOutput

type CreateVoiceConnectorOutput struct {

	// The Amazon Chime Voice Connector details.
	VoiceConnector *types.VoiceConnector

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteAccountInput

type DeleteAccountInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string
}

type DeleteAccountOutput

type DeleteAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteAppInstanceAdminInput added in v0.30.0

type DeleteAppInstanceAdminInput struct {

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

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

type DeleteAppInstanceAdminOutput added in v0.30.0

type DeleteAppInstanceAdminOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteAppInstanceInput added in v0.30.0

type DeleteAppInstanceInput struct {

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

type DeleteAppInstanceOutput added in v0.30.0

type DeleteAppInstanceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteAppInstanceStreamingConfigurationsInput added in v0.30.0

type DeleteAppInstanceStreamingConfigurationsInput struct {

	// The ARN of the streaming configurations being deleted.
	//
	// This member is required.
	AppInstanceArn *string
}

type DeleteAppInstanceStreamingConfigurationsOutput added in v0.30.0

type DeleteAppInstanceStreamingConfigurationsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteAppInstanceUserInput added in v0.30.0

type DeleteAppInstanceUserInput struct {

	// The ARN of the user request being deleted.
	//
	// This member is required.
	AppInstanceUserArn *string
}

type DeleteAppInstanceUserOutput added in v0.30.0

type DeleteAppInstanceUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteAttendeeInput

type DeleteAttendeeInput struct {

	// The Amazon Chime SDK attendee ID.
	//
	// This member is required.
	AttendeeId *string

	// The Amazon Chime SDK meeting ID.
	//
	// This member is required.
	MeetingId *string
}

type DeleteAttendeeOutput

type DeleteAttendeeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteChannelBanInput added in v0.30.0

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 that you want to reinstate.
	//
	// This member is required.
	MemberArn *string

	// The AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *string
}

type DeleteChannelBanOutput added in v0.30.0

type DeleteChannelBanOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteChannelInput added in v0.30.0

type DeleteChannelInput struct {

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

	// The AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *string
}

type DeleteChannelMembershipInput added in v0.30.0

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 member that you're removing from the channel.
	//
	// This member is required.
	MemberArn *string

	// The AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *string
}

type DeleteChannelMembershipOutput added in v0.30.0

type DeleteChannelMembershipOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteChannelMessageInput added in v0.30.0

type DeleteChannelMessageInput struct {

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

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

	// The AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *string
}

type DeleteChannelMessageOutput added in v0.30.0

type DeleteChannelMessageOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteChannelModeratorInput added in v0.30.0

type DeleteChannelModeratorInput struct {

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

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

	// The AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *string
}

type DeleteChannelModeratorOutput added in v0.30.0

type DeleteChannelModeratorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteChannelOutput added in v0.30.0

type DeleteChannelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteEventsConfigurationInput

type DeleteEventsConfigurationInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The bot ID.
	//
	// This member is required.
	BotId *string
}

type DeleteEventsConfigurationOutput

type DeleteEventsConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteMeetingInput

type DeleteMeetingInput struct {

	// The Amazon Chime SDK meeting ID.
	//
	// This member is required.
	MeetingId *string
}

type DeleteMeetingOutput

type DeleteMeetingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeletePhoneNumberInput

type DeletePhoneNumberInput struct {

	// The phone number ID.
	//
	// This member is required.
	PhoneNumberId *string
}

type DeletePhoneNumberOutput

type DeletePhoneNumberOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteProxySessionInput

type DeleteProxySessionInput struct {

	// The proxy session ID.
	//
	// This member is required.
	ProxySessionId *string

	// The Amazon Chime voice connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type DeleteProxySessionOutput

type DeleteProxySessionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteRoomInput

type DeleteRoomInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The chat room ID.
	//
	// This member is required.
	RoomId *string
}

type DeleteRoomMembershipInput

type DeleteRoomMembershipInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The member ID (user ID or bot ID).
	//
	// This member is required.
	MemberId *string

	// The room ID.
	//
	// This member is required.
	RoomId *string
}

type DeleteRoomMembershipOutput

type DeleteRoomMembershipOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteRoomOutput

type DeleteRoomOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteSipMediaApplicationInput added in v0.30.0

type DeleteSipMediaApplicationInput struct {

	// The SIP media application ID.
	//
	// This member is required.
	SipMediaApplicationId *string
}

type DeleteSipMediaApplicationOutput added in v0.30.0

type DeleteSipMediaApplicationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteSipRuleInput added in v0.30.0

type DeleteSipRuleInput struct {

	// The SIP rule ID.
	//
	// This member is required.
	SipRuleId *string
}

type DeleteSipRuleOutput added in v0.30.0

type DeleteSipRuleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteVoiceConnectorEmergencyCallingConfigurationInput

type DeleteVoiceConnectorEmergencyCallingConfigurationInput struct {

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type DeleteVoiceConnectorEmergencyCallingConfigurationOutput

type DeleteVoiceConnectorEmergencyCallingConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteVoiceConnectorGroupInput

type DeleteVoiceConnectorGroupInput struct {

	// The Amazon Chime Voice Connector group ID.
	//
	// This member is required.
	VoiceConnectorGroupId *string
}

type DeleteVoiceConnectorGroupOutput

type DeleteVoiceConnectorGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteVoiceConnectorInput

type DeleteVoiceConnectorInput struct {

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type DeleteVoiceConnectorOriginationInput

type DeleteVoiceConnectorOriginationInput struct {

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type DeleteVoiceConnectorOriginationOutput

type DeleteVoiceConnectorOriginationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteVoiceConnectorOutput

type DeleteVoiceConnectorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteVoiceConnectorProxyInput

type DeleteVoiceConnectorProxyInput struct {

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type DeleteVoiceConnectorProxyOutput

type DeleteVoiceConnectorProxyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteVoiceConnectorStreamingConfigurationInput

type DeleteVoiceConnectorStreamingConfigurationInput struct {

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type DeleteVoiceConnectorStreamingConfigurationOutput

type DeleteVoiceConnectorStreamingConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteVoiceConnectorTerminationCredentialsInput

type DeleteVoiceConnectorTerminationCredentialsInput struct {

	// The RFC2617 compliant username associated with the SIP credentials, in US-ASCII
	// format.
	//
	// This member is required.
	Usernames []string

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type DeleteVoiceConnectorTerminationCredentialsOutput

type DeleteVoiceConnectorTerminationCredentialsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteVoiceConnectorTerminationInput

type DeleteVoiceConnectorTerminationInput struct {

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type DeleteVoiceConnectorTerminationOutput

type DeleteVoiceConnectorTerminationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeAppInstanceAdminInput added in v0.30.0

type DescribeAppInstanceAdminInput struct {

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

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

type DescribeAppInstanceAdminOutput added in v0.30.0

type DescribeAppInstanceAdminOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeAppInstanceInput added in v0.30.0

type DescribeAppInstanceInput struct {

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

type DescribeAppInstanceOutput added in v0.30.0

type DescribeAppInstanceOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeAppInstanceUserInput added in v0.30.0

type DescribeAppInstanceUserInput struct {

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

type DescribeAppInstanceUserOutput added in v0.30.0

type DescribeAppInstanceUserOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeChannelBanInput added in v0.30.0

type DescribeChannelBanInput struct {

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

	// The ARN of the member being banned.
	//
	// This member is required.
	MemberArn *string

	// The AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *string
}

type DescribeChannelBanOutput added in v0.30.0

type DescribeChannelBanOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeChannelInput added in v0.30.0

type DescribeChannelInput struct {

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

	// The AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *string
}

type DescribeChannelMembershipForAppInstanceUserInput added in v0.30.0

type DescribeChannelMembershipForAppInstanceUserInput struct {

	// The ARN of the user 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 AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *string
}

type DescribeChannelMembershipForAppInstanceUserOutput added in v0.30.0

type DescribeChannelMembershipForAppInstanceUserOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeChannelMembershipInput added in v0.30.0

type DescribeChannelMembershipInput struct {

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

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

	// The AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *string
}

type DescribeChannelMembershipOutput added in v0.30.0

type DescribeChannelMembershipOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeChannelModeratedByAppInstanceUserInput added in v0.30.0

type DescribeChannelModeratedByAppInstanceUserInput struct {

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

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

	// The AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *string
}

type DescribeChannelModeratedByAppInstanceUserOutput added in v0.30.0

type DescribeChannelModeratedByAppInstanceUserOutput struct {

	// The moderated channel.
	Channel *types.ChannelModeratedByAppInstanceUserSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeChannelModeratorInput added in v0.30.0

type DescribeChannelModeratorInput struct {

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

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

	// The AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *string
}

type DescribeChannelModeratorOutput added in v0.30.0

type DescribeChannelModeratorOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeChannelOutput added in v0.30.0

type DescribeChannelOutput struct {

	// The channel details.
	Channel *types.Channel

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociatePhoneNumberFromUserInput

type DisassociatePhoneNumberFromUserInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The user ID.
	//
	// This member is required.
	UserId *string
}

type DisassociatePhoneNumberFromUserOutput

type DisassociatePhoneNumberFromUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociatePhoneNumbersFromVoiceConnectorGroupInput

type DisassociatePhoneNumbersFromVoiceConnectorGroupInput struct {

	// List of phone numbers, in E.164 format.
	//
	// This member is required.
	E164PhoneNumbers []string

	// The Amazon Chime Voice Connector group ID.
	//
	// This member is required.
	VoiceConnectorGroupId *string
}

type DisassociatePhoneNumbersFromVoiceConnectorGroupOutput

type DisassociatePhoneNumbersFromVoiceConnectorGroupOutput struct {

	// If the action fails for one or more of the phone numbers in the request, a list
	// of the phone numbers is returned, along with error codes and error messages.
	PhoneNumberErrors []types.PhoneNumberError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociatePhoneNumbersFromVoiceConnectorInput

type DisassociatePhoneNumbersFromVoiceConnectorInput struct {

	// List of phone numbers, in E.164 format.
	//
	// This member is required.
	E164PhoneNumbers []string

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type DisassociatePhoneNumbersFromVoiceConnectorOutput

type DisassociatePhoneNumbersFromVoiceConnectorOutput struct {

	// If the action fails for one or more of the phone numbers in the request, a list
	// of the phone numbers is returned, along with error codes and error messages.
	PhoneNumberErrors []types.PhoneNumberError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateSigninDelegateGroupsFromAccountInput

type DisassociateSigninDelegateGroupsFromAccountInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The sign-in delegate group names.
	//
	// This member is required.
	GroupNames []string
}

type DisassociateSigninDelegateGroupsFromAccountOutput

type DisassociateSigninDelegateGroupsFromAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0

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 added in v0.29.0

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetAccountInput

type GetAccountInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string
}

type GetAccountOutput

type GetAccountOutput struct {

	// The Amazon Chime account details.
	Account *types.Account

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetAccountSettingsInput

type GetAccountSettingsInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string
}

type GetAccountSettingsOutput

type GetAccountSettingsOutput struct {

	// The Amazon Chime account settings.
	AccountSettings *types.AccountSettings

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetAppInstanceRetentionSettingsInput added in v0.30.0

type GetAppInstanceRetentionSettingsInput struct {

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

type GetAppInstanceRetentionSettingsOutput added in v0.30.0

type GetAppInstanceRetentionSettingsOutput struct {

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetAppInstanceStreamingConfigurationsInput added in v0.30.0

type GetAppInstanceStreamingConfigurationsInput struct {

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

type GetAppInstanceStreamingConfigurationsOutput added in v0.30.0

type GetAppInstanceStreamingConfigurationsOutput struct {

	// The streaming settings.
	AppInstanceStreamingConfigurations []types.AppInstanceStreamingConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetAttendeeInput

type GetAttendeeInput struct {

	// The Amazon Chime SDK attendee ID.
	//
	// This member is required.
	AttendeeId *string

	// The Amazon Chime SDK meeting ID.
	//
	// This member is required.
	MeetingId *string
}

type GetAttendeeOutput

type GetAttendeeOutput struct {

	// The Amazon Chime SDK attendee information.
	Attendee *types.Attendee

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetBotInput

type GetBotInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The bot ID.
	//
	// This member is required.
	BotId *string
}

type GetBotOutput

type GetBotOutput struct {

	// The chat bot details.
	Bot *types.Bot

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetChannelMessageInput added in v0.30.0

type GetChannelMessageInput struct {

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

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

	// The AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *string
}

type GetChannelMessageOutput added in v0.30.0

type GetChannelMessageOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetEventsConfigurationInput

type GetEventsConfigurationInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The bot ID.
	//
	// This member is required.
	BotId *string
}

type GetEventsConfigurationOutput

type GetEventsConfigurationOutput struct {

	// The events configuration details.
	EventsConfiguration *types.EventsConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetGlobalSettingsInput

type GetGlobalSettingsInput struct {
}

type GetGlobalSettingsOutput

type GetGlobalSettingsOutput struct {

	// The Amazon Chime Business Calling settings.
	BusinessCalling *types.BusinessCallingSettings

	// The Amazon Chime Voice Connector settings.
	VoiceConnector *types.VoiceConnectorSettings

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetMeetingInput

type GetMeetingInput struct {

	// The Amazon Chime SDK meeting ID.
	//
	// This member is required.
	MeetingId *string
}

type GetMeetingOutput

type GetMeetingOutput struct {

	// The Amazon Chime SDK meeting information.
	Meeting *types.Meeting

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetMessagingSessionEndpointInput added in v0.30.0

type GetMessagingSessionEndpointInput struct {
}

type GetMessagingSessionEndpointOutput added in v0.30.0

type GetMessagingSessionEndpointOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetPhoneNumberInput

type GetPhoneNumberInput struct {

	// The phone number ID.
	//
	// This member is required.
	PhoneNumberId *string
}

type GetPhoneNumberOrderInput

type GetPhoneNumberOrderInput struct {

	// The ID for the phone number order.
	//
	// This member is required.
	PhoneNumberOrderId *string
}

type GetPhoneNumberOrderOutput

type GetPhoneNumberOrderOutput struct {

	// The phone number order details.
	PhoneNumberOrder *types.PhoneNumberOrder

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetPhoneNumberOutput

type GetPhoneNumberOutput struct {

	// The phone number details.
	PhoneNumber *types.PhoneNumber

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetPhoneNumberSettingsInput

type GetPhoneNumberSettingsInput struct {
}

type GetPhoneNumberSettingsOutput

type GetPhoneNumberSettingsOutput struct {

	// The default outbound calling name for the account.
	CallingName *string

	// The updated outbound calling name timestamp, in ISO 8601 format.
	CallingNameUpdatedTimestamp *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetProxySessionInput

type GetProxySessionInput struct {

	// The proxy session ID.
	//
	// This member is required.
	ProxySessionId *string

	// The Amazon Chime voice connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type GetProxySessionOutput

type GetProxySessionOutput struct {

	// The proxy session details.
	ProxySession *types.ProxySession

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRetentionSettingsInput

type GetRetentionSettingsInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string
}

type GetRetentionSettingsOutput

type GetRetentionSettingsOutput struct {

	// The timestamp representing the time at which the specified items are permanently
	// deleted, in ISO 8601 format.
	InitiateDeletionTimestamp *time.Time

	// The retention settings.
	RetentionSettings *types.RetentionSettings

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRoomInput

type GetRoomInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The room ID.
	//
	// This member is required.
	RoomId *string
}

type GetRoomOutput

type GetRoomOutput struct {

	// The room details.
	Room *types.Room

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetSipMediaApplicationInput added in v0.30.0

type GetSipMediaApplicationInput struct {

	// The SIP media application ID.
	//
	// This member is required.
	SipMediaApplicationId *string
}

type GetSipMediaApplicationLoggingConfigurationInput added in v0.30.0

type GetSipMediaApplicationLoggingConfigurationInput struct {

	// The SIP media application ID.
	//
	// This member is required.
	SipMediaApplicationId *string
}

type GetSipMediaApplicationLoggingConfigurationOutput added in v0.30.0

type GetSipMediaApplicationLoggingConfigurationOutput struct {

	// The actual logging configuration.
	SipMediaApplicationLoggingConfiguration *types.SipMediaApplicationLoggingConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetSipMediaApplicationOutput added in v0.30.0

type GetSipMediaApplicationOutput struct {

	// The SIP media application details.
	SipMediaApplication *types.SipMediaApplication

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetSipRuleInput added in v0.30.0

type GetSipRuleInput struct {

	// The SIP rule ID.
	//
	// This member is required.
	SipRuleId *string
}

type GetSipRuleOutput added in v0.30.0

type GetSipRuleOutput struct {

	// The SIP rule details.
	SipRule *types.SipRule

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetUserInput

type GetUserInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The user ID.
	//
	// This member is required.
	UserId *string
}

type GetUserOutput

type GetUserOutput struct {

	// The user details.
	User *types.User

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetUserSettingsInput

type GetUserSettingsInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The user ID.
	//
	// This member is required.
	UserId *string
}

type GetUserSettingsOutput

type GetUserSettingsOutput struct {

	// The user settings.
	UserSettings *types.UserSettings

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetVoiceConnectorEmergencyCallingConfigurationInput

type GetVoiceConnectorEmergencyCallingConfigurationInput struct {

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type GetVoiceConnectorEmergencyCallingConfigurationOutput

type GetVoiceConnectorEmergencyCallingConfigurationOutput struct {

	// The emergency calling configuration details.
	EmergencyCallingConfiguration *types.EmergencyCallingConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetVoiceConnectorGroupInput

type GetVoiceConnectorGroupInput struct {

	// The Amazon Chime Voice Connector group ID.
	//
	// This member is required.
	VoiceConnectorGroupId *string
}

type GetVoiceConnectorGroupOutput

type GetVoiceConnectorGroupOutput struct {

	// The Amazon Chime Voice Connector group details.
	VoiceConnectorGroup *types.VoiceConnectorGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetVoiceConnectorInput

type GetVoiceConnectorInput struct {

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type GetVoiceConnectorLoggingConfigurationInput

type GetVoiceConnectorLoggingConfigurationInput struct {

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type GetVoiceConnectorLoggingConfigurationOutput

type GetVoiceConnectorLoggingConfigurationOutput struct {

	// The logging configuration details.
	LoggingConfiguration *types.LoggingConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetVoiceConnectorOriginationInput

type GetVoiceConnectorOriginationInput struct {

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type GetVoiceConnectorOriginationOutput

type GetVoiceConnectorOriginationOutput struct {

	// The origination setting details.
	Origination *types.Origination

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetVoiceConnectorOutput

type GetVoiceConnectorOutput struct {

	// The Amazon Chime Voice Connector details.
	VoiceConnector *types.VoiceConnector

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetVoiceConnectorProxyInput

type GetVoiceConnectorProxyInput struct {

	// The Amazon Chime voice connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type GetVoiceConnectorProxyOutput

type GetVoiceConnectorProxyOutput struct {

	// The proxy configuration details.
	Proxy *types.Proxy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetVoiceConnectorStreamingConfigurationInput

type GetVoiceConnectorStreamingConfigurationInput struct {

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type GetVoiceConnectorStreamingConfigurationOutput

type GetVoiceConnectorStreamingConfigurationOutput struct {

	// The streaming configuration details.
	StreamingConfiguration *types.StreamingConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetVoiceConnectorTerminationHealthInput

type GetVoiceConnectorTerminationHealthInput struct {

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type GetVoiceConnectorTerminationHealthOutput

type GetVoiceConnectorTerminationHealthOutput struct {

	// The termination health details.
	TerminationHealth *types.TerminationHealth

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetVoiceConnectorTerminationInput

type GetVoiceConnectorTerminationInput struct {

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type GetVoiceConnectorTerminationOutput

type GetVoiceConnectorTerminationOutput struct {

	// The termination setting details.
	Termination *types.Termination

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 InviteUsersInput

type InviteUsersInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The user email addresses to which to send the email invitation.
	//
	// This member is required.
	UserEmailList []string

	// The user type.
	UserType types.UserType
}

type InviteUsersOutput

type InviteUsersOutput struct {

	// The email invitation details.
	Invites []types.Invite

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAccountsAPIClient added in v0.30.0

type ListAccountsAPIClient interface {
	ListAccounts(context.Context, *ListAccountsInput, ...func(*Options)) (*ListAccountsOutput, error)
}

ListAccountsAPIClient is a client that implements the ListAccounts operation.

type ListAccountsInput

type ListAccountsInput struct {

	// The maximum number of results to return in a single call. Defaults to 100.
	MaxResults *int32

	// Amazon Chime account name prefix with which to filter results.
	Name *string

	// The token to use to retrieve the next page of results.
	NextToken *string

	// User email address with which to filter results.
	UserEmail *string
}

type ListAccountsOutput

type ListAccountsOutput struct {

	// List of Amazon Chime accounts and account details.
	Accounts []types.Account

	// The token to use to retrieve the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAccountsPaginator added in v0.30.0

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

ListAccountsPaginator is a paginator for ListAccounts

func NewListAccountsPaginator added in v0.30.0

func NewListAccountsPaginator(client ListAccountsAPIClient, params *ListAccountsInput, optFns ...func(*ListAccountsPaginatorOptions)) *ListAccountsPaginator

NewListAccountsPaginator returns a new ListAccountsPaginator

func (*ListAccountsPaginator) HasMorePages added in v0.30.0

func (p *ListAccountsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAccountsPaginator) NextPage added in v0.30.0

func (p *ListAccountsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAccountsOutput, error)

NextPage retrieves the next ListAccounts page.

type ListAccountsPaginatorOptions added in v0.30.0

type ListAccountsPaginatorOptions struct {
	// The maximum number of results to return in a single call. Defaults to 100.
	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
}

ListAccountsPaginatorOptions is the paginator options for ListAccounts

type ListAppInstanceAdminsAPIClient added in v0.30.0

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

ListAppInstanceAdminsAPIClient is a client that implements the ListAppInstanceAdmins operation.

type ListAppInstanceAdminsInput added in v0.30.0

type ListAppInstanceAdminsInput struct {

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

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

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

type ListAppInstanceAdminsOutput added in v0.30.0

type ListAppInstanceAdminsOutput struct {

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

	// The ARN of the AppInstance.
	AppInstanceArn *string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAppInstanceAdminsPaginator added in v0.30.0

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

ListAppInstanceAdminsPaginator is a paginator for ListAppInstanceAdmins

func NewListAppInstanceAdminsPaginator added in v0.30.0

NewListAppInstanceAdminsPaginator returns a new ListAppInstanceAdminsPaginator

func (*ListAppInstanceAdminsPaginator) HasMorePages added in v0.30.0

func (p *ListAppInstanceAdminsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAppInstanceAdminsPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListAppInstanceAdmins page.

type ListAppInstanceAdminsPaginatorOptions added in v0.30.0

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

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

ListAppInstanceAdminsPaginatorOptions is the paginator options for ListAppInstanceAdmins

type ListAppInstanceUsersAPIClient added in v0.30.0

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

ListAppInstanceUsersAPIClient is a client that implements the ListAppInstanceUsers operation.

type ListAppInstanceUsersInput added in v0.30.0

type ListAppInstanceUsersInput struct {

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

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

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

type ListAppInstanceUsersOutput added in v0.30.0

type ListAppInstanceUsersOutput struct {

	// The ARN of the AppInstance.
	AppInstanceArn *string

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAppInstanceUsersPaginator added in v0.30.0

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

ListAppInstanceUsersPaginator is a paginator for ListAppInstanceUsers

func NewListAppInstanceUsersPaginator added in v0.30.0

NewListAppInstanceUsersPaginator returns a new ListAppInstanceUsersPaginator

func (*ListAppInstanceUsersPaginator) HasMorePages added in v0.30.0

func (p *ListAppInstanceUsersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAppInstanceUsersPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListAppInstanceUsers page.

type ListAppInstanceUsersPaginatorOptions added in v0.30.0

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

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

ListAppInstanceUsersPaginatorOptions is the paginator options for ListAppInstanceUsers

type ListAppInstancesAPIClient added in v0.30.0

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

ListAppInstancesAPIClient is a client that implements the ListAppInstances operation.

type ListAppInstancesInput added in v0.30.0

type ListAppInstancesInput struct {

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

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

type ListAppInstancesOutput added in v0.30.0

type ListAppInstancesOutput struct {

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAppInstancesPaginator added in v0.30.0

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

ListAppInstancesPaginator is a paginator for ListAppInstances

func NewListAppInstancesPaginator added in v0.30.0

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

NewListAppInstancesPaginator returns a new ListAppInstancesPaginator

func (*ListAppInstancesPaginator) HasMorePages added in v0.30.0

func (p *ListAppInstancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAppInstancesPaginator) NextPage added in v0.30.0

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

NextPage retrieves the next ListAppInstances page.

type ListAppInstancesPaginatorOptions added in v0.30.0

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

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

ListAppInstancesPaginatorOptions is the paginator options for ListAppInstances

type ListAttendeeTagsInput

type ListAttendeeTagsInput struct {

	// The Amazon Chime SDK attendee ID.
	//
	// This member is required.
	AttendeeId *string

	// The Amazon Chime SDK meeting ID.
	//
	// This member is required.
	MeetingId *string
}

type ListAttendeeTagsOutput

type ListAttendeeTagsOutput struct {

	// A list of tag key-value pairs.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAttendeesAPIClient added in v0.30.0

type ListAttendeesAPIClient interface {
	ListAttendees(context.Context, *ListAttendeesInput, ...func(*Options)) (*ListAttendeesOutput, error)
}

ListAttendeesAPIClient is a client that implements the ListAttendees operation.

type ListAttendeesInput

type ListAttendeesInput struct {

	// The Amazon Chime SDK meeting ID.
	//
	// This member is required.
	MeetingId *string

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results.
	NextToken *string
}

type ListAttendeesOutput

type ListAttendeesOutput struct {

	// The Amazon Chime SDK attendee information.
	Attendees []types.Attendee

	// The token to use to retrieve the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAttendeesPaginator added in v0.30.0

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

ListAttendeesPaginator is a paginator for ListAttendees

func NewListAttendeesPaginator added in v0.30.0

func NewListAttendeesPaginator(client ListAttendeesAPIClient, params *ListAttendeesInput, optFns ...func(*ListAttendeesPaginatorOptions)) *ListAttendeesPaginator

NewListAttendeesPaginator returns a new ListAttendeesPaginator

func (*ListAttendeesPaginator) HasMorePages added in v0.30.0

func (p *ListAttendeesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAttendeesPaginator) NextPage added in v0.30.0

func (p *ListAttendeesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAttendeesOutput, error)

NextPage retrieves the next ListAttendees page.

type ListAttendeesPaginatorOptions added in v0.30.0

type ListAttendeesPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	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
}

ListAttendeesPaginatorOptions is the paginator options for ListAttendees

type ListBotsAPIClient added in v0.30.0

type ListBotsAPIClient interface {
	ListBots(context.Context, *ListBotsInput, ...func(*Options)) (*ListBotsOutput, error)
}

ListBotsAPIClient is a client that implements the ListBots operation.

type ListBotsInput

type ListBotsInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The maximum number of results to return in a single call. The default is 10.
	MaxResults *int32

	// The token to use to retrieve the next page of results.
	NextToken *string
}

type ListBotsOutput

type ListBotsOutput struct {

	// List of bots and bot details.
	Bots []types.Bot

	// The token to use to retrieve the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListBotsPaginator added in v0.30.0

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

ListBotsPaginator is a paginator for ListBots

func NewListBotsPaginator added in v0.30.0

func NewListBotsPaginator(client ListBotsAPIClient, params *ListBotsInput, optFns ...func(*ListBotsPaginatorOptions)) *ListBotsPaginator

NewListBotsPaginator returns a new ListBotsPaginator

func (*ListBotsPaginator) HasMorePages added in v0.30.0

func (p *ListBotsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBotsPaginator) NextPage added in v0.30.0

func (p *ListBotsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBotsOutput, error)

NextPage retrieves the next ListBots page.

type ListBotsPaginatorOptions added in v0.30.0

type ListBotsPaginatorOptions struct {
	// The maximum number of results to return in a single call. The default is 10.
	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
}

ListBotsPaginatorOptions is the paginator options for ListBots

type ListChannelBansAPIClient added in v0.30.0

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

ListChannelBansAPIClient is a client that implements the ListChannelBans operation.

type ListChannelBansInput added in v0.30.0

type ListChannelBansInput struct {

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

	// The AppInstanceUserArn of the user that makes the API call.
	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
}

type ListChannelBansOutput added in v0.30.0

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
}

type ListChannelBansPaginator added in v0.30.0

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

ListChannelBansPaginator is a paginator for ListChannelBans

func NewListChannelBansPaginator added in v0.30.0

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

NewListChannelBansPaginator returns a new ListChannelBansPaginator

func (*ListChannelBansPaginator) HasMorePages added in v0.30.0

func (p *ListChannelBansPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChannelBansPaginator) NextPage added in v0.30.0

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

NextPage retrieves the next ListChannelBans page.

type ListChannelBansPaginatorOptions added in v0.30.0

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 ListChannelMembershipsAPIClient added in v0.30.0

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

ListChannelMembershipsAPIClient is a client that implements the ListChannelMemberships operation.

type ListChannelMembershipsForAppInstanceUserAPIClient added in v0.30.0

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

ListChannelMembershipsForAppInstanceUserAPIClient is a client that implements the ListChannelMembershipsForAppInstanceUser operation.

type ListChannelMembershipsForAppInstanceUserInput added in v0.30.0

type ListChannelMembershipsForAppInstanceUserInput struct {

	// The ARN of the AppInstanceUsers
	AppInstanceUserArn *string

	// The AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *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
}

type ListChannelMembershipsForAppInstanceUserOutput added in v0.30.0

type ListChannelMembershipsForAppInstanceUserOutput struct {

	// The token passed by previous API calls until all requested users are returned.
	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
}

type ListChannelMembershipsForAppInstanceUserPaginator added in v0.30.0

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

ListChannelMembershipsForAppInstanceUserPaginator is a paginator for ListChannelMembershipsForAppInstanceUser

func NewListChannelMembershipsForAppInstanceUserPaginator added in v0.30.0

NewListChannelMembershipsForAppInstanceUserPaginator returns a new ListChannelMembershipsForAppInstanceUserPaginator

func (*ListChannelMembershipsForAppInstanceUserPaginator) HasMorePages added in v0.30.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChannelMembershipsForAppInstanceUserPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListChannelMembershipsForAppInstanceUser page.

type ListChannelMembershipsForAppInstanceUserPaginatorOptions added in v0.30.0

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 added in v0.30.0

type ListChannelMembershipsInput struct {

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

	// The AppInstanceUserArn of the user that makes the API call.
	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 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.
	Type types.ChannelMembershipType
}

type ListChannelMembershipsOutput added in v0.30.0

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
}

type ListChannelMembershipsPaginator added in v0.30.0

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

ListChannelMembershipsPaginator is a paginator for ListChannelMemberships

func NewListChannelMembershipsPaginator added in v0.30.0

NewListChannelMembershipsPaginator returns a new ListChannelMembershipsPaginator

func (*ListChannelMembershipsPaginator) HasMorePages added in v0.30.0

func (p *ListChannelMembershipsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChannelMembershipsPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListChannelMemberships page.

type ListChannelMembershipsPaginatorOptions added in v0.30.0

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 added in v0.30.0

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

ListChannelMessagesAPIClient is a client that implements the ListChannelMessages operation.

type ListChannelMessagesInput added in v0.30.0

type ListChannelMessagesInput struct {

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

	// The AppInstanceUserArn of the user that makes the API call.
	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
}

type ListChannelMessagesOutput added in v0.30.0

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListChannelMessagesPaginator added in v0.30.0

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

ListChannelMessagesPaginator is a paginator for ListChannelMessages

func NewListChannelMessagesPaginator added in v0.30.0

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

NewListChannelMessagesPaginator returns a new ListChannelMessagesPaginator

func (*ListChannelMessagesPaginator) HasMorePages added in v0.30.0

func (p *ListChannelMessagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChannelMessagesPaginator) NextPage added in v0.30.0

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

NextPage retrieves the next ListChannelMessages page.

type ListChannelMessagesPaginatorOptions added in v0.30.0

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 added in v0.30.0

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

ListChannelModeratorsAPIClient is a client that implements the ListChannelModerators operation.

type ListChannelModeratorsInput added in v0.30.0

type ListChannelModeratorsInput struct {

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

	// The AppInstanceUserArn of the user that makes the API call.
	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
}

type ListChannelModeratorsOutput added in v0.30.0

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
}

type ListChannelModeratorsPaginator added in v0.30.0

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

ListChannelModeratorsPaginator is a paginator for ListChannelModerators

func NewListChannelModeratorsPaginator added in v0.30.0

NewListChannelModeratorsPaginator returns a new ListChannelModeratorsPaginator

func (*ListChannelModeratorsPaginator) HasMorePages added in v0.30.0

func (p *ListChannelModeratorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChannelModeratorsPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListChannelModerators page.

type ListChannelModeratorsPaginatorOptions added in v0.30.0

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 added in v0.30.0

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

ListChannelsAPIClient is a client that implements the ListChannels operation.

type ListChannelsInput added in v0.30.0

type ListChannelsInput struct {

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

	// The AppInstanceUserArn of the user that makes the API call.
	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
}

type ListChannelsModeratedByAppInstanceUserAPIClient added in v0.30.0

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

ListChannelsModeratedByAppInstanceUserAPIClient is a client that implements the ListChannelsModeratedByAppInstanceUser operation.

type ListChannelsModeratedByAppInstanceUserInput added in v0.30.0

type ListChannelsModeratedByAppInstanceUserInput struct {

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

	// The AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *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
}

type ListChannelsModeratedByAppInstanceUserOutput added in v0.30.0

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
}

type ListChannelsModeratedByAppInstanceUserPaginator added in v0.30.0

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

ListChannelsModeratedByAppInstanceUserPaginator is a paginator for ListChannelsModeratedByAppInstanceUser

func NewListChannelsModeratedByAppInstanceUserPaginator added in v0.30.0

NewListChannelsModeratedByAppInstanceUserPaginator returns a new ListChannelsModeratedByAppInstanceUserPaginator

func (*ListChannelsModeratedByAppInstanceUserPaginator) HasMorePages added in v0.30.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChannelsModeratedByAppInstanceUserPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListChannelsModeratedByAppInstanceUser page.

type ListChannelsModeratedByAppInstanceUserPaginatorOptions added in v0.30.0

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 added in v0.30.0

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
}

type ListChannelsPaginator added in v0.30.0

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

ListChannelsPaginator is a paginator for ListChannels

func NewListChannelsPaginator added in v0.30.0

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

NewListChannelsPaginator returns a new ListChannelsPaginator

func (*ListChannelsPaginator) HasMorePages added in v0.30.0

func (p *ListChannelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChannelsPaginator) NextPage added in v0.30.0

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

NextPage retrieves the next ListChannels page.

type ListChannelsPaginatorOptions added in v0.30.0

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 ListMeetingTagsInput

type ListMeetingTagsInput struct {

	// The Amazon Chime SDK meeting ID.
	//
	// This member is required.
	MeetingId *string
}

type ListMeetingTagsOutput

type ListMeetingTagsOutput struct {

	// A list of tag key-value pairs.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListMeetingsAPIClient added in v0.30.0

type ListMeetingsAPIClient interface {
	ListMeetings(context.Context, *ListMeetingsInput, ...func(*Options)) (*ListMeetingsOutput, error)
}

ListMeetingsAPIClient is a client that implements the ListMeetings operation.

type ListMeetingsInput

type ListMeetingsInput struct {

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results.
	NextToken *string
}

type ListMeetingsOutput

type ListMeetingsOutput struct {

	// The Amazon Chime SDK meeting information.
	Meetings []types.Meeting

	// The token to use to retrieve the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListMeetingsPaginator added in v0.30.0

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

ListMeetingsPaginator is a paginator for ListMeetings

func NewListMeetingsPaginator added in v0.30.0

func NewListMeetingsPaginator(client ListMeetingsAPIClient, params *ListMeetingsInput, optFns ...func(*ListMeetingsPaginatorOptions)) *ListMeetingsPaginator

NewListMeetingsPaginator returns a new ListMeetingsPaginator

func (*ListMeetingsPaginator) HasMorePages added in v0.30.0

func (p *ListMeetingsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMeetingsPaginator) NextPage added in v0.30.0

func (p *ListMeetingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMeetingsOutput, error)

NextPage retrieves the next ListMeetings page.

type ListMeetingsPaginatorOptions added in v0.30.0

type ListMeetingsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	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
}

ListMeetingsPaginatorOptions is the paginator options for ListMeetings

type ListPhoneNumberOrdersAPIClient added in v0.30.0

type ListPhoneNumberOrdersAPIClient interface {
	ListPhoneNumberOrders(context.Context, *ListPhoneNumberOrdersInput, ...func(*Options)) (*ListPhoneNumberOrdersOutput, error)
}

ListPhoneNumberOrdersAPIClient is a client that implements the ListPhoneNumberOrders operation.

type ListPhoneNumberOrdersInput

type ListPhoneNumberOrdersInput struct {

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results.
	NextToken *string
}

type ListPhoneNumberOrdersOutput

type ListPhoneNumberOrdersOutput struct {

	// The token to use to retrieve the next page of results.
	NextToken *string

	// The phone number order details.
	PhoneNumberOrders []types.PhoneNumberOrder

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListPhoneNumberOrdersPaginator added in v0.30.0

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

ListPhoneNumberOrdersPaginator is a paginator for ListPhoneNumberOrders

func NewListPhoneNumberOrdersPaginator added in v0.30.0

NewListPhoneNumberOrdersPaginator returns a new ListPhoneNumberOrdersPaginator

func (*ListPhoneNumberOrdersPaginator) HasMorePages added in v0.30.0

func (p *ListPhoneNumberOrdersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPhoneNumberOrdersPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListPhoneNumberOrders page.

type ListPhoneNumberOrdersPaginatorOptions added in v0.30.0

type ListPhoneNumberOrdersPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	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
}

ListPhoneNumberOrdersPaginatorOptions is the paginator options for ListPhoneNumberOrders

type ListPhoneNumbersAPIClient added in v0.30.0

type ListPhoneNumbersAPIClient interface {
	ListPhoneNumbers(context.Context, *ListPhoneNumbersInput, ...func(*Options)) (*ListPhoneNumbersOutput, error)
}

ListPhoneNumbersAPIClient is a client that implements the ListPhoneNumbers operation.

type ListPhoneNumbersInput

type ListPhoneNumbersInput struct {

	// The filter to use to limit the number of results.
	FilterName types.PhoneNumberAssociationName

	// The value to use for the filter.
	FilterValue *string

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results.
	NextToken *string

	// The phone number product type.
	ProductType types.PhoneNumberProductType

	// The phone number status.
	Status types.PhoneNumberStatus
}

type ListPhoneNumbersOutput

type ListPhoneNumbersOutput struct {

	// The token to use to retrieve the next page of results.
	NextToken *string

	// The phone number details.
	PhoneNumbers []types.PhoneNumber

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListPhoneNumbersPaginator added in v0.30.0

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

ListPhoneNumbersPaginator is a paginator for ListPhoneNumbers

func NewListPhoneNumbersPaginator added in v0.30.0

func NewListPhoneNumbersPaginator(client ListPhoneNumbersAPIClient, params *ListPhoneNumbersInput, optFns ...func(*ListPhoneNumbersPaginatorOptions)) *ListPhoneNumbersPaginator

NewListPhoneNumbersPaginator returns a new ListPhoneNumbersPaginator

func (*ListPhoneNumbersPaginator) HasMorePages added in v0.30.0

func (p *ListPhoneNumbersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPhoneNumbersPaginator) NextPage added in v0.30.0

func (p *ListPhoneNumbersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPhoneNumbersOutput, error)

NextPage retrieves the next ListPhoneNumbers page.

type ListPhoneNumbersPaginatorOptions added in v0.30.0

type ListPhoneNumbersPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	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
}

ListPhoneNumbersPaginatorOptions is the paginator options for ListPhoneNumbers

type ListProxySessionsAPIClient added in v0.30.0

type ListProxySessionsAPIClient interface {
	ListProxySessions(context.Context, *ListProxySessionsInput, ...func(*Options)) (*ListProxySessionsOutput, error)
}

ListProxySessionsAPIClient is a client that implements the ListProxySessions operation.

type ListProxySessionsInput

type ListProxySessionsInput struct {

	// The Amazon Chime voice connector ID.
	//
	// This member is required.
	VoiceConnectorId *string

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results.
	NextToken *string

	// The proxy session status.
	Status types.ProxySessionStatus
}

type ListProxySessionsOutput

type ListProxySessionsOutput struct {

	// The token to use to retrieve the next page of results.
	NextToken *string

	// The proxy session details.
	ProxySessions []types.ProxySession

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListProxySessionsPaginator added in v0.30.0

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

ListProxySessionsPaginator is a paginator for ListProxySessions

func NewListProxySessionsPaginator added in v0.30.0

func NewListProxySessionsPaginator(client ListProxySessionsAPIClient, params *ListProxySessionsInput, optFns ...func(*ListProxySessionsPaginatorOptions)) *ListProxySessionsPaginator

NewListProxySessionsPaginator returns a new ListProxySessionsPaginator

func (*ListProxySessionsPaginator) HasMorePages added in v0.30.0

func (p *ListProxySessionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProxySessionsPaginator) NextPage added in v0.30.0

func (p *ListProxySessionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProxySessionsOutput, error)

NextPage retrieves the next ListProxySessions page.

type ListProxySessionsPaginatorOptions added in v0.30.0

type ListProxySessionsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	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
}

ListProxySessionsPaginatorOptions is the paginator options for ListProxySessions

type ListRoomMembershipsAPIClient added in v0.30.0

type ListRoomMembershipsAPIClient interface {
	ListRoomMemberships(context.Context, *ListRoomMembershipsInput, ...func(*Options)) (*ListRoomMembershipsOutput, error)
}

ListRoomMembershipsAPIClient is a client that implements the ListRoomMemberships operation.

type ListRoomMembershipsInput

type ListRoomMembershipsInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The room ID.
	//
	// This member is required.
	RoomId *string

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results.
	NextToken *string
}

type ListRoomMembershipsOutput

type ListRoomMembershipsOutput struct {

	// The token to use to retrieve the next page of results.
	NextToken *string

	// The room membership details.
	RoomMemberships []types.RoomMembership

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListRoomMembershipsPaginator added in v0.30.0

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

ListRoomMembershipsPaginator is a paginator for ListRoomMemberships

func NewListRoomMembershipsPaginator added in v0.30.0

func NewListRoomMembershipsPaginator(client ListRoomMembershipsAPIClient, params *ListRoomMembershipsInput, optFns ...func(*ListRoomMembershipsPaginatorOptions)) *ListRoomMembershipsPaginator

NewListRoomMembershipsPaginator returns a new ListRoomMembershipsPaginator

func (*ListRoomMembershipsPaginator) HasMorePages added in v0.30.0

func (p *ListRoomMembershipsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRoomMembershipsPaginator) NextPage added in v0.30.0

func (p *ListRoomMembershipsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRoomMembershipsOutput, error)

NextPage retrieves the next ListRoomMemberships page.

type ListRoomMembershipsPaginatorOptions added in v0.30.0

type ListRoomMembershipsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	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
}

ListRoomMembershipsPaginatorOptions is the paginator options for ListRoomMemberships

type ListRoomsAPIClient added in v0.30.0

type ListRoomsAPIClient interface {
	ListRooms(context.Context, *ListRoomsInput, ...func(*Options)) (*ListRoomsOutput, error)
}

ListRoomsAPIClient is a client that implements the ListRooms operation.

type ListRoomsInput

type ListRoomsInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The member ID (user ID or bot ID).
	MemberId *string

	// The token to use to retrieve the next page of results.
	NextToken *string
}

type ListRoomsOutput

type ListRoomsOutput struct {

	// The token to use to retrieve the next page of results.
	NextToken *string

	// The room details.
	Rooms []types.Room

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListRoomsPaginator added in v0.30.0

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

ListRoomsPaginator is a paginator for ListRooms

func NewListRoomsPaginator added in v0.30.0

func NewListRoomsPaginator(client ListRoomsAPIClient, params *ListRoomsInput, optFns ...func(*ListRoomsPaginatorOptions)) *ListRoomsPaginator

NewListRoomsPaginator returns a new ListRoomsPaginator

func (*ListRoomsPaginator) HasMorePages added in v0.30.0

func (p *ListRoomsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRoomsPaginator) NextPage added in v0.30.0

func (p *ListRoomsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRoomsOutput, error)

NextPage retrieves the next ListRooms page.

type ListRoomsPaginatorOptions added in v0.30.0

type ListRoomsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	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
}

ListRoomsPaginatorOptions is the paginator options for ListRooms

type ListSipMediaApplicationsAPIClient added in v0.30.0

type ListSipMediaApplicationsAPIClient interface {
	ListSipMediaApplications(context.Context, *ListSipMediaApplicationsInput, ...func(*Options)) (*ListSipMediaApplicationsOutput, error)
}

ListSipMediaApplicationsAPIClient is a client that implements the ListSipMediaApplications operation.

type ListSipMediaApplicationsInput added in v0.30.0

type ListSipMediaApplicationsInput struct {

	// The maximum number of results to return in a single call. Defaults to 100.
	MaxResults *int32

	// The token to use to retrieve the next page of results.
	NextToken *string
}

type ListSipMediaApplicationsOutput added in v0.30.0

type ListSipMediaApplicationsOutput struct {

	// The token to use to retrieve the next page of results.
	NextToken *string

	// List of SIP media applications and application details.
	SipMediaApplications []types.SipMediaApplication

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListSipMediaApplicationsPaginator added in v0.30.0

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

ListSipMediaApplicationsPaginator is a paginator for ListSipMediaApplications

func NewListSipMediaApplicationsPaginator added in v0.30.0

NewListSipMediaApplicationsPaginator returns a new ListSipMediaApplicationsPaginator

func (*ListSipMediaApplicationsPaginator) HasMorePages added in v0.30.0

func (p *ListSipMediaApplicationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSipMediaApplicationsPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListSipMediaApplications page.

type ListSipMediaApplicationsPaginatorOptions added in v0.30.0

type ListSipMediaApplicationsPaginatorOptions struct {
	// The maximum number of results to return in a single call. Defaults to 100.
	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
}

ListSipMediaApplicationsPaginatorOptions is the paginator options for ListSipMediaApplications

type ListSipRulesAPIClient added in v0.30.0

type ListSipRulesAPIClient interface {
	ListSipRules(context.Context, *ListSipRulesInput, ...func(*Options)) (*ListSipRulesOutput, error)
}

ListSipRulesAPIClient is a client that implements the ListSipRules operation.

type ListSipRulesInput added in v0.30.0

type ListSipRulesInput struct {

	// The maximum number of results to return in a single call. Defaults to 100.
	MaxResults *int32

	// The token to use to retrieve the next page of results.
	NextToken *string

	// The SIP media application ID.
	SipMediaApplicationId *string
}

type ListSipRulesOutput added in v0.30.0

type ListSipRulesOutput struct {

	// The token to use to retrieve the next page of results.
	NextToken *string

	// List of SIP rules and rule details.
	SipRules []types.SipRule

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListSipRulesPaginator added in v0.30.0

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

ListSipRulesPaginator is a paginator for ListSipRules

func NewListSipRulesPaginator added in v0.30.0

func NewListSipRulesPaginator(client ListSipRulesAPIClient, params *ListSipRulesInput, optFns ...func(*ListSipRulesPaginatorOptions)) *ListSipRulesPaginator

NewListSipRulesPaginator returns a new ListSipRulesPaginator

func (*ListSipRulesPaginator) HasMorePages added in v0.30.0

func (p *ListSipRulesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSipRulesPaginator) NextPage added in v0.30.0

func (p *ListSipRulesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSipRulesOutput, error)

NextPage retrieves the next ListSipRules page.

type ListSipRulesPaginatorOptions added in v0.30.0

type ListSipRulesPaginatorOptions struct {
	// The maximum number of results to return in a single call. Defaults to 100.
	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
}

ListSipRulesPaginatorOptions is the paginator options for ListSipRules

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

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

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// A list of tag-key value pairs.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListUsersAPIClient added in v0.30.0

type ListUsersAPIClient interface {
	ListUsers(context.Context, *ListUsersInput, ...func(*Options)) (*ListUsersOutput, error)
}

ListUsersAPIClient is a client that implements the ListUsers operation.

type ListUsersInput

type ListUsersInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The maximum number of results to return in a single call. Defaults to 100.
	MaxResults *int32

	// The token to use to retrieve the next page of results.
	NextToken *string

	// Optional. The user email address used to filter results. Maximum 1.
	UserEmail *string

	// The user type.
	UserType types.UserType
}

type ListUsersOutput

type ListUsersOutput struct {

	// The token to use to retrieve the next page of results.
	NextToken *string

	// List of users and user details.
	Users []types.User

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListUsersPaginator added in v0.30.0

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

ListUsersPaginator is a paginator for ListUsers

func NewListUsersPaginator added in v0.30.0

func NewListUsersPaginator(client ListUsersAPIClient, params *ListUsersInput, optFns ...func(*ListUsersPaginatorOptions)) *ListUsersPaginator

NewListUsersPaginator returns a new ListUsersPaginator

func (*ListUsersPaginator) HasMorePages added in v0.30.0

func (p *ListUsersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListUsersPaginator) NextPage added in v0.30.0

func (p *ListUsersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUsersOutput, error)

NextPage retrieves the next ListUsers page.

type ListUsersPaginatorOptions added in v0.30.0

type ListUsersPaginatorOptions struct {
	// The maximum number of results to return in a single call. Defaults to 100.
	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
}

ListUsersPaginatorOptions is the paginator options for ListUsers

type ListVoiceConnectorGroupsAPIClient added in v0.30.0

type ListVoiceConnectorGroupsAPIClient interface {
	ListVoiceConnectorGroups(context.Context, *ListVoiceConnectorGroupsInput, ...func(*Options)) (*ListVoiceConnectorGroupsOutput, error)
}

ListVoiceConnectorGroupsAPIClient is a client that implements the ListVoiceConnectorGroups operation.

type ListVoiceConnectorGroupsInput

type ListVoiceConnectorGroupsInput struct {

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results.
	NextToken *string
}

type ListVoiceConnectorGroupsOutput

type ListVoiceConnectorGroupsOutput struct {

	// The token to use to retrieve the next page of results.
	NextToken *string

	// The details of the Amazon Chime Voice Connector groups.
	VoiceConnectorGroups []types.VoiceConnectorGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListVoiceConnectorGroupsPaginator added in v0.30.0

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

ListVoiceConnectorGroupsPaginator is a paginator for ListVoiceConnectorGroups

func NewListVoiceConnectorGroupsPaginator added in v0.30.0

NewListVoiceConnectorGroupsPaginator returns a new ListVoiceConnectorGroupsPaginator

func (*ListVoiceConnectorGroupsPaginator) HasMorePages added in v0.30.0

func (p *ListVoiceConnectorGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListVoiceConnectorGroupsPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListVoiceConnectorGroups page.

type ListVoiceConnectorGroupsPaginatorOptions added in v0.30.0

type ListVoiceConnectorGroupsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	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
}

ListVoiceConnectorGroupsPaginatorOptions is the paginator options for ListVoiceConnectorGroups

type ListVoiceConnectorTerminationCredentialsInput

type ListVoiceConnectorTerminationCredentialsInput struct {

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type ListVoiceConnectorTerminationCredentialsOutput

type ListVoiceConnectorTerminationCredentialsOutput struct {

	// A list of user names.
	Usernames []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListVoiceConnectorsAPIClient added in v0.30.0

type ListVoiceConnectorsAPIClient interface {
	ListVoiceConnectors(context.Context, *ListVoiceConnectorsInput, ...func(*Options)) (*ListVoiceConnectorsOutput, error)
}

ListVoiceConnectorsAPIClient is a client that implements the ListVoiceConnectors operation.

type ListVoiceConnectorsInput

type ListVoiceConnectorsInput struct {

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results.
	NextToken *string
}

type ListVoiceConnectorsOutput

type ListVoiceConnectorsOutput struct {

	// The token to use to retrieve the next page of results.
	NextToken *string

	// The details of the Amazon Chime Voice Connectors.
	VoiceConnectors []types.VoiceConnector

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListVoiceConnectorsPaginator added in v0.30.0

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

ListVoiceConnectorsPaginator is a paginator for ListVoiceConnectors

func NewListVoiceConnectorsPaginator added in v0.30.0

func NewListVoiceConnectorsPaginator(client ListVoiceConnectorsAPIClient, params *ListVoiceConnectorsInput, optFns ...func(*ListVoiceConnectorsPaginatorOptions)) *ListVoiceConnectorsPaginator

NewListVoiceConnectorsPaginator returns a new ListVoiceConnectorsPaginator

func (*ListVoiceConnectorsPaginator) HasMorePages added in v0.30.0

func (p *ListVoiceConnectorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListVoiceConnectorsPaginator) NextPage added in v0.30.0

func (p *ListVoiceConnectorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVoiceConnectorsOutput, error)

NextPage retrieves the next ListVoiceConnectors page.

type ListVoiceConnectorsPaginatorOptions added in v0.30.0

type ListVoiceConnectorsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	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
}

ListVoiceConnectorsPaginatorOptions is the paginator options for ListVoiceConnectors

type LogoutUserInput

type LogoutUserInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The user ID.
	//
	// This member is required.
	UserId *string
}

type LogoutUserOutput

type LogoutUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Options

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

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

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

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

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

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

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

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

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

type PutAppInstanceRetentionSettingsInput added in v0.30.0

type PutAppInstanceRetentionSettingsInput struct {

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

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

type PutAppInstanceRetentionSettingsOutput added in v0.30.0

type PutAppInstanceRetentionSettingsOutput struct {

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutAppInstanceStreamingConfigurationsInput added in v0.30.0

type PutAppInstanceStreamingConfigurationsInput struct {

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

	// The streaming configurations set for an AppInstance.
	//
	// This member is required.
	AppInstanceStreamingConfigurations []types.AppInstanceStreamingConfiguration
}

type PutAppInstanceStreamingConfigurationsOutput added in v0.30.0

type PutAppInstanceStreamingConfigurationsOutput struct {

	// The streaming configurations of an AppInstance.
	AppInstanceStreamingConfigurations []types.AppInstanceStreamingConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutEventsConfigurationInput

type PutEventsConfigurationInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The bot ID.
	//
	// This member is required.
	BotId *string

	// Lambda function ARN that allows the bot to receive outgoing events.
	LambdaFunctionArn *string

	// HTTPS endpoint that allows the bot to receive outgoing events.
	OutboundEventsHTTPSEndpoint *string
}

type PutEventsConfigurationOutput

type PutEventsConfigurationOutput struct {

	// The configuration that allows a bot to receive outgoing events. Can be either an
	// HTTPS endpoint or a Lambda function ARN.
	EventsConfiguration *types.EventsConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutRetentionSettingsInput

type PutRetentionSettingsInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The retention settings.
	//
	// This member is required.
	RetentionSettings *types.RetentionSettings
}

type PutRetentionSettingsOutput

type PutRetentionSettingsOutput struct {

	// The timestamp representing the time at which the specified items are permanently
	// deleted, in ISO 8601 format.
	InitiateDeletionTimestamp *time.Time

	// The retention settings.
	RetentionSettings *types.RetentionSettings

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutSipMediaApplicationLoggingConfigurationInput added in v0.30.0

type PutSipMediaApplicationLoggingConfigurationInput struct {

	// The SIP media application ID.
	//
	// This member is required.
	SipMediaApplicationId *string

	// The actual logging configuration.
	SipMediaApplicationLoggingConfiguration *types.SipMediaApplicationLoggingConfiguration
}

type PutSipMediaApplicationLoggingConfigurationOutput added in v0.30.0

type PutSipMediaApplicationLoggingConfigurationOutput struct {

	// Logging configuration of the SIP media application.
	SipMediaApplicationLoggingConfiguration *types.SipMediaApplicationLoggingConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutVoiceConnectorEmergencyCallingConfigurationInput

type PutVoiceConnectorEmergencyCallingConfigurationInput struct {

	// The emergency calling configuration details.
	//
	// This member is required.
	EmergencyCallingConfiguration *types.EmergencyCallingConfiguration

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type PutVoiceConnectorEmergencyCallingConfigurationOutput

type PutVoiceConnectorEmergencyCallingConfigurationOutput struct {

	// The emergency calling configuration details.
	EmergencyCallingConfiguration *types.EmergencyCallingConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutVoiceConnectorLoggingConfigurationInput

type PutVoiceConnectorLoggingConfigurationInput struct {

	// The logging configuration details to add.
	//
	// This member is required.
	LoggingConfiguration *types.LoggingConfiguration

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type PutVoiceConnectorLoggingConfigurationOutput

type PutVoiceConnectorLoggingConfigurationOutput struct {

	// The updated logging configuration details.
	LoggingConfiguration *types.LoggingConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutVoiceConnectorOriginationInput

type PutVoiceConnectorOriginationInput struct {

	// The origination setting details to add.
	//
	// This member is required.
	Origination *types.Origination

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type PutVoiceConnectorOriginationOutput

type PutVoiceConnectorOriginationOutput struct {

	// The updated origination setting details.
	Origination *types.Origination

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutVoiceConnectorProxyInput

type PutVoiceConnectorProxyInput struct {

	// The default number of minutes allowed for proxy sessions.
	//
	// This member is required.
	DefaultSessionExpiryMinutes *int32

	// The countries for proxy phone numbers to be selected from.
	//
	// This member is required.
	PhoneNumberPoolCountries []string

	// The Amazon Chime voice connector ID.
	//
	// This member is required.
	VoiceConnectorId *string

	// When true, stops proxy sessions from being created on the specified Amazon Chime
	// Voice Connector.
	Disabled *bool

	// The phone number to route calls to after a proxy session expires.
	FallBackPhoneNumber *string
}

type PutVoiceConnectorProxyOutput

type PutVoiceConnectorProxyOutput struct {

	// The proxy configuration details.
	Proxy *types.Proxy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutVoiceConnectorStreamingConfigurationInput

type PutVoiceConnectorStreamingConfigurationInput struct {

	// The streaming configuration details to add.
	//
	// This member is required.
	StreamingConfiguration *types.StreamingConfiguration

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type PutVoiceConnectorStreamingConfigurationOutput

type PutVoiceConnectorStreamingConfigurationOutput struct {

	// The updated streaming configuration details.
	StreamingConfiguration *types.StreamingConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutVoiceConnectorTerminationCredentialsInput

type PutVoiceConnectorTerminationCredentialsInput struct {

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string

	// The termination SIP credentials.
	Credentials []types.Credential
}

type PutVoiceConnectorTerminationCredentialsOutput

type PutVoiceConnectorTerminationCredentialsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutVoiceConnectorTerminationInput

type PutVoiceConnectorTerminationInput struct {

	// The termination setting details to add.
	//
	// This member is required.
	Termination *types.Termination

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type PutVoiceConnectorTerminationOutput

type PutVoiceConnectorTerminationOutput struct {

	// The updated termination setting details.
	Termination *types.Termination

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RedactChannelMessageInput added in v0.30.0

type RedactChannelMessageInput struct {

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

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

	// The AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *string
}

type RedactChannelMessageOutput added in v0.30.0

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RedactConversationMessageInput

type RedactConversationMessageInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The conversation ID.
	//
	// This member is required.
	ConversationId *string

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

type RedactConversationMessageOutput

type RedactConversationMessageOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RedactRoomMessageInput

type RedactRoomMessageInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

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

	// The room ID.
	//
	// This member is required.
	RoomId *string
}

type RedactRoomMessageOutput

type RedactRoomMessageOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RegenerateSecurityTokenInput

type RegenerateSecurityTokenInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The bot ID.
	//
	// This member is required.
	BotId *string
}

type RegenerateSecurityTokenOutput

type RegenerateSecurityTokenOutput struct {

	// A resource that allows Enterprise account administrators to configure an
	// interface to receive events from Amazon Chime.
	Bot *types.Bot

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResetPersonalPINInput

type ResetPersonalPINInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The user ID.
	//
	// This member is required.
	UserId *string
}

type ResetPersonalPINOutput

type ResetPersonalPINOutput struct {

	// The user details and new personal meeting PIN.
	User *types.User

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type RestorePhoneNumberInput

type RestorePhoneNumberInput struct {

	// The phone number.
	//
	// This member is required.
	PhoneNumberId *string
}

type RestorePhoneNumberOutput

type RestorePhoneNumberOutput struct {

	// The phone number details.
	PhoneNumber *types.PhoneNumber

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SearchAvailablePhoneNumbersInput

type SearchAvailablePhoneNumbersInput struct {

	// The area code used to filter results.
	AreaCode *string

	// The city used to filter results.
	City *string

	// The country used to filter results.
	Country *string

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token to use to retrieve the next page of results.
	NextToken *string

	// The state used to filter results.
	State *string

	// The toll-free prefix that you use to filter results.
	TollFreePrefix *string
}

type SearchAvailablePhoneNumbersOutput

type SearchAvailablePhoneNumbersOutput struct {

	// List of phone numbers, in E.164 format.
	E164PhoneNumbers []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SendChannelMessageInput added in v0.30.0

type SendChannelMessageInput struct {

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

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

	// The content of the 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.
	//
	// This member is required.
	Type types.ChannelMessageType

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

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

type SendChannelMessageOutput added in v0.30.0

type SendChannelMessageOutput struct {

	// The ARN of the channel.
	ChannelArn *string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TagAttendeeInput

type TagAttendeeInput struct {

	// The Amazon Chime SDK attendee ID.
	//
	// This member is required.
	AttendeeId *string

	// The Amazon Chime SDK meeting ID.
	//
	// This member is required.
	MeetingId *string

	// The tag key-value pairs.
	//
	// This member is required.
	Tags []types.Tag
}

type TagAttendeeOutput

type TagAttendeeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TagMeetingInput

type TagMeetingInput struct {

	// The Amazon Chime SDK meeting ID.
	//
	// This member is required.
	MeetingId *string

	// The tag key-value pairs.
	//
	// This member is required.
	Tags []types.Tag
}

type TagMeetingOutput

type TagMeetingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagAttendeeInput

type UntagAttendeeInput struct {

	// The Amazon Chime SDK attendee ID.
	//
	// This member is required.
	AttendeeId *string

	// The Amazon Chime SDK meeting ID.
	//
	// This member is required.
	MeetingId *string

	// The tag keys.
	//
	// This member is required.
	TagKeys []string
}

type UntagAttendeeOutput

type UntagAttendeeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagMeetingInput

type UntagMeetingInput struct {

	// The Amazon Chime SDK meeting ID.
	//
	// This member is required.
	MeetingId *string

	// The tag keys.
	//
	// This member is required.
	TagKeys []string
}

type UntagMeetingOutput

type UntagMeetingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagResourceInput

type UntagResourceInput struct {

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

	// The tag keys.
	//
	// This member is required.
	TagKeys []string
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateAccountInput

type UpdateAccountInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The new name for the specified Amazon Chime account.
	Name *string
}

type UpdateAccountOutput

type UpdateAccountOutput struct {

	// The updated Amazon Chime account details.
	Account *types.Account

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateAccountSettingsInput

type UpdateAccountSettingsInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The Amazon Chime account settings to update.
	//
	// This member is required.
	AccountSettings *types.AccountSettings
}

type UpdateAccountSettingsOutput

type UpdateAccountSettingsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateAppInstanceInput added in v0.30.0

type UpdateAppInstanceInput struct {

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

	// The name that you want to change.
	//
	// This member is required.
	Name *string

	// The metadata that you want to change.
	Metadata *string
}

type UpdateAppInstanceOutput added in v0.30.0

type UpdateAppInstanceOutput struct {

	// The ARN of the AppInstance.
	AppInstanceArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateAppInstanceUserInput added in v0.30.0

type UpdateAppInstanceUserInput struct {

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

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

	// The metadata of the AppInstanceUser.
	Metadata *string
}

type UpdateAppInstanceUserOutput added in v0.30.0

type UpdateAppInstanceUserOutput struct {

	// The ARN of the AppInstanceUser.
	AppInstanceUserArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateBotInput

type UpdateBotInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The bot ID.
	//
	// This member is required.
	BotId *string

	// When true, stops the specified bot from running in your account.
	Disabled *bool
}

type UpdateBotOutput

type UpdateBotOutput struct {

	// The updated bot details.
	Bot *types.Bot

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateChannelInput added in v0.30.0

type UpdateChannelInput struct {

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

	// The mode of the update request.
	//
	// This member is required.
	Mode types.ChannelMode

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

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

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

type UpdateChannelMessageInput added in v0.30.0

type UpdateChannelMessageInput struct {

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

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

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

	// The content of the message being updated.
	Content *string

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

type UpdateChannelMessageOutput added in v0.30.0

type UpdateChannelMessageOutput struct {

	// The ARN of the channel.
	ChannelArn *string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateChannelOutput added in v0.30.0

type UpdateChannelOutput struct {

	// The ARN of the channel.
	ChannelArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateChannelReadMarkerInput added in v0.30.0

type UpdateChannelReadMarkerInput struct {

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

	// The AppInstanceUserArn of the user that makes the API call.
	ChimeBearer *string
}

type UpdateChannelReadMarkerOutput added in v0.30.0

type UpdateChannelReadMarkerOutput struct {

	// The ARN of the channel.
	ChannelArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateGlobalSettingsInput

type UpdateGlobalSettingsInput struct {

	// The Amazon Chime Business Calling settings.
	//
	// This member is required.
	BusinessCalling *types.BusinessCallingSettings

	// The Amazon Chime Voice Connector settings.
	//
	// This member is required.
	VoiceConnector *types.VoiceConnectorSettings
}

type UpdateGlobalSettingsOutput

type UpdateGlobalSettingsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdatePhoneNumberInput

type UpdatePhoneNumberInput struct {

	// The phone number ID.
	//
	// This member is required.
	PhoneNumberId *string

	// The outbound calling name associated with the phone number.
	CallingName *string

	// The product type.
	ProductType types.PhoneNumberProductType
}

type UpdatePhoneNumberOutput

type UpdatePhoneNumberOutput struct {

	// The updated phone number details.
	PhoneNumber *types.PhoneNumber

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdatePhoneNumberSettingsInput

type UpdatePhoneNumberSettingsInput struct {

	// The default outbound calling name for the account.
	//
	// This member is required.
	CallingName *string
}

type UpdatePhoneNumberSettingsOutput

type UpdatePhoneNumberSettingsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateProxySessionInput

type UpdateProxySessionInput struct {

	// The proxy session capabilities.
	//
	// This member is required.
	Capabilities []types.Capability

	// The proxy session ID.
	//
	// This member is required.
	ProxySessionId *string

	// The Amazon Chime voice connector ID.
	//
	// This member is required.
	VoiceConnectorId *string

	// The number of minutes allowed for the proxy session.
	ExpiryMinutes *int32
}

type UpdateProxySessionOutput

type UpdateProxySessionOutput struct {

	// The proxy session details.
	ProxySession *types.ProxySession

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateRoomInput

type UpdateRoomInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The room ID.
	//
	// This member is required.
	RoomId *string

	// The room name.
	Name *string
}

type UpdateRoomMembershipInput

type UpdateRoomMembershipInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The member ID.
	//
	// This member is required.
	MemberId *string

	// The room ID.
	//
	// This member is required.
	RoomId *string

	// The role of the member.
	Role types.RoomMembershipRole
}

type UpdateRoomMembershipOutput

type UpdateRoomMembershipOutput struct {

	// The room membership details.
	RoomMembership *types.RoomMembership

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateRoomOutput

type UpdateRoomOutput struct {

	// The room details.
	Room *types.Room

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateSipMediaApplicationInput added in v0.30.0

type UpdateSipMediaApplicationInput struct {

	// The SIP media application ID.
	//
	// This member is required.
	SipMediaApplicationId *string

	// The new set of endpoints for the specified SIP media application.
	Endpoints []types.SipMediaApplicationEndpoint

	// The new name for the specified SIP media application.
	Name *string
}

type UpdateSipMediaApplicationOutput added in v0.30.0

type UpdateSipMediaApplicationOutput struct {

	// The updated SIP media application details.
	SipMediaApplication *types.SipMediaApplication

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateSipRuleInput added in v0.30.0

type UpdateSipRuleInput struct {

	// The new name for the specified SIP rule.
	//
	// This member is required.
	Name *string

	// The SIP rule ID.
	//
	// This member is required.
	SipRuleId *string

	// The new value specified to indicate whether the rule is disabled.
	Disabled *bool

	// The new value of the list of target applications.
	TargetApplications []types.SipRuleTargetApplication
}

type UpdateSipRuleOutput added in v0.30.0

type UpdateSipRuleOutput struct {

	// Updated SIP rule details.
	SipRule *types.SipRule

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateUserInput

type UpdateUserInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The user ID.
	//
	// This member is required.
	UserId *string

	// The Alexa for Business metadata.
	AlexaForBusinessMetadata *types.AlexaForBusinessMetadata

	// The user license type to update. This must be a supported license type for the
	// Amazon Chime account that the user belongs to.
	LicenseType types.License

	// The user type.
	UserType types.UserType
}

type UpdateUserOutput

type UpdateUserOutput struct {

	// The updated user details.
	User *types.User

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateUserSettingsInput

type UpdateUserSettingsInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The user ID.
	//
	// This member is required.
	UserId *string

	// The user settings to update.
	//
	// This member is required.
	UserSettings *types.UserSettings
}

type UpdateUserSettingsOutput

type UpdateUserSettingsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateVoiceConnectorGroupInput

type UpdateVoiceConnectorGroupInput struct {

	// The name of the Amazon Chime Voice Connector group.
	//
	// This member is required.
	Name *string

	// The Amazon Chime Voice Connector group ID.
	//
	// This member is required.
	VoiceConnectorGroupId *string

	// The VoiceConnectorItems to associate with the group.
	//
	// This member is required.
	VoiceConnectorItems []types.VoiceConnectorItem
}

type UpdateVoiceConnectorGroupOutput

type UpdateVoiceConnectorGroupOutput struct {

	// The updated Amazon Chime Voice Connector group details.
	VoiceConnectorGroup *types.VoiceConnectorGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateVoiceConnectorInput

type UpdateVoiceConnectorInput struct {

	// The name of the Amazon Chime Voice Connector.
	//
	// This member is required.
	Name *string

	// When enabled, requires encryption for the Amazon Chime Voice Connector.
	//
	// This member is required.
	RequireEncryption *bool

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

type UpdateVoiceConnectorOutput

type UpdateVoiceConnectorOutput struct {

	// The updated Amazon Chime Voice Connector details.
	VoiceConnector *types.VoiceConnector

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL