View on GitHub
Chime Structure Reference
Chime
public struct ChimeClient object for interacting with AWS Chime service.
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 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. 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 in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference. Using REST API 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 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 in the Amazon Chime Administration Guide.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the Chime client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)Parameters
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
Associates a phone number with the specified Amazon Chime user.
Declaration
Swift
public func associatePhoneNumberWithUser(_ input: AssociatePhoneNumberWithUserRequest) -> EventLoopFuture<AssociatePhoneNumberWithUserResponse> -
Associates phone numbers with the specified Amazon Chime Voice Connector.
Declaration
Swift
public func associatePhoneNumbersWithVoiceConnector(_ input: AssociatePhoneNumbersWithVoiceConnectorRequest) -> EventLoopFuture<AssociatePhoneNumbersWithVoiceConnectorResponse> -
Associates phone numbers with the specified Amazon Chime Voice Connector group.
Declaration
Swift
public func associatePhoneNumbersWithVoiceConnectorGroup(_ input: AssociatePhoneNumbersWithVoiceConnectorGroupRequest) -> EventLoopFuture<AssociatePhoneNumbersWithVoiceConnectorGroupResponse> -
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
Declaration
Swift
public func associateSigninDelegateGroupsWithAccount(_ input: AssociateSigninDelegateGroupsWithAccountRequest) -> EventLoopFuture<AssociateSigninDelegateGroupsWithAccountResponse> -
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 in the Amazon Chime Developer Guide.
Declaration
Swift
public func batchCreateAttendee(_ input: BatchCreateAttendeeRequest) -> EventLoopFuture<BatchCreateAttendeeResponse> -
Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be either users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.
Declaration
Swift
public func batchCreateRoomMembership(_ input: BatchCreateRoomMembershipRequest) -> EventLoopFuture<BatchCreateRoomMembershipResponse> -
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.
Declaration
Swift
public func batchDeletePhoneNumber(_ input: BatchDeletePhoneNumberRequest) -> EventLoopFuture<BatchDeletePhoneNumberResponse> -
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 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.
Declaration
Swift
public func batchSuspendUser(_ input: BatchSuspendUserRequest) -> EventLoopFuture<BatchSuspendUserResponse> -
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 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.
Declaration
Swift
public func batchUnsuspendUser(_ input: BatchUnsuspendUserRequest) -> EventLoopFuture<BatchUnsuspendUserResponse> -
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.
Declaration
Swift
public func batchUpdatePhoneNumber(_ input: BatchUpdatePhoneNumberRequest) -> EventLoopFuture<BatchUpdatePhoneNumberResponse> -
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.
Declaration
Swift
public func batchUpdateUser(_ input: BatchUpdateUserRequest) -> EventLoopFuture<BatchUpdateUserResponse> -
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 in the Amazon Chime Administration Guide.
Declaration
Swift
public func createAccount(_ input: CreateAccountRequest) -> EventLoopFuture<CreateAccountResponse> -
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 in the Amazon Chime Developer Guide.
Declaration
Swift
public func createAttendee(_ input: CreateAttendeeRequest) -> EventLoopFuture<CreateAttendeeResponse> -
Creates a bot for an Amazon Chime Enterprise account.
Declaration
Swift
public func createBot(_ input: CreateBotRequest) -> EventLoopFuture<CreateBotResponse> -
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 in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
Declaration
Swift
public func createMeeting(_ input: CreateMeetingRequest) -> EventLoopFuture<CreateMeetingResponse> -
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 in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
Declaration
Swift
public func createMeetingWithAttendees(_ input: CreateMeetingWithAttendeesRequest) -> EventLoopFuture<CreateMeetingWithAttendeesResponse> -
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.
Declaration
Swift
public func createPhoneNumberOrder(_ input: CreatePhoneNumberOrderRequest) -> EventLoopFuture<CreatePhoneNumberOrderResponse> -
Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
Declaration
Swift
public func createProxySession(_ input: CreateProxySessionRequest) -> EventLoopFuture<CreateProxySessionResponse> -
Creates a chat room for the specified Amazon Chime Enterprise account.
Declaration
Swift
public func createRoom(_ input: CreateRoomRequest) -> EventLoopFuture<CreateRoomResponse> -
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.
Declaration
Swift
public func createRoomMembership(_ input: CreateRoomMembershipRequest) -> EventLoopFuture<CreateRoomMembershipResponse> -
Creates a user under the specified Amazon Chime account.
Declaration
Swift
public func createUser(_ input: CreateUserRequest) -> EventLoopFuture<CreateUserResponse> -
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.
Declaration
Swift
public func createVoiceConnector(_ input: CreateVoiceConnectorRequest) -> EventLoopFuture<CreateVoiceConnectorResponse> -
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.
Declaration
Swift
public func createVoiceConnectorGroup(_ input: CreateVoiceConnectorGroupRequest) -> EventLoopFuture<CreateVoiceConnectorGroupResponse> -
Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team account. You can use the BatchSuspendUser action to do so. 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 a 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.
Declaration
Swift
public func deleteAccount(_ input: DeleteAccountRequest) -> EventLoopFuture<DeleteAccountResponse> -
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 in the Amazon Chime Developer Guide.
Declaration
Swift
@discardableResult public func deleteAttendee(_ input: DeleteAttendeeRequest) -> EventLoopFuture<Void> -
Deletes the events configuration that allows a bot to receive outgoing events.
Declaration
Swift
@discardableResult public func deleteEventsConfiguration(_ input: DeleteEventsConfigurationRequest) -> EventLoopFuture<Void> -
Deletes the specified Amazon Chime SDK meeting. When a meeting is deleted, its attendees are also deleted and clients can no longer join it. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
Declaration
Swift
@discardableResult public func deleteMeeting(_ input: DeleteMeetingRequest) -> EventLoopFuture<Void> -
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.
Declaration
Swift
@discardableResult public func deletePhoneNumber(_ input: DeletePhoneNumberRequest) -> EventLoopFuture<Void> -
Deletes the specified proxy session from the specified Amazon Chime Voice Connector.
Declaration
Swift
@discardableResult public func deleteProxySession(_ input: DeleteProxySessionRequest) -> EventLoopFuture<Void> -
Deletes a chat room in an Amazon Chime Enterprise account.
Declaration
Swift
@discardableResult public func deleteRoom(_ input: DeleteRoomRequest) -> EventLoopFuture<Void> -
Removes a member from a chat room in an Amazon Chime Enterprise account.
Declaration
Swift
@discardableResult public func deleteRoomMembership(_ input: DeleteRoomMembershipRequest) -> EventLoopFuture<Void> -
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.
Declaration
Swift
@discardableResult public func deleteVoiceConnector(_ input: DeleteVoiceConnectorRequest) -> EventLoopFuture<Void> -
Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.
Declaration
Swift
@discardableResult public func deleteVoiceConnectorEmergencyCallingConfiguration(_ input: DeleteVoiceConnectorEmergencyCallingConfigurationRequest) -> EventLoopFuture<Void> -
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.
Declaration
Swift
@discardableResult public func deleteVoiceConnectorGroup(_ input: DeleteVoiceConnectorGroupRequest) -> EventLoopFuture<Void> -
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.
Declaration
Swift
@discardableResult public func deleteVoiceConnectorOrigination(_ input: DeleteVoiceConnectorOriginationRequest) -> EventLoopFuture<Void> -
Deletes the proxy configuration from the specified Amazon Chime Voice Connector.
Declaration
Swift
@discardableResult public func deleteVoiceConnectorProxy(_ input: DeleteVoiceConnectorProxyRequest) -> EventLoopFuture<Void> -
Deletes the streaming configuration for the specified Amazon Chime Voice Connector.
Declaration
Swift
@discardableResult public func deleteVoiceConnectorStreamingConfiguration(_ input: DeleteVoiceConnectorStreamingConfigurationRequest) -> EventLoopFuture<Void> -
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.
Declaration
Swift
@discardableResult public func deleteVoiceConnectorTermination(_ input: DeleteVoiceConnectorTerminationRequest) -> EventLoopFuture<Void> -
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
Declaration
Swift
@discardableResult public func deleteVoiceConnectorTerminationCredentials(_ input: DeleteVoiceConnectorTerminationCredentialsRequest) -> EventLoopFuture<Void> -
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
Declaration
Swift
public func disassociatePhoneNumberFromUser(_ input: DisassociatePhoneNumberFromUserRequest) -> EventLoopFuture<DisassociatePhoneNumberFromUserResponse> -
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
Declaration
Swift
public func disassociatePhoneNumbersFromVoiceConnector(_ input: DisassociatePhoneNumbersFromVoiceConnectorRequest) -> EventLoopFuture<DisassociatePhoneNumbersFromVoiceConnectorResponse> -
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
Declaration
Swift
public func disassociatePhoneNumbersFromVoiceConnectorGroup(_ input: DisassociatePhoneNumbersFromVoiceConnectorGroupRequest) -> EventLoopFuture<DisassociatePhoneNumbersFromVoiceConnectorGroupResponse> -
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
Declaration
Swift
public func disassociateSigninDelegateGroupsFromAccount(_ input: DisassociateSigninDelegateGroupsFromAccountRequest) -> EventLoopFuture<DisassociateSigninDelegateGroupsFromAccountResponse> -
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
Declaration
Swift
public func getAccount(_ input: GetAccountRequest) -> EventLoopFuture<GetAccountResponse> -
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
Declaration
Swift
public func getAccountSettings(_ input: GetAccountSettingsRequest) -> EventLoopFuture<GetAccountSettingsResponse> -
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 in the Amazon Chime Developer Guide.
Declaration
Swift
public func getAttendee(_ input: GetAttendeeRequest) -> EventLoopFuture<GetAttendeeResponse> -
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
Declaration
Swift
public func getBot(_ input: GetBotRequest) -> EventLoopFuture<GetBotResponse> -
Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
Declaration
Swift
public func getEventsConfiguration(_ input: GetEventsConfigurationRequest) -> EventLoopFuture<GetEventsConfigurationResponse> -
Retrieves global settings for the administrator’s AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
Declaration
Swift
public func getGlobalSettings() -> EventLoopFuture<GetGlobalSettingsResponse> -
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 in the Amazon Chime Developer Guide.
Declaration
Swift
public func getMeeting(_ input: GetMeetingRequest) -> EventLoopFuture<GetMeetingResponse> -
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
Declaration
Swift
public func getPhoneNumber(_ input: GetPhoneNumberRequest) -> EventLoopFuture<GetPhoneNumberResponse> -
Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E.164 format, product type, and order status.
Declaration
Swift
public func getPhoneNumberOrder(_ input: GetPhoneNumberOrderRequest) -> EventLoopFuture<GetPhoneNumberOrderResponse> -
Retrieves the phone number settings for the administrator’s AWS account, such as the default outbound calling name.
Declaration
Swift
public func getPhoneNumberSettings() -> EventLoopFuture<GetPhoneNumberSettingsResponse> -
Gets the specified proxy session details for the specified Amazon Chime Voice Connector.
Declaration
Swift
public func getProxySession(_ input: GetProxySessionRequest) -> EventLoopFuture<GetProxySessionResponse> -
Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
Declaration
Swift
public func getRetentionSettings(_ input: GetRetentionSettingsRequest) -> EventLoopFuture<GetRetentionSettingsResponse> -
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
Declaration
Swift
public func getRoom(_ input: GetRoomRequest) -> EventLoopFuture<GetRoomResponse> -
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.
Declaration
Swift
public func getUser(_ input: GetUserRequest) -> EventLoopFuture<GetUserResponse> -
Retrieves settings for the specified user ID, such as any associated phone number settings.
Declaration
Swift
public func getUserSettings(_ input: GetUserSettingsRequest) -> EventLoopFuture<GetUserSettingsResponse> -
Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.
Declaration
Swift
public func getVoiceConnector(_ input: GetVoiceConnectorRequest) -> EventLoopFuture<GetVoiceConnectorResponse> -
Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.
Declaration
Swift
public func getVoiceConnectorEmergencyCallingConfiguration(_ input: GetVoiceConnectorEmergencyCallingConfigurationRequest) -> EventLoopFuture<GetVoiceConnectorEmergencyCallingConfigurationResponse> -
Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps, name, and associated VoiceConnectorItems.
Declaration
Swift
public func getVoiceConnectorGroup(_ input: GetVoiceConnectorGroupRequest) -> EventLoopFuture<GetVoiceConnectorGroupResponse> -
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.
Declaration
Swift
public func getVoiceConnectorLoggingConfiguration(_ input: GetVoiceConnectorLoggingConfigurationRequest) -> EventLoopFuture<GetVoiceConnectorLoggingConfigurationResponse> -
Retrieves origination setting details for the specified Amazon Chime Voice Connector.
Declaration
Swift
public func getVoiceConnectorOrigination(_ input: GetVoiceConnectorOriginationRequest) -> EventLoopFuture<GetVoiceConnectorOriginationResponse> -
Gets the proxy configuration details for the specified Amazon Chime Voice Connector.
Declaration
Swift
public func getVoiceConnectorProxy(_ input: GetVoiceConnectorProxyRequest) -> EventLoopFuture<GetVoiceConnectorProxyResponse> -
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.
Declaration
Swift
public func getVoiceConnectorStreamingConfiguration(_ input: GetVoiceConnectorStreamingConfigurationRequest) -> EventLoopFuture<GetVoiceConnectorStreamingConfigurationResponse> -
Retrieves termination setting details for the specified Amazon Chime Voice Connector.
Declaration
Swift
public func getVoiceConnectorTermination(_ input: GetVoiceConnectorTerminationRequest) -> EventLoopFuture<GetVoiceConnectorTerminationResponse> -
Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.
Declaration
Swift
public func getVoiceConnectorTerminationHealth(_ input: GetVoiceConnectorTerminationHealthRequest) -> EventLoopFuture<GetVoiceConnectorTerminationHealthResponse> -
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.
Declaration
Swift
public func inviteUsers(_ input: InviteUsersRequest) -> EventLoopFuture<InviteUsersResponse> -
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.
Declaration
Swift
public func listAccounts(_ input: ListAccountsRequest) -> EventLoopFuture<ListAccountsResponse> -
Lists the tags applied to an Amazon Chime SDK attendee resource.
Declaration
Swift
public func listAttendeeTags(_ input: ListAttendeeTagsRequest) -> EventLoopFuture<ListAttendeeTagsResponse> -
Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
Declaration
Swift
public func listAttendees(_ input: ListAttendeesRequest) -> EventLoopFuture<ListAttendeesResponse> -
Lists the bots associated with the administrator’s Amazon Chime Enterprise account ID.
Declaration
Swift
public func listBots(_ input: ListBotsRequest) -> EventLoopFuture<ListBotsResponse> -
Lists the tags applied to an Amazon Chime SDK meeting resource.
Declaration
Swift
public func listMeetingTags(_ input: ListMeetingTagsRequest) -> EventLoopFuture<ListMeetingTagsResponse> -
Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
Declaration
Swift
public func listMeetings(_ input: ListMeetingsRequest) -> EventLoopFuture<ListMeetingsResponse> -
Lists the phone number orders for the administrator’s Amazon Chime account.
Declaration
Swift
public func listPhoneNumberOrders(_ input: ListPhoneNumberOrdersRequest) -> EventLoopFuture<ListPhoneNumberOrdersResponse> -
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
Declaration
Swift
public func listPhoneNumbers(_ input: ListPhoneNumbersRequest) -> EventLoopFuture<ListPhoneNumbersResponse> -
Lists the proxy sessions for the specified Amazon Chime Voice Connector.
Declaration
Swift
public func listProxySessions(_ input: ListProxySessionsRequest) -> EventLoopFuture<ListProxySessionsResponse> -
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members’ IDs, email addresses, and names.
Declaration
Swift
public func listRoomMemberships(_ input: ListRoomMembershipsRequest) -> EventLoopFuture<ListRoomMembershipsResponse> -
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.
Declaration
Swift
public func listRooms(_ input: ListRoomsRequest) -> EventLoopFuture<ListRoomsResponse> -
Lists the tags applied to an Amazon Chime SDK meeting resource.
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse> -
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.
Declaration
Swift
public func listUsers(_ input: ListUsersRequest) -> EventLoopFuture<ListUsersResponse> -
Lists the Amazon Chime Voice Connector groups for the administrator’s AWS account.
Declaration
Swift
public func listVoiceConnectorGroups(_ input: ListVoiceConnectorGroupsRequest) -> EventLoopFuture<ListVoiceConnectorGroupsResponse> -
Lists the SIP credentials for the specified Amazon Chime Voice Connector.
Declaration
Swift
public func listVoiceConnectorTerminationCredentials(_ input: ListVoiceConnectorTerminationCredentialsRequest) -> EventLoopFuture<ListVoiceConnectorTerminationCredentialsResponse> -
Lists the Amazon Chime Voice Connectors for the administrator’s AWS account.
Declaration
Swift
public func listVoiceConnectors(_ input: ListVoiceConnectorsRequest) -> EventLoopFuture<ListVoiceConnectorsResponse> -
Logs out the specified user from all of the devices they are currently logged into.
Declaration
Swift
public func logoutUser(_ input: LogoutUserRequest) -> EventLoopFuture<LogoutUserResponse> -
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.
Declaration
Swift
public func putEventsConfiguration(_ input: PutEventsConfigurationRequest) -> EventLoopFuture<PutEventsConfigurationResponse> -
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 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 in the Amazon Chime Administration Guide.
Declaration
Swift
public func putRetentionSettings(_ input: PutRetentionSettingsRequest) -> EventLoopFuture<PutRetentionSettingsResponse> -
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.
Declaration
Swift
public func putVoiceConnectorEmergencyCallingConfiguration(_ input: PutVoiceConnectorEmergencyCallingConfigurationRequest) -> EventLoopFuture<PutVoiceConnectorEmergencyCallingConfigurationResponse> -
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.
Declaration
Swift
public func putVoiceConnectorLoggingConfiguration(_ input: PutVoiceConnectorLoggingConfigurationRequest) -> EventLoopFuture<PutVoiceConnectorLoggingConfigurationResponse> -
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.
Declaration
Swift
public func putVoiceConnectorOrigination(_ input: PutVoiceConnectorOriginationRequest) -> EventLoopFuture<PutVoiceConnectorOriginationResponse> -
Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.
Declaration
Swift
public func putVoiceConnectorProxy(_ input: PutVoiceConnectorProxyRequest) -> EventLoopFuture<PutVoiceConnectorProxyResponse> -
Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Amazon Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.
Declaration
Swift
public func putVoiceConnectorStreamingConfiguration(_ input: PutVoiceConnectorStreamingConfigurationRequest) -> EventLoopFuture<PutVoiceConnectorStreamingConfigurationResponse> -
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.
Declaration
Swift
public func putVoiceConnectorTermination(_ input: PutVoiceConnectorTerminationRequest) -> EventLoopFuture<PutVoiceConnectorTerminationResponse> -
Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
Declaration
Swift
@discardableResult public func putVoiceConnectorTerminationCredentials(_ input: PutVoiceConnectorTerminationCredentialsRequest) -> EventLoopFuture<Void> -
Redacts the specified message from the specified Amazon Chime conversation.
Declaration
Swift
public func redactConversationMessage(_ input: RedactConversationMessageRequest) -> EventLoopFuture<RedactConversationMessageResponse> -
Redacts the specified message from the specified Amazon Chime chat room.
Declaration
Swift
public func redactRoomMessage(_ input: RedactRoomMessageRequest) -> EventLoopFuture<RedactRoomMessageResponse> -
Regenerates the security token for a bot.
Declaration
Swift
public func regenerateSecurityToken(_ input: RegenerateSecurityTokenRequest) -> EventLoopFuture<RegenerateSecurityTokenResponse> -
Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
Declaration
Swift
public func resetPersonalPIN(_ input: ResetPersonalPINRequest) -> EventLoopFuture<ResetPersonalPINResponse> -
Moves a phone number from the Deletion queue back into the phone number Inventory.
Declaration
Swift
public func restorePhoneNumber(_ input: RestorePhoneNumberRequest) -> EventLoopFuture<RestorePhoneNumberResponse> -
Searches phone numbers that can be ordered.
Declaration
Swift
public func searchAvailablePhoneNumbers(_ input: SearchAvailablePhoneNumbersRequest) -> EventLoopFuture<SearchAvailablePhoneNumbersResponse> -
Applies the specified tags to the specified Amazon Chime SDK attendee.
Declaration
Swift
@discardableResult public func tagAttendee(_ input: TagAttendeeRequest) -> EventLoopFuture<Void> -
Applies the specified tags to the specified Amazon Chime SDK meeting.
Declaration
Swift
@discardableResult public func tagMeeting(_ input: TagMeetingRequest) -> EventLoopFuture<Void> -
Applies the specified tags to the specified Amazon Chime SDK meeting resource.
Declaration
Swift
@discardableResult public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<Void> -
Untags the specified tags from the specified Amazon Chime SDK attendee.
Declaration
Swift
@discardableResult public func untagAttendee(_ input: UntagAttendeeRequest) -> EventLoopFuture<Void> -
Untags the specified tags from the specified Amazon Chime SDK meeting.
Declaration
Swift
@discardableResult public func untagMeeting(_ input: UntagMeetingRequest) -> EventLoopFuture<Void> -
Untags the specified tags from the specified Amazon Chime SDK meeting resource.
Declaration
Swift
@discardableResult public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<Void> -
Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.
Declaration
Swift
public func updateAccount(_ input: UpdateAccountRequest) -> EventLoopFuture<UpdateAccountResponse> -
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 in the Amazon Chime Administration Guide.
Declaration
Swift
public func updateAccountSettings(_ input: UpdateAccountSettingsRequest) -> EventLoopFuture<UpdateAccountSettingsResponse> -
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
Declaration
Swift
public func updateBot(_ input: UpdateBotRequest) -> EventLoopFuture<UpdateBotResponse> -
Updates global settings for the administrator’s AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
Declaration
Swift
@discardableResult public func updateGlobalSettings(_ input: UpdateGlobalSettingsRequest) -> EventLoopFuture<Void> -
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.
Declaration
Swift
public func updatePhoneNumber(_ input: UpdatePhoneNumberRequest) -> EventLoopFuture<UpdatePhoneNumberResponse> -
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.
Declaration
Swift
@discardableResult public func updatePhoneNumberSettings(_ input: UpdatePhoneNumberSettingsRequest) -> EventLoopFuture<Void> -
Updates the specified proxy session details, such as voice or SMS capabilities.
Declaration
Swift
public func updateProxySession(_ input: UpdateProxySessionRequest) -> EventLoopFuture<UpdateProxySessionResponse> -
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
Declaration
Swift
public func updateRoom(_ input: UpdateRoomRequest) -> EventLoopFuture<UpdateRoomResponse> -
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.
Declaration
Swift
public func updateRoomMembership(_ input: UpdateRoomMembershipRequest) -> EventLoopFuture<UpdateRoomMembershipResponse> -
Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.
Declaration
Swift
public func updateUser(_ input: UpdateUserRequest) -> EventLoopFuture<UpdateUserResponse> -
Updates the settings for the specified user, such as phone number settings.
Declaration
Swift
@discardableResult public func updateUserSettings(_ input: UpdateUserSettingsRequest) -> EventLoopFuture<Void> -
Updates details for the specified Amazon Chime Voice Connector.
Declaration
Swift
public func updateVoiceConnector(_ input: UpdateVoiceConnectorRequest) -> EventLoopFuture<UpdateVoiceConnectorResponse> -
Updates details for the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
Declaration
Swift
public func updateVoiceConnectorGroup(_ input: UpdateVoiceConnectorGroupRequest) -> EventLoopFuture<UpdateVoiceConnectorGroupResponse>
-
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.
Declaration
Swift
public func listAccountsPaginator(_ input: ListAccountsRequest, onPage: @escaping (ListAccountsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
Declaration
Swift
public func listAttendeesPaginator(_ input: ListAttendeesRequest, onPage: @escaping (ListAttendeesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists the bots associated with the administrator’s Amazon Chime Enterprise account ID.
Declaration
Swift
public func listBotsPaginator(_ input: ListBotsRequest, onPage: @escaping (ListBotsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
Declaration
Swift
public func listMeetingsPaginator(_ input: ListMeetingsRequest, onPage: @escaping (ListMeetingsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists the phone number orders for the administrator’s Amazon Chime account.
Declaration
Swift
public func listPhoneNumberOrdersPaginator(_ input: ListPhoneNumberOrdersRequest, onPage: @escaping (ListPhoneNumberOrdersResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
Declaration
Swift
public func listPhoneNumbersPaginator(_ input: ListPhoneNumbersRequest, onPage: @escaping (ListPhoneNumbersResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists the proxy sessions for the specified Amazon Chime Voice Connector.
Declaration
Swift
public func listProxySessionsPaginator(_ input: ListProxySessionsRequest, onPage: @escaping (ListProxySessionsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members’ IDs, email addresses, and names.
Declaration
Swift
public func listRoomMembershipsPaginator(_ input: ListRoomMembershipsRequest, onPage: @escaping (ListRoomMembershipsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
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.
Declaration
Swift
public func listRoomsPaginator(_ input: ListRoomsRequest, onPage: @escaping (ListRoomsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
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.
Declaration
Swift
public func listUsersPaginator(_ input: ListUsersRequest, onPage: @escaping (ListUsersResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists the Amazon Chime Voice Connector groups for the administrator’s AWS account.
Declaration
Swift
public func listVoiceConnectorGroupsPaginator(_ input: ListVoiceConnectorGroupsRequest, onPage: @escaping (ListVoiceConnectorGroupsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists the Amazon Chime Voice Connectors for the administrator’s AWS account.
Declaration
Swift
public func listVoiceConnectorsPaginator(_ input: ListVoiceConnectorsRequest, onPage: @escaping (ListVoiceConnectorsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct ListAccountsRequest : AWSShapeextension Chime.ListAccountsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListAttendeesRequest : AWSShapeextension Chime.ListAttendeesRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListBotsRequest : AWSShapeextension Chime.ListBotsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListMeetingsRequest : AWSShapeextension Chime.ListMeetingsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListPhoneNumberOrdersRequest : AWSShapeextension Chime.ListPhoneNumberOrdersRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListPhoneNumbersRequest : AWSShapeextension Chime.ListPhoneNumbersRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListProxySessionsRequest : AWSShapeextension Chime.ListProxySessionsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListRoomMembershipsRequest : AWSShapeextension Chime.ListRoomMembershipsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListRoomsRequest : AWSShapeextension Chime.ListRoomsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListUsersRequest : AWSShapeextension Chime.ListUsersRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListVoiceConnectorGroupsRequest : AWSShapeextension Chime.ListVoiceConnectorGroupsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListVoiceConnectorsRequest : AWSShapeextension Chime.ListVoiceConnectorsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum AccountType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum BotType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum CallingNameStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum Capability : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum EmailStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ErrorCode : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum GeoMatchLevel : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum InviteStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum License : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum MemberType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum NotificationTarget : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum NumberSelectionBehavior : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum OrderedPhoneNumberStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum OriginationRouteProtocol : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum PhoneNumberAssociationName : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum PhoneNumberOrderStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum PhoneNumberProductType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum PhoneNumberStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum PhoneNumberType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ProxySessionStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum RegistrationStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum RoomMembershipRole : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum UserType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum VoiceConnectorAwsRegion : String, CustomStringConvertible, Codable