chime

package module
v1.36.2 Latest Latest
Warning

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

 Go to latest Published: Apr 3, 2025 License: Apache-2.0 Imports: 45 Imported by: 10

Documentation

Overview

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

Most of these APIs are no longer supported and will not be updated. We

recommend using the latest versions in the Amazon Chime SDK API reference, in the Amazon Chime SDK.

Using the latest versions requires migrating to dedicated namespaces. For more information, refer to Migrating from the Amazon Chime namespacein the Amazon Chime SDK Developer Guide.

The Amazon Chime application programming interface (API) is designed so administrators can 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.

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls for Amazon Chime. We recommend using an AWS SDK or the AWS CLI. The page for each API action contains a See Also section that includes links to information about using the action 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.

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 Interfacein the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commandsin 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 Processin 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 Chimein the Amazon Chime Administration Guide.

Deprecated: This namespace has been deprecated

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 deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

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

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

func WithEndpointResolverV2 added in v1.25.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.27.2 

func WithSigV4SigningName(name string) func(*Options)

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

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

func WithSigV4SigningRegion added in v1.27.2 

func WithSigV4SigningRegion(region string) func(*Options)

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

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

Types

type 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
	// contains filtered or unexported fields
}

type AssociatePhoneNumberWithUserOutput 

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

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
	// contains filtered or unexported fields
}

type AssociateSigninDelegateGroupsWithAccountOutput 

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

type AuthResolverParameters added in v1.27.2 

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

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

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

type AuthSchemeResolver added in v1.27.2 

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

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

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type BatchDeletePhoneNumberInput 

type BatchDeletePhoneNumberInput struct {

	// List of phone number IDs.
	//
	// This member is required.
	PhoneNumberIds []string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type Client 

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

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

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) 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) 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 Accountsin 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 InviteUsersaction 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 Accountsin the account types, 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 the product type or the calling name.

For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In 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 Accountsin the Amazon Chime Administration 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) 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.

This API is not available in a dedicated namespace.

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. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.

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

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

Moves the specified phone number into the Deletion queue. 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) 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) 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) 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 Pagein the Amazon Chime Administration 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) 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) 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) 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 Policiesin 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) 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) 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, you can filter by the user's email address, which returns one account result.

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) 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) 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) ListSupportedPhoneNumberCountries added in v1.3.0 

func (c *Client) ListSupportedPhoneNumberCountries(ctx context.Context, params *ListSupportedPhoneNumberCountriesInput, optFns ...func(*Options)) (*ListSupportedPhoneNumberCountriesOutput, error)

Lists supported phone number countries.

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) 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) Options added in v1.28.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

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

func (*Client) 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 CloudTrailin 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 Policiesin the Amazon Chime Administration Guide.

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 Userobject 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 for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: AreaCode , City , State , or TollFreePrefix . If you provide City , you must also provide State . Numbers outside the US only support the PhoneNumberType filter, which you must use.

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 and default license 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 Pagein the Amazon Chime Administration Guide.

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) 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 cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.

Updates to outbound calling names can take 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) 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) 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.

type CreateAccountInput 

type CreateAccountInput struct {

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

type CreateAccountOutput 

type CreateAccountOutput struct {

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

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

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
	// contains filtered or unexported fields
}

type CreateBotOutput 

type CreateBotOutput struct {

	// The bot details.
	Bot *types.Bot

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

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] action to get a join
	// token.
	//
	// [CreateAttendee]: https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateAttendee.html
	//
	// 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type CreatePhoneNumberOrderOutput 

type CreatePhoneNumberOrderOutput struct {

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

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

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type CreateRoomMembershipOutput 

type CreateRoomMembershipOutput struct {

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

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

type CreateRoomOutput 

type CreateRoomOutput struct {

	// The room details.
	Room *types.Room

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

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type DeleteAccountInput 

type DeleteAccountInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string
	// contains filtered or unexported fields
}

type DeleteAccountOutput 

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

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
	// contains filtered or unexported fields
}

type DeleteEventsConfigurationOutput 

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

type DeletePhoneNumberInput 

type DeletePhoneNumberInput struct {

	// The phone number ID.
	//
	// This member is required.
	PhoneNumberId *string
	// contains filtered or unexported fields
}

type DeletePhoneNumberOutput 

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

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type DeleteRoomMembershipOutput 

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

type DeleteRoomOutput 

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

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
	// contains filtered or unexported fields
}

type DisassociatePhoneNumberFromUserOutput 

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

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
	// contains filtered or unexported fields
}

type DisassociateSigninDelegateGroupsFromAccountOutput 

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

type EndpointParameters added in v1.25.0 

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

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

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

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

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.25.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.25.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

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

type EndpointResolver 

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 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 EndpointResolverV2 added in v1.25.0 

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

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.25.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAccountInput 

type GetAccountInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string
	// contains filtered or unexported fields
}

type GetAccountOutput 

type GetAccountOutput struct {

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

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

type GetAccountSettingsInput 

type GetAccountSettingsInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string
	// contains filtered or unexported fields
}

type GetAccountSettingsOutput 

type GetAccountSettingsOutput struct {

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

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

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
	// contains filtered or unexported fields
}

type GetBotOutput 

type GetBotOutput struct {

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

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

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
	// contains filtered or unexported fields
}

type GetEventsConfigurationOutput 

type GetEventsConfigurationOutput struct {

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

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

type GetGlobalSettingsInput 

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

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
	// contains filtered or unexported fields
}

type GetPhoneNumberInput 

type GetPhoneNumberInput struct {

	// The phone number ID.
	//
	// This member is required.
	PhoneNumberId *string
	// contains filtered or unexported fields
}

type GetPhoneNumberOrderInput 

type GetPhoneNumberOrderInput struct {

	// The ID for the phone number order.
	//
	// This member is required.
	PhoneNumberOrderId *string
	// contains filtered or unexported fields
}

type GetPhoneNumberOrderOutput 

type GetPhoneNumberOrderOutput struct {

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

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

type GetPhoneNumberOutput 

type GetPhoneNumberOutput struct {

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

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

type GetPhoneNumberSettingsInput 

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

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
	// contains filtered or unexported fields
}

type GetRetentionSettingsInput 

type GetRetentionSettingsInput struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetRoomOutput 

type GetRoomOutput struct {

	// The room details.
	Room *types.Room

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

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
	// contains filtered or unexported fields
}

type GetUserOutput 

type GetUserOutput struct {

	// The user details.
	User *types.User

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

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
	// contains filtered or unexported fields
}

type GetUserSettingsOutput 

type GetUserSettingsOutput struct {

	// The user settings.
	UserSettings *types.UserSettings

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

type HTTPClient 

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

type HTTPSignerV4 

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

type IdempotencyTokenProvider 

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

IdempotencyTokenProvider interface for providing idempotency token

type 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
	// contains filtered or unexported fields
}

type InviteUsersOutput 

type InviteUsersOutput struct {

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

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

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 

func NewListPhoneNumberOrdersPaginator(client ListPhoneNumberOrdersAPIClient, params *ListPhoneNumberOrdersInput, optFns ...func(*ListPhoneNumberOrdersPaginatorOptions)) *ListPhoneNumberOrdersPaginator

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 

func (p *ListPhoneNumberOrdersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPhoneNumberOrdersOutput, error)

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 ListSupportedPhoneNumberCountriesInput added in v1.3.0 

type ListSupportedPhoneNumberCountriesInput struct {

	// The phone number product type.
	//
	// This member is required.
	ProductType types.PhoneNumberProductType
	// contains filtered or unexported fields
}

type ListSupportedPhoneNumberCountriesOutput added in v1.3.0 

type ListSupportedPhoneNumberCountriesOutput struct {

	// The supported phone number countries.
	PhoneNumberCountries []types.PhoneNumberCountry

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

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 LogoutUserInput 

type LogoutUserInput struct {

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

	// The user ID.
	//
	// This member is required.
	UserId *string
	// contains filtered or unexported fields
}

type LogoutUserOutput 

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

type Options 

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

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

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

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

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

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

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

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

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

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

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

	// The client meter provider.
	MeterProvider metrics.MeterProvider

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

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

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

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

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

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

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

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

func (Options) Copy 

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver added in v1.27.2 

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

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
	// contains filtered or unexported fields
}

type PutEventsConfigurationOutput 

type PutEventsConfigurationOutput struct {

	// The configuration that allows a bot to receive outgoing events. Can be an HTTPS
	// endpoint or an AWS Lambda function ARN.
	EventsConfiguration *types.EventsConfiguration

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

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type RedactConversationMessageOutput 

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

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
	// contains filtered or unexported fields
}

type RedactRoomMessageOutput 

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

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
	// contains filtered or unexported fields
}

type RegenerateSecurityTokenOutput 

type RegenerateSecurityTokenOutput struct {

	// A resource that allows Enterprise account administrators to configure an
	// interface that receives events from Amazon Chime.
	Bot *types.Bot

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

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

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

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type RestorePhoneNumberInput 

type RestorePhoneNumberInput struct {

	// The phone number.
	//
	// This member is required.
	PhoneNumberId *string
	// contains filtered or unexported fields
}

type RestorePhoneNumberOutput 

type RestorePhoneNumberOutput struct {

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

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

type SearchAvailablePhoneNumbersAPIClient added in v1.3.0 

type SearchAvailablePhoneNumbersAPIClient interface {
	SearchAvailablePhoneNumbers(context.Context, *SearchAvailablePhoneNumbersInput, ...func(*Options)) (*SearchAvailablePhoneNumbersOutput, error)
}

SearchAvailablePhoneNumbersAPIClient is a client that implements the SearchAvailablePhoneNumbers operation.

type SearchAvailablePhoneNumbersInput 

type SearchAvailablePhoneNumbersInput struct {

	// The area code used to filter results. Only applies to the US.
	AreaCode *string

	// The city used to filter results. Only applies to the US.
	City *string

	// The country used to filter results. Defaults to the US Format: ISO 3166-1
	// alpha-2.
	Country *string

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

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

	// The phone number type used to filter results. Required for non-US numbers.
	PhoneNumberType types.PhoneNumberType

	// The state used to filter results. Required only if you provide City . Only
	// applies to the US.
	State *string

	// The toll-free prefix that you use to filter results. Only applies to the US.
	TollFreePrefix *string
	// contains filtered or unexported fields
}

type SearchAvailablePhoneNumbersOutput 

type SearchAvailablePhoneNumbersOutput struct {

	// List of phone numbers, in E.164 format.
	E164PhoneNumbers []string

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

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

type SearchAvailablePhoneNumbersPaginator added in v1.3.0 

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

SearchAvailablePhoneNumbersPaginator is a paginator for SearchAvailablePhoneNumbers

func NewSearchAvailablePhoneNumbersPaginator added in v1.3.0 

func NewSearchAvailablePhoneNumbersPaginator(client SearchAvailablePhoneNumbersAPIClient, params *SearchAvailablePhoneNumbersInput, optFns ...func(*SearchAvailablePhoneNumbersPaginatorOptions)) *SearchAvailablePhoneNumbersPaginator

NewSearchAvailablePhoneNumbersPaginator returns a new SearchAvailablePhoneNumbersPaginator

func (*SearchAvailablePhoneNumbersPaginator) HasMorePages added in v1.3.0 

func (p *SearchAvailablePhoneNumbersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchAvailablePhoneNumbersPaginator) NextPage added in v1.3.0 

func (p *SearchAvailablePhoneNumbersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchAvailablePhoneNumbersOutput, error)

NextPage retrieves the next SearchAvailablePhoneNumbers page.

type SearchAvailablePhoneNumbersPaginatorOptions added in v1.3.0 

type SearchAvailablePhoneNumbersPaginatorOptions 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
}

SearchAvailablePhoneNumbersPaginatorOptions is the paginator options for SearchAvailablePhoneNumbers

type UpdateAccountInput 

type UpdateAccountInput struct {

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

	// The default license applied when you add users to an Amazon Chime account.
	DefaultLicense types.License

	// The new name for the specified Amazon Chime account.
	Name *string
	// contains filtered or unexported fields
}

type UpdateAccountOutput 

type UpdateAccountOutput struct {

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

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

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
	// contains filtered or unexported fields
}

type UpdateAccountSettingsOutput 

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

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
	// contains filtered or unexported fields
}

type UpdateBotOutput 

type UpdateBotOutput struct {

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

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

type UpdateGlobalSettingsInput 

type UpdateGlobalSettingsInput struct {

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

	// The Amazon Chime Voice Connector settings.
	VoiceConnector *types.VoiceConnectorSettings
	// contains filtered or unexported fields
}

type UpdateGlobalSettingsOutput 

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

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
	// contains filtered or unexported fields
}

type UpdatePhoneNumberOutput 

type UpdatePhoneNumberOutput struct {

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

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

type UpdatePhoneNumberSettingsInput 

type UpdatePhoneNumberSettingsInput struct {

	// The default outbound calling name for the account.
	//
	// This member is required.
	CallingName *string
	// contains filtered or unexported fields
}

type UpdatePhoneNumberSettingsOutput 

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

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type UpdateRoomMembershipOutput 

type UpdateRoomMembershipOutput struct {

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

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

type UpdateRoomOutput 

type UpdateRoomOutput struct {

	// The room details.
	Room *types.Room

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

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
	// contains filtered or unexported fields
}

type UpdateUserOutput 

type UpdateUserOutput struct {

	// The updated user details.
	User *types.User

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

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
	// contains filtered or unexported fields
}

type UpdateUserSettingsOutput 

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

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

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