Amazon Chime 2018-05-01
- Client: Aws\Chime\ChimeClient
- Service ID: chime
- Version: 2018-05-01
This page describes the parameters and results for the operations of the Amazon Chime (2018-05-01), and shows how to use the Aws\Chime\ChimeClient object to call the described operations. This documentation is specific to the 2018-05-01 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- AssociatePhoneNumberWithUser ( array $params = [] )
- Associates a phone number with the specified Amazon Chime user.
- AssociatePhoneNumbersWithVoiceConnector ( array $params = [] )
- Associates phone numbers with the specified Amazon Chime Voice Connector.
- AssociatePhoneNumbersWithVoiceConnectorGroup ( array $params = [] )
- Associates phone numbers with the specified Amazon Chime Voice Connector group.
- AssociateSigninDelegateGroupsWithAccount ( array $params = [] )
- Associates the specified sign-in delegate groups with the specified Amazon Chime account.
- BatchCreateAttendee ( array $params = [] )
- Creates up to 100 new attendees for an active Amazon Chime SDK meeting.
- BatchCreateChannelMembership ( array $params = [] )
- Adds a specified number of users to a channel.
- BatchCreateRoomMembership ( array $params = [] )
- Adds up to 50 members to a chat room in an Amazon Chime Enterprise account.
- BatchDeletePhoneNumber ( array $params = [] )
- Moves phone numbers into the Deletion queue.
- BatchSuspendUser ( array $params = [] )
- Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account.
- BatchUnsuspendUser ( array $params = [] )
- Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account.
- BatchUpdatePhoneNumber ( array $params = [] )
- Updates phone number product types or calling names.
- BatchUpdateUser ( array $params = [] )
- Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account.
- CreateAccount ( array $params = [] )
- Creates an Amazon Chime account under the administrator's AWS account.
- CreateAppInstance ( array $params = [] )
- Creates an Amazon Chime SDK messaging AppInstance under an AWS account.
- CreateAppInstanceAdmin ( array $params = [] )
- Promotes an AppInstanceUser to an AppInstanceAdmin.
- CreateAppInstanceUser ( array $params = [] )
- Creates a user under an Amazon Chime AppInstance.
- CreateAttendee ( array $params = [] )
- Creates a new attendee for an active Amazon Chime SDK meeting.
- CreateBot ( array $params = [] )
- Creates a bot for an Amazon Chime Enterprise account.
- CreateChannel ( array $params = [] )
- Creates a channel to which you can add users and send messages.
- CreateChannelBan ( array $params = [] )
- Permanently bans a member from a channel.
- CreateChannelMembership ( array $params = [] )
- Adds a user to a channel.
- CreateChannelModerator ( array $params = [] )
- Creates a new ChannelModerator.
- CreateMediaCapturePipeline ( array $params = [] )
- Creates a media capture pipeline.
- CreateMeeting ( array $params = [] )
- Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.
- CreateMeetingDialOut ( array $params = [] )
- 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.
- CreateMeetingWithAttendees ( array $params = [] )
- Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.
- CreatePhoneNumberOrder ( array $params = [] )
- Creates an order for phone numbers to be provisioned.
- CreateProxySession ( array $params = [] )
- Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
- CreateRoom ( array $params = [] )
- Creates a chat room for the specified Amazon Chime Enterprise account.
- CreateRoomMembership ( array $params = [] )
- Adds a member to a chat room in an Amazon Chime Enterprise account.
- CreateSipMediaApplication ( array $params = [] )
- Creates a SIP media application.
- CreateSipMediaApplicationCall ( array $params = [] )
- Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.
- CreateSipRule ( array $params = [] )
- Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.
- CreateUser ( array $params = [] )
- Creates a user under the specified Amazon Chime account.
- CreateVoiceConnector ( array $params = [] )
- Creates an Amazon Chime Voice Connector under the administrator's AWS account.
- CreateVoiceConnectorGroup ( array $params = [] )
- Creates an Amazon Chime Voice Connector group under the administrator's AWS account.
- DeleteAccount ( array $params = [] )
- Deletes the specified Amazon Chime account.
- DeleteAppInstance ( array $params = [] )
- Deletes an AppInstance and all associated data asynchronously.
- DeleteAppInstanceAdmin ( array $params = [] )
- Demotes an AppInstanceAdmin to an AppInstanceUser.
- DeleteAppInstanceStreamingConfigurations ( array $params = [] )
- Deletes the streaming configurations of an AppInstance.
- DeleteAppInstanceUser ( array $params = [] )
- Deletes an AppInstanceUser.
- DeleteAttendee ( array $params = [] )
- Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken.
- DeleteChannel ( array $params = [] )
- Immediately makes a channel and its memberships inaccessible and marks them for deletion.
- DeleteChannelBan ( array $params = [] )
- Removes a user from a channel's ban list.
- DeleteChannelMembership ( array $params = [] )
- Removes a member from a channel.
- DeleteChannelMessage ( array $params = [] )
- Deletes a channel message.
- DeleteChannelModerator ( array $params = [] )
- Deletes a channel moderator.
- DeleteEventsConfiguration ( array $params = [] )
- Deletes the events configuration that allows a bot to receive outgoing events.
- DeleteMediaCapturePipeline ( array $params = [] )
- Deletes the media capture pipeline.
- DeleteMeeting ( array $params = [] )
- Deletes the specified Amazon Chime SDK meeting.
- DeletePhoneNumber ( array $params = [] )
- Moves the specified phone number into the Deletion queue.
- DeleteProxySession ( array $params = [] )
- Deletes the specified proxy session from the specified Amazon Chime Voice Connector.
- DeleteRoom ( array $params = [] )
- Deletes a chat room in an Amazon Chime Enterprise account.
- DeleteRoomMembership ( array $params = [] )
- Removes a member from a chat room in an Amazon Chime Enterprise account.
- DeleteSipMediaApplication ( array $params = [] )
- Deletes a SIP media application.
- DeleteSipRule ( array $params = [] )
- Deletes a SIP rule.
- DeleteVoiceConnector ( array $params = [] )
- Deletes the specified Amazon Chime Voice Connector.
- DeleteVoiceConnectorEmergencyCallingConfiguration ( array $params = [] )
- Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.
- DeleteVoiceConnectorGroup ( array $params = [] )
- Deletes the specified Amazon Chime Voice Connector group.
- DeleteVoiceConnectorOrigination ( array $params = [] )
- Deletes the origination settings for the specified Amazon Chime Voice Connector.
- DeleteVoiceConnectorProxy ( array $params = [] )
- Deletes the proxy configuration from the specified Amazon Chime Voice Connector.
- DeleteVoiceConnectorStreamingConfiguration ( array $params = [] )
- Deletes the streaming configuration for the specified Amazon Chime Voice Connector.
- DeleteVoiceConnectorTermination ( array $params = [] )
- Deletes the termination settings for the specified Amazon Chime Voice Connector.
- DeleteVoiceConnectorTerminationCredentials ( array $params = [] )
- Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
- DescribeAppInstance ( array $params = [] )
- Returns the full details of an AppInstance.
- DescribeAppInstanceAdmin ( array $params = [] )
- Returns the full details of an AppInstanceAdmin.
- DescribeAppInstanceUser ( array $params = [] )
- Returns the full details of an AppInstanceUser.
- DescribeChannel ( array $params = [] )
- Returns the full details of a channel in an Amazon Chime AppInstance.
- DescribeChannelBan ( array $params = [] )
- Returns the full details of a channel ban.
- DescribeChannelMembership ( array $params = [] )
- Returns the full details of a user's channel membership.
- DescribeChannelMembershipForAppInstanceUser ( array $params = [] )
- Returns the details of a channel based on the membership of the specified AppInstanceUser.
- DescribeChannelModeratedByAppInstanceUser ( array $params = [] )
- Returns the full details of a channel moderated by the specified AppInstanceUser.
- DescribeChannelModerator ( array $params = [] )
- Returns the full details of a single ChannelModerator.
- DisassociatePhoneNumberFromUser ( array $params = [] )
- Disassociates the primary provisioned phone number from the specified Amazon Chime user.
- DisassociatePhoneNumbersFromVoiceConnector ( array $params = [] )
- Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
- DisassociatePhoneNumbersFromVoiceConnectorGroup ( array $params = [] )
- Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
- DisassociateSigninDelegateGroupsFromAccount ( array $params = [] )
- Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
- GetAccount ( array $params = [] )
- Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
- GetAccountSettings ( array $params = [] )
- Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings.
- GetAppInstanceRetentionSettings ( array $params = [] )
- Gets the retention settings for an AppInstance.
- GetAppInstanceStreamingConfigurations ( array $params = [] )
- Gets the streaming settings for an AppInstance.
- GetAttendee ( array $params = [] )
- Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.
- GetBot ( array $params = [] )
- Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
- GetChannelMessage ( array $params = [] )
- Gets the full details of a channel message.
- GetEventsConfiguration ( array $params = [] )
- Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
- GetGlobalSettings ( array $params = [] )
- Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
- GetMediaCapturePipeline ( array $params = [] )
- Gets an existing media capture pipeline.
- GetMeeting ( array $params = [] )
- This API is is no longer supported and will not be updated.
- GetMessagingSessionEndpoint ( array $params = [] )
- The details of the endpoint for the messaging session.
- GetPhoneNumber ( array $params = [] )
- Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
- GetPhoneNumberOrder ( array $params = [] )
- Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.
- GetPhoneNumberSettings ( array $params = [] )
- Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
- GetProxySession ( array $params = [] )
- Gets the specified proxy session details for the specified Amazon Chime Voice Connector.
- GetRetentionSettings ( array $params = [] )
- Gets the retention settings for the specified Amazon Chime Enterprise account.
- GetRoom ( array $params = [] )
- Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
- GetSipMediaApplication ( array $params = [] )
- Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
- GetSipMediaApplicationLoggingConfiguration ( array $params = [] )
- Returns the logging configuration for the specified SIP media application.
- GetSipRule ( array $params = [] )
- Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
- GetUser ( array $params = [] )
- Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.
- GetUserSettings ( array $params = [] )
- Retrieves settings for the specified user ID, such as any associated phone number settings.
- GetVoiceConnector ( array $params = [] )
- Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
- GetVoiceConnectorEmergencyCallingConfiguration ( array $params = [] )
- Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.
- GetVoiceConnectorGroup ( array $params = [] )
- Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.
- GetVoiceConnectorLoggingConfiguration ( array $params = [] )
- Retrieves the logging configuration details for the specified Amazon Chime Voice Connector.
- GetVoiceConnectorOrigination ( array $params = [] )
- Retrieves origination setting details for the specified Amazon Chime Voice Connector.
- GetVoiceConnectorProxy ( array $params = [] )
- Gets the proxy configuration details for the specified Amazon Chime Voice Connector.
- GetVoiceConnectorStreamingConfiguration ( array $params = [] )
- Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector.
- GetVoiceConnectorTermination ( array $params = [] )
- Retrieves termination setting details for the specified Amazon Chime Voice Connector.
- GetVoiceConnectorTerminationHealth ( array $params = [] )
- This API is is no longer supported and will not be updated.
- InviteUsers ( array $params = [] )
- Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account.
- ListAccounts ( array $params = [] )
- Lists the Amazon Chime accounts under the administrator's AWS account.
- ListAppInstanceAdmins ( array $params = [] )
- Returns a list of the administrators in the AppInstance.
- ListAppInstanceUsers ( array $params = [] )
- List all AppInstanceUsers created under a single AppInstance.
- ListAppInstances ( array $params = [] )
- Lists all Amazon Chime AppInstances created under a single AWS account.
- ListAttendeeTags ( array $params = [] )
- Lists the tags applied to an Amazon Chime SDK attendee resource.
- ListAttendees ( array $params = [] )
- Lists the attendees for the specified Amazon Chime SDK meeting.
- ListBots ( array $params = [] )
- Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
- ListChannelBans ( array $params = [] )
- Lists all the users banned from a particular channel.
- ListChannelMemberships ( array $params = [] )
- Lists all channel memberships in a channel.
- ListChannelMembershipsForAppInstanceUser ( array $params = [] )
- Lists all channels that a particular AppInstanceUser is a part of.
- ListChannelMessages ( array $params = [] )
- List all the messages in a channel.
- ListChannelModerators ( array $params = [] )
- Lists all the moderators for a channel.
- ListChannels ( array $params = [] )
- Lists all Channels created under a single Chime App as a paginated list.
- ListChannelsModeratedByAppInstanceUser ( array $params = [] )
- A list of the channels moderated by an AppInstanceUser.
- ListMediaCapturePipelines ( array $params = [] )
- Returns a list of media capture pipelines.
- ListMeetingTags ( array $params = [] )
- Lists the tags applied to an Amazon Chime SDK meeting resource.
- ListMeetings ( array $params = [] )
- Lists up to 100 active Amazon Chime SDK meetings.
- ListPhoneNumberOrders ( array $params = [] )
- Lists the phone number orders for the administrator's Amazon Chime account.
- ListPhoneNumbers ( array $params = [] )
- Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
- ListProxySessions ( array $params = [] )
- Lists the proxy sessions for the specified Amazon Chime Voice Connector.
- ListRoomMemberships ( array $params = [] )
- Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
- ListRooms ( array $params = [] )
- Lists the room details for the specified Amazon Chime Enterprise account.
- ListSipMediaApplications ( array $params = [] )
- Lists the SIP media applications under the administrator's AWS account.
- ListSipRules ( array $params = [] )
- Lists the SIP rules under the administrator's AWS account.
- ListSupportedPhoneNumberCountries ( array $params = [] )
- Lists supported phone number countries.
- ListTagsForResource ( array $params = [] )
- Lists the tags applied to an Amazon Chime SDK meeting and messaging resources.
- ListUsers ( array $params = [] )
- Lists the users that belong to the specified Amazon Chime account.
- ListVoiceConnectorGroups ( array $params = [] )
- Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.
- ListVoiceConnectorTerminationCredentials ( array $params = [] )
- Lists the SIP credentials for the specified Amazon Chime Voice Connector.
- ListVoiceConnectors ( array $params = [] )
- Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
- LogoutUser ( array $params = [] )
- Logs out the specified user from all of the devices they are currently logged into.
- PutAppInstanceRetentionSettings ( array $params = [] )
- Sets the amount of time in days that a given AppInstance retains data.
- PutAppInstanceStreamingConfigurations ( array $params = [] )
- The data streaming configurations of an AppInstance.
- PutEventsConfiguration ( array $params = [] )
- Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime.
- PutRetentionSettings ( array $params = [] )
- Puts retention settings for the specified Amazon Chime Enterprise account.
- PutSipMediaApplicationLoggingConfiguration ( array $params = [] )
- Updates the logging configuration for the specified SIP media application.
- PutVoiceConnectorEmergencyCallingConfiguration ( array $params = [] )
- Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries.
- PutVoiceConnectorLoggingConfiguration ( array $params = [] )
- Adds a logging configuration for the specified Amazon Chime Voice Connector.
- PutVoiceConnectorOrigination ( array $params = [] )
- Adds origination settings for the specified Amazon Chime Voice Connector.
- PutVoiceConnectorProxy ( array $params = [] )
- Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.
- PutVoiceConnectorStreamingConfiguration ( array $params = [] )
- Adds a streaming configuration for the specified Amazon Chime Voice Connector.
- PutVoiceConnectorTermination ( array $params = [] )
- Adds termination settings for the specified Amazon Chime Voice Connector.
- PutVoiceConnectorTerminationCredentials ( array $params = [] )
- Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
- RedactChannelMessage ( array $params = [] )
- Redacts message content, but not metadata.
- RedactConversationMessage ( array $params = [] )
- Redacts the specified message from the specified Amazon Chime conversation.
- RedactRoomMessage ( array $params = [] )
- Redacts the specified message from the specified Amazon Chime channel.
- RegenerateSecurityToken ( array $params = [] )
- Regenerates the security token for a bot.
- ResetPersonalPIN ( array $params = [] )
- Resets the personal meeting PIN for the specified user on an Amazon Chime account.
- RestorePhoneNumber ( array $params = [] )
- Moves a phone number from the Deletion queue back into the phone number Inventory.
- SearchAvailablePhoneNumbers ( array $params = [] )
- Searches for phone numbers that can be ordered.
- SendChannelMessage ( array $params = [] )
- Sends a message to a particular channel that the member is a part of.
- StartMeetingTranscription ( array $params = [] )
- Starts transcription for the specified meetingId.
- StopMeetingTranscription ( array $params = [] )
- Stops transcription for the specified meetingId.
- TagAttendee ( array $params = [] )
- Applies the specified tags to the specified Amazon Chime attendee.
- TagMeeting ( array $params = [] )
- Applies the specified tags to the specified Amazon Chime SDK meeting.
- TagResource ( array $params = [] )
- Applies the specified tags to the specified Amazon Chime SDK meeting resource.
- UntagAttendee ( array $params = [] )
- Untags the specified tags from the specified Amazon Chime SDK attendee.
- UntagMeeting ( array $params = [] )
- Untags the specified tags from the specified Amazon Chime SDK meeting.
- UntagResource ( array $params = [] )
- Untags the specified tags from the specified Amazon Chime SDK meeting resource.
- UpdateAccount ( array $params = [] )
- Updates account details for the specified Amazon Chime account.
- UpdateAccountSettings ( array $params = [] )
- Updates the settings for the specified Amazon Chime account.
- UpdateAppInstance ( array $params = [] )
- Updates AppInstance metadata.
- UpdateAppInstanceUser ( array $params = [] )
- Updates the details of an AppInstanceUser.
- UpdateBot ( array $params = [] )
- Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
- UpdateChannel ( array $params = [] )
- Update a channel's attributes.
- UpdateChannelMessage ( array $params = [] )
- Updates the content of a message.
- UpdateChannelReadMarker ( array $params = [] )
- The details of the time when a user last read messages in a channel.
- UpdateGlobalSettings ( array $params = [] )
- Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
- UpdatePhoneNumber ( array $params = [] )
- Updates phone number details, such as product type or calling name, for the specified phone number ID.
- UpdatePhoneNumberSettings ( array $params = [] )
- Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.
- UpdateProxySession ( array $params = [] )
- Updates the specified proxy session details, such as voice or SMS capabilities.
- UpdateRoom ( array $params = [] )
- Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
- UpdateRoomMembership ( array $params = [] )
- Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account.
- UpdateSipMediaApplication ( array $params = [] )
- Updates the details of the specified SIP media application.
- UpdateSipMediaApplicationCall ( array $params = [] )
- Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request.
- UpdateSipRule ( array $params = [] )
- Updates the details of the specified SIP rule.
- UpdateUser ( array $params = [] )
- Updates user details for a specified user ID.
- UpdateUserSettings ( array $params = [] )
- Updates the settings for the specified user, such as phone number settings.
- UpdateVoiceConnector ( array $params = [] )
- Updates details for the specified Amazon Chime Voice Connector.
- UpdateVoiceConnectorGroup ( array $params = [] )
- Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
- ValidateE911Address ( array $params = [] )
- Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- ListAccounts
- ListAppInstanceAdmins
- ListAppInstanceUsers
- ListAppInstances
- ListAttendees
- ListBots
- ListChannelBans
- ListChannelMemberships
- ListChannelMembershipsForAppInstanceUser
- ListChannelMessages
- ListChannelModerators
- ListChannels
- ListChannelsModeratedByAppInstanceUser
- ListMediaCapturePipelines
- ListMeetings
- ListPhoneNumberOrders
- ListPhoneNumbers
- ListProxySessions
- ListRoomMemberships
- ListRooms
- ListSipMediaApplications
- ListSipRules
- ListUsers
- ListVoiceConnectorGroups
- ListVoiceConnectors
- SearchAvailablePhoneNumbers
Operations
AssociatePhoneNumberWithUser
$result = $client->associatePhoneNumberWithUser
([/* ... */]); $promise = $client->associatePhoneNumberWithUserAsync
([/* ... */]);
Associates a phone number with the specified Amazon Chime user.
Parameter Syntax
$result = $client->associatePhoneNumberWithUser([ 'AccountId' => '<string>', // REQUIRED 'E164PhoneNumber' => '<string>', // REQUIRED 'UserId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- E164PhoneNumber
-
- Required: Yes
- Type: string
The phone number, in E.164 format.
- UserId
-
- Required: Yes
- Type: string
The user ID.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- AccessDeniedException:
You don't have permissions to perform the requested operation.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
AssociatePhoneNumbersWithVoiceConnector
$result = $client->associatePhoneNumbersWithVoiceConnector
([/* ... */]); $promise = $client->associatePhoneNumbersWithVoiceConnectorAsync
([/* ... */]);
Associates phone numbers with the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, AssociatePhoneNumbersWithVoiceConnector, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->associatePhoneNumbersWithVoiceConnector([ 'E164PhoneNumbers' => ['<string>', ...], // REQUIRED 'ForceAssociate' => true || false, 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- E164PhoneNumbers
-
- Required: Yes
- Type: Array of strings
List of phone numbers, in E.164 format.
- ForceAssociate
-
- Type: boolean
If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[ 'PhoneNumberErrors' => [ [ 'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist', 'ErrorMessage' => '<string>', 'PhoneNumberId' => '<string>', ], // ... ], ]
Result Details
Members
- PhoneNumberErrors
-
- Type: Array of PhoneNumberError structures
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.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- AccessDeniedException:
You don't have permissions to perform the requested operation.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
AssociatePhoneNumbersWithVoiceConnectorGroup
$result = $client->associatePhoneNumbersWithVoiceConnectorGroup
([/* ... */]); $promise = $client->associatePhoneNumbersWithVoiceConnectorGroupAsync
([/* ... */]);
Associates phone numbers with the specified Amazon Chime Voice Connector group.
This API is is no longer supported and will not be updated. We recommend using the latest version, AssociatePhoneNumbersWithVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->associatePhoneNumbersWithVoiceConnectorGroup([ 'E164PhoneNumbers' => ['<string>', ...], // REQUIRED 'ForceAssociate' => true || false, 'VoiceConnectorGroupId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- E164PhoneNumbers
-
- Required: Yes
- Type: Array of strings
List of phone numbers, in E.164 format.
- ForceAssociate
-
- Type: boolean
If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.
- VoiceConnectorGroupId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector group ID.
Result Syntax
[ 'PhoneNumberErrors' => [ [ 'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist', 'ErrorMessage' => '<string>', 'PhoneNumberId' => '<string>', ], // ... ], ]
Result Details
Members
- PhoneNumberErrors
-
- Type: Array of PhoneNumberError structures
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.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- AccessDeniedException:
You don't have permissions to perform the requested operation.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
AssociateSigninDelegateGroupsWithAccount
$result = $client->associateSigninDelegateGroupsWithAccount
([/* ... */]); $promise = $client->associateSigninDelegateGroupsWithAccountAsync
([/* ... */]);
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
Parameter Syntax
$result = $client->associateSigninDelegateGroupsWithAccount([ 'AccountId' => '<string>', // REQUIRED 'SigninDelegateGroups' => [ // REQUIRED [ 'GroupName' => '<string>', ], // ... ], ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- SigninDelegateGroups
-
- Required: Yes
- Type: Array of SigninDelegateGroup structures
The sign-in delegate groups.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
BatchCreateAttendee
$result = $client->batchCreateAttendee
([/* ... */]); $promise = $client->batchCreateAttendeeAsync
([/* ... */]);
Creates up to 100 new attendees for an active Amazon Chime SDK meeting.
This API is is no longer supported and will not be updated. We recommend using the latest version, BatchCreateAttendee, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->batchCreateAttendee([ 'Attendees' => [ // REQUIRED [ 'ExternalUserId' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], // ... ], 'MeetingId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Attendees
-
- Required: Yes
- Type: Array of CreateAttendeeRequestItem structures
The request containing the attendees to create.
- MeetingId
-
- Required: Yes
- Type: string
The Amazon Chime SDK meeting ID.
Result Syntax
[ 'Attendees' => [ [ 'AttendeeId' => '<string>', 'ExternalUserId' => '<string>', 'JoinToken' => '<string>', ], // ... ], 'Errors' => [ [ 'ErrorCode' => '<string>', 'ErrorMessage' => '<string>', 'ExternalUserId' => '<string>', ], // ... ], ]
Result Details
Members
- Attendees
-
- Type: Array of Attendee structures
The attendee information, including attendees IDs and join tokens.
- Errors
-
- Type: Array of CreateAttendeeError structures
If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
BatchCreateChannelMembership
$result = $client->batchCreateChannelMembership
([/* ... */]); $promise = $client->batchCreateChannelMembershipAsync
([/* ... */]);
Adds a specified number of users to a channel.
This API is is no longer supported and will not be updated. We recommend using the latest version, BatchCreateChannelMembership, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->batchCreateChannelMembership([ 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', 'MemberArns' => ['<string>', ...], // REQUIRED 'Type' => 'DEFAULT|HIDDEN', ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the channel to which you're adding users.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call. - MemberArns
-
- Required: Yes
- Type: Array of strings
The ARNs of the members you want to add to the channel.
- Type
-
- Type: string
The membership type of a user,
DEFAULT
orHIDDEN
. Default members are always returned as part ofListChannelMemberships
. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
. Otherwise hidden members are not returned. This is only supported by moderators.
Result Syntax
[ 'BatchChannelMemberships' => [ 'ChannelArn' => '<string>', 'InvitedBy' => [ 'Arn' => '<string>', 'Name' => '<string>', ], 'Members' => [ [ 'Arn' => '<string>', 'Name' => '<string>', ], // ... ], 'Type' => 'DEFAULT|HIDDEN', ], 'Errors' => [ [ 'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist', 'ErrorMessage' => '<string>', 'MemberArn' => '<string>', ], // ... ], ]
Result Details
Members
- BatchChannelMemberships
-
- Type: BatchChannelMemberships structure
The list of channel memberships in the response.
- Errors
-
- Type: Array of BatchCreateChannelMembershipError structures
If the action fails for one or more of the memberships in the request, a list of the memberships is returned, along with error codes and error messages.
Errors
- ServiceFailureException:
The service encountered an unexpected error.
- ServiceUnavailableException:
The service is currently unavailable.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
BatchCreateRoomMembership
$result = $client->batchCreateRoomMembership
([/* ... */]); $promise = $client->batchCreateRoomMembershipAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->batchCreateRoomMembership([ 'AccountId' => '<string>', // REQUIRED 'MembershipItemList' => [ // REQUIRED [ 'MemberId' => '<string>', 'Role' => 'Administrator|Member', ], // ... ], 'RoomId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- MembershipItemList
-
- Required: Yes
- Type: Array of MembershipItem structures
The list of membership items.
- RoomId
-
- Required: Yes
- Type: string
The room ID.
Result Syntax
[ 'Errors' => [ [ 'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist', 'ErrorMessage' => '<string>', 'MemberId' => '<string>', ], // ... ], ]
Result Details
Members
- Errors
-
- Type: Array of MemberError structures
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
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
BatchDeletePhoneNumber
$result = $client->batchDeletePhoneNumber
([/* ... */]); $promise = $client->batchDeletePhoneNumberAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->batchDeletePhoneNumber([ 'PhoneNumberIds' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- PhoneNumberIds
-
- Required: Yes
- Type: Array of strings
List of phone number IDs.
Result Syntax
[ 'PhoneNumberErrors' => [ [ 'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist', 'ErrorMessage' => '<string>', 'PhoneNumberId' => '<string>', ], // ... ], ]
Result Details
Members
- PhoneNumberErrors
-
- Type: Array of PhoneNumberError structures
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.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
BatchSuspendUser
$result = $client->batchSuspendUser
([/* ... */]); $promise = $client->batchSuspendUserAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->batchSuspendUser([ 'AccountId' => '<string>', // REQUIRED 'UserIdList' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- UserIdList
-
- Required: Yes
- Type: Array of strings
The request containing the user IDs to suspend.
Result Syntax
[ 'UserErrors' => [ [ 'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist', 'ErrorMessage' => '<string>', 'UserId' => '<string>', ], // ... ], ]
Result Details
Members
- UserErrors
-
- Type: Array of UserError structures
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.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
BatchUnsuspendUser
$result = $client->batchUnsuspendUser
([/* ... */]); $promise = $client->batchUnsuspendUserAsync
([/* ... */]);
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 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.
Parameter Syntax
$result = $client->batchUnsuspendUser([ 'AccountId' => '<string>', // REQUIRED 'UserIdList' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- UserIdList
-
- Required: Yes
- Type: Array of strings
The request containing the user IDs to unsuspend.
Result Syntax
[ 'UserErrors' => [ [ 'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist', 'ErrorMessage' => '<string>', 'UserId' => '<string>', ], // ... ], ]
Result Details
Members
- UserErrors
-
- Type: Array of UserError structures
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.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
BatchUpdatePhoneNumber
$result = $client->batchUpdatePhoneNumber
([/* ... */]); $promise = $client->batchUpdatePhoneNumberAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->batchUpdatePhoneNumber([ 'UpdatePhoneNumberRequestItems' => [ // REQUIRED [ 'CallingName' => '<string>', 'PhoneNumberId' => '<string>', // REQUIRED 'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn', ], // ... ], ]);
Parameter Details
Members
- UpdatePhoneNumberRequestItems
-
- Required: Yes
- Type: Array of UpdatePhoneNumberRequestItem structures
The request containing the phone number IDs and product types or calling names to update.
Result Syntax
[ 'PhoneNumberErrors' => [ [ 'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist', 'ErrorMessage' => '<string>', 'PhoneNumberId' => '<string>', ], // ... ], ]
Result Details
Members
- PhoneNumberErrors
-
- Type: Array of PhoneNumberError structures
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.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
BatchUpdateUser
$result = $client->batchUpdateUser
([/* ... */]); $promise = $client->batchUpdateUserAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->batchUpdateUser([ 'AccountId' => '<string>', // REQUIRED 'UpdateUserRequestItems' => [ // REQUIRED [ 'AlexaForBusinessMetadata' => [ 'AlexaForBusinessRoomArn' => '<string>', 'IsAlexaForBusinessEnabled' => true || false, ], 'LicenseType' => 'Basic|Plus|Pro|ProTrial', 'UserId' => '<string>', // REQUIRED 'UserType' => 'PrivateUser|SharedDevice', ], // ... ], ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- UpdateUserRequestItems
-
- Required: Yes
- Type: Array of UpdateUserRequestItem structures
The request containing the user IDs and details to update.
Result Syntax
[ 'UserErrors' => [ [ 'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist', 'ErrorMessage' => '<string>', 'UserId' => '<string>', ], // ... ], ]
Result Details
Members
- UserErrors
-
- Type: Array of UserError structures
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.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateAccount
$result = $client->createAccount
([/* ... */]); $promise = $client->createAccountAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createAccount([ 'Name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Name
-
- Required: Yes
- Type: string
The name of the Amazon Chime account.
Result Syntax
[ 'Account' => [ 'AccountId' => '<string>', 'AccountStatus' => 'Suspended|Active', 'AccountType' => 'Team|EnterpriseDirectory|EnterpriseLWA|EnterpriseOIDC', 'AwsAccountId' => '<string>', 'CreatedTimestamp' => <DateTime>, 'DefaultLicense' => 'Basic|Plus|Pro|ProTrial', 'Name' => '<string>', 'SigninDelegateGroups' => [ [ 'GroupName' => '<string>', ], // ... ], 'SupportedLicenses' => ['<string>', ...], ], ]
Result Details
Members
- Account
-
- Type: Account structure
The Amazon Chime account details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateAppInstance
$result = $client->createAppInstance
([/* ... */]); $promise = $client->createAppInstanceAsync
([/* ... */]);
Creates an Amazon Chime SDK messaging AppInstance
under an AWS account. Only SDK messaging customers use this API. CreateAppInstance
supports idempotency behavior as described in the AWS API Standard.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstance, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->createAppInstance([ 'ClientRequestToken' => '<string>', // REQUIRED 'Metadata' => '<string>', 'Name' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- ClientRequestToken
-
- Required: Yes
- Type: string
The
ClientRequestToken
of theAppInstance
. - Metadata
-
- Type: string
The metadata of the
AppInstance
. Limited to a 1KB string in UTF-8. - Name
-
- Required: Yes
- Type: string
The name of the
AppInstance
. - Tags
-
- Type: Array of Tag structures
Tags assigned to the
AppInstance
.
Result Syntax
[ 'AppInstanceArn' => '<string>', ]
Result Details
Members
- AppInstanceArn
-
- Type: string
The Amazon Resource Number (ARN) of the
AppInstance
.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateAppInstanceAdmin
$result = $client->createAppInstanceAdmin
([/* ... */]); $promise = $client->createAppInstanceAdminAsync
([/* ... */]);
Promotes an AppInstanceUser
to an AppInstanceAdmin
. The promoted user can perform the following actions.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstanceAdmin, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
-
ChannelModerator
actions across all channels in theAppInstance
. -
DeleteChannelMessage
actions.
Only an AppInstanceUser
can be promoted to an AppInstanceAdmin
role.
Parameter Syntax
$result = $client->createAppInstanceAdmin([ 'AppInstanceAdminArn' => '<string>', // REQUIRED 'AppInstanceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AppInstanceAdminArn
-
- Required: Yes
- Type: string
The ARN of the administrator of the current
AppInstance
. - AppInstanceArn
-
- Required: Yes
- Type: string
The ARN of the
AppInstance
.
Result Syntax
[ 'AppInstanceAdmin' => [ 'Arn' => '<string>', 'Name' => '<string>', ], 'AppInstanceArn' => '<string>', ]
Result Details
Members
- AppInstanceAdmin
-
- Type: Identity structure
The name and ARN of the admin for the
AppInstance
. - AppInstanceArn
-
- Type: string
The ARN of the of the admin for the
AppInstance
.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateAppInstanceUser
$result = $client->createAppInstanceUser
([/* ... */]); $promise = $client->createAppInstanceUserAsync
([/* ... */]);
Creates a user under an Amazon Chime AppInstance
. The request consists of a unique appInstanceUserId
and Name
for that user.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->createAppInstanceUser([ 'AppInstanceArn' => '<string>', // REQUIRED 'AppInstanceUserId' => '<string>', // REQUIRED 'ClientRequestToken' => '<string>', // REQUIRED 'Metadata' => '<string>', 'Name' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- AppInstanceArn
-
- Required: Yes
- Type: string
The ARN of the
AppInstance
request. - AppInstanceUserId
-
- Required: Yes
- Type: string
The user ID of the
AppInstance
. - ClientRequestToken
-
- Required: Yes
- Type: string
The token assigned to the user requesting an
AppInstance
. - Metadata
-
- Type: string
The request's metadata. Limited to a 1KB string in UTF-8.
- Name
-
- Required: Yes
- Type: string
The user's name.
- Tags
-
- Type: Array of Tag structures
Tags assigned to the
AppInstanceUser
.
Result Syntax
[ 'AppInstanceUserArn' => '<string>', ]
Result Details
Members
- AppInstanceUserArn
-
- Type: string
The user's ARN.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateAttendee
$result = $client->createAttendee
([/* ... */]); $promise = $client->createAttendeeAsync
([/* ... */]);
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 SDK Developer Guide.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAttendee, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->createAttendee([ 'ExternalUserId' => '<string>', // REQUIRED 'MeetingId' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- ExternalUserId
-
- Required: Yes
- Type: string
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
- MeetingId
-
- Required: Yes
- Type: string
The Amazon Chime SDK meeting ID.
- Tags
-
- Type: Array of Tag structures
The tag key-value pairs.
Result Syntax
[ 'Attendee' => [ 'AttendeeId' => '<string>', 'ExternalUserId' => '<string>', 'JoinToken' => '<string>', ], ]
Result Details
Members
- Attendee
-
- Type: Attendee structure
The attendee information, including attendee ID and join token.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateBot
$result = $client->createBot
([/* ... */]); $promise = $client->createBotAsync
([/* ... */]);
Creates a bot for an Amazon Chime Enterprise account.
Parameter Syntax
$result = $client->createBot([ 'AccountId' => '<string>', // REQUIRED 'DisplayName' => '<string>', // REQUIRED 'Domain' => '<string>', ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- DisplayName
-
- Required: Yes
- Type: string
The bot display name.
- Domain
-
- Type: string
The domain of the Amazon Chime Enterprise account.
Result Syntax
[ 'Bot' => [ 'BotEmail' => '<string>', 'BotId' => '<string>', 'BotType' => 'ChatBot', 'CreatedTimestamp' => <DateTime>, 'Disabled' => true || false, 'DisplayName' => '<string>', 'SecurityToken' => '<string>', 'UpdatedTimestamp' => <DateTime>, 'UserId' => '<string>', ], ]
Result Details
Members
- Bot
-
- Type: Bot structure
The bot details.
Errors
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ThrottledClientException:
The client exceeded its request rate limit.
CreateChannel
$result = $client->createChannel
([/* ... */]); $promise = $client->createChannelAsync
([/* ... */]);
Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannel, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->createChannel([ 'AppInstanceArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', 'ClientRequestToken' => '<string>', // REQUIRED 'Metadata' => '<string>', 'Mode' => 'UNRESTRICTED|RESTRICTED', 'Name' => '<string>', // REQUIRED 'Privacy' => 'PUBLIC|PRIVATE', 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- AppInstanceArn
-
- Required: Yes
- Type: string
The ARN of the channel request.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call. - ClientRequestToken
-
- Required: Yes
- Type: string
The client token for the request. An
Idempotency
token. - Metadata
-
- Type: string
The metadata of the creation request. Limited to 1KB and UTF-8.
- Mode
-
- Type: string
The channel mode:
UNRESTRICTED
orRESTRICTED
. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels. - Name
-
- Required: Yes
- Type: string
The name of the channel.
- Privacy
-
- Type: string
The channel's privacy level:
PUBLIC
orPRIVATE
. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in theAppInstance
. - Tags
-
- Type: Array of Tag structures
The tags for the creation request.
Result Syntax
[ 'ChannelArn' => '<string>', ]
Result Details
Members
- ChannelArn
-
- Type: string
The ARN of the channel.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateChannelBan
$result = $client->createChannelBan
([/* ... */]); $promise = $client->createChannelBanAsync
([/* ... */]);
Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan
, and then CreateChannelMembership
. Bans are cleaned up when you delete users or channels.
If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelBan, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->createChannelBan([ 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', 'MemberArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the ban request.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call. - MemberArn
-
- Required: Yes
- Type: string
The ARN of the member being banned.
Result Syntax
[ 'ChannelArn' => '<string>', 'Member' => [ 'Arn' => '<string>', 'Name' => '<string>', ], ]
Result Details
Members
- ChannelArn
-
- Type: string
The ARN of the response to the ban request.
- Member
-
- Type: Identity structure
The
ChannelArn
andBannedIdentity
of the member in the ban response.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateChannelMembership
$result = $client->createChannelMembership
([/* ... */]); $promise = $client->createChannelMembershipAsync
([/* ... */]);
Adds a user to a channel. The InvitedBy
response field is derived from the request header. A channel member can:
-
List messages
-
Send messages
-
Receive messages
-
Edit their own messages
-
Leave the channel
Privacy settings impact this action as follows:
-
Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
-
Private Channels: You must be a member to list or send messages.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelMembership, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->createChannelMembership([ 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', 'MemberArn' => '<string>', // REQUIRED 'Type' => 'DEFAULT|HIDDEN', // REQUIRED ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the channel to which you're adding users.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call. - MemberArn
-
- Required: Yes
- Type: string
The ARN of the member you want to add to the channel.
- Type
-
- Required: Yes
- Type: string
The membership type of a user,
DEFAULT
orHIDDEN
. Default members are always returned as part ofListChannelMemberships
. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
. Otherwise hidden members are not returned. This is only supported by moderators.
Result Syntax
[ 'ChannelArn' => '<string>', 'Member' => [ 'Arn' => '<string>', 'Name' => '<string>', ], ]
Result Details
Members
- ChannelArn
-
- Type: string
The ARN of the channel.
- Member
-
- Type: Identity structure
The ARN and metadata of the member being added.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateChannelModerator
$result = $client->createChannelModerator
([/* ... */]); $promise = $client->createChannelModeratorAsync
([/* ... */]);
Creates a new ChannelModerator
. A channel moderator can:
-
Add and remove other members of the channel.
-
Add and remove other moderators of the channel.
-
Add and remove user bans for the channel.
-
Redact messages in the channel.
-
List messages in the channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelModerator, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->createChannelModerator([ 'ChannelArn' => '<string>', // REQUIRED 'ChannelModeratorArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the channel.
- ChannelModeratorArn
-
- Required: Yes
- Type: string
The ARN of the moderator.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call.
Result Syntax
[ 'ChannelArn' => '<string>', 'ChannelModerator' => [ 'Arn' => '<string>', 'Name' => '<string>', ], ]
Result Details
Members
- ChannelArn
-
- Type: string
The ARN of the channel.
- ChannelModerator
-
- Type: Identity structure
The ARNs of the channel and the moderator.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateMediaCapturePipeline
$result = $client->createMediaCapturePipeline
([/* ... */]); $promise = $client->createMediaCapturePipelineAsync
([/* ... */]);
Creates a media capture pipeline.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMediaCapturePipeline, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->createMediaCapturePipeline([ 'ChimeSdkMeetingConfiguration' => [ 'ArtifactsConfiguration' => [ 'Audio' => [ // REQUIRED 'MuxType' => 'AudioOnly|AudioWithActiveSpeakerVideo', // REQUIRED ], 'Content' => [ // REQUIRED 'MuxType' => 'ContentOnly', 'State' => 'Enabled|Disabled', // REQUIRED ], 'Video' => [ // REQUIRED 'MuxType' => 'VideoOnly', 'State' => 'Enabled|Disabled', // REQUIRED ], ], 'SourceConfiguration' => [ 'SelectedVideoStreams' => [ 'AttendeeIds' => ['<string>', ...], 'ExternalUserIds' => ['<string>', ...], ], ], ], 'ClientRequestToken' => '<string>', 'SinkArn' => '<string>', // REQUIRED 'SinkType' => 'S3Bucket', // REQUIRED 'SourceArn' => '<string>', // REQUIRED 'SourceType' => 'ChimeSdkMeeting', // REQUIRED ]);
Parameter Details
Members
- ChimeSdkMeetingConfiguration
-
- Type: ChimeSdkMeetingConfiguration structure
The configuration for a specified media capture pipeline.
SourceType
must beChimeSdkMeeting
. - ClientRequestToken
-
- Type: string
The unique identifier for the client request. The token makes the API request idempotent. Use a different token for different media pipeline requests.
- SinkArn
-
- Required: Yes
- Type: string
The ARN of the sink type.
- SinkType
-
- Required: Yes
- Type: string
Destination type to which the media artifacts are saved. You must use an S3 bucket.
- SourceArn
-
- Required: Yes
- Type: string
ARN of the source from which the media artifacts are captured.
- SourceType
-
- Required: Yes
- Type: string
Source type from which the media artifacts will be captured. A Chime SDK Meeting is the only supported source.
Result Syntax
[ 'MediaCapturePipeline' => [ 'ChimeSdkMeetingConfiguration' => [ 'ArtifactsConfiguration' => [ 'Audio' => [ 'MuxType' => 'AudioOnly|AudioWithActiveSpeakerVideo', ], 'Content' => [ 'MuxType' => 'ContentOnly', 'State' => 'Enabled|Disabled', ], 'Video' => [ 'MuxType' => 'VideoOnly', 'State' => 'Enabled|Disabled', ], ], 'SourceConfiguration' => [ 'SelectedVideoStreams' => [ 'AttendeeIds' => ['<string>', ...], 'ExternalUserIds' => ['<string>', ...], ], ], ], 'CreatedTimestamp' => <DateTime>, 'MediaPipelineId' => '<string>', 'SinkArn' => '<string>', 'SinkType' => 'S3Bucket', 'SourceArn' => '<string>', 'SourceType' => 'ChimeSdkMeeting', 'Status' => 'Initializing|InProgress|Failed|Stopping|Stopped', 'UpdatedTimestamp' => <DateTime>, ], ]
Result Details
Members
- MediaCapturePipeline
-
- Type: MediaCapturePipeline structure
A media capture pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media capture pipeline object.
Errors
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateMeeting
$result = $client->createMeeting
([/* ... */]); $promise = $client->createMeetingAsync
([/* ... */]);
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 SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMeeting, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->createMeeting([ 'ClientRequestToken' => '<string>', // REQUIRED 'ExternalMeetingId' => '<string>', 'MediaRegion' => '<string>', 'MeetingHostId' => '<string>', 'NotificationsConfiguration' => [ 'SnsTopicArn' => '<string>', 'SqsQueueArn' => '<string>', ], 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- ClientRequestToken
-
- Required: Yes
- Type: string
The unique identifier for the client request. Use a different token for different meetings.
- ExternalMeetingId
-
- Type: string
The external meeting ID.
- MediaRegion
-
- Type: string
The Region in which to create the meeting. Default:
us-east-1
.Available values:
af-south-1
,ap-northeast-1
,ap-northeast-2
,ap-south-1
,ap-southeast-1
,ap-southeast-2
,ca-central-1
,eu-central-1
,eu-north-1
,eu-south-1
,eu-west-1
,eu-west-2
,eu-west-3
,sa-east-1
,us-east-1
,us-east-2
,us-west-1
,us-west-2
. - MeetingHostId
-
- Type: string
Reserved.
- NotificationsConfiguration
-
- Type: MeetingNotificationConfiguration structure
The configuration for resource targets to receive notifications when meeting and attendee events occur.
- Tags
-
- Type: Array of Tag structures
The tag key-value pairs.
Result Syntax
[ 'Meeting' => [ 'ExternalMeetingId' => '<string>', 'MediaPlacement' => [ 'AudioFallbackUrl' => '<string>', 'AudioHostUrl' => '<string>', 'EventIngestionUrl' => '<string>', 'ScreenDataUrl' => '<string>', 'ScreenSharingUrl' => '<string>', 'ScreenViewingUrl' => '<string>', 'SignalingUrl' => '<string>', 'TurnControlUrl' => '<string>', ], 'MediaRegion' => '<string>', 'MeetingId' => '<string>', ], ]
Result Details
Members
- Meeting
-
- Type: Meeting structure
The meeting information, including the meeting ID and
MediaPlacement
.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateMeetingDialOut
$result = $client->createMeetingDialOut
([/* ... */]); $promise = $client->createMeetingDialOutAsync
([/* ... */]);
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 is not available in a dedicated namespace.
Parameter Syntax
$result = $client->createMeetingDialOut([ 'FromPhoneNumber' => '<string>', // REQUIRED 'JoinToken' => '<string>', // REQUIRED 'MeetingId' => '<string>', // REQUIRED 'ToPhoneNumber' => '<string>', // REQUIRED ]);
Parameter Details
Members
- FromPhoneNumber
-
- Required: Yes
- Type: string
Phone number used as the caller ID when the remote party receives a call.
- JoinToken
-
- Required: Yes
- Type: string
Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.
- MeetingId
-
- Required: Yes
- Type: string
The Amazon Chime SDK meeting ID.
- ToPhoneNumber
-
- Required: Yes
- Type: string
Phone number called when inviting someone to a meeting.
Result Syntax
[ 'TransactionId' => '<string>', ]
Result Details
Members
- TransactionId
-
- Type: string
Unique ID that tracks API calls.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- AccessDeniedException:
You don't have permissions to perform the requested operation.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateMeetingWithAttendees
$result = $client->createMeetingWithAttendees
([/* ... */]); $promise = $client->createMeetingWithAttendeesAsync
([/* ... */]);
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 SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMeetingWithAttendees, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->createMeetingWithAttendees([ 'Attendees' => [ [ 'ExternalUserId' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], // ... ], 'ClientRequestToken' => '<string>', // REQUIRED 'ExternalMeetingId' => '<string>', 'MediaRegion' => '<string>', 'MeetingHostId' => '<string>', 'NotificationsConfiguration' => [ 'SnsTopicArn' => '<string>', 'SqsQueueArn' => '<string>', ], 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- Attendees
-
- Type: Array of CreateAttendeeRequestItem structures
The request containing the attendees to create.
- ClientRequestToken
-
- Required: Yes
- Type: string
The unique identifier for the client request. Use a different token for different meetings.
- ExternalMeetingId
-
- Type: string
The external meeting ID.
- MediaRegion
-
- Type: string
The Region in which to create the meeting. Default:
us-east-1
.Available values:
af-south-1
,ap-northeast-1
,ap-northeast-2
,ap-south-1
,ap-southeast-1
,ap-southeast-2
,ca-central-1
,eu-central-1
,eu-north-1
,eu-south-1
,eu-west-1
,eu-west-2
,eu-west-3
,sa-east-1
,us-east-1
,us-east-2
,us-west-1
,us-west-2
. - MeetingHostId
-
- Type: string
Reserved.
- NotificationsConfiguration
-
- Type: MeetingNotificationConfiguration structure
The resource target configurations for receiving Amazon Chime SDK meeting and attendee event notifications. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS Region (us-east-1).
- Tags
-
- Type: Array of Tag structures
The tag key-value pairs.
Result Syntax
[ 'Attendees' => [ [ 'AttendeeId' => '<string>', 'ExternalUserId' => '<string>', 'JoinToken' => '<string>', ], // ... ], 'Errors' => [ [ 'ErrorCode' => '<string>', 'ErrorMessage' => '<string>', 'ExternalUserId' => '<string>', ], // ... ], 'Meeting' => [ 'ExternalMeetingId' => '<string>', 'MediaPlacement' => [ 'AudioFallbackUrl' => '<string>', 'AudioHostUrl' => '<string>', 'EventIngestionUrl' => '<string>', 'ScreenDataUrl' => '<string>', 'ScreenSharingUrl' => '<string>', 'ScreenViewingUrl' => '<string>', 'SignalingUrl' => '<string>', 'TurnControlUrl' => '<string>', ], 'MediaRegion' => '<string>', 'MeetingId' => '<string>', ], ]
Result Details
Members
- Attendees
-
- Type: Array of Attendee structures
The attendee information, including attendees IDs and join tokens.
- Errors
-
- Type: Array of CreateAttendeeError structures
If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.
- Meeting
-
- Type: Meeting structure
A meeting created using the Amazon Chime SDK.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreatePhoneNumberOrder
$result = $client->createPhoneNumberOrder
([/* ... */]); $promise = $client->createPhoneNumberOrderAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createPhoneNumberOrder([ 'E164PhoneNumbers' => ['<string>', ...], // REQUIRED 'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn', // REQUIRED ]);
Parameter Details
Members
- E164PhoneNumbers
-
- Required: Yes
- Type: Array of strings
List of phone numbers, in E.164 format.
- ProductType
-
- Required: Yes
- Type: string
The phone number product type.
Result Syntax
[ 'PhoneNumberOrder' => [ 'CreatedTimestamp' => <DateTime>, 'OrderedPhoneNumbers' => [ [ 'E164PhoneNumber' => '<string>', 'Status' => 'Processing|Acquired|Failed', ], // ... ], 'PhoneNumberOrderId' => '<string>', 'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn', 'Status' => 'Processing|Successful|Failed|Partial', 'UpdatedTimestamp' => <DateTime>, ], ]
Result Details
Members
- PhoneNumberOrder
-
- Type: PhoneNumberOrder structure
The phone number order details.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- AccessDeniedException:
You don't have permissions to perform the requested operation.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateProxySession
$result = $client->createProxySession
([/* ... */]); $promise = $client->createProxySessionAsync
([/* ... */]);
Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateProxySession, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->createProxySession([ 'Capabilities' => ['<string>', ...], // REQUIRED 'ExpiryMinutes' => <integer>, 'GeoMatchLevel' => 'Country|AreaCode', 'GeoMatchParams' => [ 'AreaCode' => '<string>', // REQUIRED 'Country' => '<string>', // REQUIRED ], 'Name' => '<string>', 'NumberSelectionBehavior' => 'PreferSticky|AvoidSticky', 'ParticipantPhoneNumbers' => ['<string>', ...], // REQUIRED 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Capabilities
-
- Required: Yes
- Type: Array of strings
The proxy session capabilities.
- ExpiryMinutes
-
- Type: int
The number of minutes allowed for the proxy session.
- GeoMatchLevel
-
- Type: string
The preference for matching the country or area code of the proxy phone number with that of the first participant.
- GeoMatchParams
-
- Type: GeoMatchParams structure
The country and area code for the proxy phone number.
- Name
-
- Type: string
The name of the proxy session.
- NumberSelectionBehavior
-
- Type: string
The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
- ParticipantPhoneNumbers
-
- Required: Yes
- Type: Array of strings
The participant phone numbers.
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime voice connector ID.
Result Syntax
[ 'ProxySession' => [ 'Capabilities' => ['<string>', ...], 'CreatedTimestamp' => <DateTime>, 'EndedTimestamp' => <DateTime>, 'ExpiryMinutes' => <integer>, 'GeoMatchLevel' => 'Country|AreaCode', 'GeoMatchParams' => [ 'AreaCode' => '<string>', 'Country' => '<string>', ], 'Name' => '<string>', 'NumberSelectionBehavior' => 'PreferSticky|AvoidSticky', 'Participants' => [ [ 'PhoneNumber' => '<string>', 'ProxyPhoneNumber' => '<string>', ], // ... ], 'ProxySessionId' => '<string>', 'Status' => 'Open|InProgress|Closed', 'UpdatedTimestamp' => <DateTime>, 'VoiceConnectorId' => '<string>', ], ]
Result Details
Members
- ProxySession
-
- Type: ProxySession structure
The proxy session details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateRoom
$result = $client->createRoom
([/* ... */]); $promise = $client->createRoomAsync
([/* ... */]);
Creates a chat room for the specified Amazon Chime Enterprise account.
Parameter Syntax
$result = $client->createRoom([ 'AccountId' => '<string>', // REQUIRED 'ClientRequestToken' => '<string>', 'Name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- ClientRequestToken
-
- Type: string
The idempotency token for the request.
- Name
-
- Required: Yes
- Type: string
The room name.
Result Syntax
[ 'Room' => [ 'AccountId' => '<string>', 'CreatedBy' => '<string>', 'CreatedTimestamp' => <DateTime>, 'Name' => '<string>', 'RoomId' => '<string>', 'UpdatedTimestamp' => <DateTime>, ], ]
Result Details
Members
- Room
-
- Type: Room structure
The room details.
Errors
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateRoomMembership
$result = $client->createRoomMembership
([/* ... */]); $promise = $client->createRoomMembershipAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createRoomMembership([ 'AccountId' => '<string>', // REQUIRED 'MemberId' => '<string>', // REQUIRED 'Role' => 'Administrator|Member', 'RoomId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- MemberId
-
- Required: Yes
- Type: string
The Amazon Chime member ID (user ID or bot ID).
- Role
-
- Type: string
The role of the member.
- RoomId
-
- Required: Yes
- Type: string
The room ID.
Result Syntax
[ 'RoomMembership' => [ 'InvitedBy' => '<string>', 'Member' => [ 'AccountId' => '<string>', 'Email' => '<string>', 'FullName' => '<string>', 'MemberId' => '<string>', 'MemberType' => 'User|Bot|Webhook', ], 'Role' => 'Administrator|Member', 'RoomId' => '<string>', 'UpdatedTimestamp' => <DateTime>, ], ]
Result Details
Members
- RoomMembership
-
- Type: RoomMembership structure
The room membership details.
Errors
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateSipMediaApplication
$result = $client->createSipMediaApplication
([/* ... */]); $promise = $client->createSipMediaApplicationAsync
([/* ... */]);
Creates a SIP media application.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipMediaApplication, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->createSipMediaApplication([ 'AwsRegion' => '<string>', // REQUIRED 'Endpoints' => [ // REQUIRED [ 'LambdaArn' => '<string>', ], // ... ], 'Name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AwsRegion
-
- Required: Yes
- Type: string
The AWS Region assigned to the SIP media application.
- Endpoints
-
- Required: Yes
- Type: Array of SipMediaApplicationEndpoint structures
List of endpoints (Lambda Amazon Resource Names) specified for the SIP media application. Currently, only one endpoint is supported.
- Name
-
- Required: Yes
- Type: string
The SIP media application name.
Result Syntax
[ 'SipMediaApplication' => [ 'AwsRegion' => '<string>', 'CreatedTimestamp' => <DateTime>, 'Endpoints' => [ [ 'LambdaArn' => '<string>', ], // ... ], 'Name' => '<string>', 'SipMediaApplicationId' => '<string>', 'UpdatedTimestamp' => <DateTime>, ], ]
Result Details
Members
- SipMediaApplication
-
- Type: SipMediaApplication structure
The SIP media application details.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- AccessDeniedException:
You don't have permissions to perform the requested operation.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateSipMediaApplicationCall
$result = $client->createSipMediaApplicationCall
([/* ... */]); $promise = $client->createSipMediaApplicationCallAsync
([/* ... */]);
Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId
.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipMediaApplicationCall, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->createSipMediaApplicationCall([ 'FromPhoneNumber' => '<string>', // REQUIRED 'SipHeaders' => ['<string>', ...], 'SipMediaApplicationId' => '<string>', // REQUIRED 'ToPhoneNumber' => '<string>', // REQUIRED ]);
Parameter Details
Members
- FromPhoneNumber
-
- Required: Yes
- Type: string
The phone number that a user calls from. This is a phone number in your Amazon Chime phone number inventory.
- SipHeaders
-
- Type: Associative array of custom strings keys (SensitiveString) to strings
The SIP headers added to an outbound call leg.
- SipMediaApplicationId
-
- Required: Yes
- Type: string
The ID of the SIP media application.
- ToPhoneNumber
-
- Required: Yes
- Type: string
The phone number that the service should call.
Result Syntax
[ 'SipMediaApplicationCall' => [ 'TransactionId' => '<string>', ], ]
Result Details
Members
- SipMediaApplicationCall
-
- Type: SipMediaApplicationCall structure
The actual call.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- AccessDeniedException:
You don't have permissions to perform the requested operation.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateSipRule
$result = $client->createSipRule
([/* ... */]); $promise = $client->createSipRuleAsync
([/* ... */]);
Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipRule, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->createSipRule([ 'Disabled' => true || false, 'Name' => '<string>', // REQUIRED 'TargetApplications' => [ // REQUIRED [ 'AwsRegion' => '<string>', 'Priority' => <integer>, 'SipMediaApplicationId' => '<string>', ], // ... ], 'TriggerType' => 'ToPhoneNumber|RequestUriHostname', // REQUIRED 'TriggerValue' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Disabled
-
- Type: boolean
Enables or disables a rule. You must disable rules before you can delete them.
- Name
-
- Required: Yes
- Type: string
The name of the SIP rule.
- TargetApplications
-
- Required: Yes
- Type: Array of SipRuleTargetApplication structures
List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.
- TriggerType
-
- Required: Yes
- Type: string
The type of trigger assigned to the SIP rule in
TriggerValue
, currentlyRequestUriHostname
orToPhoneNumber
. - TriggerValue
-
- Required: Yes
- Type: string
If
TriggerType
isRequestUriHostname
, the value can be the outbound host name of an Amazon Chime Voice Connector. IfTriggerType
isToPhoneNumber
, the value can be a customer-owned phone number in the E164 format. TheSipMediaApplication
specified in theSipRule
is triggered if the request URI in an incoming SIP request matches theRequestUriHostname
, or if theTo
header in the incoming SIP request matches theToPhoneNumber
value.
Result Syntax
[ 'SipRule' => [ 'CreatedTimestamp' => <DateTime>, 'Disabled' => true || false, 'Name' => '<string>', 'SipRuleId' => '<string>', 'TargetApplications' => [ [ 'AwsRegion' => '<string>', 'Priority' => <integer>, 'SipMediaApplicationId' => '<string>', ], // ... ], 'TriggerType' => 'ToPhoneNumber|RequestUriHostname', 'TriggerValue' => '<string>', 'UpdatedTimestamp' => <DateTime>, ], ]
Result Details
Members
- SipRule
-
- Type: SipRule structure
Returns the SIP rule information, including the rule ID, triggers, and target applications.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- AccessDeniedException:
You don't have permissions to perform the requested operation.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateUser
$result = $client->createUser
([/* ... */]); $promise = $client->createUserAsync
([/* ... */]);
Creates a user under the specified Amazon Chime account.
Parameter Syntax
$result = $client->createUser([ 'AccountId' => '<string>', // REQUIRED 'Email' => '<string>', 'UserType' => 'PrivateUser|SharedDevice', 'Username' => '<string>', ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
-
- Type: string
The user's email address.
- UserType
-
- Type: string
The user type.
- Username
-
- Type: string
The user name.
Result Syntax
[ 'User' => [ 'AccountId' => '<string>', 'AlexaForBusinessMetadata' => [ 'AlexaForBusinessRoomArn' => '<string>', 'IsAlexaForBusinessEnabled' => true || false, ], 'DisplayName' => '<string>', 'InvitedOn' => <DateTime>, 'LicenseType' => 'Basic|Plus|Pro|ProTrial', 'PersonalPIN' => '<string>', 'PrimaryEmail' => '<string>', 'PrimaryProvisionedNumber' => '<string>', 'RegisteredOn' => <DateTime>, 'UserId' => '<string>', 'UserInvitationStatus' => 'Pending|Accepted|Failed', 'UserRegistrationStatus' => 'Unregistered|Registered|Suspended', 'UserType' => 'PrivateUser|SharedDevice', ], ]
Result Details
Members
- User
-
- Type: User structure
The user on the Amazon Chime account.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateVoiceConnector
$result = $client->createVoiceConnector
([/* ... */]); $promise = $client->createVoiceConnectorAsync
([/* ... */]);
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateVoiceConnector, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->createVoiceConnector([ 'AwsRegion' => 'us-east-1|us-west-2', 'Name' => '<string>', // REQUIRED 'RequireEncryption' => true || false, // REQUIRED ]);
Parameter Details
Members
- AwsRegion
-
- Type: string
The AWS Region in which the Amazon Chime Voice Connector is created. Default value:
us-east-1
. - Name
-
- Required: Yes
- Type: string
The name of the Amazon Chime Voice Connector.
- RequireEncryption
-
- Required: Yes
- Type: boolean
When enabled, requires encryption for the Amazon Chime Voice Connector.
Result Syntax
[ 'VoiceConnector' => [ 'AwsRegion' => 'us-east-1|us-west-2', 'CreatedTimestamp' => <DateTime>, 'Name' => '<string>', 'OutboundHostName' => '<string>', 'RequireEncryption' => true || false, 'UpdatedTimestamp' => <DateTime>, 'VoiceConnectorArn' => '<string>', 'VoiceConnectorId' => '<string>', ], ]
Result Details
Members
- VoiceConnector
-
- Type: VoiceConnector structure
The Amazon Chime Voice Connector details.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- AccessDeniedException:
You don't have permissions to perform the requested operation.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
CreateVoiceConnectorGroup
$result = $client->createVoiceConnectorGroup
([/* ... */]); $promise = $client->createVoiceConnectorGroupAsync
([/* ... */]);
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->createVoiceConnectorGroup([ 'Name' => '<string>', // REQUIRED 'VoiceConnectorItems' => [ [ 'Priority' => <integer>, // REQUIRED 'VoiceConnectorId' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- Name
-
- Required: Yes
- Type: string
The name of the Amazon Chime Voice Connector group.
- VoiceConnectorItems
-
- Type: Array of VoiceConnectorItem structures
The Amazon Chime Voice Connectors to route inbound calls to.
Result Syntax
[ 'VoiceConnectorGroup' => [ 'CreatedTimestamp' => <DateTime>, 'Name' => '<string>', 'UpdatedTimestamp' => <DateTime>, 'VoiceConnectorGroupArn' => '<string>', 'VoiceConnectorGroupId' => '<string>', 'VoiceConnectorItems' => [ [ 'Priority' => <integer>, 'VoiceConnectorId' => '<string>', ], // ... ], ], ]
Result Details
Members
- VoiceConnectorGroup
-
- Type: VoiceConnectorGroup structure
The Amazon Chime Voice Connector group details.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- AccessDeniedException:
You don't have permissions to perform the requested operation.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteAccount
$result = $client->deleteAccount
([/* ... */]); $promise = $client->deleteAccountAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteAccount([ 'AccountId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnprocessableEntityException:
The request was well-formed but was unable to be followed due to semantic errors.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteAppInstance
$result = $client->deleteAppInstance
([/* ... */]); $promise = $client->deleteAppInstanceAsync
([/* ... */]);
Deletes an AppInstance
and all associated data asynchronously.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstance, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteAppInstance([ 'AppInstanceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AppInstanceArn
-
- Required: Yes
- Type: string
The ARN of the
AppInstance
.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteAppInstanceAdmin
$result = $client->deleteAppInstanceAdmin
([/* ... */]); $promise = $client->deleteAppInstanceAdminAsync
([/* ... */]);
Demotes an AppInstanceAdmin
to an AppInstanceUser
. This action does not delete the user.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceAdmin, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteAppInstanceAdmin([ 'AppInstanceAdminArn' => '<string>', // REQUIRED 'AppInstanceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AppInstanceAdminArn
-
- Required: Yes
- Type: string
The ARN of the
AppInstance
's administrator. - AppInstanceArn
-
- Required: Yes
- Type: string
The ARN of the
AppInstance
.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteAppInstanceStreamingConfigurations
$result = $client->deleteAppInstanceStreamingConfigurations
([/* ... */]); $promise = $client->deleteAppInstanceStreamingConfigurationsAsync
([/* ... */]);
Deletes the streaming configurations of an AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceStreamingConfigurations, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteAppInstanceStreamingConfigurations([ 'AppInstanceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AppInstanceArn
-
- Required: Yes
- Type: string
The ARN of the streaming configurations being deleted.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteAppInstanceUser
$result = $client->deleteAppInstanceUser
([/* ... */]); $promise = $client->deleteAppInstanceUserAsync
([/* ... */]);
Deletes an AppInstanceUser
.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteAppInstanceUser([ 'AppInstanceUserArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AppInstanceUserArn
-
- Required: Yes
- Type: string
The ARN of the user request being deleted.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteAttendee
$result = $client->deleteAttendee
([/* ... */]); $promise = $client->deleteAttendeeAsync
([/* ... */]);
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 SDK Developer Guide.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAttendee, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteAttendee([ 'AttendeeId' => '<string>', // REQUIRED 'MeetingId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AttendeeId
-
- Required: Yes
- Type: string
The Amazon Chime SDK attendee ID.
- MeetingId
-
- Required: Yes
- Type: string
The Amazon Chime SDK meeting ID.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteChannel
$result = $client->deleteChannel
([/* ... */]); $promise = $client->deleteChannelAsync
([/* ... */]);
Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannel, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteChannel([ 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the channel being deleted.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteChannelBan
$result = $client->deleteChannelBan
([/* ... */]); $promise = $client->deleteChannelBanAsync
([/* ... */]);
Removes a user from a channel's ban list.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelBan, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteChannelBan([ 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', 'MemberArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the channel from which the
AppInstanceUser
was banned. - ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call. - MemberArn
-
- Required: Yes
- Type: string
The ARN of the
AppInstanceUser
that you want to reinstate.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteChannelMembership
$result = $client->deleteChannelMembership
([/* ... */]); $promise = $client->deleteChannelMembershipAsync
([/* ... */]);
Removes a member from a channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelMembership, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteChannelMembership([ 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', 'MemberArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the channel from which you want to remove the user.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call. - MemberArn
-
- Required: Yes
- Type: string
The ARN of the member that you're removing from the channel.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteChannelMessage
$result = $client->deleteChannelMessage
([/* ... */]); $promise = $client->deleteChannelMessageAsync
([/* ... */]);
Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage
.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteChannelMessage([ 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', 'MessageId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the channel.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call. - MessageId
-
- Required: Yes
- Type: string
The ID of the message being deleted.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteChannelModerator
$result = $client->deleteChannelModerator
([/* ... */]); $promise = $client->deleteChannelModeratorAsync
([/* ... */]);
Deletes a channel moderator.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannelModerator, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteChannelModerator([ 'ChannelArn' => '<string>', // REQUIRED 'ChannelModeratorArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the channel.
- ChannelModeratorArn
-
- Required: Yes
- Type: string
The ARN of the moderator being deleted.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteEventsConfiguration
$result = $client->deleteEventsConfiguration
([/* ... */]); $promise = $client->deleteEventsConfigurationAsync
([/* ... */]);
Deletes the events configuration that allows a bot to receive outgoing events.
Parameter Syntax
$result = $client->deleteEventsConfiguration([ 'AccountId' => '<string>', // REQUIRED 'BotId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- BotId
-
- Required: Yes
- Type: string
The bot ID.
Result Syntax
[]
Result Details
Errors
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ResourceLimitExceededException:
The request exceeds the resource limit.
DeleteMediaCapturePipeline
$result = $client->deleteMediaCapturePipeline
([/* ... */]); $promise = $client->deleteMediaCapturePipelineAsync
([/* ... */]);
Deletes the media capture pipeline.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteMediaCapturePipeline, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteMediaCapturePipeline([ 'MediaPipelineId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MediaPipelineId
-
- Required: Yes
- Type: string
The ID of the media capture pipeline being deleted.
Result Syntax
[]
Result Details
Errors
- ForbiddenException:
The client is permanently forbidden from making the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteMeeting
$result = $client->deleteMeeting
([/* ... */]); $promise = $client->deleteMeetingAsync
([/* ... */]);
Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteMeeting, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteMeeting([ 'MeetingId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MeetingId
-
- Required: Yes
- Type: string
The Amazon Chime SDK meeting ID.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeletePhoneNumber
$result = $client->deletePhoneNumber
([/* ... */]); $promise = $client->deletePhoneNumberAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->deletePhoneNumber([ 'PhoneNumberId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- PhoneNumberId
-
- Required: Yes
- Type: string
The phone number ID.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteProxySession
$result = $client->deleteProxySession
([/* ... */]); $promise = $client->deleteProxySessionAsync
([/* ... */]);
Deletes the specified proxy session from the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteProxySession, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteProxySession([ 'ProxySessionId' => '<string>', // REQUIRED 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ProxySessionId
-
- Required: Yes
- Type: string
The proxy session ID.
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime voice connector ID.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteRoom
$result = $client->deleteRoom
([/* ... */]); $promise = $client->deleteRoomAsync
([/* ... */]);
Deletes a chat room in an Amazon Chime Enterprise account.
Parameter Syntax
$result = $client->deleteRoom([ 'AccountId' => '<string>', // REQUIRED 'RoomId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- RoomId
-
- Required: Yes
- Type: string
The chat room ID.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteRoomMembership
$result = $client->deleteRoomMembership
([/* ... */]); $promise = $client->deleteRoomMembershipAsync
([/* ... */]);
Removes a member from a chat room in an Amazon Chime Enterprise account.
Parameter Syntax
$result = $client->deleteRoomMembership([ 'AccountId' => '<string>', // REQUIRED 'MemberId' => '<string>', // REQUIRED 'RoomId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- MemberId
-
- Required: Yes
- Type: string
The member ID (user ID or bot ID).
- RoomId
-
- Required: Yes
- Type: string
The room ID.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteSipMediaApplication
$result = $client->deleteSipMediaApplication
([/* ... */]); $promise = $client->deleteSipMediaApplicationAsync
([/* ... */]);
Deletes a SIP media application.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteSipMediaApplication, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteSipMediaApplication([ 'SipMediaApplicationId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- SipMediaApplicationId
-
- Required: Yes
- Type: string
The SIP media application ID.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteSipRule
$result = $client->deleteSipRule
([/* ... */]); $promise = $client->deleteSipRuleAsync
([/* ... */]);
Deletes a SIP rule. You must disable a SIP rule before you can delete it.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteSipRule, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteSipRule([ 'SipRuleId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- SipRuleId
-
- Required: Yes
- Type: string
The SIP rule ID.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteVoiceConnector
$result = $client->deleteVoiceConnector
([/* ... */]); $promise = $client->deleteVoiceConnectorAsync
([/* ... */]);
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnector, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteVoiceConnector([ 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteVoiceConnectorEmergencyCallingConfiguration
$result = $client->deleteVoiceConnectorEmergencyCallingConfiguration
([/* ... */]); $promise = $client->deleteVoiceConnectorEmergencyCallingConfigurationAsync
([/* ... */]);
Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteVoiceConnectorEmergencyCallingConfiguration([ 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteVoiceConnectorGroup
$result = $client->deleteVoiceConnectorGroup
([/* ... */]); $promise = $client->deleteVoiceConnectorGroupAsync
([/* ... */]);
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteVoiceConnectorGroup([ 'VoiceConnectorGroupId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- VoiceConnectorGroupId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector group ID.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteVoiceConnectorOrigination
$result = $client->deleteVoiceConnectorOrigination
([/* ... */]); $promise = $client->deleteVoiceConnectorOriginationAsync
([/* ... */]);
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorOrigination, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteVoiceConnectorOrigination([ 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteVoiceConnectorProxy
$result = $client->deleteVoiceConnectorProxy
([/* ... */]); $promise = $client->deleteVoiceConnectorProxyAsync
([/* ... */]);
Deletes the proxy configuration from the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceProxy, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteVoiceConnectorProxy([ 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteVoiceConnectorStreamingConfiguration
$result = $client->deleteVoiceConnectorStreamingConfiguration
([/* ... */]); $promise = $client->deleteVoiceConnectorStreamingConfigurationAsync
([/* ... */]);
Deletes the streaming configuration for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteVoiceConnectorStreamingConfiguration([ 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteVoiceConnectorTermination
$result = $client->deleteVoiceConnectorTermination
([/* ... */]); $promise = $client->deleteVoiceConnectorTerminationAsync
([/* ... */]);
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorTermination, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteVoiceConnectorTermination([ 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DeleteVoiceConnectorTerminationCredentials
$result = $client->deleteVoiceConnectorTerminationCredentials
([/* ... */]); $promise = $client->deleteVoiceConnectorTerminationCredentialsAsync
([/* ... */]);
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorTerminationCredentials, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->deleteVoiceConnectorTerminationCredentials([ 'Usernames' => ['<string>', ...], // REQUIRED 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Usernames
-
- Required: Yes
- Type: Array of strings
The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DescribeAppInstance
$result = $client->describeAppInstance
([/* ... */]); $promise = $client->describeAppInstanceAsync
([/* ... */]);
Returns the full details of an AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstance, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->describeAppInstance([ 'AppInstanceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AppInstanceArn
-
- Required: Yes
- Type: string
The ARN of the
AppInstance
.
Result Syntax
[ 'AppInstance' => [ 'AppInstanceArn' => '<string>', 'CreatedTimestamp' => <DateTime>, 'LastUpdatedTimestamp' => <DateTime>, 'Metadata' => '<string>', 'Name' => '<string>', ], ]
Result Details
Members
- AppInstance
-
- Type: AppInstance structure
The ARN, metadata, created and last-updated timestamps, and the name of the
AppInstance
. All timestamps use epoch milliseconds.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DescribeAppInstanceAdmin
$result = $client->describeAppInstanceAdmin
([/* ... */]); $promise = $client->describeAppInstanceAdminAsync
([/* ... */]);
Returns the full details of an AppInstanceAdmin
.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstanceAdmin, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->describeAppInstanceAdmin([ 'AppInstanceAdminArn' => '<string>', // REQUIRED 'AppInstanceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AppInstanceAdminArn
-
- Required: Yes
- Type: string
The ARN of the
AppInstanceAdmin
. - AppInstanceArn
-
- Required: Yes
- Type: string
The ARN of the
AppInstance
.
Result Syntax
[ 'AppInstanceAdmin' => [ 'Admin' => [ 'Arn' => '<string>', 'Name' => '<string>', ], 'AppInstanceArn' => '<string>', 'CreatedTimestamp' => <DateTime>, ], ]
Result Details
Members
- AppInstanceAdmin
-
- Type: AppInstanceAdmin structure
The ARN and name of the
AppInstanceUser
, the ARN of theAppInstance
, and the created and last-updated timestamps. All timestamps use epoch milliseconds.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DescribeAppInstanceUser
$result = $client->describeAppInstanceUser
([/* ... */]); $promise = $client->describeAppInstanceUserAsync
([/* ... */]);
Returns the full details of an AppInstanceUser
.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->describeAppInstanceUser([ 'AppInstanceUserArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AppInstanceUserArn
-
- Required: Yes
- Type: string
The ARN of the
AppInstanceUser
.
Result Syntax
[ 'AppInstanceUser' => [ 'AppInstanceUserArn' => '<string>', 'CreatedTimestamp' => <DateTime>, 'LastUpdatedTimestamp' => <DateTime>, 'Metadata' => '<string>', 'Name' => '<string>', ], ]
Result Details
Members
- AppInstanceUser
-
- Type: AppInstanceUser structure
The name of the
AppInstanceUser
.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DescribeChannel
$result = $client->describeChannel
([/* ... */]); $promise = $client->describeChannelAsync
([/* ... */]);
Returns the full details of a channel in an Amazon Chime AppInstance
.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannel, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->describeChannel([ 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the channel.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call.
Result Syntax
[ 'Channel' => [ 'ChannelArn' => '<string>', 'CreatedBy' => [ 'Arn' => '<string>', 'Name' => '<string>', ], 'CreatedTimestamp' => <DateTime>, 'LastMessageTimestamp' => <DateTime>, 'LastUpdatedTimestamp' => <DateTime>, 'Metadata' => '<string>', 'Mode' => 'UNRESTRICTED|RESTRICTED', 'Name' => '<string>', 'Privacy' => 'PUBLIC|PRIVATE', ], ]
Result Details
Members
- Channel
-
- Type: Channel structure
The channel details.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DescribeChannelBan
$result = $client->describeChannelBan
([/* ... */]); $promise = $client->describeChannelBanAsync
([/* ... */]);
Returns the full details of a channel ban.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelBan, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->describeChannelBan([ 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', 'MemberArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the channel from which the user is banned.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call. - MemberArn
-
- Required: Yes
- Type: string
The ARN of the member being banned.
Result Syntax
[ 'ChannelBan' => [ 'ChannelArn' => '<string>', 'CreatedBy' => [ 'Arn' => '<string>', 'Name' => '<string>', ], 'CreatedTimestamp' => <DateTime>, 'Member' => [ 'Arn' => '<string>', 'Name' => '<string>', ], ], ]
Result Details
Members
- ChannelBan
-
- Type: ChannelBan structure
The details of the ban.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DescribeChannelMembership
$result = $client->describeChannelMembership
([/* ... */]); $promise = $client->describeChannelMembershipAsync
([/* ... */]);
Returns the full details of a user's channel membership.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembership, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->describeChannelMembership([ 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', 'MemberArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the channel.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call. - MemberArn
-
- Required: Yes
- Type: string
The ARN of the member.
Result Syntax
[ 'ChannelMembership' => [ 'ChannelArn' => '<string>', 'CreatedTimestamp' => <DateTime>, 'InvitedBy' => [ 'Arn' => '<string>', 'Name' => '<string>', ], 'LastUpdatedTimestamp' => <DateTime>, 'Member' => [ 'Arn' => '<string>', 'Name' => '<string>', ], 'Type' => 'DEFAULT|HIDDEN', ], ]
Result Details
Members
- ChannelMembership
-
- Type: ChannelMembership structure
The details of the membership.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DescribeChannelMembershipForAppInstanceUser
$result = $client->describeChannelMembershipForAppInstanceUser
([/* ... */]); $promise = $client->describeChannelMembershipForAppInstanceUserAsync
([/* ... */]);
Returns the details of a channel based on the membership of the specified AppInstanceUser
.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembershipForAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->describeChannelMembershipForAppInstanceUser([ 'AppInstanceUserArn' => '<string>', // REQUIRED 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', ]);
Parameter Details
Members
- AppInstanceUserArn
-
- Required: Yes
- Type: string
The ARN of the user in a channel.
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the channel to which the user belongs.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call.
Result Syntax
[ 'ChannelMembership' => [ 'AppInstanceUserMembershipSummary' => [ 'ReadMarkerTimestamp' => <DateTime>, 'Type' => 'DEFAULT|HIDDEN', ], 'ChannelSummary' => [ 'ChannelArn' => '<string>', 'LastMessageTimestamp' => <DateTime>, 'Metadata' => '<string>', 'Mode' => 'UNRESTRICTED|RESTRICTED', 'Name' => '<string>', 'Privacy' => 'PUBLIC|PRIVATE', ], ], ]
Result Details
Members
- ChannelMembership
-
- Type: ChannelMembershipForAppInstanceUserSummary structure
The channel to which a user belongs.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DescribeChannelModeratedByAppInstanceUser
$result = $client->describeChannelModeratedByAppInstanceUser
([/* ... */]); $promise = $client->describeChannelModeratedByAppInstanceUserAsync
([/* ... */]);
Returns the full details of a channel moderated by the specified AppInstanceUser
.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelModeratedByAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->describeChannelModeratedByAppInstanceUser([ 'AppInstanceUserArn' => '<string>', // REQUIRED 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', ]);
Parameter Details
Members
- AppInstanceUserArn
-
- Required: Yes
- Type: string
The ARN of the
AppInstanceUser
in the moderated channel. - ChannelArn
-
- Required: Yes
- Type: string
The ARN of the moderated channel.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call.
Result Syntax
[ 'Channel' => [ 'ChannelSummary' => [ 'ChannelArn' => '<string>', 'LastMessageTimestamp' => <DateTime>, 'Metadata' => '<string>', 'Mode' => 'UNRESTRICTED|RESTRICTED', 'Name' => '<string>', 'Privacy' => 'PUBLIC|PRIVATE', ], ], ]
Result Details
Members
- Channel
-
- Type: ChannelModeratedByAppInstanceUserSummary structure
The moderated channel.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DescribeChannelModerator
$result = $client->describeChannelModerator
([/* ... */]); $promise = $client->describeChannelModeratorAsync
([/* ... */]);
Returns the full details of a single ChannelModerator.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelModerator, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->describeChannelModerator([ 'ChannelArn' => '<string>', // REQUIRED 'ChannelModeratorArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the channel.
- ChannelModeratorArn
-
- Required: Yes
- Type: string
The ARN of the channel moderator.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call.
Result Syntax
[ 'ChannelModerator' => [ 'ChannelArn' => '<string>', 'CreatedBy' => [ 'Arn' => '<string>', 'Name' => '<string>', ], 'CreatedTimestamp' => <DateTime>, 'Moderator' => [ 'Arn' => '<string>', 'Name' => '<string>', ], ], ]
Result Details
Members
- ChannelModerator
-
- Type: ChannelModerator structure
The details of the channel moderator.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DisassociatePhoneNumberFromUser
$result = $client->disassociatePhoneNumberFromUser
([/* ... */]); $promise = $client->disassociatePhoneNumberFromUserAsync
([/* ... */]);
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
Parameter Syntax
$result = $client->disassociatePhoneNumberFromUser([ 'AccountId' => '<string>', // REQUIRED 'UserId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- UserId
-
- Required: Yes
- Type: string
The user ID.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DisassociatePhoneNumbersFromVoiceConnector
$result = $client->disassociatePhoneNumbersFromVoiceConnector
([/* ... */]); $promise = $client->disassociatePhoneNumbersFromVoiceConnectorAsync
([/* ... */]);
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, DisassociatePhoneNumbersFromVoiceConnector, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->disassociatePhoneNumbersFromVoiceConnector([ 'E164PhoneNumbers' => ['<string>', ...], // REQUIRED 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- E164PhoneNumbers
-
- Required: Yes
- Type: Array of strings
List of phone numbers, in E.164 format.
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[ 'PhoneNumberErrors' => [ [ 'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist', 'ErrorMessage' => '<string>', 'PhoneNumberId' => '<string>', ], // ... ], ]
Result Details
Members
- PhoneNumberErrors
-
- Type: Array of PhoneNumberError structures
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.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DisassociatePhoneNumbersFromVoiceConnectorGroup
$result = $client->disassociatePhoneNumbersFromVoiceConnectorGroup
([/* ... */]); $promise = $client->disassociatePhoneNumbersFromVoiceConnectorGroupAsync
([/* ... */]);
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
This API is is no longer supported and will not be updated. We recommend using the latest version, DisassociatePhoneNumbersFromVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->disassociatePhoneNumbersFromVoiceConnectorGroup([ 'E164PhoneNumbers' => ['<string>', ...], // REQUIRED 'VoiceConnectorGroupId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- E164PhoneNumbers
-
- Required: Yes
- Type: Array of strings
List of phone numbers, in E.164 format.
- VoiceConnectorGroupId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector group ID.
Result Syntax
[ 'PhoneNumberErrors' => [ [ 'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist', 'ErrorMessage' => '<string>', 'PhoneNumberId' => '<string>', ], // ... ], ]
Result Details
Members
- PhoneNumberErrors
-
- Type: Array of PhoneNumberError structures
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.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
DisassociateSigninDelegateGroupsFromAccount
$result = $client->disassociateSigninDelegateGroupsFromAccount
([/* ... */]); $promise = $client->disassociateSigninDelegateGroupsFromAccountAsync
([/* ... */]);
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
Parameter Syntax
$result = $client->disassociateSigninDelegateGroupsFromAccount([ 'AccountId' => '<string>', // REQUIRED 'GroupNames' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- GroupNames
-
- Required: Yes
- Type: Array of strings
The sign-in delegate group names.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetAccount
$result = $client->getAccount
([/* ... */]); $promise = $client->getAccountAsync
([/* ... */]);
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
Parameter Syntax
$result = $client->getAccount([ 'AccountId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
Result Syntax
[ 'Account' => [ 'AccountId' => '<string>', 'AccountStatus' => 'Suspended|Active', 'AccountType' => 'Team|EnterpriseDirectory|EnterpriseLWA|EnterpriseOIDC', 'AwsAccountId' => '<string>', 'CreatedTimestamp' => <DateTime>, 'DefaultLicense' => 'Basic|Plus|Pro|ProTrial', 'Name' => '<string>', 'SigninDelegateGroups' => [ [ 'GroupName' => '<string>', ], // ... ], 'SupportedLicenses' => ['<string>', ...], ], ]
Result Details
Members
- Account
-
- Type: Account structure
The Amazon Chime account details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetAccountSettings
$result = $client->getAccountSettings
([/* ... */]); $promise = $client->getAccountSettingsAsync
([/* ... */]);
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
Parameter Syntax
$result = $client->getAccountSettings([ 'AccountId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
Result Syntax
[ 'AccountSettings' => [ 'DisableRemoteControl' => true || false, 'EnableDialOut' => true || false, ], ]
Result Details
Members
- AccountSettings
-
- Type: AccountSettings structure
The Amazon Chime account settings.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetAppInstanceRetentionSettings
$result = $client->getAppInstanceRetentionSettings
([/* ... */]); $promise = $client->getAppInstanceRetentionSettingsAsync
([/* ... */]);
Gets the retention settings for an AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingRetentionSettings, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->getAppInstanceRetentionSettings([ 'AppInstanceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AppInstanceArn
-
- Required: Yes
- Type: string
The ARN of the
AppInstance
.
Result Syntax
[ 'AppInstanceRetentionSettings' => [ 'ChannelRetentionSettings' => [ 'RetentionDays' => <integer>, ], ], 'InitiateDeletionTimestamp' => <DateTime>, ]
Result Details
Members
- AppInstanceRetentionSettings
-
- Type: AppInstanceRetentionSettings structure
The retention settings for the
AppInstance
. - InitiateDeletionTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp representing the time at which the specified items are retained, in Epoch Seconds.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetAppInstanceStreamingConfigurations
$result = $client->getAppInstanceStreamingConfigurations
([/* ... */]); $promise = $client->getAppInstanceStreamingConfigurationsAsync
([/* ... */]);
Gets the streaming settings for an AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingStreamingConfigurations, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->getAppInstanceStreamingConfigurations([ 'AppInstanceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AppInstanceArn
-
- Required: Yes
- Type: string
The ARN of the
AppInstance
.
Result Syntax
[ 'AppInstanceStreamingConfigurations' => [ [ 'AppInstanceDataType' => 'Channel|ChannelMessage', 'ResourceArn' => '<string>', ], // ... ], ]
Result Details
Members
- AppInstanceStreamingConfigurations
-
- Type: Array of AppInstanceStreamingConfiguration structures
The streaming settings.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetAttendee
$result = $client->getAttendee
([/* ... */]); $promise = $client->getAttendeeAsync
([/* ... */]);
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 SDK Developer Guide.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetAttendee, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->getAttendee([ 'AttendeeId' => '<string>', // REQUIRED 'MeetingId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AttendeeId
-
- Required: Yes
- Type: string
The Amazon Chime SDK attendee ID.
- MeetingId
-
- Required: Yes
- Type: string
The Amazon Chime SDK meeting ID.
Result Syntax
[ 'Attendee' => [ 'AttendeeId' => '<string>', 'ExternalUserId' => '<string>', 'JoinToken' => '<string>', ], ]
Result Details
Members
- Attendee
-
- Type: Attendee structure
The Amazon Chime SDK attendee information.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetBot
$result = $client->getBot
([/* ... */]); $promise = $client->getBotAsync
([/* ... */]);
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
Parameter Syntax
$result = $client->getBot([ 'AccountId' => '<string>', // REQUIRED 'BotId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- BotId
-
- Required: Yes
- Type: string
The bot ID.
Result Syntax
[ 'Bot' => [ 'BotEmail' => '<string>', 'BotId' => '<string>', 'BotType' => 'ChatBot', 'CreatedTimestamp' => <DateTime>, 'Disabled' => true || false, 'DisplayName' => '<string>', 'SecurityToken' => '<string>', 'UpdatedTimestamp' => <DateTime>, 'UserId' => '<string>', ], ]
Result Details
Members
- Bot
-
- Type: Bot structure
The chat bot details.
Errors
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
GetChannelMessage
$result = $client->getChannelMessage
([/* ... */]); $promise = $client->getChannelMessageAsync
([/* ... */]);
Gets the full details of a channel message.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->getChannelMessage([ 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', 'MessageId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the channel.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call. - MessageId
-
- Required: Yes
- Type: string
The ID of the message.
Result Syntax
[ 'ChannelMessage' => [ 'ChannelArn' => '<string>', 'Content' => '<string>', 'CreatedTimestamp' => <DateTime>, 'LastEditedTimestamp' => <DateTime>, 'LastUpdatedTimestamp' => <DateTime>, 'MessageId' => '<string>', 'Metadata' => '<string>', 'Persistence' => 'PERSISTENT|NON_PERSISTENT', 'Redacted' => true || false, 'Sender' => [ 'Arn' => '<string>', 'Name' => '<string>', ], 'Type' => 'STANDARD|CONTROL', ], ]
Result Details
Members
- ChannelMessage
-
- Type: ChannelMessage structure
The details of and content in the message.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetEventsConfiguration
$result = $client->getEventsConfiguration
([/* ... */]); $promise = $client->getEventsConfigurationAsync
([/* ... */]);
Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
Parameter Syntax
$result = $client->getEventsConfiguration([ 'AccountId' => '<string>', // REQUIRED 'BotId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- BotId
-
- Required: Yes
- Type: string
The bot ID.
Result Syntax
[ 'EventsConfiguration' => [ 'BotId' => '<string>', 'LambdaFunctionArn' => '<string>', 'OutboundEventsHTTPSEndpoint' => '<string>', ], ]
Result Details
Members
- EventsConfiguration
-
- Type: EventsConfiguration structure
The events configuration details.
Errors
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
GetGlobalSettings
$result = $client->getGlobalSettings
([/* ... */]); $promise = $client->getGlobalSettingsAsync
([/* ... */]);
Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
Parameter Syntax
$result = $client->getGlobalSettings([ ]);
Parameter Details
Members
Result Syntax
[ 'BusinessCalling' => [ 'CdrBucket' => '<string>', ], 'VoiceConnector' => [ 'CdrBucket' => '<string>', ], ]
Result Details
Members
- BusinessCalling
-
- Type: BusinessCallingSettings structure
The Amazon Chime Business Calling settings.
- VoiceConnector
-
- Type: VoiceConnectorSettings structure
The Amazon Chime Voice Connector settings.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetMediaCapturePipeline
$result = $client->getMediaCapturePipeline
([/* ... */]); $promise = $client->getMediaCapturePipelineAsync
([/* ... */]);
Gets an existing media capture pipeline.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetMediaCapturePipeline, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->getMediaCapturePipeline([ 'MediaPipelineId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MediaPipelineId
-
- Required: Yes
- Type: string
The ID of the pipeline that you want to get.
Result Syntax
[ 'MediaCapturePipeline' => [ 'ChimeSdkMeetingConfiguration' => [ 'ArtifactsConfiguration' => [ 'Audio' => [ 'MuxType' => 'AudioOnly|AudioWithActiveSpeakerVideo', ], 'Content' => [ 'MuxType' => 'ContentOnly', 'State' => 'Enabled|Disabled', ], 'Video' => [ 'MuxType' => 'VideoOnly', 'State' => 'Enabled|Disabled', ], ], 'SourceConfiguration' => [ 'SelectedVideoStreams' => [ 'AttendeeIds' => ['<string>', ...], 'ExternalUserIds' => ['<string>', ...], ], ], ], 'CreatedTimestamp' => <DateTime>, 'MediaPipelineId' => '<string>', 'SinkArn' => '<string>', 'SinkType' => 'S3Bucket', 'SourceArn' => '<string>', 'SourceType' => 'ChimeSdkMeeting', 'Status' => 'Initializing|InProgress|Failed|Stopping|Stopped', 'UpdatedTimestamp' => <DateTime>, ], ]
Result Details
Members
- MediaCapturePipeline
-
- Type: MediaCapturePipeline structure
The media capture pipeline object.
Errors
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetMeeting
$result = $client->getMeeting
([/* ... */]); $promise = $client->getMeetingAsync
([/* ... */]);
This API is is no longer supported and will not be updated. We recommend using the latest version, GetMeeting, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
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 SDK Developer Guide .
Parameter Syntax
$result = $client->getMeeting([ 'MeetingId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MeetingId
-
- Required: Yes
- Type: string
The Amazon Chime SDK meeting ID.
Result Syntax
[ 'Meeting' => [ 'ExternalMeetingId' => '<string>', 'MediaPlacement' => [ 'AudioFallbackUrl' => '<string>', 'AudioHostUrl' => '<string>', 'EventIngestionUrl' => '<string>', 'ScreenDataUrl' => '<string>', 'ScreenSharingUrl' => '<string>', 'ScreenViewingUrl' => '<string>', 'SignalingUrl' => '<string>', 'TurnControlUrl' => '<string>', ], 'MediaRegion' => '<string>', 'MeetingId' => '<string>', ], ]
Result Details
Members
- Meeting
-
- Type: Meeting structure
The Amazon Chime SDK meeting information.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetMessagingSessionEndpoint
$result = $client->getMessagingSessionEndpoint
([/* ... */]); $promise = $client->getMessagingSessionEndpointAsync
([/* ... */]);
The details of the endpoint for the messaging session.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingSessionEndpoint, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->getMessagingSessionEndpoint([ ]);
Parameter Details
Members
Result Syntax
[ 'Endpoint' => [ 'Url' => '<string>', ], ]
Result Details
Members
- Endpoint
-
- Type: MessagingSessionEndpoint structure
The endpoint returned in the response.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetPhoneNumber
$result = $client->getPhoneNumber
([/* ... */]); $promise = $client->getPhoneNumberAsync
([/* ... */]);
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
Parameter Syntax
$result = $client->getPhoneNumber([ 'PhoneNumberId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- PhoneNumberId
-
- Required: Yes
- Type: string
The phone number ID.
Result Syntax
[ 'PhoneNumber' => [ 'Associations' => [ [ 'AssociatedTimestamp' => <DateTime>, 'Name' => 'AccountId|UserId|VoiceConnectorId|VoiceConnectorGroupId|SipRuleId', 'Value' => '<string>', ], // ... ], 'CallingName' => '<string>', 'CallingNameStatus' => 'Unassigned|UpdateInProgress|UpdateSucceeded|UpdateFailed', 'Capabilities' => [ 'InboundCall' => true || false, 'InboundMMS' => true || false, 'InboundSMS' => true || false, 'OutboundCall' => true || false, 'OutboundMMS' => true || false, 'OutboundSMS' => true || false, ], 'Country' => '<string>', 'CreatedTimestamp' => <DateTime>, 'DeletionTimestamp' => <DateTime>, 'E164PhoneNumber' => '<string>', 'PhoneNumberId' => '<string>', 'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn', 'Status' => 'AcquireInProgress|AcquireFailed|Unassigned|Assigned|ReleaseInProgress|DeleteInProgress|ReleaseFailed|DeleteFailed', 'Type' => 'Local|TollFree', 'UpdatedTimestamp' => <DateTime>, ], ]
Result Details
Members
- PhoneNumber
-
- Type: PhoneNumber structure
The phone number details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetPhoneNumberOrder
$result = $client->getPhoneNumberOrder
([/* ... */]); $promise = $client->getPhoneNumberOrderAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->getPhoneNumberOrder([ 'PhoneNumberOrderId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- PhoneNumberOrderId
-
- Required: Yes
- Type: string
The ID for the phone number order.
Result Syntax
[ 'PhoneNumberOrder' => [ 'CreatedTimestamp' => <DateTime>, 'OrderedPhoneNumbers' => [ [ 'E164PhoneNumber' => '<string>', 'Status' => 'Processing|Acquired|Failed', ], // ... ], 'PhoneNumberOrderId' => '<string>', 'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn', 'Status' => 'Processing|Successful|Failed|Partial', 'UpdatedTimestamp' => <DateTime>, ], ]
Result Details
Members
- PhoneNumberOrder
-
- Type: PhoneNumberOrder structure
The phone number order details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetPhoneNumberSettings
$result = $client->getPhoneNumberSettings
([/* ... */]); $promise = $client->getPhoneNumberSettingsAsync
([/* ... */]);
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
Parameter Syntax
$result = $client->getPhoneNumberSettings([ ]);
Parameter Details
Members
Result Syntax
[ 'CallingName' => '<string>', 'CallingNameUpdatedTimestamp' => <DateTime>, ]
Result Details
Members
- CallingName
-
- Type: string
The default outbound calling name for the account.
- CallingNameUpdatedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The updated outbound calling name timestamp, in ISO 8601 format.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetProxySession
$result = $client->getProxySession
([/* ... */]); $promise = $client->getProxySessionAsync
([/* ... */]);
Gets the specified proxy session details for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetProxySession, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->getProxySession([ 'ProxySessionId' => '<string>', // REQUIRED 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ProxySessionId
-
- Required: Yes
- Type: string
The proxy session ID.
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime voice connector ID.
Result Syntax
[ 'ProxySession' => [ 'Capabilities' => ['<string>', ...], 'CreatedTimestamp' => <DateTime>, 'EndedTimestamp' => <DateTime>, 'ExpiryMinutes' => <integer>, 'GeoMatchLevel' => 'Country|AreaCode', 'GeoMatchParams' => [ 'AreaCode' => '<string>', 'Country' => '<string>', ], 'Name' => '<string>', 'NumberSelectionBehavior' => 'PreferSticky|AvoidSticky', 'Participants' => [ [ 'PhoneNumber' => '<string>', 'ProxyPhoneNumber' => '<string>', ], // ... ], 'ProxySessionId' => '<string>', 'Status' => 'Open|InProgress|Closed', 'UpdatedTimestamp' => <DateTime>, 'VoiceConnectorId' => '<string>', ], ]
Result Details
Members
- ProxySession
-
- Type: ProxySession structure
The proxy session details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetRetentionSettings
$result = $client->getRetentionSettings
([/* ... */]); $promise = $client->getRetentionSettingsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->getRetentionSettings([ 'AccountId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
Result Syntax
[ 'InitiateDeletionTimestamp' => <DateTime>, 'RetentionSettings' => [ 'ConversationRetentionSettings' => [ 'RetentionDays' => <integer>, ], 'RoomRetentionSettings' => [ 'RetentionDays' => <integer>, ], ], ]
Result Details
Members
- InitiateDeletionTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.
- RetentionSettings
-
- Type: RetentionSettings structure
The retention settings.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetRoom
$result = $client->getRoom
([/* ... */]); $promise = $client->getRoomAsync
([/* ... */]);
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
Parameter Syntax
$result = $client->getRoom([ 'AccountId' => '<string>', // REQUIRED 'RoomId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- RoomId
-
- Required: Yes
- Type: string
The room ID.
Result Syntax
[ 'Room' => [ 'AccountId' => '<string>', 'CreatedBy' => '<string>', 'CreatedTimestamp' => <DateTime>, 'Name' => '<string>', 'RoomId' => '<string>', 'UpdatedTimestamp' => <DateTime>, ], ]
Result Details
Members
- Room
-
- Type: Room structure
The room details.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetSipMediaApplication
$result = $client->getSipMediaApplication
([/* ... */]); $promise = $client->getSipMediaApplicationAsync
([/* ... */]);
Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipMediaApplication, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->getSipMediaApplication([ 'SipMediaApplicationId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- SipMediaApplicationId
-
- Required: Yes
- Type: string
The SIP media application ID.
Result Syntax
[ 'SipMediaApplication' => [ 'AwsRegion' => '<string>', 'CreatedTimestamp' => <DateTime>, 'Endpoints' => [ [ 'LambdaArn' => '<string>', ], // ... ], 'Name' => '<string>', 'SipMediaApplicationId' => '<string>', 'UpdatedTimestamp' => <DateTime>, ], ]
Result Details
Members
- SipMediaApplication
-
- Type: SipMediaApplication structure
The SIP media application details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetSipMediaApplicationLoggingConfiguration
$result = $client->getSipMediaApplicationLoggingConfiguration
([/* ... */]); $promise = $client->getSipMediaApplicationLoggingConfigurationAsync
([/* ... */]);
Returns the logging configuration for the specified SIP media application.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipMediaApplicationLoggingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->getSipMediaApplicationLoggingConfiguration([ 'SipMediaApplicationId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- SipMediaApplicationId
-
- Required: Yes
- Type: string
The SIP media application ID.
Result Syntax
[ 'SipMediaApplicationLoggingConfiguration' => [ 'EnableSipMediaApplicationMessageLogs' => true || false, ], ]
Result Details
Members
- SipMediaApplicationLoggingConfiguration
-
- Type: SipMediaApplicationLoggingConfiguration structure
The actual logging configuration.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetSipRule
$result = $client->getSipRule
([/* ... */]); $promise = $client->getSipRuleAsync
([/* ... */]);
Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipRule, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->getSipRule([ 'SipRuleId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- SipRuleId
-
- Required: Yes
- Type: string
The SIP rule ID.
Result Syntax
[ 'SipRule' => [ 'CreatedTimestamp' => <DateTime>, 'Disabled' => true || false, 'Name' => '<string>', 'SipRuleId' => '<string>', 'TargetApplications' => [ [ 'AwsRegion' => '<string>', 'Priority' => <integer>, 'SipMediaApplicationId' => '<string>', ], // ... ], 'TriggerType' => 'ToPhoneNumber|RequestUriHostname', 'TriggerValue' => '<string>', 'UpdatedTimestamp' => <DateTime>, ], ]
Result Details
Members
- SipRule
-
- Type: SipRule structure
The SIP rule details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetUser
$result = $client->getUser
([/* ... */]); $promise = $client->getUserAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->getUser([ 'AccountId' => '<string>', // REQUIRED 'UserId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- UserId
-
- Required: Yes
- Type: string
The user ID.
Result Syntax
[ 'User' => [ 'AccountId' => '<string>', 'AlexaForBusinessMetadata' => [ 'AlexaForBusinessRoomArn' => '<string>', 'IsAlexaForBusinessEnabled' => true || false, ], 'DisplayName' => '<string>', 'InvitedOn' => <DateTime>, 'LicenseType' => 'Basic|Plus|Pro|ProTrial', 'PersonalPIN' => '<string>', 'PrimaryEmail' => '<string>', 'PrimaryProvisionedNumber' => '<string>', 'RegisteredOn' => <DateTime>, 'UserId' => '<string>', 'UserInvitationStatus' => 'Pending|Accepted|Failed', 'UserRegistrationStatus' => 'Unregistered|Registered|Suspended', 'UserType' => 'PrivateUser|SharedDevice', ], ]
Result Details
Members
- User
-
- Type: User structure
The user details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetUserSettings
$result = $client->getUserSettings
([/* ... */]); $promise = $client->getUserSettingsAsync
([/* ... */]);
Retrieves settings for the specified user ID, such as any associated phone number settings.
Parameter Syntax
$result = $client->getUserSettings([ 'AccountId' => '<string>', // REQUIRED 'UserId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- UserId
-
- Required: Yes
- Type: string
The user ID.
Result Syntax
[ 'UserSettings' => [ 'Telephony' => [ 'InboundCalling' => true || false, 'OutboundCalling' => true || false, 'SMS' => true || false, ], ], ]
Result Details
Members
- UserSettings
-
- Type: UserSettings structure
The user settings.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetVoiceConnector
$result = $client->getVoiceConnector
([/* ... */]); $promise = $client->getVoiceConnectorAsync
([/* ... */]);
Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnector, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->getVoiceConnector([ 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[ 'VoiceConnector' => [ 'AwsRegion' => 'us-east-1|us-west-2', 'CreatedTimestamp' => <DateTime>, 'Name' => '<string>', 'OutboundHostName' => '<string>', 'RequireEncryption' => true || false, 'UpdatedTimestamp' => <DateTime>, 'VoiceConnectorArn' => '<string>', 'VoiceConnectorId' => '<string>', ], ]
Result Details
Members
- VoiceConnector
-
- Type: VoiceConnector structure
The Amazon Chime Voice Connector details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetVoiceConnectorEmergencyCallingConfiguration
$result = $client->getVoiceConnectorEmergencyCallingConfiguration
([/* ... */]); $promise = $client->getVoiceConnectorEmergencyCallingConfigurationAsync
([/* ... */]);
Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->getVoiceConnectorEmergencyCallingConfiguration([ 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[ 'EmergencyCallingConfiguration' => [ 'DNIS' => [ [ 'CallingCountry' => '<string>', 'EmergencyPhoneNumber' => '<string>', 'TestPhoneNumber' => '<string>', ], // ... ], ], ]
Result Details
Members
- EmergencyCallingConfiguration
-
- Type: EmergencyCallingConfiguration structure
The emergency calling configuration details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetVoiceConnectorGroup
$result = $client->getVoiceConnectorGroup
([/* ... */]); $promise = $client->getVoiceConnectorGroupAsync
([/* ... */]);
Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems
.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorGroup, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->getVoiceConnectorGroup([ 'VoiceConnectorGroupId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- VoiceConnectorGroupId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector group ID.
Result Syntax
[ 'VoiceConnectorGroup' => [ 'CreatedTimestamp' => <DateTime>, 'Name' => '<string>', 'UpdatedTimestamp' => <DateTime>, 'VoiceConnectorGroupArn' => '<string>', 'VoiceConnectorGroupId' => '<string>', 'VoiceConnectorItems' => [ [ 'Priority' => <integer>, 'VoiceConnectorId' => '<string>', ], // ... ], ], ]
Result Details
Members
- VoiceConnectorGroup
-
- Type: VoiceConnectorGroup structure
The Amazon Chime Voice Connector group details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetVoiceConnectorLoggingConfiguration
$result = $client->getVoiceConnectorLoggingConfiguration
([/* ... */]); $promise = $client->getVoiceConnectorLoggingConfigurationAsync
([/* ... */]);
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->getVoiceConnectorLoggingConfiguration([ 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[ 'LoggingConfiguration' => [ 'EnableMediaMetricLogs' => true || false, 'EnableSIPLogs' => true || false, ], ]
Result Details
Members
- LoggingConfiguration
-
- Type: LoggingConfiguration structure
The logging configuration details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetVoiceConnectorOrigination
$result = $client->getVoiceConnectorOrigination
([/* ... */]); $promise = $client->getVoiceConnectorOriginationAsync
([/* ... */]);
Retrieves origination setting details for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorOrigination, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->getVoiceConnectorOrigination([ 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[ 'Origination' => [ 'Disabled' => true || false, 'Routes' => [ [ 'Host' => '<string>', 'Port' => <integer>, 'Priority' => <integer>, 'Protocol' => 'TCP|UDP', 'Weight' => <integer>, ], // ... ], ], ]
Result Details
Members
- Origination
-
- Type: Origination structure
The origination setting details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetVoiceConnectorProxy
$result = $client->getVoiceConnectorProxy
([/* ... */]); $promise = $client->getVoiceConnectorProxyAsync
([/* ... */]);
Gets the proxy configuration details for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorProxy, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->getVoiceConnectorProxy([ 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime voice connector ID.
Result Syntax
[ 'Proxy' => [ 'DefaultSessionExpiryMinutes' => <integer>, 'Disabled' => true || false, 'FallBackPhoneNumber' => '<string>', 'PhoneNumberCountries' => ['<string>', ...], ], ]
Result Details
Members
- Proxy
-
- Type: Proxy structure
The proxy configuration details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetVoiceConnectorStreamingConfiguration
$result = $client->getVoiceConnectorStreamingConfiguration
([/* ... */]); $promise = $client->getVoiceConnectorStreamingConfigurationAsync
([/* ... */]);
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->getVoiceConnectorStreamingConfiguration([ 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[ 'StreamingConfiguration' => [ 'DataRetentionInHours' => <integer>, 'Disabled' => true || false, 'StreamingNotificationTargets' => [ [ 'NotificationTarget' => 'EventBridge|SNS|SQS', ], // ... ], ], ]
Result Details
Members
- StreamingConfiguration
-
- Type: StreamingConfiguration structure
The streaming configuration details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetVoiceConnectorTermination
$result = $client->getVoiceConnectorTermination
([/* ... */]); $promise = $client->getVoiceConnectorTerminationAsync
([/* ... */]);
Retrieves termination setting details for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTermination, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->getVoiceConnectorTermination([ 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[ 'Termination' => [ 'CallingRegions' => ['<string>', ...], 'CidrAllowedList' => ['<string>', ...], 'CpsLimit' => <integer>, 'DefaultPhoneNumber' => '<string>', 'Disabled' => true || false, ], ]
Result Details
Members
- Termination
-
- Type: Termination structure
The termination setting details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
GetVoiceConnectorTerminationHealth
$result = $client->getVoiceConnectorTerminationHealth
([/* ... */]); $promise = $client->getVoiceConnectorTerminationHealthAsync
([/* ... */]);
This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTerminationHealth, in the Amazon Chime SDK. Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Retrieves information about the last time a SIP OPTIONS
ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.
Parameter Syntax
$result = $client->getVoiceConnectorTerminationHealth([ 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[ 'TerminationHealth' => [ 'Source' => '<string>', 'Timestamp' => <DateTime>, ], ]
Result Details
Members
- TerminationHealth
-
- Type: TerminationHealth structure
The termination health details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
InviteUsers
$result = $client->inviteUsers
([/* ... */]); $promise = $client->inviteUsersAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->inviteUsers([ 'AccountId' => '<string>', // REQUIRED 'UserEmailList' => ['<string>', ...], // REQUIRED 'UserType' => 'PrivateUser|SharedDevice', ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- UserEmailList
-
- Required: Yes
- Type: Array of strings
The user email addresses to which to send the email invitation.
- UserType
-
- Type: string
The user type.
Result Syntax
[ 'Invites' => [ [ 'EmailAddress' => '<string>', 'EmailStatus' => 'NotSent|Sent|Failed', 'InviteId' => '<string>', 'Status' => 'Pending|Accepted|Failed', ], // ... ], ]
Result Details
Members
- Invites
-
- Type: Array of Invite structures
The email invitation details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListAccounts
$result = $client->listAccounts
([/* ... */]); $promise = $client->listAccountsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listAccounts([ 'MaxResults' => <integer>, 'Name' => '<string>', 'NextToken' => '<string>', 'UserEmail' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return in a single call. Defaults to 100.
- Name
-
- Type: string
Amazon Chime account name prefix with which to filter results.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
- UserEmail
-
- Type: string
User email address with which to filter results.
Result Syntax
[ 'Accounts' => [ [ 'AccountId' => '<string>', 'AccountStatus' => 'Suspended|Active', 'AccountType' => 'Team|EnterpriseDirectory|EnterpriseLWA|EnterpriseOIDC', 'AwsAccountId' => '<string>', 'CreatedTimestamp' => <DateTime>, 'DefaultLicense' => 'Basic|Plus|Pro|ProTrial', 'Name' => '<string>', 'SigninDelegateGroups' => [ [ 'GroupName' => '<string>', ], // ... ], 'SupportedLicenses' => ['<string>', ...], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- Accounts
-
- Type: Array of Account structures
List of Amazon Chime accounts and account details.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListAppInstanceAdmins
$result = $client->listAppInstanceAdmins
([/* ... */]); $promise = $client->listAppInstanceAdminsAsync
([/* ... */]);
Returns a list of the administrators in the AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstanceAdmins, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listAppInstanceAdmins([ 'AppInstanceArn' => '<string>', // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- AppInstanceArn
-
- Required: Yes
- Type: string
The ARN of the
AppInstance
. - MaxResults
-
- Type: int
The maximum number of administrators that you want to return.
- NextToken
-
- Type: string
The token returned from previous API requests until the number of administrators is reached.
Result Syntax
[ 'AppInstanceAdmins' => [ [ 'Admin' => [ 'Arn' => '<string>', 'Name' => '<string>', ], ], // ... ], 'AppInstanceArn' => '<string>', 'NextToken' => '<string>', ]
Result Details
Members
- AppInstanceAdmins
-
- Type: Array of AppInstanceAdminSummary structures
The information for each administrator.
- AppInstanceArn
-
- Type: string
The ARN of the
AppInstance
. - NextToken
-
- Type: string
The token returned from previous API requests until the number of administrators is reached.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListAppInstanceUsers
$result = $client->listAppInstanceUsers
([/* ... */]); $promise = $client->listAppInstanceUsersAsync
([/* ... */]);
List all AppInstanceUsers
created under a single AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstanceUsers, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listAppInstanceUsers([ 'AppInstanceArn' => '<string>', // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- AppInstanceArn
-
- Required: Yes
- Type: string
The ARN of the
AppInstance
. - MaxResults
-
- Type: int
The maximum number of requests that you want returned.
- NextToken
-
- Type: string
The token passed by previous API calls until all requested users are returned.
Result Syntax
[ 'AppInstanceArn' => '<string>', 'AppInstanceUsers' => [ [ 'AppInstanceUserArn' => '<string>', 'Metadata' => '<string>', 'Name' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- AppInstanceArn
-
- Type: string
The ARN of the
AppInstance
. - AppInstanceUsers
-
- Type: Array of AppInstanceUserSummary structures
The information for each requested
AppInstanceUser
. - NextToken
-
- Type: string
The token passed by previous API calls until all requested users are returned.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListAppInstances
$result = $client->listAppInstances
([/* ... */]); $promise = $client->listAppInstancesAsync
([/* ... */]);
Lists all Amazon Chime AppInstance
s created under a single AWS account.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstances, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listAppInstances([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of
AppInstance
s that you want to return. - NextToken
-
- Type: string
The token passed by previous API requests until you reach the maximum number of
AppInstance
s.
Result Syntax
[ 'AppInstances' => [ [ 'AppInstanceArn' => '<string>', 'Metadata' => '<string>', 'Name' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- AppInstances
-
- Type: Array of AppInstanceSummary structures
The information for each
AppInstance
. - NextToken
-
- Type: string
The token passed by previous API requests until the maximum number of
AppInstance
s is reached.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListAttendeeTags
$result = $client->listAttendeeTags
([/* ... */]); $promise = $client->listAttendeeTagsAsync
([/* ... */]);
Lists the tags applied to an Amazon Chime SDK attendee resource.
ListAttendeeTags is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.
Parameter Syntax
$result = $client->listAttendeeTags([ 'AttendeeId' => '<string>', // REQUIRED 'MeetingId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AttendeeId
-
- Required: Yes
- Type: string
The Amazon Chime SDK attendee ID.
- MeetingId
-
- Required: Yes
- Type: string
The Amazon Chime SDK meeting ID.
Result Syntax
[ 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- Tags
-
- Type: Array of Tag structures
A list of tag key-value pairs.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListAttendees
$result = $client->listAttendees
([/* ... */]); $promise = $client->listAttendeesAsync
([/* ... */]);
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 SDK Developer Guide.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListAttendees, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listAttendees([ 'MaxResults' => <integer>, 'MeetingId' => '<string>', // REQUIRED 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return in a single call.
- MeetingId
-
- Required: Yes
- Type: string
The Amazon Chime SDK meeting ID.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
Result Syntax
[ 'Attendees' => [ [ 'AttendeeId' => '<string>', 'ExternalUserId' => '<string>', 'JoinToken' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- Attendees
-
- Type: Array of Attendee structures
The Amazon Chime SDK attendee information.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListBots
$result = $client->listBots
([/* ... */]); $promise = $client->listBotsAsync
([/* ... */]);
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
Parameter Syntax
$result = $client->listBots([ 'AccountId' => '<string>', // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- MaxResults
-
- Type: int
The maximum number of results to return in a single call. The default is 10.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
Result Syntax
[ 'Bots' => [ [ 'BotEmail' => '<string>', 'BotId' => '<string>', 'BotType' => 'ChatBot', 'CreatedTimestamp' => <DateTime>, 'Disabled' => true || false, 'DisplayName' => '<string>', 'SecurityToken' => '<string>', 'UpdatedTimestamp' => <DateTime>, 'UserId' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- Bots
-
- Type: Array of Bot structures
List of bots and bot details.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
Errors
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ThrottledClientException:
The client exceeded its request rate limit.
ListChannelBans
$result = $client->listChannelBans
([/* ... */]); $promise = $client->listChannelBansAsync
([/* ... */]);
Lists all the users banned from a particular channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelBans, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listChannelBans([ 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the channel.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call. - MaxResults
-
- Type: int
The maximum number of bans that you want returned.
- NextToken
-
- Type: string
The token passed by previous API calls until all requested bans are returned.
Result Syntax
[ 'ChannelArn' => '<string>', 'ChannelBans' => [ [ 'Member' => [ 'Arn' => '<string>', 'Name' => '<string>', ], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ChannelArn
-
- Type: string
The ARN of the channel.
- ChannelBans
-
- Type: Array of ChannelBanSummary structures
The information for each requested ban.
- NextToken
-
- Type: string
The token passed by previous API calls until all requested bans are returned.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListChannelMemberships
$result = $client->listChannelMemberships
([/* ... */]); $promise = $client->listChannelMembershipsAsync
([/* ... */]);
Lists all channel memberships in a channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMemberships, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listChannelMemberships([ 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', 'Type' => 'DEFAULT|HIDDEN', ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The maximum number of channel memberships that you want returned.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call. - MaxResults
-
- Type: int
The maximum number of channel memberships that you want returned.
- NextToken
-
- Type: string
The token passed by previous API calls until all requested channel memberships are returned.
- Type
-
- Type: string
The membership type of a user,
DEFAULT
orHIDDEN
. Default members are always returned as part ofListChannelMemberships
. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
. Otherwise hidden members are not returned.
Result Syntax
[ 'ChannelArn' => '<string>', 'ChannelMemberships' => [ [ 'Member' => [ 'Arn' => '<string>', 'Name' => '<string>', ], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ChannelArn
-
- Type: string
The ARN of the channel.
- ChannelMemberships
-
- Type: Array of ChannelMembershipSummary structures
The information for the requested channel memberships.
- NextToken
-
- Type: string
The token passed by previous API calls until all requested channel memberships are returned.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListChannelMembershipsForAppInstanceUser
$result = $client->listChannelMembershipsForAppInstanceUser
([/* ... */]); $promise = $client->listChannelMembershipsForAppInstanceUserAsync
([/* ... */]);
Lists all channels that a particular AppInstanceUser
is a part of. Only an AppInstanceAdmin
can call the API with a user ARN that is not their own.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMembershipsForAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listChannelMembershipsForAppInstanceUser([ 'AppInstanceUserArn' => '<string>', 'ChimeBearer' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- AppInstanceUserArn
-
- Type: string
The ARN of the
AppInstanceUser
s - ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call. - MaxResults
-
- Type: int
The maximum number of users that you want returned.
- NextToken
-
- Type: string
The token returned from previous API requests until the number of channel memberships is reached.
Result Syntax
[ 'ChannelMemberships' => [ [ 'AppInstanceUserMembershipSummary' => [ 'ReadMarkerTimestamp' => <DateTime>, 'Type' => 'DEFAULT|HIDDEN', ], 'ChannelSummary' => [ 'ChannelArn' => '<string>', 'LastMessageTimestamp' => <DateTime>, 'Metadata' => '<string>', 'Mode' => 'UNRESTRICTED|RESTRICTED', 'Name' => '<string>', 'Privacy' => 'PUBLIC|PRIVATE', ], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ChannelMemberships
-
- Type: Array of ChannelMembershipForAppInstanceUserSummary structures
The information for the requested channel memberships.
- NextToken
-
- Type: string
The token passed by previous API calls until all requested users are returned.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListChannelMessages
$result = $client->listChannelMessages
([/* ... */]); $promise = $client->listChannelMessagesAsync
([/* ... */]);
List all the messages in a channel. Returns a paginated list of ChannelMessages
. By default, sorted by creation timestamp in descending order.
Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMessages, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listChannelMessages([ 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', 'NotAfter' => <integer || string || DateTime>, 'NotBefore' => <integer || string || DateTime>, 'SortOrder' => 'ASCENDING|DESCENDING', ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the channel.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call. - MaxResults
-
- Type: int
The maximum number of messages that you want returned.
- NextToken
-
- Type: string
The token passed by previous API calls until all requested messages are returned.
- NotAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The final or ending time stamp for your requested messages.
- NotBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The initial or starting time stamp for your requested messages.
- SortOrder
-
- Type: string
The order in which you want messages sorted. Default is Descending, based on time created.
Result Syntax
[ 'ChannelArn' => '<string>', 'ChannelMessages' => [ [ 'Content' => '<string>', 'CreatedTimestamp' => <DateTime>, 'LastEditedTimestamp' => <DateTime>, 'LastUpdatedTimestamp' => <DateTime>, 'MessageId' => '<string>', 'Metadata' => '<string>', 'Redacted' => true || false, 'Sender' => [ 'Arn' => '<string>', 'Name' => '<string>', ], 'Type' => 'STANDARD|CONTROL', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ChannelArn
-
- Type: string
The ARN of the channel containing the requested messages.
- ChannelMessages
-
- Type: Array of ChannelMessageSummary structures
The information about, and content of, each requested message.
- NextToken
-
- Type: string
The token passed by previous API calls until all requested messages are returned.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListChannelModerators
$result = $client->listChannelModerators
([/* ... */]); $promise = $client->listChannelModeratorsAsync
([/* ... */]);
Lists all the moderators for a channel.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelModerators, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listChannelModerators([ 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the channel.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call. - MaxResults
-
- Type: int
The maximum number of moderators that you want returned.
- NextToken
-
- Type: string
The token passed by previous API calls until all requested moderators are returned.
Result Syntax
[ 'ChannelArn' => '<string>', 'ChannelModerators' => [ [ 'Moderator' => [ 'Arn' => '<string>', 'Name' => '<string>', ], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ChannelArn
-
- Type: string
The ARN of the channel.
- ChannelModerators
-
- Type: Array of ChannelModeratorSummary structures
The information about and names of each moderator.
- NextToken
-
- Type: string
The token passed by previous API calls until all requested moderators are returned.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListChannels
$result = $client->listChannels
([/* ... */]); $promise = $client->listChannelsAsync
([/* ... */]);
Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
-
Use privacy =
PUBLIC
to retrieve all public channels in the account. -
Only an
AppInstanceAdmin
can set privacy =PRIVATE
to list the private channels in an account.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannels, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listChannels([ 'AppInstanceArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', 'Privacy' => 'PUBLIC|PRIVATE', ]);
Parameter Details
Members
- AppInstanceArn
-
- Required: Yes
- Type: string
The ARN of the
AppInstance
. - ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call. - MaxResults
-
- Type: int
The maximum number of channels that you want to return.
- NextToken
-
- Type: string
The token passed by previous API calls until all requested channels are returned.
- Privacy
-
- Type: string
The privacy setting.
PUBLIC
retrieves all the public channels.PRIVATE
retrieves private channels. Only anAppInstanceAdmin
can retrieve private channels.
Result Syntax
[ 'Channels' => [ [ 'ChannelArn' => '<string>', 'LastMessageTimestamp' => <DateTime>, 'Metadata' => '<string>', 'Mode' => 'UNRESTRICTED|RESTRICTED', 'Name' => '<string>', 'Privacy' => 'PUBLIC|PRIVATE', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- Channels
-
- Type: Array of ChannelSummary structures
The information about each channel.
- NextToken
-
- Type: string
The token returned from previous API requests until the number of channels is reached.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListChannelsModeratedByAppInstanceUser
$result = $client->listChannelsModeratedByAppInstanceUser
([/* ... */]); $promise = $client->listChannelsModeratedByAppInstanceUserAsync
([/* ... */]);
A list of the channels moderated by an AppInstanceUser
.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelsModeratedByAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listChannelsModeratedByAppInstanceUser([ 'AppInstanceUserArn' => '<string>', 'ChimeBearer' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- AppInstanceUserArn
-
- Type: string
The ARN of the user in the moderated channel.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call. - MaxResults
-
- Type: int
The maximum number of channels in the request.
- NextToken
-
- Type: string
The token returned from previous API requests until the number of channels moderated by the user is reached.
Result Syntax
[ 'Channels' => [ [ 'ChannelSummary' => [ 'ChannelArn' => '<string>', 'LastMessageTimestamp' => <DateTime>, 'Metadata' => '<string>', 'Mode' => 'UNRESTRICTED|RESTRICTED', 'Name' => '<string>', 'Privacy' => 'PUBLIC|PRIVATE', ], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- Channels
-
- Type: Array of ChannelModeratedByAppInstanceUserSummary structures
The moderated channels in the request.
- NextToken
-
- Type: string
The token returned from previous API requests until the number of channels moderated by the user is reached.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListMediaCapturePipelines
$result = $client->listMediaCapturePipelines
([/* ... */]); $promise = $client->listMediaCapturePipelinesAsync
([/* ... */]);
Returns a list of media capture pipelines.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListMediaCapturePipelines, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listMediaCapturePipelines([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return in a single call. Valid Range: 1 - 99.
- NextToken
-
- Type: string
The token used to retrieve the next page of results.
Result Syntax
[ 'MediaCapturePipelines' => [ [ 'ChimeSdkMeetingConfiguration' => [ 'ArtifactsConfiguration' => [ 'Audio' => [ 'MuxType' => 'AudioOnly|AudioWithActiveSpeakerVideo', ], 'Content' => [ 'MuxType' => 'ContentOnly', 'State' => 'Enabled|Disabled', ], 'Video' => [ 'MuxType' => 'VideoOnly', 'State' => 'Enabled|Disabled', ], ], 'SourceConfiguration' => [ 'SelectedVideoStreams' => [ 'AttendeeIds' => ['<string>', ...], 'ExternalUserIds' => ['<string>', ...], ], ], ], 'CreatedTimestamp' => <DateTime>, 'MediaPipelineId' => '<string>', 'SinkArn' => '<string>', 'SinkType' => 'S3Bucket', 'SourceArn' => '<string>', 'SourceType' => 'ChimeSdkMeeting', 'Status' => 'Initializing|InProgress|Failed|Stopping|Stopped', 'UpdatedTimestamp' => <DateTime>, ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- MediaCapturePipelines
-
- Type: Array of MediaCapturePipeline structures
The media capture pipeline objects in the list.
- NextToken
-
- Type: string
The token used to retrieve the next page of results.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListMeetingTags
$result = $client->listMeetingTags
([/* ... */]); $promise = $client->listMeetingTagsAsync
([/* ... */]);
Lists the tags applied to an Amazon Chime SDK meeting resource.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListTagsForResource, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listMeetingTags([ 'MeetingId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MeetingId
-
- Required: Yes
- Type: string
The Amazon Chime SDK meeting ID.
Result Syntax
[ 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- Tags
-
- Type: Array of Tag structures
A list of tag key-value pairs.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListMeetings
$result = $client->listMeetings
([/* ... */]); $promise = $client->listMeetingsAsync
([/* ... */]);
Lists up to 100 active Amazon Chime SDK meetings.
ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.
For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listMeetings([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return in a single call.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
Result Syntax
[ 'Meetings' => [ [ 'ExternalMeetingId' => '<string>', 'MediaPlacement' => [ 'AudioFallbackUrl' => '<string>', 'AudioHostUrl' => '<string>', 'EventIngestionUrl' => '<string>', 'ScreenDataUrl' => '<string>', 'ScreenSharingUrl' => '<string>', 'ScreenViewingUrl' => '<string>', 'SignalingUrl' => '<string>', 'TurnControlUrl' => '<string>', ], 'MediaRegion' => '<string>', 'MeetingId' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- Meetings
-
- Type: Array of Meeting structures
The Amazon Chime SDK meeting information.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListPhoneNumberOrders
$result = $client->listPhoneNumberOrders
([/* ... */]); $promise = $client->listPhoneNumberOrdersAsync
([/* ... */]);
Lists the phone number orders for the administrator's Amazon Chime account.
Parameter Syntax
$result = $client->listPhoneNumberOrders([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return in a single call.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
Result Syntax
[ 'NextToken' => '<string>', 'PhoneNumberOrders' => [ [ 'CreatedTimestamp' => <DateTime>, 'OrderedPhoneNumbers' => [ [ 'E164PhoneNumber' => '<string>', 'Status' => 'Processing|Acquired|Failed', ], // ... ], 'PhoneNumberOrderId' => '<string>', 'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn', 'Status' => 'Processing|Successful|Failed|Partial', 'UpdatedTimestamp' => <DateTime>, ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
- PhoneNumberOrders
-
- Type: Array of PhoneNumberOrder structures
The phone number order details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListPhoneNumbers
$result = $client->listPhoneNumbers
([/* ... */]); $promise = $client->listPhoneNumbersAsync
([/* ... */]);
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
Parameter Syntax
$result = $client->listPhoneNumbers([ 'FilterName' => 'AccountId|UserId|VoiceConnectorId|VoiceConnectorGroupId|SipRuleId', 'FilterValue' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', 'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn', 'Status' => 'AcquireInProgress|AcquireFailed|Unassigned|Assigned|ReleaseInProgress|DeleteInProgress|ReleaseFailed|DeleteFailed', ]);
Parameter Details
Members
- FilterName
-
- Type: string
The filter to use to limit the number of results.
- FilterValue
-
- Type: string
The value to use for the filter.
- MaxResults
-
- Type: int
The maximum number of results to return in a single call.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
- ProductType
-
- Type: string
The phone number product type.
- Status
-
- Type: string
The phone number status.
Result Syntax
[ 'NextToken' => '<string>', 'PhoneNumbers' => [ [ 'Associations' => [ [ 'AssociatedTimestamp' => <DateTime>, 'Name' => 'AccountId|UserId|VoiceConnectorId|VoiceConnectorGroupId|SipRuleId', 'Value' => '<string>', ], // ... ], 'CallingName' => '<string>', 'CallingNameStatus' => 'Unassigned|UpdateInProgress|UpdateSucceeded|UpdateFailed', 'Capabilities' => [ 'InboundCall' => true || false, 'InboundMMS' => true || false, 'InboundSMS' => true || false, 'OutboundCall' => true || false, 'OutboundMMS' => true || false, 'OutboundSMS' => true || false, ], 'Country' => '<string>', 'CreatedTimestamp' => <DateTime>, 'DeletionTimestamp' => <DateTime>, 'E164PhoneNumber' => '<string>', 'PhoneNumberId' => '<string>', 'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn', 'Status' => 'AcquireInProgress|AcquireFailed|Unassigned|Assigned|ReleaseInProgress|DeleteInProgress|ReleaseFailed|DeleteFailed', 'Type' => 'Local|TollFree', 'UpdatedTimestamp' => <DateTime>, ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
- PhoneNumbers
-
- Type: Array of PhoneNumber structures
The phone number details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListProxySessions
$result = $client->listProxySessions
([/* ... */]); $promise = $client->listProxySessionsAsync
([/* ... */]);
Lists the proxy sessions for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListProxySessions, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listProxySessions([ 'MaxResults' => <integer>, 'NextToken' => '<string>', 'Status' => 'Open|InProgress|Closed', 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return in a single call.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
- Status
-
- Type: string
The proxy session status.
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime voice connector ID.
Result Syntax
[ 'NextToken' => '<string>', 'ProxySessions' => [ [ 'Capabilities' => ['<string>', ...], 'CreatedTimestamp' => <DateTime>, 'EndedTimestamp' => <DateTime>, 'ExpiryMinutes' => <integer>, 'GeoMatchLevel' => 'Country|AreaCode', 'GeoMatchParams' => [ 'AreaCode' => '<string>', 'Country' => '<string>', ], 'Name' => '<string>', 'NumberSelectionBehavior' => 'PreferSticky|AvoidSticky', 'Participants' => [ [ 'PhoneNumber' => '<string>', 'ProxyPhoneNumber' => '<string>', ], // ... ], 'ProxySessionId' => '<string>', 'Status' => 'Open|InProgress|Closed', 'UpdatedTimestamp' => <DateTime>, 'VoiceConnectorId' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
- ProxySessions
-
- Type: Array of ProxySession structures
The proxy session details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListRoomMemberships
$result = $client->listRoomMemberships
([/* ... */]); $promise = $client->listRoomMembershipsAsync
([/* ... */]);
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
Parameter Syntax
$result = $client->listRoomMemberships([ 'AccountId' => '<string>', // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', 'RoomId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- MaxResults
-
- Type: int
The maximum number of results to return in a single call.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
- RoomId
-
- Required: Yes
- Type: string
The room ID.
Result Syntax
[ 'NextToken' => '<string>', 'RoomMemberships' => [ [ 'InvitedBy' => '<string>', 'Member' => [ 'AccountId' => '<string>', 'Email' => '<string>', 'FullName' => '<string>', 'MemberId' => '<string>', 'MemberType' => 'User|Bot|Webhook', ], 'Role' => 'Administrator|Member', 'RoomId' => '<string>', 'UpdatedTimestamp' => <DateTime>, ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
- RoomMemberships
-
- Type: Array of RoomMembership structures
The room membership details.
Errors
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListRooms
$result = $client->listRooms
([/* ... */]); $promise = $client->listRoomsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listRooms([ 'AccountId' => '<string>', // REQUIRED 'MaxResults' => <integer>, 'MemberId' => '<string>', 'NextToken' => '<string>', ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- MaxResults
-
- Type: int
The maximum number of results to return in a single call.
- MemberId
-
- Type: string
The member ID (user ID or bot ID).
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
Result Syntax
[ 'NextToken' => '<string>', 'Rooms' => [ [ 'AccountId' => '<string>', 'CreatedBy' => '<string>', 'CreatedTimestamp' => <DateTime>, 'Name' => '<string>', 'RoomId' => '<string>', 'UpdatedTimestamp' => <DateTime>, ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
- Rooms
-
- Type: Array of Room structures
The room details.
Errors
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListSipMediaApplications
$result = $client->listSipMediaApplications
([/* ... */]); $promise = $client->listSipMediaApplicationsAsync
([/* ... */]);
Lists the SIP media applications under the administrator's AWS account.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListSipMediaApplications, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listSipMediaApplications([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return in a single call. Defaults to 100.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
Result Syntax
[ 'NextToken' => '<string>', 'SipMediaApplications' => [ [ 'AwsRegion' => '<string>', 'CreatedTimestamp' => <DateTime>, 'Endpoints' => [ [ 'LambdaArn' => '<string>', ], // ... ], 'Name' => '<string>', 'SipMediaApplicationId' => '<string>', 'UpdatedTimestamp' => <DateTime>, ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
- SipMediaApplications
-
- Type: Array of SipMediaApplication structures
List of SIP media applications and application details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListSipRules
$result = $client->listSipRules
([/* ... */]); $promise = $client->listSipRulesAsync
([/* ... */]);
Lists the SIP rules under the administrator's AWS account.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListSipRules, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listSipRules([ 'MaxResults' => <integer>, 'NextToken' => '<string>', 'SipMediaApplicationId' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return in a single call. Defaults to 100.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
- SipMediaApplicationId
-
- Type: string
The SIP media application ID.
Result Syntax
[ 'NextToken' => '<string>', 'SipRules' => [ [ 'CreatedTimestamp' => <DateTime>, 'Disabled' => true || false, 'Name' => '<string>', 'SipRuleId' => '<string>', 'TargetApplications' => [ [ 'AwsRegion' => '<string>', 'Priority' => <integer>, 'SipMediaApplicationId' => '<string>', ], // ... ], 'TriggerType' => 'ToPhoneNumber|RequestUriHostname', 'TriggerValue' => '<string>', 'UpdatedTimestamp' => <DateTime>, ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
- SipRules
-
- Type: Array of SipRule structures
List of SIP rules and rule details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListSupportedPhoneNumberCountries
$result = $client->listSupportedPhoneNumberCountries
([/* ... */]); $promise = $client->listSupportedPhoneNumberCountriesAsync
([/* ... */]);
Lists supported phone number countries.
Parameter Syntax
$result = $client->listSupportedPhoneNumberCountries([ 'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn', // REQUIRED ]);
Parameter Details
Members
- ProductType
-
- Required: Yes
- Type: string
The phone number product type.
Result Syntax
[ 'PhoneNumberCountries' => [ [ 'CountryCode' => '<string>', 'SupportedPhoneNumberTypes' => ['<string>', ...], ], // ... ], ]
Result Details
Members
- PhoneNumberCountries
-
- Type: Array of PhoneNumberCountry structures
The supported phone number countries.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- AccessDeniedException:
You don't have permissions to perform the requested operation.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Lists the tags applied to an Amazon Chime SDK meeting and messaging resources.
This API is is no longer supported and will not be updated. We recommend using the applicable latest version in the Amazon Chime SDK.
-
For meetings: ListTagsForResource.
-
For messaging: ListTagsForResource.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listTagsForResource([ 'ResourceARN' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ResourceARN
-
- Required: Yes
- Type: string
The resource ARN.
Result Syntax
[ 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- Tags
-
- Type: Array of Tag structures
A list of tag-key value pairs.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListUsers
$result = $client->listUsers
([/* ... */]); $promise = $client->listUsersAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listUsers([ 'AccountId' => '<string>', // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', 'UserEmail' => '<string>', 'UserType' => 'PrivateUser|SharedDevice', ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- MaxResults
-
- Type: int
The maximum number of results to return in a single call. Defaults to 100.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
- UserEmail
-
- Type: string
Optional. The user email address used to filter results. Maximum 1.
- UserType
-
- Type: string
The user type.
Result Syntax
[ 'NextToken' => '<string>', 'Users' => [ [ 'AccountId' => '<string>', 'AlexaForBusinessMetadata' => [ 'AlexaForBusinessRoomArn' => '<string>', 'IsAlexaForBusinessEnabled' => true || false, ], 'DisplayName' => '<string>', 'InvitedOn' => <DateTime>, 'LicenseType' => 'Basic|Plus|Pro|ProTrial', 'PersonalPIN' => '<string>', 'PrimaryEmail' => '<string>', 'PrimaryProvisionedNumber' => '<string>', 'RegisteredOn' => <DateTime>, 'UserId' => '<string>', 'UserInvitationStatus' => 'Pending|Accepted|Failed', 'UserRegistrationStatus' => 'Unregistered|Registered|Suspended', 'UserType' => 'PrivateUser|SharedDevice', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
- Users
-
- Type: Array of User structures
List of users and user details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListVoiceConnectorGroups
$result = $client->listVoiceConnectorGroups
([/* ... */]); $promise = $client->listVoiceConnectorGroupsAsync
([/* ... */]);
Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectorGroups, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listVoiceConnectorGroups([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return in a single call.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
Result Syntax
[ 'NextToken' => '<string>', 'VoiceConnectorGroups' => [ [ 'CreatedTimestamp' => <DateTime>, 'Name' => '<string>', 'UpdatedTimestamp' => <DateTime>, 'VoiceConnectorGroupArn' => '<string>', 'VoiceConnectorGroupId' => '<string>', 'VoiceConnectorItems' => [ [ 'Priority' => <integer>, 'VoiceConnectorId' => '<string>', ], // ... ], ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
- VoiceConnectorGroups
-
- Type: Array of VoiceConnectorGroup structures
The details of the Amazon Chime Voice Connector groups.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListVoiceConnectorTerminationCredentials
$result = $client->listVoiceConnectorTerminationCredentials
([/* ... */]); $promise = $client->listVoiceConnectorTerminationCredentialsAsync
([/* ... */]);
Lists the SIP credentials for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectorTerminationCredentials, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listVoiceConnectorTerminationCredentials([ 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[ 'Usernames' => ['<string>', ...], ]
Result Details
Members
- Usernames
-
- Type: Array of strings
A list of user names.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
ListVoiceConnectors
$result = $client->listVoiceConnectors
([/* ... */]); $promise = $client->listVoiceConnectorsAsync
([/* ... */]);
Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectors, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->listVoiceConnectors([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return in a single call.
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
Result Syntax
[ 'NextToken' => '<string>', 'VoiceConnectors' => [ [ 'AwsRegion' => 'us-east-1|us-west-2', 'CreatedTimestamp' => <DateTime>, 'Name' => '<string>', 'OutboundHostName' => '<string>', 'RequireEncryption' => true || false, 'UpdatedTimestamp' => <DateTime>, 'VoiceConnectorArn' => '<string>', 'VoiceConnectorId' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results.
- VoiceConnectors
-
- Type: Array of VoiceConnector structures
The details of the Amazon Chime Voice Connectors.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
LogoutUser
$result = $client->logoutUser
([/* ... */]); $promise = $client->logoutUserAsync
([/* ... */]);
Logs out the specified user from all of the devices they are currently logged into.
Parameter Syntax
$result = $client->logoutUser([ 'AccountId' => '<string>', // REQUIRED 'UserId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- UserId
-
- Required: Yes
- Type: string
The user ID.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
PutAppInstanceRetentionSettings
$result = $client->putAppInstanceRetentionSettings
([/* ... */]); $promise = $client->putAppInstanceRetentionSettingsAsync
([/* ... */]);
Sets the amount of time in days that a given AppInstance
retains data.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutAppInstanceRetentionSettings, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->putAppInstanceRetentionSettings([ 'AppInstanceArn' => '<string>', // REQUIRED 'AppInstanceRetentionSettings' => [ // REQUIRED 'ChannelRetentionSettings' => [ 'RetentionDays' => <integer>, ], ], ]);
Parameter Details
Members
- AppInstanceArn
-
- Required: Yes
- Type: string
The ARN of the
AppInstance
. - AppInstanceRetentionSettings
-
- Required: Yes
- Type: AppInstanceRetentionSettings structure
The time in days to retain data. Data type: number.
Result Syntax
[ 'AppInstanceRetentionSettings' => [ 'ChannelRetentionSettings' => [ 'RetentionDays' => <integer>, ], ], 'InitiateDeletionTimestamp' => <DateTime>, ]
Result Details
Members
- AppInstanceRetentionSettings
-
- Type: AppInstanceRetentionSettings structure
The time in days to retain data. Data type: number.
- InitiateDeletionTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the API deletes data.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
PutAppInstanceStreamingConfigurations
$result = $client->putAppInstanceStreamingConfigurations
([/* ... */]); $promise = $client->putAppInstanceStreamingConfigurationsAsync
([/* ... */]);
The data streaming configurations of an AppInstance
.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutMessagingStreamingConfigurations, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->putAppInstanceStreamingConfigurations([ 'AppInstanceArn' => '<string>', // REQUIRED 'AppInstanceStreamingConfigurations' => [ // REQUIRED [ 'AppInstanceDataType' => 'Channel|ChannelMessage', // REQUIRED 'ResourceArn' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- AppInstanceArn
-
- Required: Yes
- Type: string
The ARN of the
AppInstance
. - AppInstanceStreamingConfigurations
-
- Required: Yes
- Type: Array of AppInstanceStreamingConfiguration structures
The streaming configurations set for an
AppInstance
.
Result Syntax
[ 'AppInstanceStreamingConfigurations' => [ [ 'AppInstanceDataType' => 'Channel|ChannelMessage', 'ResourceArn' => '<string>', ], // ... ], ]
Result Details
Members
- AppInstanceStreamingConfigurations
-
- Type: Array of AppInstanceStreamingConfiguration structures
The streaming configurations of an
AppInstance
.
Errors
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
PutEventsConfiguration
$result = $client->putEventsConfiguration
([/* ... */]); $promise = $client->putEventsConfigurationAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->putEventsConfiguration([ 'AccountId' => '<string>', // REQUIRED 'BotId' => '<string>', // REQUIRED 'LambdaFunctionArn' => '<string>', 'OutboundEventsHTTPSEndpoint' => '<string>', ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- BotId
-
- Required: Yes
- Type: string
The bot ID.
- LambdaFunctionArn
-
- Type: string
Lambda function ARN that allows the bot to receive outgoing events.
- OutboundEventsHTTPSEndpoint
-
- Type: string
HTTPS endpoint that allows the bot to receive outgoing events.
Result Syntax
[ 'EventsConfiguration' => [ 'BotId' => '<string>', 'LambdaFunctionArn' => '<string>', 'OutboundEventsHTTPSEndpoint' => '<string>', ], ]
Result Details
Members
- EventsConfiguration
-
- Type: EventsConfiguration structure
The configuration that allows a bot to receive outgoing events. Can be an HTTPS endpoint or an AWS Lambda function ARN.
Errors
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
PutRetentionSettings
$result = $client->putRetentionSettings
([/* ... */]); $promise = $client->putRetentionSettingsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->putRetentionSettings([ 'AccountId' => '<string>', // REQUIRED 'RetentionSettings' => [ // REQUIRED 'ConversationRetentionSettings' => [ 'RetentionDays' => <integer>, ], 'RoomRetentionSettings' => [ 'RetentionDays' => <integer>, ], ], ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- RetentionSettings
-
- Required: Yes
- Type: RetentionSettings structure
The retention settings.
Result Syntax
[ 'InitiateDeletionTimestamp' => <DateTime>, 'RetentionSettings' => [ 'ConversationRetentionSettings' => [ 'RetentionDays' => <integer>, ], 'RoomRetentionSettings' => [ 'RetentionDays' => <integer>, ], ], ]
Result Details
Members
- InitiateDeletionTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.
- RetentionSettings
-
- Type: RetentionSettings structure
The retention settings.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- ConflictException:
The request could not be processed because of conflict in the current state of the resource.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
PutSipMediaApplicationLoggingConfiguration
$result = $client->putSipMediaApplicationLoggingConfiguration
([/* ... */]); $promise = $client->putSipMediaApplicationLoggingConfigurationAsync
([/* ... */]);
Updates the logging configuration for the specified SIP media application.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutSipMediaApplicationLoggingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->putSipMediaApplicationLoggingConfiguration([ 'SipMediaApplicationId' => '<string>', // REQUIRED 'SipMediaApplicationLoggingConfiguration' => [ 'EnableSipMediaApplicationMessageLogs' => true || false, ], ]);
Parameter Details
Members
- SipMediaApplicationId
-
- Required: Yes
- Type: string
The SIP media application ID.
- SipMediaApplicationLoggingConfiguration
-
- Type: SipMediaApplicationLoggingConfiguration structure
The actual logging configuration.
Result Syntax
[ 'SipMediaApplicationLoggingConfiguration' => [ 'EnableSipMediaApplicationMessageLogs' => true || false, ], ]
Result Details
Members
- SipMediaApplicationLoggingConfiguration
-
- Type: SipMediaApplicationLoggingConfiguration structure
The logging configuration of the SIP media application.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
PutVoiceConnectorEmergencyCallingConfiguration
$result = $client->putVoiceConnectorEmergencyCallingConfiguration
([/* ... */]); $promise = $client->putVoiceConnectorEmergencyCallingConfigurationAsync
([/* ... */]);
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->putVoiceConnectorEmergencyCallingConfiguration([ 'EmergencyCallingConfiguration' => [ // REQUIRED 'DNIS' => [ [ 'CallingCountry' => '<string>', // REQUIRED 'EmergencyPhoneNumber' => '<string>', // REQUIRED 'TestPhoneNumber' => '<string>', ], // ... ], ], 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- EmergencyCallingConfiguration
-
- Required: Yes
- Type: EmergencyCallingConfiguration structure
The emergency calling configuration details.
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[ 'EmergencyCallingConfiguration' => [ 'DNIS' => [ [ 'CallingCountry' => '<string>', 'EmergencyPhoneNumber' => '<string>', 'TestPhoneNumber' => '<string>', ], // ... ], ], ]
Result Details
Members
- EmergencyCallingConfiguration
-
- Type: EmergencyCallingConfiguration structure
The emergency calling configuration details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
PutVoiceConnectorLoggingConfiguration
$result = $client->putVoiceConnectorLoggingConfiguration
([/* ... */]); $promise = $client->putVoiceConnectorLoggingConfigurationAsync
([/* ... */]);
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->putVoiceConnectorLoggingConfiguration([ 'LoggingConfiguration' => [ // REQUIRED 'EnableMediaMetricLogs' => true || false, 'EnableSIPLogs' => true || false, ], 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- LoggingConfiguration
-
- Required: Yes
- Type: LoggingConfiguration structure
The logging configuration details to add.
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[ 'LoggingConfiguration' => [ 'EnableMediaMetricLogs' => true || false, 'EnableSIPLogs' => true || false, ], ]
Result Details
Members
- LoggingConfiguration
-
- Type: LoggingConfiguration structure
The updated logging configuration details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
PutVoiceConnectorOrigination
$result = $client->putVoiceConnectorOrigination
([/* ... */]); $promise = $client->putVoiceConnectorOriginationAsync
([/* ... */]);
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorOrigination, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->putVoiceConnectorOrigination([ 'Origination' => [ // REQUIRED 'Disabled' => true || false, 'Routes' => [ [ 'Host' => '<string>', 'Port' => <integer>, 'Priority' => <integer>, 'Protocol' => 'TCP|UDP', 'Weight' => <integer>, ], // ... ], ], 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Origination
-
- Required: Yes
- Type: Origination structure
The origination setting details to add.
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[ 'Origination' => [ 'Disabled' => true || false, 'Routes' => [ [ 'Host' => '<string>', 'Port' => <integer>, 'Priority' => <integer>, 'Protocol' => 'TCP|UDP', 'Weight' => <integer>, ], // ... ], ], ]
Result Details
Members
- Origination
-
- Type: Origination structure
The updated origination setting details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
PutVoiceConnectorProxy
$result = $client->putVoiceConnectorProxy
([/* ... */]); $promise = $client->putVoiceConnectorProxyAsync
([/* ... */]);
Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorProxy, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->putVoiceConnectorProxy([ 'DefaultSessionExpiryMinutes' => <integer>, // REQUIRED 'Disabled' => true || false, 'FallBackPhoneNumber' => '<string>', 'PhoneNumberPoolCountries' => ['<string>', ...], // REQUIRED 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DefaultSessionExpiryMinutes
-
- Required: Yes
- Type: int
The default number of minutes allowed for proxy sessions.
- Disabled
-
- Type: boolean
When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
- FallBackPhoneNumber
-
- Type: string
The phone number to route calls to after a proxy session expires.
- PhoneNumberPoolCountries
-
- Required: Yes
- Type: Array of strings
The countries for proxy phone numbers to be selected from.
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime voice connector ID.
Result Syntax
[ 'Proxy' => [ 'DefaultSessionExpiryMinutes' => <integer>, 'Disabled' => true || false, 'FallBackPhoneNumber' => '<string>', 'PhoneNumberCountries' => ['<string>', ...], ], ]
Result Details
Members
- Proxy
-
- Type: Proxy structure
The proxy configuration details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- AccessDeniedException:
You don't have permissions to perform the requested operation.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
PutVoiceConnectorStreamingConfiguration
$result = $client->putVoiceConnectorStreamingConfiguration
([/* ... */]); $promise = $client->putVoiceConnectorStreamingConfigurationAsync
([/* ... */]);
Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->putVoiceConnectorStreamingConfiguration([ 'StreamingConfiguration' => [ // REQUIRED 'DataRetentionInHours' => <integer>, // REQUIRED 'Disabled' => true || false, 'StreamingNotificationTargets' => [ [ 'NotificationTarget' => 'EventBridge|SNS|SQS', // REQUIRED ], // ... ], ], 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- StreamingConfiguration
-
- Required: Yes
- Type: StreamingConfiguration structure
The streaming configuration details to add.
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[ 'StreamingConfiguration' => [ 'DataRetentionInHours' => <integer>, 'Disabled' => true || false, 'StreamingNotificationTargets' => [ [ 'NotificationTarget' => 'EventBridge|SNS|SQS', ], // ... ], ], ]
Result Details
Members
- StreamingConfiguration
-
- Type: StreamingConfiguration structure
The updated streaming configuration details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
PutVoiceConnectorTermination
$result = $client->putVoiceConnectorTermination
([/* ... */]); $promise = $client->putVoiceConnectorTerminationAsync
([/* ... */]);
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.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorTermination, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->putVoiceConnectorTermination([ 'Termination' => [ // REQUIRED 'CallingRegions' => ['<string>', ...], 'CidrAllowedList' => ['<string>', ...], 'CpsLimit' => <integer>, 'DefaultPhoneNumber' => '<string>', 'Disabled' => true || false, ], 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Termination
-
- Required: Yes
- Type: Termination structure
The termination setting details to add.
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[ 'Termination' => [ 'CallingRegions' => ['<string>', ...], 'CidrAllowedList' => ['<string>', ...], 'CpsLimit' => <integer>, 'DefaultPhoneNumber' => '<string>', 'Disabled' => true || false, ], ]
Result Details
Members
- Termination
-
- Type: Termination structure
The updated termination setting details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- AccessDeniedException:
You don't have permissions to perform the requested operation.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
PutVoiceConnectorTerminationCredentials
$result = $client->putVoiceConnectorTerminationCredentials
([/* ... */]); $promise = $client->putVoiceConnectorTerminationCredentialsAsync
([/* ... */]);
Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorTerminationCredentials, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->putVoiceConnectorTerminationCredentials([ 'Credentials' => [ [ 'Password' => '<string>', 'Username' => '<string>', ], // ... ], 'VoiceConnectorId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Credentials
-
- Type: Array of Credential structures
The termination SIP credentials.
- VoiceConnectorId
-
- Required: Yes
- Type: string
The Amazon Chime Voice Connector ID.
Result Syntax
[]
Result Details
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
RedactChannelMessage
$result = $client->redactChannelMessage
([/* ... */]); $promise = $client->redactChannelMessageAsync
([/* ... */]);
Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, RedactChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->redactChannelMessage([ 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', 'MessageId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ChannelArn
-
- Required: Yes
- Type: string
The ARN of the channel containing the messages that you want to redact.
- ChimeBearer
-
- Type: string
The
AppInstanceUserArn
of the user that makes the API call. - MessageId
-
- Required: Yes
- Type: string
The ID of the message being redacted.
Result Syntax
[ 'ChannelArn' => '<string>', 'MessageId' => '<string>', ]
Result Details
Members
- ChannelArn
-
- Type: string
The ARN of the channel containing the messages that you want to redact.
- MessageId
-
- Type: string
The ID of the message being redacted.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
RedactConversationMessage
$result = $client->redactConversationMessage
([/* ... */]); $promise = $client->redactConversationMessageAsync
([/* ... */]);
Redacts the specified message from the specified Amazon Chime conversation.
Parameter Syntax
$result = $client->redactConversationMessage([ 'AccountId' => '<string>', // REQUIRED 'ConversationId' => '<string>', // REQUIRED 'MessageId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- ConversationId
-
- Required: Yes
- Type: string
The conversation ID.
- MessageId
-
- Required: Yes
- Type: string
The message ID.
Result Syntax
[]
Result Details
Errors
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
RedactRoomMessage
$result = $client->redactRoomMessage
([/* ... */]); $promise = $client->redactRoomMessageAsync
([/* ... */]);
Redacts the specified message from the specified Amazon Chime channel.
Parameter Syntax
$result = $client->redactRoomMessage([ 'AccountId' => '<string>', // REQUIRED 'MessageId' => '<string>', // REQUIRED 'RoomId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- MessageId
-
- Required: Yes
- Type: string
The message ID.
- RoomId
-
- Required: Yes
- Type: string
The room ID.
Result Syntax
[]
Result Details
Errors
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
RegenerateSecurityToken
$result = $client->regenerateSecurityToken
([/* ... */]); $promise = $client->regenerateSecurityTokenAsync
([/* ... */]);
Regenerates the security token for a bot.
Parameter Syntax
$result = $client->regenerateSecurityToken([ 'AccountId' => '<string>', // REQUIRED 'BotId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- BotId
-
- Required: Yes
- Type: string
The bot ID.
Result Syntax
[ 'Bot' => [ 'BotEmail' => '<string>', 'BotId' => '<string>', 'BotType' => 'ChatBot', 'CreatedTimestamp' => <DateTime>, 'Disabled' => true || false, 'DisplayName' => '<string>', 'SecurityToken' => '<string>', 'UpdatedTimestamp' => <DateTime>, 'UserId' => '<string>', ], ]
Result Details
Members
- Bot
-
- Type: Bot structure
A resource that allows Enterprise account administrators to configure an interface that receives events from Amazon Chime.
Errors
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ThrottledClientException:
The client exceeded its request rate limit.
ResetPersonalPIN
$result = $client->resetPersonalPIN
([/* ... */]); $promise = $client->resetPersonalPINAsync
([/* ... */]);
Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
Parameter Syntax
$result = $client->resetPersonalPIN([ 'AccountId' => '<string>', // REQUIRED 'UserId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The Amazon Chime account ID.
- UserId
-
- Required: Yes
- Type: string
The user ID.
Result Syntax
[ 'User' => [ 'AccountId' => '<string>', 'AlexaForBusinessMetadata' => [ 'AlexaForBusinessRoomArn' => '<string>', 'IsAlexaForBusinessEnabled' => true || false, ], 'DisplayName' => '<string>', 'InvitedOn' => <DateTime>, 'LicenseType' => 'Basic|Plus|Pro|ProTrial', 'PersonalPIN' => '<string>', 'PrimaryEmail' => '<string>', 'PrimaryProvisionedNumber' => '<string>', 'RegisteredOn' => <DateTime>, 'UserId' => '<string>', 'UserInvitationStatus' => 'Pending|Accepted|Failed', 'UserRegistrationStatus' => 'Unregistered|Registered|Suspended', 'UserType' => 'PrivateUser|SharedDevice', ], ]
Result Details
Members
- User
-
- Type: User structure
The user details and new personal meeting PIN.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
RestorePhoneNumber
$result = $client->restorePhoneNumber
([/* ... */]); $promise = $client->restorePhoneNumberAsync
([/* ... */]);
Moves a phone number from the Deletion queue back into the phone number Inventory.
Parameter Syntax
$result = $client->restorePhoneNumber([ 'PhoneNumberId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- PhoneNumberId
-
- Required: Yes
- Type: string
The phone number.
Result Syntax
[ 'PhoneNumber' => [ 'Associations' => [ [ 'AssociatedTimestamp' => <DateTime>, 'Name' => 'AccountId|UserId|VoiceConnectorId|VoiceConnectorGroupId|SipRuleId', 'Value' => '<string>', ], // ... ], 'CallingName' => '<string>', 'CallingNameStatus' => 'Unassigned|UpdateInProgress|UpdateSucceeded|UpdateFailed', 'Capabilities' => [ 'InboundCall' => true || false, 'InboundMMS' => true || false, 'InboundSMS' => true || false, 'OutboundCall' => true || false, 'OutboundMMS' => true || false, 'OutboundSMS' => true || false, ], 'Country' => '<string>', 'CreatedTimestamp' => <DateTime>, 'DeletionTimestamp' => <DateTime>, 'E164PhoneNumber' => '<string>', 'PhoneNumberId' => '<string>', 'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn', 'Status' => 'AcquireInProgress|AcquireFailed|Unassigned|Assigned|ReleaseInProgress|DeleteInProgress|ReleaseFailed|DeleteFailed', 'Type' => 'Local|TollFree', 'UpdatedTimestamp' => <DateTime>, ], ]
Result Details
Members
- PhoneNumber
-
- Type: PhoneNumber structure
The phone number details.
Errors
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- NotFoundException:
One or more of the resources in the request does not exist in the system.
- ForbiddenException:
The client is permanently forbidden from making the request.
- BadRequestException:
The input parameters don't match the service's restrictions.
- ThrottledClientException:
The client exceeded its request rate limit.
- ResourceLimitExceededException:
The request exceeds the resource limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
SearchAvailablePhoneNumbers
$result = $client->searchAvailablePhoneNumbers
([/* ... */]); $promise = $client->searchAvailablePhoneNumbersAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->searchAvailablePhoneNumbers([ 'AreaCode' => '<string>', 'City' => '<string>', 'Country' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', 'PhoneNumberType' => 'Local|TollFree', 'State' => '<string>', 'TollFreePrefix' => '<string>', ]);
Parameter Details
Members
- AreaCode
-
- Type: string
The area code used to filter results. Only applies to the US.
- City
-
- Type: string
The city used to filter results. Only applies to the US.
- Country
-
- Type: string
The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.
- MaxResults
-
- Type: int
The maximum number of results to return in a single call.
- NextToken
-
- Type: string
The token used to retrieve the next page of results.
- PhoneNumberType
-
- Type: string
The phone number type used to filter results. Required for non-US numbers.
- State
-
- Type: string
The state used to filter results. Required only if you provide
City
. Only applies to the US. - TollFreePrefix
-
- Type: string
The toll-free prefix that you use to filter results. Only applies to the US.
Result Syntax
[ 'E164PhoneNumbers' => ['<string>', ...], 'NextToken' => '<string>', ]
Result Details
Members
- E164PhoneNumbers
-
- Type: Array of strings
List of phone numbers, in E.164 format.
- NextToken
-
- Type: string
The token used to retrieve the next page of search results.
Errors
- BadRequestException:
The input parameters don't match the service's restrictions.
- ForbiddenException:
The client is permanently forbidden from making the request.
- AccessDeniedException:
You don't have permissions to perform the requested operation.
- UnauthorizedClientException:
The client is not currently authorized to make the request.
- ThrottledClientException:
The client exceeded its request rate limit.
- ServiceUnavailableException:
The service is currently unavailable.
- ServiceFailureException:
The service encountered an unexpected error.
SendChannelMessage
$result = $client->sendChannelMessage
([/* ... */]); $promise = $client->sendChannelMessageAsync
([/* ... */]);
Sends a message to a particular channel that the member is a part of.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
Also, STANDARD
messages can contain 4KB of data and the 1KB of metadata. CONTROL
messages can contain 30 bytes of data and no metadata.
This API is is no longer supported and will not be updated. We recommend using the latest version, SendChannelMessage, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Parameter Syntax
$result = $client->sendChannelMessage([ 'ChannelArn' => '<string>', // REQUIRED 'ChimeBearer' => '<string>', 'ClientRequestToken'