2024/07/12 - Amazon Chime - 129 new api methods
Returns the full details of a single ChannelModerator.
See also: AWS API Documentation
Request Syntax
client.describe_channel_moderator(
ChannelArn='string',
ChannelModeratorArn='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel.
string
[REQUIRED]
The ARN of the channel moderator.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelModerator': {
'Moderator': {
'Arn': 'string',
'Name': 'string'
},
'ChannelArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'CreatedBy': {
'Arn': 'string',
'Name': 'string'
}
}
}
Response Structure
(dict) --
ChannelModerator (dict) --
The details of the channel moderator.
Moderator (dict) --
The moderator's data.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
ChannelArn (string) --
The ARN of the moderator's channel.
CreatedTimestamp (datetime) --
The time at which the moderator was created.
CreatedBy (dict) --
The AppInstanceUser who created the moderator.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
List all AppInstanceUsers created under a single AppInstance.
See also: AWS API Documentation
Request Syntax
client.list_app_instance_users(
AppInstanceArn='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ARN of the AppInstance.
integer
The maximum number of requests that you want returned.
string
The token passed by previous API calls until all requested users are returned.
dict
Response Syntax
{
'AppInstanceArn': 'string',
'AppInstanceUsers': [
{
'AppInstanceUserArn': 'string',
'Name': 'string',
'Metadata': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AppInstanceArn (string) --
The ARN of the AppInstance.
AppInstanceUsers (list) --
The information for each requested AppInstanceUser.
(dict) --
Summary of the details of an AppInstanceUser.
AppInstanceUserArn (string) --
The ARN of the AppInstanceUser.
Name (string) --
The name of an AppInstanceUser.
Metadata (string) --
The metadata of the AppInstanceUser.
NextToken (string) --
The token passed by previous API calls until all requested users are returned.
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.disassociate_phone_numbers_from_voice_connector(
VoiceConnectorId='string',
E164PhoneNumbers=[
'string',
]
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
list
[REQUIRED]
List of phone numbers, in E.164 format.
(string) --
dict
Response Syntax
{
'PhoneNumberErrors': [
{
'PhoneNumberId': 'string',
'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
PhoneNumberErrors (list) --
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.
(dict) --
If the phone number 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.
PhoneNumberId (string) --
The phone number ID for which the action failed.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
Lists all channel memberships in a channel.
See also: AWS API Documentation
Request Syntax
client.list_channel_memberships(
ChannelArn='string',
Type='DEFAULT'|'HIDDEN',
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
string
[REQUIRED]
The maximum number of channel memberships that you want returned.
string
The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned.
integer
The maximum number of channel memberships that you want returned.
string
The token passed by previous API calls until all requested channel memberships are returned.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelArn': 'string',
'ChannelMemberships': [
{
'Member': {
'Arn': 'string',
'Name': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
ChannelMemberships (list) --
The information for the requested channel memberships.
(dict) --
Summary of the details of a ChannelMembership.
Member (dict) --
A member's summary data.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
NextToken (string) --
The token passed by previous API calls until all requested channel memberships are returned.
Creates up to 100 new attendees for an active Amazon Chime SDK meeting.
For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
See also: AWS API Documentation
Request Syntax
client.batch_create_attendee(
MeetingId='string',
Attendees=[
{
'ExternalUserId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
string
[REQUIRED]
The Amazon Chime SDK meeting ID.
list
[REQUIRED]
The request containing the attendees to create.
(dict) --
The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.
ExternalUserId (string) -- [REQUIRED]
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
Tags (list) --
The tag key-value pairs.
(dict) --
Describes a tag applied to a resource.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag.
dict
Response Syntax
{
'Attendees': [
{
'ExternalUserId': 'string',
'AttendeeId': 'string',
'JoinToken': 'string'
},
],
'Errors': [
{
'ExternalUserId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
Attendees (list) --
The attendee information, including attendees IDs and join tokens.
(dict) --
An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken . The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.
We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.
ExternalUserId (string) --
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
AttendeeId (string) --
The Amazon Chime SDK attendee ID.
JoinToken (string) --
The join token used by the Amazon Chime SDK attendee.
Errors (list) --
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.
(dict) --
The list of errors returned when errors are encountered during the BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, error codes, and error messages.
ExternalUserId (string) --
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
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.
See also: AWS API Documentation
Request Syntax
client.delete_attendee(
MeetingId='string',
AttendeeId='string'
)
string
[REQUIRED]
The Amazon Chime SDK meeting ID.
string
[REQUIRED]
The Amazon Chime SDK attendee ID.
None
Returns the full details of an AppInstanceAdmin.
See also: AWS API Documentation
Request Syntax
client.describe_app_instance_admin(
AppInstanceAdminArn='string',
AppInstanceArn='string'
)
string
[REQUIRED]
The ARN of the AppInstanceAdmin.
string
[REQUIRED]
The ARN of the AppInstance.
dict
Response Syntax
{
'AppInstanceAdmin': {
'Admin': {
'Arn': 'string',
'Name': 'string'
},
'AppInstanceArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
AppInstanceAdmin (dict) --
The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.
Admin (dict) --
The AppInstanceAdmin data.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
AppInstanceArn (string) --
The ARN of the AppInstance for which the user is an administrator.
CreatedTimestamp (datetime) --
The time at which an administrator was created.
Returns the full details of a channel ban.
See also: AWS API Documentation
Request Syntax
client.describe_channel_ban(
ChannelArn='string',
MemberArn='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel from which the user is banned.
string
[REQUIRED]
The ARN of the member being banned.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelBan': {
'Member': {
'Arn': 'string',
'Name': 'string'
},
'ChannelArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'CreatedBy': {
'Arn': 'string',
'Name': 'string'
}
}
}
Response Structure
(dict) --
ChannelBan (dict) --
The details of the ban.
Member (dict) --
The member being banned from the channel.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
ChannelArn (string) --
The ARN of the channel from which a member is being banned.
CreatedTimestamp (datetime) --
The time at which the ban was created.
CreatedBy (dict) --
The AppInstanceUser who created the ban.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Lists the tags applied to an Amazon Chime SDK meeting resource.
See also: AWS API Documentation
Request Syntax
client.list_meeting_tags(
MeetingId='string'
)
string
[REQUIRED]
The Amazon Chime SDK meeting ID.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Tags (list) --
A list of tag key-value pairs.
(dict) --
Describes a tag applied to a resource.
Key (string) --
The key of the tag.
Value (string) --
The value of the tag.
Updates details for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.update_voice_connector(
VoiceConnectorId='string',
Name='string',
RequireEncryption=True|False
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
string
[REQUIRED]
The name of the Amazon Chime Voice Connector.
boolean
[REQUIRED]
When enabled, requires encryption for the Amazon Chime Voice Connector.
dict
Response Syntax
{
'VoiceConnector': {
'VoiceConnectorId': 'string',
'AwsRegion': 'us-east-1'|'us-west-2',
'Name': 'string',
'OutboundHostName': 'string',
'RequireEncryption': True|False,
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'VoiceConnectorArn': 'string'
}
}
Response Structure
(dict) --
VoiceConnector (dict) --
The updated Amazon Chime Voice Connector details.
VoiceConnectorId (string) --
The Amazon Chime Voice Connector ID.
AwsRegion (string) --
The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.
Name (string) --
The name of the Amazon Chime Voice Connector.
OutboundHostName (string) --
The outbound host name for the Amazon Chime Voice Connector.
RequireEncryption (boolean) --
Designates whether encryption is required for the Amazon Chime Voice Connector.
CreatedTimestamp (datetime) --
The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
VoiceConnectorArn (string) --
The ARN of the specified Amazon Chime Voice Connector.
Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.
See also: AWS API Documentation
Request Syntax
client.validate_e911_address(
AwsAccountId='string',
StreetNumber='string',
StreetInfo='string',
City='string',
State='string',
Country='string',
PostalCode='string'
)
string
[REQUIRED]
The AWS account ID.
string
[REQUIRED]
The address street number, such as 200 or 2121.
string
[REQUIRED]
The address street information, such as 8th Avenue.
string
[REQUIRED]
The address city, such as Portland.
string
[REQUIRED]
The address state, such as ME.
string
[REQUIRED]
The address country, such as US.
string
[REQUIRED]
The address postal code, such as 04352.
dict
Response Syntax
{
'ValidationResult': 123,
'AddressExternalId': 'string',
'Address': {
'streetName': 'string',
'streetSuffix': 'string',
'postDirectional': 'string',
'preDirectional': 'string',
'streetNumber': 'string',
'city': 'string',
'state': 'string',
'postalCode': 'string',
'postalCodePlus4': 'string',
'country': 'string'
},
'CandidateAddressList': [
{
'streetInfo': 'string',
'streetNumber': 'string',
'city': 'string',
'state': 'string',
'postalCode': 'string',
'postalCodePlus4': 'string',
'country': 'string'
},
]
}
Response Structure
(dict) --
ValidationResult (integer) --
Number indicating the result of address validation. 0 means the address was perfect as is and successfully validated. 1 means the address was corrected. 2 means the address sent was not close enough and was not validated.
AddressExternalId (string) --
The ID that represents the address.
Address (dict) --
The validated address.
streetName (string) --
The address street, such as 8th Avenue.
streetSuffix (string) --
The address suffix, such as the N in 8th Avenue N.
postDirectional (string) --
An address suffix location, such as the S. Unit A in Central Park S. Unit A.
preDirectional (string) --
An address prefix location, such as the N in N. Third St..
streetNumber (string) --
The numeric portion of an address.
city (string) --
The city of an address.
state (string) --
The state of an address.
postalCode (string) --
The postal code of an address.
postalCodePlus4 (string) --
The Zip + 4 or postal code + 4 of an address.
country (string) --
The country of an address.
CandidateAddressList (list) --
The list of address suggestions.
(dict) --
A suggested address.
streetInfo (string) --
The street information of a candidate address
streetNumber (string) --
The numeric portion of a candidate address.
city (string) --
The city of a candidate address.
state (string) --
The state of a candidate address.
postalCode (string) --
The postal code of a candidate address.
postalCodePlus4 (string) --
The Zip + 4 or postal code + 4 of a candidate address.
country (string) --
The country of a candidate address.
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.
See also: AWS API Documentation
Request Syntax
client.delete_meeting(
MeetingId='string'
)
string
[REQUIRED]
The Amazon Chime SDK meeting ID.
None
Starts transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide.
If you specify an invalid configuration, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.
See also: AWS API Documentation
Request Syntax
client.start_meeting_transcription(
MeetingId='string',
TranscriptionConfiguration={
'EngineTranscribeSettings': {
'LanguageCode': 'en-US'|'en-GB'|'es-US'|'fr-CA'|'fr-FR'|'en-AU'|'it-IT'|'de-DE'|'pt-BR'|'ja-JP'|'ko-KR'|'zh-CN'|'th-TH'|'hi-IN',
'VocabularyFilterMethod': 'remove'|'mask'|'tag',
'VocabularyFilterName': 'string',
'VocabularyName': 'string',
'Region': 'us-east-2'|'us-east-1'|'us-west-2'|'ap-northeast-2'|'ap-southeast-2'|'ap-northeast-1'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'sa-east-1'|'auto',
'EnablePartialResultsStabilization': True|False,
'PartialResultsStability': 'low'|'medium'|'high',
'ContentIdentificationType': 'PII',
'ContentRedactionType': 'PII',
'PiiEntityTypes': 'string',
'LanguageModelName': 'string',
'IdentifyLanguage': True|False,
'LanguageOptions': 'string',
'PreferredLanguage': 'en-US'|'en-GB'|'es-US'|'fr-CA'|'fr-FR'|'en-AU'|'it-IT'|'de-DE'|'pt-BR'|'ja-JP'|'ko-KR'|'zh-CN'|'th-TH'|'hi-IN',
'VocabularyNames': 'string',
'VocabularyFilterNames': 'string'
},
'EngineTranscribeMedicalSettings': {
'LanguageCode': 'en-US',
'Specialty': 'PRIMARYCARE'|'CARDIOLOGY'|'NEUROLOGY'|'ONCOLOGY'|'RADIOLOGY'|'UROLOGY',
'Type': 'CONVERSATION'|'DICTATION',
'VocabularyName': 'string',
'Region': 'us-east-1'|'us-east-2'|'us-west-2'|'ap-southeast-2'|'ca-central-1'|'eu-west-1'|'auto',
'ContentIdentificationType': 'PHI'
}
}
)
string
[REQUIRED]
The unique ID of the meeting being transcribed.
dict
[REQUIRED]
The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.
EngineTranscribeSettings (dict) --
The transcription configuration settings passed to Amazon Transcribe.
LanguageCode (string) --
Specify the language code that represents the language spoken.
If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.
VocabularyFilterMethod (string) --
Specify how you want your vocabulary filter applied to your transcript.
To replace words with ***, choose mask.
To delete words, choose remove.
To flag words without changing them, choose tag.
VocabularyFilterName (string) --
Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.
If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.
If you include IdentifyLanguage and want to use one or more vocabulary filters with your transcription, use the VocabularyFilterNames parameter instead.
VocabularyName (string) --
Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.
If you use Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.
If you include IdentifyLanguage and want to use one or more custom vocabularies with your transcription, use the VocabularyNames parameter instead.
Region (string) --
The AWS Region in which to use Amazon Transcribe.
If you don't specify a Region, then the MediaRegion parameter of the CreateMeeting.html API will be used. However, if Amazon Transcribe is not available in the MediaRegion, then a TranscriptFailed event is sent.
Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion. For more information, refer to Choosing a transcription Region in the Amazon Chime SDK Developer Guide.
EnablePartialResultsStabilization (boolean) --
Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.
PartialResultsStability (string) --
Specify the level of stability to use when you enable partial results stabilization ( EnablePartialResultsStabilization).
Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.
ContentIdentificationType (string) --
Labels all personally identifiable information (PII) identified in your transcript. If you don't include PiiEntityTypes, all PII is identified.
You can’t set ContentIdentificationType and ContentRedactionType.
ContentRedactionType (string) --
Content redaction is performed at the segment level. If you don't include PiiEntityTypes, all PII is redacted.
You can’t set ContentIdentificationType and ContentRedactionType.
PiiEntityTypes (string) --
Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.
Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL.
Note that if you include PiiEntityTypes, you must also include ContentIdentificationType or ContentRedactionType.
If you include ContentRedactionType or ContentIdentificationType, but do not include PiiEntityTypes, all PII is redacted or identified.
LanguageModelName (string) --
Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.
The language of the specified language model must match the language code. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
If you use Amazon Transcribe in multiple Regions, the custom language model must be available in Amazon Transcribe in each Region.
IdentifyLanguage (boolean) --
Enables automatic language identification for your transcription.
If you include IdentifyLanguage, you can optionally use LanguageOptions to include a list of language codes that you think may be present in your audio stream. Including language options can improve transcription accuracy.
You can also use PreferredLanguage to include a preferred language. Doing so can help Amazon Transcribe identify the language faster.
You must include either LanguageCode or IdentifyLanguage.
Language identification can't be combined with custom language models or redaction.
LanguageOptions (string) --
Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.
Including language options can improve the accuracy of language identification.
If you include LanguageOptions, you must also include IdentifyLanguage.
PreferredLanguage (string) --
Specify a preferred language from the subset of languages codes you specified in LanguageOptions.
You can only use this parameter if you include IdentifyLanguage and LanguageOptions.
VocabularyNames (string) --
Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.
If you use Amazon Transcribe in multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.
If you don't include IdentifyLanguage and want to use a custom vocabulary with your transcription, use the VocabularyName parameter instead.
VocabularyFilterNames (string) --
Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.
If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.
If you're not including IdentifyLanguage and want to use a custom vocabulary filter with your transcription, use the VocabularyFilterName parameter instead.
EngineTranscribeMedicalSettings (dict) --
The transcription configuration settings passed to Amazon Transcribe Medical.
LanguageCode (string) -- [REQUIRED]
The language code specified for the Amazon Transcribe Medical engine.
Specialty (string) -- [REQUIRED]
The specialty specified for the Amazon Transcribe Medical engine.
Type (string) -- [REQUIRED]
The type of transcription.
VocabularyName (string) --
The name of the vocabulary passed to Amazon Transcribe Medical.
Region (string) --
The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.
ContentIdentificationType (string) --
Labels all personally identifiable information (PII) identified in your transcript. If you don't include PiiEntityTypes, all PII is identified.
You can’t set ContentIdentificationType and ContentRedactionType.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the SIP media applications under the administrator's AWS account.
See also: AWS API Documentation
Request Syntax
client.list_sip_media_applications(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of results to return in a single call. Defaults to 100.
string
The token to use to retrieve the next page of results.
dict
Response Syntax
{
'SipMediaApplications': [
{
'SipMediaApplicationId': 'string',
'AwsRegion': 'string',
'Name': 'string',
'Endpoints': [
{
'LambdaArn': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SipMediaApplications (list) --
List of SIP media applications and application details.
(dict) --
The details of the SIP media application, including name and endpoints. An AWS account can have multiple SIP media applications.
SipMediaApplicationId (string) --
The SIP media application ID.
AwsRegion (string) --
The AWS Region in which the SIP media application is created.
Name (string) --
The name of the SIP media application.
Endpoints (list) --
List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.
(dict) --
The endpoint assigned to the SIP media application.
LambdaArn (string) --
Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.
CreatedTimestamp (datetime) --
The SIP media application creation timestamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The SIP media application updated timestamp, in ISO 8601 format.
NextToken (string) --
The token to use to retrieve the next page of results.
Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.delete_voice_connector_emergency_calling_configuration(
VoiceConnectorId='string'
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
None
Returns the full details of a user's channel membership.
See also: AWS API Documentation
Request Syntax
client.describe_channel_membership(
ChannelArn='string',
MemberArn='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel.
string
[REQUIRED]
The ARN of the member.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelMembership': {
'InvitedBy': {
'Arn': 'string',
'Name': 'string'
},
'Type': 'DEFAULT'|'HIDDEN',
'Member': {
'Arn': 'string',
'Name': 'string'
},
'ChannelArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
ChannelMembership (dict) --
The details of the membership.
InvitedBy (dict) --
The identifier of the member who invited another member.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Type (string) --
The membership type set for the channel member.
Member (dict) --
The data of the channel member.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
ChannelArn (string) --
The ARN of the member's channel.
CreatedTimestamp (datetime) --
The time at which the channel membership was created.
LastUpdatedTimestamp (datetime) --
The time at which a channel membership was last updated.
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.
See also: AWS API Documentation
Request Syntax
client.put_voice_connector_logging_configuration(
VoiceConnectorId='string',
LoggingConfiguration={
'EnableSIPLogs': True|False,
'EnableMediaMetricLogs': True|False
}
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
dict
[REQUIRED]
The logging configuration details to add.
EnableSIPLogs (boolean) --
Boolean that enables SIP message logs to Amazon CloudWatch logs.
EnableMediaMetricLogs (boolean) --
Boolean that enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.
dict
Response Syntax
{
'LoggingConfiguration': {
'EnableSIPLogs': True|False,
'EnableMediaMetricLogs': True|False
}
}
Response Structure
(dict) --
LoggingConfiguration (dict) --
The updated logging configuration details.
EnableSIPLogs (boolean) --
Boolean that enables SIP message logs to Amazon CloudWatch logs.
EnableMediaMetricLogs (boolean) --
Boolean that enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.
Untags the specified tags from the specified Amazon Chime SDK meeting.
See also: AWS API Documentation
Request Syntax
client.untag_meeting(
MeetingId='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Chime SDK meeting ID.
list
[REQUIRED]
The tag keys.
(string) --
None
Removes a user from a channel's ban list.
See also: AWS API Documentation
Request Syntax
client.delete_channel_ban(
ChannelArn='string',
MemberArn='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel from which the AppInstanceUser was banned.
string
[REQUIRED]
The ARN of the AppInstanceUser that you want to reinstate.
string
The AppInstanceUserArn of the user that makes the API call.
None
Sets the amount of time in days that a given AppInstance retains data.
See also: AWS API Documentation
Request Syntax
client.put_app_instance_retention_settings(
AppInstanceArn='string',
AppInstanceRetentionSettings={
'ChannelRetentionSettings': {
'RetentionDays': 123
}
}
)
string
[REQUIRED]
The ARN of the AppInstance.
dict
[REQUIRED]
The time in days to retain data. Data type: number.
ChannelRetentionSettings (dict) --
The length of time in days to retain the messages in a channel.
RetentionDays (integer) --
The time in days to retain the messages in a channel.
dict
Response Syntax
{
'AppInstanceRetentionSettings': {
'ChannelRetentionSettings': {
'RetentionDays': 123
}
},
'InitiateDeletionTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
AppInstanceRetentionSettings (dict) --
The time in days to retain data. Data type: number.
ChannelRetentionSettings (dict) --
The length of time in days to retain the messages in a channel.
RetentionDays (integer) --
The time in days to retain the messages in a channel.
InitiateDeletionTimestamp (datetime) --
The time at which the API deletes data.
Returns the full details of a channel moderated by the specified AppInstanceUser.
See also: AWS API Documentation
Request Syntax
client.describe_channel_moderated_by_app_instance_user(
ChannelArn='string',
AppInstanceUserArn='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the moderated channel.
string
[REQUIRED]
The ARN of the AppInstanceUser in the moderated channel.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'Channel': {
'ChannelSummary': {
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'LastMessageTimestamp': datetime(2015, 1, 1)
}
}
}
Response Structure
(dict) --
Channel (dict) --
The moderated channel.
ChannelSummary (dict) --
Summary of the details of a Channel.
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The privacy setting of the channel.
Metadata (string) --
The metadata of the channel.
LastMessageTimestamp (datetime) --
The time at which the last message in a channel was sent.
Deletes the origination settings for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.delete_voice_connector_origination(
VoiceConnectorId='string'
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
None
Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.get_voice_connector_termination_health(
VoiceConnectorId='string'
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
dict
Response Syntax
{
'TerminationHealth': {
'Timestamp': datetime(2015, 1, 1),
'Source': 'string'
}
}
Response Structure
(dict) --
TerminationHealth (dict) --
The termination health details.
Timestamp (datetime) --
The timestamp, in ISO 8601 format.
Source (string) --
The source IP address.
Updates the content of a message.
See also: AWS API Documentation
Request Syntax
client.update_channel_message(
ChannelArn='string',
MessageId='string',
Content='string',
Metadata='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel.
string
[REQUIRED]
The ID string of the message being updated.
string
The content of the message being updated.
string
The metadata of the message being updated.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelArn': 'string',
'MessageId': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
MessageId (string) --
The ID string of the message being updated.
Untags the specified tags from the specified Amazon Chime SDK meeting resource.
Applies the specified tags to the specified Amazon Chime SDK meeting resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The resource ARN.
list
[REQUIRED]
The tag keys.
(string) --
None
Sends a message to a particular channel that the member is a part of.
See also: AWS API Documentation
Request Syntax
client.send_channel_message(
ChannelArn='string',
Content='string',
Type='STANDARD'|'CONTROL',
Persistence='PERSISTENT'|'NON_PERSISTENT',
Metadata='string',
ClientRequestToken='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel.
string
[REQUIRED]
The content of the message.
string
[REQUIRED]
The type of message, STANDARD or CONTROL.
string
[REQUIRED]
Boolean that controls whether the message is persisted on the back end. Required.
string
The optional metadata for each message.
string
[REQUIRED]
The Idempotency token for each client request.
This field is autopopulated if not provided.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelArn': 'string',
'MessageId': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
MessageId (string) --
The ID string assigned to each message.
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.
See also: AWS API Documentation
Request Syntax
client.create_sip_media_application_call(
FromPhoneNumber='string',
ToPhoneNumber='string',
SipMediaApplicationId='string',
SipHeaders={
'string': 'string'
}
)
string
[REQUIRED]
The phone number that a user calls from. This is a phone number in your Amazon Chime phone number inventory.
string
[REQUIRED]
The phone number that the service should call.
string
[REQUIRED]
The ID of the SIP media application.
dict
The SIP headers added to an outbound call leg.
(string) --
(string) --
dict
Response Syntax
{
'SipMediaApplicationCall': {
'TransactionId': 'string'
}
}
Response Structure
(dict) --
SipMediaApplicationCall (dict) --
The actual call.
TransactionId (string) --
The transaction ID of a call.
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 .
See also: AWS API Documentation
Request Syntax
client.get_meeting(
MeetingId='string'
)
string
[REQUIRED]
The Amazon Chime SDK meeting ID.
dict
Response Syntax
{
'Meeting': {
'MeetingId': 'string',
'ExternalMeetingId': 'string',
'MediaPlacement': {
'AudioHostUrl': 'string',
'AudioFallbackUrl': 'string',
'ScreenDataUrl': 'string',
'ScreenSharingUrl': 'string',
'ScreenViewingUrl': 'string',
'SignalingUrl': 'string',
'TurnControlUrl': 'string',
'EventIngestionUrl': 'string'
},
'MediaRegion': 'string'
}
}
Response Structure
(dict) --
Meeting (dict) --
The Amazon Chime SDK meeting information.
MeetingId (string) --
The Amazon Chime SDK meeting ID.
ExternalMeetingId (string) --
The external meeting ID.
MediaPlacement (dict) --
The media placement for the meeting.
AudioHostUrl (string) --
The audio host URL.
AudioFallbackUrl (string) --
The audio fallback URL.
ScreenDataUrl (string) --
The screen data URL.
ScreenSharingUrl (string) --
The screen sharing URL.
ScreenViewingUrl (string) --
The screen viewing URL.
SignalingUrl (string) --
The signaling URL.
TurnControlUrl (string) --
The turn control URL.
EventIngestionUrl (string) --
The event ingestion URL to which you send client meeting events.
MediaRegion (string) --
The Region in which you create the meeting. 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.
Deletes an AppInstanceUser.
See also: AWS API Documentation
Request Syntax
client.delete_app_instance_user(
AppInstanceUserArn='string'
)
string
[REQUIRED]
The ARN of the user request being deleted.
None
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
See also: AWS API Documentation
Request Syntax
client.delete_voice_connector_termination_credentials(
VoiceConnectorId='string',
Usernames=[
'string',
]
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
list
[REQUIRED]
The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.
(string) --
None
Lists all the users banned from a particular channel.
See also: AWS API Documentation
Request Syntax
client.list_channel_bans(
ChannelArn='string',
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel.
integer
The maximum number of bans that you want returned.
string
The token passed by previous API calls until all requested bans are returned.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelArn': 'string',
'NextToken': 'string',
'ChannelBans': [
{
'Member': {
'Arn': 'string',
'Name': 'string'
}
},
]
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
NextToken (string) --
The token passed by previous API calls until all requested bans are returned.
ChannelBans (list) --
The information for each requested ban.
(dict) --
Summary of the details of a ChannelBan.
Member (dict) --
The member being banned from a channel.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Updates the details of the specified SIP rule.
See also: AWS API Documentation
Request Syntax
client.update_sip_rule(
SipRuleId='string',
Name='string',
Disabled=True|False,
TargetApplications=[
{
'SipMediaApplicationId': 'string',
'Priority': 123,
'AwsRegion': 'string'
},
]
)
string
[REQUIRED]
The SIP rule ID.
string
[REQUIRED]
The new name for the specified SIP rule.
boolean
The new value specified to indicate whether the rule is disabled.
list
The new value of the list of target applications.
(dict) --
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
SipMediaApplicationId (string) --
The SIP media application ID.
Priority (integer) --
Priority of the SIP media application in the target list.
AwsRegion (string) --
The AWS Region of the target application.
dict
Response Syntax
{
'SipRule': {
'SipRuleId': 'string',
'Name': 'string',
'Disabled': True|False,
'TriggerType': 'ToPhoneNumber'|'RequestUriHostname',
'TriggerValue': 'string',
'TargetApplications': [
{
'SipMediaApplicationId': 'string',
'Priority': 123,
'AwsRegion': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
SipRule (dict) --
Updated SIP rule details.
SipRuleId (string) --
The SIP rule ID.
Name (string) --
The name of the SIP rule.
Disabled (boolean) --
Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
TriggerType (string) --
The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
TriggerValue (string) --
If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.
TargetApplications (list) --
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
(dict) --
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
SipMediaApplicationId (string) --
The SIP media application ID.
Priority (integer) --
Priority of the SIP media application in the target list.
AwsRegion (string) --
The AWS Region of the target application.
CreatedTimestamp (datetime) --
The time at which the SIP rule was created, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The time at which the SIP rule was last updated, in ISO 8601 format.
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.
See also: AWS API Documentation
Request Syntax
client.create_channel_moderator(
ChannelArn='string',
ChannelModeratorArn='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel.
string
[REQUIRED]
The ARN of the moderator.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelArn': 'string',
'ChannelModerator': {
'Arn': 'string',
'Name': 'string'
}
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
ChannelModerator (dict) --
The ARNs of the channel and the moderator.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
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 .
See also: AWS API Documentation
Request Syntax
client.create_meeting_with_attendees(
ClientRequestToken='string',
ExternalMeetingId='string',
MeetingHostId='string',
MediaRegion='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
NotificationsConfiguration={
'SnsTopicArn': 'string',
'SqsQueueArn': 'string'
},
Attendees=[
{
'ExternalUserId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
string
[REQUIRED]
The unique identifier for the client request. Use a different token for different meetings.
This field is autopopulated if not provided.
string
The external meeting ID.
string
Reserved.
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 .
list
The tag key-value pairs.
(dict) --
Describes a tag applied to a resource.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag.
dict
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).
SnsTopicArn (string) --
The SNS topic ARN.
SqsQueueArn (string) --
The SQS queue ARN.
list
The request containing the attendees to create.
(dict) --
The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.
ExternalUserId (string) -- [REQUIRED]
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
Tags (list) --
The tag key-value pairs.
(dict) --
Describes a tag applied to a resource.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag.
dict
Response Syntax
{
'Meeting': {
'MeetingId': 'string',
'ExternalMeetingId': 'string',
'MediaPlacement': {
'AudioHostUrl': 'string',
'AudioFallbackUrl': 'string',
'ScreenDataUrl': 'string',
'ScreenSharingUrl': 'string',
'ScreenViewingUrl': 'string',
'SignalingUrl': 'string',
'TurnControlUrl': 'string',
'EventIngestionUrl': 'string'
},
'MediaRegion': 'string'
},
'Attendees': [
{
'ExternalUserId': 'string',
'AttendeeId': 'string',
'JoinToken': 'string'
},
],
'Errors': [
{
'ExternalUserId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
Meeting (dict) --
A meeting created using the Amazon Chime SDK.
MeetingId (string) --
The Amazon Chime SDK meeting ID.
ExternalMeetingId (string) --
The external meeting ID.
MediaPlacement (dict) --
The media placement for the meeting.
AudioHostUrl (string) --
The audio host URL.
AudioFallbackUrl (string) --
The audio fallback URL.
ScreenDataUrl (string) --
The screen data URL.
ScreenSharingUrl (string) --
The screen sharing URL.
ScreenViewingUrl (string) --
The screen viewing URL.
SignalingUrl (string) --
The signaling URL.
TurnControlUrl (string) --
The turn control URL.
EventIngestionUrl (string) --
The event ingestion URL to which you send client meeting events.
MediaRegion (string) --
The Region in which you create the meeting. 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.
Attendees (list) --
The attendee information, including attendees IDs and join tokens.
(dict) --
An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken . The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.
We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.
ExternalUserId (string) --
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
AttendeeId (string) --
The Amazon Chime SDK attendee ID.
JoinToken (string) --
The join token used by the Amazon Chime SDK attendee.
Errors (list) --
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.
(dict) --
The list of errors returned when errors are encountered during the BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, error codes, and error messages.
ExternalUserId (string) --
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
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.
See also: AWS API Documentation
Request Syntax
client.create_meeting(
ClientRequestToken='string',
ExternalMeetingId='string',
MeetingHostId='string',
MediaRegion='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
NotificationsConfiguration={
'SnsTopicArn': 'string',
'SqsQueueArn': 'string'
}
)
string
[REQUIRED]
The unique identifier for the client request. Use a different token for different meetings.
This field is autopopulated if not provided.
string
The external meeting ID.
string
Reserved.
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 .
list
The tag key-value pairs.
(dict) --
Describes a tag applied to a resource.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag.
dict
The configuration for resource targets to receive notifications when meeting and attendee events occur.
SnsTopicArn (string) --
The SNS topic ARN.
SqsQueueArn (string) --
The SQS queue ARN.
dict
Response Syntax
{
'Meeting': {
'MeetingId': 'string',
'ExternalMeetingId': 'string',
'MediaPlacement': {
'AudioHostUrl': 'string',
'AudioFallbackUrl': 'string',
'ScreenDataUrl': 'string',
'ScreenSharingUrl': 'string',
'ScreenViewingUrl': 'string',
'SignalingUrl': 'string',
'TurnControlUrl': 'string',
'EventIngestionUrl': 'string'
},
'MediaRegion': 'string'
}
}
Response Structure
(dict) --
Meeting (dict) --
The meeting information, including the meeting ID and MediaPlacement .
MeetingId (string) --
The Amazon Chime SDK meeting ID.
ExternalMeetingId (string) --
The external meeting ID.
MediaPlacement (dict) --
The media placement for the meeting.
AudioHostUrl (string) --
The audio host URL.
AudioFallbackUrl (string) --
The audio fallback URL.
ScreenDataUrl (string) --
The screen data URL.
ScreenSharingUrl (string) --
The screen sharing URL.
ScreenViewingUrl (string) --
The screen viewing URL.
SignalingUrl (string) --
The signaling URL.
TurnControlUrl (string) --
The turn control URL.
EventIngestionUrl (string) --
The event ingestion URL to which you send client meeting events.
MediaRegion (string) --
The Region in which you create the meeting. 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.
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.
See also: AWS API Documentation
Request Syntax
client.create_attendee(
MeetingId='string',
ExternalUserId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Chime SDK meeting ID.
string
[REQUIRED]
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
list
The tag key-value pairs.
(dict) --
Describes a tag applied to a resource.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag.
dict
Response Syntax
{
'Attendee': {
'ExternalUserId': 'string',
'AttendeeId': 'string',
'JoinToken': 'string'
}
}
Response Structure
(dict) --
Attendee (dict) --
The attendee information, including attendee ID and join token.
ExternalUserId (string) --
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
AttendeeId (string) --
The Amazon Chime SDK attendee ID.
JoinToken (string) --
The join token used by the Amazon Chime SDK attendee.
Deletes an AppInstance and all associated data asynchronously.
See also: AWS API Documentation
Request Syntax
client.delete_app_instance(
AppInstanceArn='string'
)
string
[REQUIRED]
The ARN of the AppInstance.
None
Deletes the media capture pipeline.
See also: AWS API Documentation
Request Syntax
client.delete_media_capture_pipeline(
MediaPipelineId='string'
)
string
[REQUIRED]
The ID of the media capture pipeline being deleted.
None
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
See also: AWS API Documentation
Request Syntax
client.disassociate_phone_numbers_from_voice_connector_group(
VoiceConnectorGroupId='string',
E164PhoneNumbers=[
'string',
]
)
string
[REQUIRED]
The Amazon Chime Voice Connector group ID.
list
[REQUIRED]
List of phone numbers, in E.164 format.
(string) --
dict
Response Syntax
{
'PhoneNumberErrors': [
{
'PhoneNumberId': 'string',
'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
PhoneNumberErrors (list) --
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.
(dict) --
If the phone number 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.
PhoneNumberId (string) --
The phone number ID for which the action failed.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
Retrieves termination setting details for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.get_voice_connector_termination(
VoiceConnectorId='string'
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
dict
Response Syntax
{
'Termination': {
'CpsLimit': 123,
'DefaultPhoneNumber': 'string',
'CallingRegions': [
'string',
],
'CidrAllowedList': [
'string',
],
'Disabled': True|False
}
}
Response Structure
(dict) --
Termination (dict) --
The termination setting details.
CpsLimit (integer) --
The limit on calls per second. Max value based on account service quota. Default value of 1.
DefaultPhoneNumber (string) --
The default caller ID phone number.
CallingRegions (list) --
The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
(string) --
CidrAllowedList (list) --
The IP addresses allowed to make calls, in CIDR format. Required.
(string) --
Disabled (boolean) --
When termination settings are disabled, outbound calls can not be made.
The details of the time when a user last read messages in a channel.
See also: AWS API Documentation
Request Syntax
client.update_channel_read_marker(
ChannelArn='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelArn': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
See also: AWS API Documentation
Request Syntax
client.get_sip_rule(
SipRuleId='string'
)
string
[REQUIRED]
The SIP rule ID.
dict
Response Syntax
{
'SipRule': {
'SipRuleId': 'string',
'Name': 'string',
'Disabled': True|False,
'TriggerType': 'ToPhoneNumber'|'RequestUriHostname',
'TriggerValue': 'string',
'TargetApplications': [
{
'SipMediaApplicationId': 'string',
'Priority': 123,
'AwsRegion': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
SipRule (dict) --
The SIP rule details.
SipRuleId (string) --
The SIP rule ID.
Name (string) --
The name of the SIP rule.
Disabled (boolean) --
Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
TriggerType (string) --
The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
TriggerValue (string) --
If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.
TargetApplications (list) --
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
(dict) --
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
SipMediaApplicationId (string) --
The SIP media application ID.
Priority (integer) --
Priority of the SIP media application in the target list.
AwsRegion (string) --
The AWS Region of the target application.
CreatedTimestamp (datetime) --
The time at which the SIP rule was created, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The time at which the SIP rule was last updated, in ISO 8601 format.
Gets the full details of a channel message.
See also: AWS API Documentation
Request Syntax
client.get_channel_message(
ChannelArn='string',
MessageId='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel.
string
[REQUIRED]
The ID of the message.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelMessage': {
'ChannelArn': 'string',
'MessageId': 'string',
'Content': 'string',
'Metadata': 'string',
'Type': 'STANDARD'|'CONTROL',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastEditedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1),
'Sender': {
'Arn': 'string',
'Name': 'string'
},
'Redacted': True|False,
'Persistence': 'PERSISTENT'|'NON_PERSISTENT'
}
}
Response Structure
(dict) --
ChannelMessage (dict) --
The details of and content in the message.
ChannelArn (string) --
The ARN of the channel.
MessageId (string) --
The ID of a message.
Content (string) --
The message content.
Metadata (string) --
The message metadata.
Type (string) --
The message type.
CreatedTimestamp (datetime) --
The time at which the message was created.
LastEditedTimestamp (datetime) --
The time at which a message was edited.
LastUpdatedTimestamp (datetime) --
The time at which a message was updated.
Sender (dict) --
The message sender.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Redacted (boolean) --
Hides the content of a message.
Persistence (string) --
The persistence setting for a channel message.
Lists up to 100 active Amazon Chime SDK meetings.
For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
See also: AWS API Documentation
Request Syntax
client.list_meetings(
NextToken='string',
MaxResults=123
)
string
The token to use to retrieve the next page of results.
integer
The maximum number of results to return in a single call.
dict
Response Syntax
{
'Meetings': [
{
'MeetingId': 'string',
'ExternalMeetingId': 'string',
'MediaPlacement': {
'AudioHostUrl': 'string',
'AudioFallbackUrl': 'string',
'ScreenDataUrl': 'string',
'ScreenSharingUrl': 'string',
'ScreenViewingUrl': 'string',
'SignalingUrl': 'string',
'TurnControlUrl': 'string',
'EventIngestionUrl': 'string'
},
'MediaRegion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Meetings (list) --
The Amazon Chime SDK meeting information.
(dict) --
A meeting created using the Amazon Chime SDK.
MeetingId (string) --
The Amazon Chime SDK meeting ID.
ExternalMeetingId (string) --
The external meeting ID.
MediaPlacement (dict) --
The media placement for the meeting.
AudioHostUrl (string) --
The audio host URL.
AudioFallbackUrl (string) --
The audio fallback URL.
ScreenDataUrl (string) --
The screen data URL.
ScreenSharingUrl (string) --
The screen sharing URL.
ScreenViewingUrl (string) --
The screen viewing URL.
SignalingUrl (string) --
The signaling URL.
TurnControlUrl (string) --
The turn control URL.
EventIngestionUrl (string) --
The event ingestion URL to which you send client meeting events.
MediaRegion (string) --
The Region in which you create the meeting. 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.
NextToken (string) --
The token to use to retrieve the next page of results.
Lists the SIP credentials for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.list_voice_connector_termination_credentials(
VoiceConnectorId='string'
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
dict
Response Syntax
{
'Usernames': [
'string',
]
}
Response Structure
(dict) --
Usernames (list) --
A list of user names.
(string) --
Removes a member from a channel.
See also: AWS API Documentation
Request Syntax
client.delete_channel_membership(
ChannelArn='string',
MemberArn='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel from which you want to remove the user.
string
[REQUIRED]
The ARN of the member that you're removing from the channel.
string
The AppInstanceUserArn of the user that makes the API call.
None
Lists all the moderators for a channel.
See also: AWS API Documentation
Request Syntax
client.list_channel_moderators(
ChannelArn='string',
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel.
integer
The maximum number of moderators that you want returned.
string
The token passed by previous API calls until all requested moderators are returned.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelArn': 'string',
'NextToken': 'string',
'ChannelModerators': [
{
'Moderator': {
'Arn': 'string',
'Name': 'string'
}
},
]
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
NextToken (string) --
The token passed by previous API calls until all requested moderators are returned.
ChannelModerators (list) --
The information about and names of each moderator.
(dict) --
Summary of the details of a ChannelModerator.
Moderator (dict) --
The data for a moderator.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
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.
See also: AWS API Documentation
Request Syntax
client.get_voice_connector_logging_configuration(
VoiceConnectorId='string'
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
dict
Response Syntax
{
'LoggingConfiguration': {
'EnableSIPLogs': True|False,
'EnableMediaMetricLogs': True|False
}
}
Response Structure
(dict) --
LoggingConfiguration (dict) --
The logging configuration details.
EnableSIPLogs (boolean) --
Boolean that enables SIP message logs to Amazon CloudWatch logs.
EnableMediaMetricLogs (boolean) --
Boolean that enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.
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.
See also: AWS API Documentation
Request Syntax
client.delete_voice_connector_group(
VoiceConnectorGroupId='string'
)
string
[REQUIRED]
The Amazon Chime Voice Connector group ID.
None
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.
See also: AWS API Documentation
Request Syntax
client.get_voice_connector_streaming_configuration(
VoiceConnectorId='string'
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
dict
Response Syntax
{
'StreamingConfiguration': {
'DataRetentionInHours': 123,
'Disabled': True|False,
'StreamingNotificationTargets': [
{
'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
},
]
}
}
Response Structure
(dict) --
StreamingConfiguration (dict) --
The streaming configuration details.
DataRetentionInHours (integer) --
The retention period, in hours, for the Amazon Kinesis data.
Disabled (boolean) --
When true, media streaming to Amazon Kinesis is turned off.
StreamingNotificationTargets (list) --
The streaming notification targets.
(dict) --
The targeted recipient for a streaming configuration notification.
NotificationTarget (string) --
The streaming notification target.
Updates the logging configuration for the specified SIP media application.
See also: AWS API Documentation
Request Syntax
client.put_sip_media_application_logging_configuration(
SipMediaApplicationId='string',
SipMediaApplicationLoggingConfiguration={
'EnableSipMediaApplicationMessageLogs': True|False
}
)
string
[REQUIRED]
The SIP media application ID.
dict
The actual logging configuration.
EnableSipMediaApplicationMessageLogs (boolean) --
Enables application message logs for the SIP media application.
dict
Response Syntax
{
'SipMediaApplicationLoggingConfiguration': {
'EnableSipMediaApplicationMessageLogs': True|False
}
}
Response Structure
(dict) --
SipMediaApplicationLoggingConfiguration (dict) --
The logging configuration of the SIP media application.
EnableSipMediaApplicationMessageLogs (boolean) --
Enables application message logs for the SIP media application.
The data streaming configurations of an AppInstance.
See also: AWS API Documentation
Request Syntax
client.put_app_instance_streaming_configurations(
AppInstanceArn='string',
AppInstanceStreamingConfigurations=[
{
'AppInstanceDataType': 'Channel'|'ChannelMessage',
'ResourceArn': 'string'
},
]
)
string
[REQUIRED]
The ARN of the AppInstance.
list
[REQUIRED]
The streaming configurations set for an AppInstance.
(dict) --
The details of the streaming configuration of an AppInstance.
AppInstanceDataType (string) -- [REQUIRED]
The type of data to be streamed.
ResourceArn (string) -- [REQUIRED]
The resource ARN.
dict
Response Syntax
{
'AppInstanceStreamingConfigurations': [
{
'AppInstanceDataType': 'Channel'|'ChannelMessage',
'ResourceArn': 'string'
},
]
}
Response Structure
(dict) --
AppInstanceStreamingConfigurations (list) --
The streaming configurations of an AppInstance.
(dict) --
The details of the streaming configuration of an AppInstance.
AppInstanceDataType (string) --
The type of data to be streamed.
ResourceArn (string) --
The resource ARN.
Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.put_voice_connector_termination_credentials(
VoiceConnectorId='string',
Credentials=[
{
'Username': 'string',
'Password': 'string'
},
]
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
list
The termination SIP credentials.
(dict) --
The SIP credentials used to authenticate requests to your Amazon Chime Voice Connector.
Username (string) --
The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.
Password (string) --
The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.
None
Lists all Amazon Chime ``AppInstance``s created under a single AWS account.
See also: AWS API Documentation
Request Syntax
client.list_app_instances(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of ``AppInstance``s that you want to return.
string
The token passed by previous API requests until you reach the maximum number of ``AppInstance``s.
dict
Response Syntax
{
'AppInstances': [
{
'AppInstanceArn': 'string',
'Name': 'string',
'Metadata': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AppInstances (list) --
The information for each AppInstance.
(dict) --
Summary of the data for an AppInstance.
AppInstanceArn (string) --
The AppInstance ARN.
Name (string) --
The name of the AppInstance.
Metadata (string) --
The metadata of the AppInstance.
NextToken (string) --
The token passed by previous API requests until the maximum number of ``AppInstance``s is reached.
Deletes a SIP rule. You must disable a SIP rule before you can delete it.
See also: AWS API Documentation
Request Syntax
client.delete_sip_rule(
SipRuleId='string'
)
string
[REQUIRED]
The SIP rule ID.
None
Lists the proxy sessions for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.list_proxy_sessions(
VoiceConnectorId='string',
Status='Open'|'InProgress'|'Closed',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Chime voice connector ID.
string
The proxy session status.
string
The token to use to retrieve the next page of results.
integer
The maximum number of results to return in a single call.
dict
Response Syntax
{
'ProxySessions': [
{
'VoiceConnectorId': 'string',
'ProxySessionId': 'string',
'Name': 'string',
'Status': 'Open'|'InProgress'|'Closed',
'ExpiryMinutes': 123,
'Capabilities': [
'Voice'|'SMS',
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'EndedTimestamp': datetime(2015, 1, 1),
'Participants': [
{
'PhoneNumber': 'string',
'ProxyPhoneNumber': 'string'
},
],
'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
'GeoMatchLevel': 'Country'|'AreaCode',
'GeoMatchParams': {
'Country': 'string',
'AreaCode': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProxySessions (list) --
The proxy session details.
(dict) --
The proxy session for an Amazon Chime Voice Connector.
VoiceConnectorId (string) --
The Amazon Chime voice connector ID.
ProxySessionId (string) --
The proxy session ID.
Name (string) --
The name of the proxy session.
Status (string) --
The status of the proxy session.
ExpiryMinutes (integer) --
The number of minutes allowed for the proxy session.
Capabilities (list) --
The proxy session capabilities.
(string) --
CreatedTimestamp (datetime) --
The created time stamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated time stamp, in ISO 8601 format.
EndedTimestamp (datetime) --
The ended time stamp, in ISO 8601 format.
Participants (list) --
The proxy session participants.
(dict) --
The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.
PhoneNumber (string) --
The participant's phone number.
ProxyPhoneNumber (string) --
The participant's proxy phone number.
NumberSelectionBehavior (string) --
The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
GeoMatchLevel (string) --
The preference for matching the country or area code of the proxy phone number with that of the first participant.
GeoMatchParams (dict) --
The country and area code for the proxy phone number.
Country (string) --
The country.
AreaCode (string) --
The area code.
NextToken (string) --
The token to use to retrieve the next page of results.
A list of the channels moderated by an AppInstanceUser.
See also: AWS API Documentation
Request Syntax
client.list_channels_moderated_by_app_instance_user(
AppInstanceUserArn='string',
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
string
The ARN of the user in the moderated channel.
integer
The maximum number of channels in the request.
string
The token returned from previous API requests until the number of channels moderated by the user is reached.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'Channels': [
{
'ChannelSummary': {
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'LastMessageTimestamp': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Channels (list) --
The moderated channels in the request.
(dict) --
Summary of the details of a moderated channel.
ChannelSummary (dict) --
Summary of the details of a Channel.
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The privacy setting of the channel.
Metadata (string) --
The metadata of the channel.
LastMessageTimestamp (datetime) --
The time at which the last message in a channel was sent.
NextToken (string) --
The token returned from previous API requests until the number of channels moderated by the user is reached.
Associates phone numbers with the specified Amazon Chime Voice Connector group.
See also: AWS API Documentation
Request Syntax
client.associate_phone_numbers_with_voice_connector_group(
VoiceConnectorGroupId='string',
E164PhoneNumbers=[
'string',
],
ForceAssociate=True|False
)
string
[REQUIRED]
The Amazon Chime Voice Connector group ID.
list
[REQUIRED]
List of phone numbers, in E.164 format.
(string) --
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.
dict
Response Syntax
{
'PhoneNumberErrors': [
{
'PhoneNumberId': 'string',
'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
PhoneNumberErrors (list) --
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.
(dict) --
If the phone number 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.
PhoneNumberId (string) --
The phone number ID for which the action failed.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
Deletes a channel moderator.
See also: AWS API Documentation
Request Syntax
client.delete_channel_moderator(
ChannelArn='string',
ChannelModeratorArn='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel.
string
[REQUIRED]
The ARN of the moderator being deleted.
string
The AppInstanceUserArn of the user that makes the API call.
None
Updates the specified proxy session details, such as voice or SMS capabilities.
See also: AWS API Documentation
Request Syntax
client.update_proxy_session(
VoiceConnectorId='string',
ProxySessionId='string',
Capabilities=[
'Voice'|'SMS',
],
ExpiryMinutes=123
)
string
[REQUIRED]
The Amazon Chime voice connector ID.
string
[REQUIRED]
The proxy session ID.
list
[REQUIRED]
The proxy session capabilities.
(string) --
integer
The number of minutes allowed for the proxy session.
dict
Response Syntax
{
'ProxySession': {
'VoiceConnectorId': 'string',
'ProxySessionId': 'string',
'Name': 'string',
'Status': 'Open'|'InProgress'|'Closed',
'ExpiryMinutes': 123,
'Capabilities': [
'Voice'|'SMS',
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'EndedTimestamp': datetime(2015, 1, 1),
'Participants': [
{
'PhoneNumber': 'string',
'ProxyPhoneNumber': 'string'
},
],
'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
'GeoMatchLevel': 'Country'|'AreaCode',
'GeoMatchParams': {
'Country': 'string',
'AreaCode': 'string'
}
}
}
Response Structure
(dict) --
ProxySession (dict) --
The proxy session details.
VoiceConnectorId (string) --
The Amazon Chime voice connector ID.
ProxySessionId (string) --
The proxy session ID.
Name (string) --
The name of the proxy session.
Status (string) --
The status of the proxy session.
ExpiryMinutes (integer) --
The number of minutes allowed for the proxy session.
Capabilities (list) --
The proxy session capabilities.
(string) --
CreatedTimestamp (datetime) --
The created time stamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated time stamp, in ISO 8601 format.
EndedTimestamp (datetime) --
The ended time stamp, in ISO 8601 format.
Participants (list) --
The proxy session participants.
(dict) --
The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.
PhoneNumber (string) --
The participant's phone number.
ProxyPhoneNumber (string) --
The participant's proxy phone number.
NumberSelectionBehavior (string) --
The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
GeoMatchLevel (string) --
The preference for matching the country or area code of the proxy phone number with that of the first participant.
GeoMatchParams (dict) --
The country and area code for the proxy phone number.
Country (string) --
The country.
AreaCode (string) --
The area code.
Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.
See also: AWS API Documentation
Request Syntax
client.list_voice_connector_groups(
NextToken='string',
MaxResults=123
)
string
The token to use to retrieve the next page of results.
integer
The maximum number of results to return in a single call.
dict
Response Syntax
{
'VoiceConnectorGroups': [
{
'VoiceConnectorGroupId': 'string',
'Name': 'string',
'VoiceConnectorItems': [
{
'VoiceConnectorId': 'string',
'Priority': 123
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'VoiceConnectorGroupArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
VoiceConnectorGroups (list) --
The details of the Amazon Chime Voice Connector groups.
(dict) --
The Amazon Chime Voice Connector group configuration, including associated Amazon Chime Voice Connectors. 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.
VoiceConnectorGroupId (string) --
The Amazon Chime Voice Connector group ID.
Name (string) --
The name of the Amazon Chime Voice Connector group.
VoiceConnectorItems (list) --
The Amazon Chime Voice Connectors to which to route inbound calls.
(dict) --
For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
VoiceConnectorId (string) --
The Amazon Chime Voice Connector ID.
Priority (integer) --
The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
CreatedTimestamp (datetime) --
The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
VoiceConnectorGroupArn (string) --
The ARN of the specified Amazon Chime Voice Connector group.
NextToken (string) --
The token to use to retrieve the next page of results.
List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.
See also: AWS API Documentation
Request Syntax
client.list_channel_messages(
ChannelArn='string',
SortOrder='ASCENDING'|'DESCENDING',
NotBefore=datetime(2015, 1, 1),
NotAfter=datetime(2015, 1, 1),
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel.
string
The order in which you want messages sorted. Default is Descending, based on time created.
datetime
The initial or starting time stamp for your requested messages.
datetime
The final or ending time stamp for your requested messages.
integer
The maximum number of messages that you want returned.
string
The token passed by previous API calls until all requested messages are returned.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelArn': 'string',
'NextToken': 'string',
'ChannelMessages': [
{
'MessageId': 'string',
'Content': 'string',
'Metadata': 'string',
'Type': 'STANDARD'|'CONTROL',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1),
'LastEditedTimestamp': datetime(2015, 1, 1),
'Sender': {
'Arn': 'string',
'Name': 'string'
},
'Redacted': True|False
},
]
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel containing the requested messages.
NextToken (string) --
The token passed by previous API calls until all requested messages are returned.
ChannelMessages (list) --
The information about, and content of, each requested message.
(dict) --
Summary of the messages in a Channel.
MessageId (string) --
The ID of the message.
Content (string) --
The content of the message.
Metadata (string) --
The metadata of the message.
Type (string) --
The type of message.
CreatedTimestamp (datetime) --
The time at which the message summary was created.
LastUpdatedTimestamp (datetime) --
The time at which a message was last updated.
LastEditedTimestamp (datetime) --
The time at which a message was last edited.
Sender (dict) --
The message sender.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Redacted (boolean) --
Indicates whether a message was redacted.
Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.
See also: AWS API Documentation
Request Syntax
client.delete_app_instance_admin(
AppInstanceAdminArn='string',
AppInstanceArn='string'
)
string
[REQUIRED]
The ARN of the AppInstance's administrator.
string
[REQUIRED]
The ARN of the AppInstance.
None
Associates phone numbers with the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.associate_phone_numbers_with_voice_connector(
VoiceConnectorId='string',
E164PhoneNumbers=[
'string',
],
ForceAssociate=True|False
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
list
[REQUIRED]
List of phone numbers, in E.164 format.
(string) --
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.
dict
Response Syntax
{
'PhoneNumberErrors': [
{
'PhoneNumberId': 'string',
'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
PhoneNumberErrors (list) --
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.
(dict) --
If the phone number 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.
PhoneNumberId (string) --
The phone number ID for which the action failed.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
Returns the logging configuration for the specified SIP media application.
See also: AWS API Documentation
Request Syntax
client.get_sip_media_application_logging_configuration(
SipMediaApplicationId='string'
)
string
[REQUIRED]
The SIP media application ID.
dict
Response Syntax
{
'SipMediaApplicationLoggingConfiguration': {
'EnableSipMediaApplicationMessageLogs': True|False
}
}
Response Structure
(dict) --
SipMediaApplicationLoggingConfiguration (dict) --
The actual logging configuration.
EnableSipMediaApplicationMessageLogs (boolean) --
Enables application message logs for the SIP media application.
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.
See also: AWS API Documentation
Request Syntax
client.delete_voice_connector(
VoiceConnectorId='string'
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
None
Lists the SIP rules under the administrator's AWS account.
See also: AWS API Documentation
Request Syntax
client.list_sip_rules(
SipMediaApplicationId='string',
MaxResults=123,
NextToken='string'
)
string
The SIP media application ID.
integer
The maximum number of results to return in a single call. Defaults to 100.
string
The token to use to retrieve the next page of results.
dict
Response Syntax
{
'SipRules': [
{
'SipRuleId': 'string',
'Name': 'string',
'Disabled': True|False,
'TriggerType': 'ToPhoneNumber'|'RequestUriHostname',
'TriggerValue': 'string',
'TargetApplications': [
{
'SipMediaApplicationId': 'string',
'Priority': 123,
'AwsRegion': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SipRules (list) --
List of SIP rules and rule details.
(dict) --
The SIP rule details, including name, triggers, and target applications. An AWS account can have multiple SIP rules.
SipRuleId (string) --
The SIP rule ID.
Name (string) --
The name of the SIP rule.
Disabled (boolean) --
Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
TriggerType (string) --
The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
TriggerValue (string) --
If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.
TargetApplications (list) --
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
(dict) --
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
SipMediaApplicationId (string) --
The SIP media application ID.
Priority (integer) --
Priority of the SIP media application in the target list.
AwsRegion (string) --
The AWS Region of the target application.
CreatedTimestamp (datetime) --
The time at which the SIP rule was created, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The time at which the SIP rule was last updated, in ISO 8601 format.
NextToken (string) --
The token to use to retrieve the next page of results.
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.
See also: AWS API Documentation
Request Syntax
client.list_attendees(
MeetingId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Chime SDK meeting ID.
string
The token to use to retrieve the next page of results.
integer
The maximum number of results to return in a single call.
dict
Response Syntax
{
'Attendees': [
{
'ExternalUserId': 'string',
'AttendeeId': 'string',
'JoinToken': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Attendees (list) --
The Amazon Chime SDK attendee information.
(dict) --
An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken . The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.
We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.
ExternalUserId (string) --
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
AttendeeId (string) --
The Amazon Chime SDK attendee ID.
JoinToken (string) --
The join token used by the Amazon Chime SDK attendee.
NextToken (string) --
The token to use to retrieve the next page of results.
Retrieves origination setting details for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.get_voice_connector_origination(
VoiceConnectorId='string'
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
dict
Response Syntax
{
'Origination': {
'Routes': [
{
'Host': 'string',
'Port': 123,
'Protocol': 'TCP'|'UDP',
'Priority': 123,
'Weight': 123
},
],
'Disabled': True|False
}
}
Response Structure
(dict) --
Origination (dict) --
The origination setting details.
Routes (list) --
The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. This parameter is not required, but you must specify this parameter or Disabled.
(dict) --
Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice Connector.
Host (string) --
The FQDN or IP address to contact for origination traffic.
Port (integer) --
The designated origination route port. Defaults to 5060.
Protocol (string) --
The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.
Priority (integer) --
The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
Weight (integer) --
The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.
Disabled (boolean) --
When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector. This parameter is not required, but you must specify this parameter or Routes.
Updates the details of the specified SIP media application.
See also: AWS API Documentation
Request Syntax
client.update_sip_media_application(
SipMediaApplicationId='string',
Name='string',
Endpoints=[
{
'LambdaArn': 'string'
},
]
)
string
[REQUIRED]
The SIP media application ID.
string
The new name for the specified SIP media application.
list
The new set of endpoints for the specified SIP media application.
(dict) --
The endpoint assigned to the SIP media application.
LambdaArn (string) --
Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.
dict
Response Syntax
{
'SipMediaApplication': {
'SipMediaApplicationId': 'string',
'AwsRegion': 'string',
'Name': 'string',
'Endpoints': [
{
'LambdaArn': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
SipMediaApplication (dict) --
The updated SIP media application details.
SipMediaApplicationId (string) --
The SIP media application ID.
AwsRegion (string) --
The AWS Region in which the SIP media application is created.
Name (string) --
The name of the SIP media application.
Endpoints (list) --
List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.
(dict) --
The endpoint assigned to the SIP media application.
LambdaArn (string) --
Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.
CreatedTimestamp (datetime) --
The SIP media application creation timestamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The SIP media application updated timestamp, in ISO 8601 format.
Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
See also: AWS API Documentation
Request Syntax
client.update_voice_connector_group(
VoiceConnectorGroupId='string',
Name='string',
VoiceConnectorItems=[
{
'VoiceConnectorId': 'string',
'Priority': 123
},
]
)
string
[REQUIRED]
The Amazon Chime Voice Connector group ID.
string
[REQUIRED]
The name of the Amazon Chime Voice Connector group.
list
[REQUIRED]
The VoiceConnectorItems to associate with the group.
(dict) --
For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
VoiceConnectorId (string) -- [REQUIRED]
The Amazon Chime Voice Connector ID.
Priority (integer) -- [REQUIRED]
The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
dict
Response Syntax
{
'VoiceConnectorGroup': {
'VoiceConnectorGroupId': 'string',
'Name': 'string',
'VoiceConnectorItems': [
{
'VoiceConnectorId': 'string',
'Priority': 123
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'VoiceConnectorGroupArn': 'string'
}
}
Response Structure
(dict) --
VoiceConnectorGroup (dict) --
The updated Amazon Chime Voice Connector group details.
VoiceConnectorGroupId (string) --
The Amazon Chime Voice Connector group ID.
Name (string) --
The name of the Amazon Chime Voice Connector group.
VoiceConnectorItems (list) --
The Amazon Chime Voice Connectors to which to route inbound calls.
(dict) --
For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
VoiceConnectorId (string) --
The Amazon Chime Voice Connector ID.
Priority (integer) --
The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
CreatedTimestamp (datetime) --
The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
VoiceConnectorGroupArn (string) --
The ARN of the specified Amazon Chime Voice Connector group.
Lists the tags applied to an Amazon Chime SDK meeting and messaging resources.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceARN='string'
)
string
[REQUIRED]
The resource ARN.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Tags (list) --
A list of tag-key value pairs.
(dict) --
Describes a tag applied to a resource.
Key (string) --
The key of the tag.
Value (string) --
The value of the tag.
Deletes the proxy configuration from the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.delete_voice_connector_proxy(
VoiceConnectorId='string'
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
None
Updates AppInstance metadata.
See also: AWS API Documentation
Request Syntax
client.update_app_instance(
AppInstanceArn='string',
Name='string',
Metadata='string'
)
string
[REQUIRED]
The ARN of the AppInstance.
string
[REQUIRED]
The name that you want to change.
string
The metadata that you want to change.
dict
Response Syntax
{
'AppInstanceArn': 'string'
}
Response Structure
(dict) --
AppInstanceArn (string) --
The ARN of the AppInstance.
Deletes a SIP media application.
See also: AWS API Documentation
Request Syntax
client.delete_sip_media_application(
SipMediaApplicationId='string'
)
string
[REQUIRED]
The SIP media application ID.
None
Returns a list of media capture pipelines.
See also: AWS API Documentation
Request Syntax
client.list_media_capture_pipelines(
NextToken='string',
MaxResults=123
)
string
The token used to retrieve the next page of results.
integer
The maximum number of results to return in a single call. Valid Range: 1 - 99.
dict
Response Syntax
{
'MediaCapturePipelines': [
{
'MediaPipelineId': 'string',
'SourceType': 'ChimeSdkMeeting',
'SourceArn': 'string',
'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
'SinkType': 'S3Bucket',
'SinkArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'ChimeSdkMeetingConfiguration': {
'SourceConfiguration': {
'SelectedVideoStreams': {
'AttendeeIds': [
'string',
],
'ExternalUserIds': [
'string',
]
}
},
'ArtifactsConfiguration': {
'Audio': {
'MuxType': 'AudioOnly'|'AudioWithActiveSpeakerVideo'
},
'Video': {
'State': 'Enabled'|'Disabled',
'MuxType': 'VideoOnly'
},
'Content': {
'State': 'Enabled'|'Disabled',
'MuxType': 'ContentOnly'
}
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
MediaCapturePipelines (list) --
The media capture pipeline objects in the list.
(dict) --
A media capture pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object.
MediaPipelineId (string) --
The ID of a media capture pipeline.
SourceType (string) --
Source type from which media artifacts are saved. You must use ChimeMeeting.
SourceArn (string) --
ARN of the source from which the media artifacts will be saved.
Status (string) --
The status of the media capture pipeline.
SinkType (string) --
Destination type to which the media artifacts are saved. You must use an S3 Bucket.
SinkArn (string) --
ARN of the destination to which the media artifacts are saved.
CreatedTimestamp (datetime) --
The time at which the capture pipeline was created, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The time at which the capture pipeline was updated, in ISO 8601 format.
ChimeSdkMeetingConfiguration (dict) --
The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.
SourceConfiguration (dict) --
The source configuration for a specified media capture pipeline.
SelectedVideoStreams (dict) --
The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.
AttendeeIds (list) --
The attendee IDs of the streams selected for a media capture pipeline.
(string) --
ExternalUserIds (list) --
The external user IDs of the streams selected for a media capture pipeline.
(string) --
ArtifactsConfiguration (dict) --
The configuration for the artifacts in an Amazon Chime SDK meeting.
Audio (dict) --
The configuration for the audio artifacts.
MuxType (string) --
The MUX type of the audio artifact configuration object.
Video (dict) --
The configuration for the video artifacts.
State (string) --
Indicates whether the video artifact is enabled or disabled.
MuxType (string) --
The MUX type of the video artifact configuration object.
Content (dict) --
The configuration for the content artifacts.
State (string) --
Indicates whether the content artifact is enabled or disabled.
MuxType (string) --
The MUX type of the artifact configuration.
NextToken (string) --
The token used to retrieve the next page of results.
Gets the streaming settings for an AppInstance.
See also: AWS API Documentation
Request Syntax
client.get_app_instance_streaming_configurations(
AppInstanceArn='string'
)
string
[REQUIRED]
The ARN of the AppInstance.
dict
Response Syntax
{
'AppInstanceStreamingConfigurations': [
{
'AppInstanceDataType': 'Channel'|'ChannelMessage',
'ResourceArn': 'string'
},
]
}
Response Structure
(dict) --
AppInstanceStreamingConfigurations (list) --
The streaming settings.
(dict) --
The details of the streaming configuration of an AppInstance.
AppInstanceDataType (string) --
The type of data to be streamed.
ResourceArn (string) --
The resource ARN.
Adds origination settings for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.put_voice_connector_origination(
VoiceConnectorId='string',
Origination={
'Routes': [
{
'Host': 'string',
'Port': 123,
'Protocol': 'TCP'|'UDP',
'Priority': 123,
'Weight': 123
},
],
'Disabled': True|False
}
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
dict
[REQUIRED]
The origination setting details to add.
Routes (list) --
The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. This parameter is not required, but you must specify this parameter or Disabled.
(dict) --
Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice Connector.
Host (string) --
The FQDN or IP address to contact for origination traffic.
Port (integer) --
The designated origination route port. Defaults to 5060.
Protocol (string) --
The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.
Priority (integer) --
The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
Weight (integer) --
The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.
Disabled (boolean) --
When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector. This parameter is not required, but you must specify this parameter or Routes.
dict
Response Syntax
{
'Origination': {
'Routes': [
{
'Host': 'string',
'Port': 123,
'Protocol': 'TCP'|'UDP',
'Priority': 123,
'Weight': 123
},
],
'Disabled': True|False
}
}
Response Structure
(dict) --
Origination (dict) --
The updated origination setting details.
Routes (list) --
The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. This parameter is not required, but you must specify this parameter or Disabled.
(dict) --
Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice Connector.
Host (string) --
The FQDN or IP address to contact for origination traffic.
Port (integer) --
The designated origination route port. Defaults to 5060.
Protocol (string) --
The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.
Priority (integer) --
The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
Weight (integer) --
The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.
Disabled (boolean) --
When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector. This parameter is not required, but you must specify this parameter or Routes.
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.
See also: AWS API Documentation
Request Syntax
client.redact_channel_message(
ChannelArn='string',
MessageId='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel containing the messages that you want to redact.
string
[REQUIRED]
The ID of the message being redacted.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelArn': 'string',
'MessageId': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel containing the messages that you want to redact.
MessageId (string) --
The ID of the message being redacted.
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.
See also: AWS API Documentation
Request Syntax
client.list_channels(
AppInstanceArn='string',
Privacy='PUBLIC'|'PRIVATE',
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the AppInstance.
string
The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.
integer
The maximum number of channels that you want to return.
string
The token passed by previous API calls until all requested channels are returned.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'Channels': [
{
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'LastMessageTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Channels (list) --
The information about each channel.
(dict) --
Summary of the details of a Channel.
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The privacy setting of the channel.
Metadata (string) --
The metadata of the channel.
LastMessageTimestamp (datetime) --
The time at which the last message in a channel was sent.
NextToken (string) --
The token returned from previous API requests until the number of channels is reached.
Updates the details of an AppInstanceUser. You can update names and metadata.
See also: AWS API Documentation
Request Syntax
client.update_app_instance_user(
AppInstanceUserArn='string',
Name='string',
Metadata='string'
)
string
[REQUIRED]
The ARN of the AppInstanceUser.
string
[REQUIRED]
The name of the AppInstanceUser.
string
The metadata of the AppInstanceUser.
dict
Response Syntax
{
'AppInstanceUserArn': 'string'
}
Response Structure
(dict) --
AppInstanceUserArn (string) --
The ARN of the AppInstanceUser.
Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.put_voice_connector_proxy(
VoiceConnectorId='string',
DefaultSessionExpiryMinutes=123,
PhoneNumberPoolCountries=[
'string',
],
FallBackPhoneNumber='string',
Disabled=True|False
)
string
[REQUIRED]
The Amazon Chime voice connector ID.
integer
[REQUIRED]
The default number of minutes allowed for proxy sessions.
list
[REQUIRED]
The countries for proxy phone numbers to be selected from.
(string) --
string
The phone number to route calls to after a proxy session expires.
boolean
When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
dict
Response Syntax
{
'Proxy': {
'DefaultSessionExpiryMinutes': 123,
'Disabled': True|False,
'FallBackPhoneNumber': 'string',
'PhoneNumberCountries': [
'string',
]
}
}
Response Structure
(dict) --
Proxy (dict) --
The proxy configuration details.
DefaultSessionExpiryMinutes (integer) --
The default number of minutes allowed for proxy sessions.
Disabled (boolean) --
When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
FallBackPhoneNumber (string) --
The phone number to route calls to after a proxy session expires.
PhoneNumberCountries (list) --
The countries for proxy phone numbers to be selected from.
(string) --
Returns the full details of a channel in an Amazon Chime AppInstance.
See also: AWS API Documentation
Request Syntax
client.describe_channel(
ChannelArn='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'Channel': {
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'CreatedBy': {
'Arn': 'string',
'Name': 'string'
},
'CreatedTimestamp': datetime(2015, 1, 1),
'LastMessageTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Channel (dict) --
The channel details.
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The channel's privacy setting.
Metadata (string) --
The channel's metadata.
CreatedBy (dict) --
The AppInstanceUser who created the channel.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
CreatedTimestamp (datetime) --
The time at which the AppInstanceUser created the channel.
LastMessageTimestamp (datetime) --
The time at which a member sent the last message in the channel.
LastUpdatedTimestamp (datetime) --
The time at which a channel was last updated.
Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
See also: AWS API Documentation
Request Syntax
client.get_voice_connector(
VoiceConnectorId='string'
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
dict
Response Syntax
{
'VoiceConnector': {
'VoiceConnectorId': 'string',
'AwsRegion': 'us-east-1'|'us-west-2',
'Name': 'string',
'OutboundHostName': 'string',
'RequireEncryption': True|False,
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'VoiceConnectorArn': 'string'
}
}
Response Structure
(dict) --
VoiceConnector (dict) --
The Amazon Chime Voice Connector details.
VoiceConnectorId (string) --
The Amazon Chime Voice Connector ID.
AwsRegion (string) --
The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.
Name (string) --
The name of the Amazon Chime Voice Connector.
OutboundHostName (string) --
The outbound host name for the Amazon Chime Voice Connector.
RequireEncryption (boolean) --
Designates whether encryption is required for the Amazon Chime Voice Connector.
CreatedTimestamp (datetime) --
The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
VoiceConnectorArn (string) --
The ARN of the specified Amazon Chime Voice Connector.
Applies the specified tags to the specified Amazon Chime SDK meeting.
See also: AWS API Documentation
Request Syntax
client.tag_meeting(
MeetingId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Chime SDK meeting ID.
list
[REQUIRED]
The tag key-value pairs.
(dict) --
Describes a tag applied to a resource.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag.
None
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.
See also: AWS API Documentation
Request Syntax
client.list_channel_memberships_for_app_instance_user(
AppInstanceUserArn='string',
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
string
The ARN of the ``AppInstanceUser``s
integer
The maximum number of users that you want returned.
string
The token returned from previous API requests until the number of channel memberships is reached.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelMemberships': [
{
'ChannelSummary': {
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'LastMessageTimestamp': datetime(2015, 1, 1)
},
'AppInstanceUserMembershipSummary': {
'Type': 'DEFAULT'|'HIDDEN',
'ReadMarkerTimestamp': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ChannelMemberships (list) --
The information for the requested channel memberships.
(dict) --
Summary of the channel membership details of an AppInstanceUser.
ChannelSummary (dict) --
Summary of the details of a Channel.
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The privacy setting of the channel.
Metadata (string) --
The metadata of the channel.
LastMessageTimestamp (datetime) --
The time at which the last message in a channel was sent.
AppInstanceUserMembershipSummary (dict) --
Summary of the membership details of an AppInstanceUser.
Type (string) --
The type of ChannelMembership.
ReadMarkerTimestamp (datetime) --
The time at which a message was last read.
NextToken (string) --
The token passed by previous API calls until all requested users are returned.
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.
See also: AWS API Documentation
Request Syntax
client.put_voice_connector_emergency_calling_configuration(
VoiceConnectorId='string',
EmergencyCallingConfiguration={
'DNIS': [
{
'EmergencyPhoneNumber': 'string',
'TestPhoneNumber': 'string',
'CallingCountry': 'string'
},
]
}
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
dict
[REQUIRED]
The emergency calling configuration details.
DNIS (list) --
The Dialed Number Identification Service (DNIS) emergency calling configuration details.
(dict) --
The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.
EmergencyPhoneNumber (string) -- [REQUIRED]
The DNIS phone number to route emergency calls to, in E.164 format.
TestPhoneNumber (string) --
The DNIS phone number to route test emergency calls to, in E.164 format.
CallingCountry (string) -- [REQUIRED]
The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.
dict
Response Syntax
{
'EmergencyCallingConfiguration': {
'DNIS': [
{
'EmergencyPhoneNumber': 'string',
'TestPhoneNumber': 'string',
'CallingCountry': 'string'
},
]
}
}
Response Structure
(dict) --
EmergencyCallingConfiguration (dict) --
The emergency calling configuration details.
DNIS (list) --
The Dialed Number Identification Service (DNIS) emergency calling configuration details.
(dict) --
The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.
EmergencyPhoneNumber (string) --
The DNIS phone number to route emergency calls to, in E.164 format.
TestPhoneNumber (string) --
The DNIS phone number to route test emergency calls to, in E.164 format.
CallingCountry (string) --
The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.
Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.
See also: AWS API Documentation
Request Syntax
client.update_sip_media_application_call(
SipMediaApplicationId='string',
TransactionId='string',
Arguments={
'string': 'string'
}
)
string
[REQUIRED]
The ID of the SIP media application handling the call.
string
[REQUIRED]
The ID of the call transaction.
dict
[REQUIRED]
Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED event. Can contain 0-20 key-value pairs.
(string) --
(string) --
dict
Response Syntax
{
'SipMediaApplicationCall': {
'TransactionId': 'string'
}
}
Response Structure
(dict) --
SipMediaApplicationCall (dict) --
A Call instance for a SIP media application.
TransactionId (string) --
The transaction ID of a call.
Gets the proxy configuration details for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.get_voice_connector_proxy(
VoiceConnectorId='string'
)
string
[REQUIRED]
The Amazon Chime voice connector ID.
dict
Response Syntax
{
'Proxy': {
'DefaultSessionExpiryMinutes': 123,
'Disabled': True|False,
'FallBackPhoneNumber': 'string',
'PhoneNumberCountries': [
'string',
]
}
}
Response Structure
(dict) --
Proxy (dict) --
The proxy configuration details.
DefaultSessionExpiryMinutes (integer) --
The default number of minutes allowed for proxy sessions.
Disabled (boolean) --
When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
FallBackPhoneNumber (string) --
The phone number to route calls to after a proxy session expires.
PhoneNumberCountries (list) --
The countries for proxy phone numbers to be selected from.
(string) --
Stops transcription for the specified meetingId.
See also: AWS API Documentation
Request Syntax
client.stop_meeting_transcription(
MeetingId='string'
)
string
[REQUIRED]
The unique ID of the meeting for which you stop transcription.
dict
Response Syntax
{}
Response Structure
(dict) --
Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
See also: AWS API Documentation
Request Syntax
client.delete_channel(
ChannelArn='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel being deleted.
string
The AppInstanceUserArn of the user that makes the API call.
None
Update a channel's attributes.
Restriction: You can't change a channel's privacy.
See also: AWS API Documentation
Request Syntax
client.update_channel(
ChannelArn='string',
Name='string',
Mode='UNRESTRICTED'|'RESTRICTED',
Metadata='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel.
string
[REQUIRED]
The name of the channel.
string
[REQUIRED]
The mode of the update request.
string
The metadata for the update request.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelArn': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
Untags the specified tags from the specified Amazon Chime SDK attendee.
See also: AWS API Documentation
Request Syntax
client.untag_attendee(
MeetingId='string',
AttendeeId='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Chime SDK meeting ID.
string
[REQUIRED]
The Amazon Chime SDK attendee ID.
list
[REQUIRED]
The tag keys.
(string) --
None
Gets an existing media capture pipeline.
See also: AWS API Documentation
Request Syntax
client.get_media_capture_pipeline(
MediaPipelineId='string'
)
string
[REQUIRED]
The ID of the pipeline that you want to get.
dict
Response Syntax
{
'MediaCapturePipeline': {
'MediaPipelineId': 'string',
'SourceType': 'ChimeSdkMeeting',
'SourceArn': 'string',
'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
'SinkType': 'S3Bucket',
'SinkArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'ChimeSdkMeetingConfiguration': {
'SourceConfiguration': {
'SelectedVideoStreams': {
'AttendeeIds': [
'string',
],
'ExternalUserIds': [
'string',
]
}
},
'ArtifactsConfiguration': {
'Audio': {
'MuxType': 'AudioOnly'|'AudioWithActiveSpeakerVideo'
},
'Video': {
'State': 'Enabled'|'Disabled',
'MuxType': 'VideoOnly'
},
'Content': {
'State': 'Enabled'|'Disabled',
'MuxType': 'ContentOnly'
}
}
}
}
}
Response Structure
(dict) --
MediaCapturePipeline (dict) --
The media capture pipeline object.
MediaPipelineId (string) --
The ID of a media capture pipeline.
SourceType (string) --
Source type from which media artifacts are saved. You must use ChimeMeeting.
SourceArn (string) --
ARN of the source from which the media artifacts will be saved.
Status (string) --
The status of the media capture pipeline.
SinkType (string) --
Destination type to which the media artifacts are saved. You must use an S3 Bucket.
SinkArn (string) --
ARN of the destination to which the media artifacts are saved.
CreatedTimestamp (datetime) --
The time at which the capture pipeline was created, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The time at which the capture pipeline was updated, in ISO 8601 format.
ChimeSdkMeetingConfiguration (dict) --
The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.
SourceConfiguration (dict) --
The source configuration for a specified media capture pipeline.
SelectedVideoStreams (dict) --
The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.
AttendeeIds (list) --
The attendee IDs of the streams selected for a media capture pipeline.
(string) --
ExternalUserIds (list) --
The external user IDs of the streams selected for a media capture pipeline.
(string) --
ArtifactsConfiguration (dict) --
The configuration for the artifacts in an Amazon Chime SDK meeting.
Audio (dict) --
The configuration for the audio artifacts.
MuxType (string) --
The MUX type of the audio artifact configuration object.
Video (dict) --
The configuration for the video artifacts.
State (string) --
Indicates whether the video artifact is enabled or disabled.
MuxType (string) --
The MUX type of the video artifact configuration object.
Content (dict) --
The configuration for the content artifacts.
State (string) --
Indicates whether the content artifact is enabled or disabled.
MuxType (string) --
The MUX type of the artifact configuration.
Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.
See also: AWS API Documentation
Request Syntax
client.get_voice_connector_group(
VoiceConnectorGroupId='string'
)
string
[REQUIRED]
The Amazon Chime Voice Connector group ID.
dict
Response Syntax
{
'VoiceConnectorGroup': {
'VoiceConnectorGroupId': 'string',
'Name': 'string',
'VoiceConnectorItems': [
{
'VoiceConnectorId': 'string',
'Priority': 123
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'VoiceConnectorGroupArn': 'string'
}
}
Response Structure
(dict) --
VoiceConnectorGroup (dict) --
The Amazon Chime Voice Connector group details.
VoiceConnectorGroupId (string) --
The Amazon Chime Voice Connector group ID.
Name (string) --
The name of the Amazon Chime Voice Connector group.
VoiceConnectorItems (list) --
The Amazon Chime Voice Connectors to which to route inbound calls.
(dict) --
For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
VoiceConnectorId (string) --
The Amazon Chime Voice Connector ID.
Priority (integer) --
The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
CreatedTimestamp (datetime) --
The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
VoiceConnectorGroupArn (string) --
The ARN of the specified Amazon Chime Voice Connector group.
Gets the specified proxy session details for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.get_proxy_session(
VoiceConnectorId='string',
ProxySessionId='string'
)
string
[REQUIRED]
The Amazon Chime voice connector ID.
string
[REQUIRED]
The proxy session ID.
dict
Response Syntax
{
'ProxySession': {
'VoiceConnectorId': 'string',
'ProxySessionId': 'string',
'Name': 'string',
'Status': 'Open'|'InProgress'|'Closed',
'ExpiryMinutes': 123,
'Capabilities': [
'Voice'|'SMS',
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'EndedTimestamp': datetime(2015, 1, 1),
'Participants': [
{
'PhoneNumber': 'string',
'ProxyPhoneNumber': 'string'
},
],
'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
'GeoMatchLevel': 'Country'|'AreaCode',
'GeoMatchParams': {
'Country': 'string',
'AreaCode': 'string'
}
}
}
Response Structure
(dict) --
ProxySession (dict) --
The proxy session details.
VoiceConnectorId (string) --
The Amazon Chime voice connector ID.
ProxySessionId (string) --
The proxy session ID.
Name (string) --
The name of the proxy session.
Status (string) --
The status of the proxy session.
ExpiryMinutes (integer) --
The number of minutes allowed for the proxy session.
Capabilities (list) --
The proxy session capabilities.
(string) --
CreatedTimestamp (datetime) --
The created time stamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated time stamp, in ISO 8601 format.
EndedTimestamp (datetime) --
The ended time stamp, in ISO 8601 format.
Participants (list) --
The proxy session participants.
(dict) --
The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.
PhoneNumber (string) --
The participant's phone number.
ProxyPhoneNumber (string) --
The participant's proxy phone number.
NumberSelectionBehavior (string) --
The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
GeoMatchLevel (string) --
The preference for matching the country or area code of the proxy phone number with that of the first participant.
GeoMatchParams (dict) --
The country and area code for the proxy phone number.
Country (string) --
The country.
AreaCode (string) --
The area code.
Adds termination settings for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.put_voice_connector_termination(
VoiceConnectorId='string',
Termination={
'CpsLimit': 123,
'DefaultPhoneNumber': 'string',
'CallingRegions': [
'string',
],
'CidrAllowedList': [
'string',
],
'Disabled': True|False
}
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
dict
[REQUIRED]
The termination setting details to add.
CpsLimit (integer) --
The limit on calls per second. Max value based on account service quota. Default value of 1.
DefaultPhoneNumber (string) --
The default caller ID phone number.
CallingRegions (list) --
The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
(string) --
CidrAllowedList (list) --
The IP addresses allowed to make calls, in CIDR format. Required.
(string) --
Disabled (boolean) --
When termination settings are disabled, outbound calls can not be made.
dict
Response Syntax
{
'Termination': {
'CpsLimit': 123,
'DefaultPhoneNumber': 'string',
'CallingRegions': [
'string',
],
'CidrAllowedList': [
'string',
],
'Disabled': True|False
}
}
Response Structure
(dict) --
Termination (dict) --
The updated termination setting details.
CpsLimit (integer) --
The limit on calls per second. Max value based on account service quota. Default value of 1.
DefaultPhoneNumber (string) --
The default caller ID phone number.
CallingRegions (list) --
The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
(string) --
CidrAllowedList (list) --
The IP addresses allowed to make calls, in CIDR format. Required.
(string) --
Disabled (boolean) --
When termination settings are disabled, outbound calls can not be made.
Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions.
ChannelModerator actions across all channels in the AppInstance.
DeleteChannelMessage actions.
Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.
See also: AWS API Documentation
Request Syntax
client.create_app_instance_admin(
AppInstanceAdminArn='string',
AppInstanceArn='string'
)
string
[REQUIRED]
The ARN of the administrator of the current AppInstance.
string
[REQUIRED]
The ARN of the AppInstance.
dict
Response Syntax
{
'AppInstanceAdmin': {
'Arn': 'string',
'Name': 'string'
},
'AppInstanceArn': 'string'
}
Response Structure
(dict) --
AppInstanceAdmin (dict) --
The name and ARN of the admin for the AppInstance.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
AppInstanceArn (string) --
The ARN of the of the admin for the AppInstance.
Creates a media capture pipeline.
See also: AWS API Documentation
Request Syntax
client.create_media_capture_pipeline(
SourceType='ChimeSdkMeeting',
SourceArn='string',
SinkType='S3Bucket',
SinkArn='string',
ClientRequestToken='string',
ChimeSdkMeetingConfiguration={
'SourceConfiguration': {
'SelectedVideoStreams': {
'AttendeeIds': [
'string',
],
'ExternalUserIds': [
'string',
]
}
},
'ArtifactsConfiguration': {
'Audio': {
'MuxType': 'AudioOnly'|'AudioWithActiveSpeakerVideo'
},
'Video': {
'State': 'Enabled'|'Disabled',
'MuxType': 'VideoOnly'
},
'Content': {
'State': 'Enabled'|'Disabled',
'MuxType': 'ContentOnly'
}
}
}
)
string
[REQUIRED]
Source type from which the media artifacts will be captured. A Chime SDK Meeting is the only supported source.
string
[REQUIRED]
ARN of the source from which the media artifacts are captured.
string
[REQUIRED]
Destination type to which the media artifacts are saved. You must use an S3 bucket.
string
[REQUIRED]
The ARN of the sink 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.
This field is autopopulated if not provided.
dict
The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.
SourceConfiguration (dict) --
The source configuration for a specified media capture pipeline.
SelectedVideoStreams (dict) --
The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.
AttendeeIds (list) --
The attendee IDs of the streams selected for a media capture pipeline.
(string) --
ExternalUserIds (list) --
The external user IDs of the streams selected for a media capture pipeline.
(string) --
ArtifactsConfiguration (dict) --
The configuration for the artifacts in an Amazon Chime SDK meeting.
Audio (dict) -- [REQUIRED]
The configuration for the audio artifacts.
MuxType (string) -- [REQUIRED]
The MUX type of the audio artifact configuration object.
Video (dict) -- [REQUIRED]
The configuration for the video artifacts.
State (string) -- [REQUIRED]
Indicates whether the video artifact is enabled or disabled.
MuxType (string) --
The MUX type of the video artifact configuration object.
Content (dict) -- [REQUIRED]
The configuration for the content artifacts.
State (string) -- [REQUIRED]
Indicates whether the content artifact is enabled or disabled.
MuxType (string) --
The MUX type of the artifact configuration.
dict
Response Syntax
{
'MediaCapturePipeline': {
'MediaPipelineId': 'string',
'SourceType': 'ChimeSdkMeeting',
'SourceArn': 'string',
'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
'SinkType': 'S3Bucket',
'SinkArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'ChimeSdkMeetingConfiguration': {
'SourceConfiguration': {
'SelectedVideoStreams': {
'AttendeeIds': [
'string',
],
'ExternalUserIds': [
'string',
]
}
},
'ArtifactsConfiguration': {
'Audio': {
'MuxType': 'AudioOnly'|'AudioWithActiveSpeakerVideo'
},
'Video': {
'State': 'Enabled'|'Disabled',
'MuxType': 'VideoOnly'
},
'Content': {
'State': 'Enabled'|'Disabled',
'MuxType': 'ContentOnly'
}
}
}
}
}
Response Structure
(dict) --
MediaCapturePipeline (dict) --
A media capture pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media capture pipeline object.
MediaPipelineId (string) --
The ID of a media capture pipeline.
SourceType (string) --
Source type from which media artifacts are saved. You must use ChimeMeeting.
SourceArn (string) --
ARN of the source from which the media artifacts will be saved.
Status (string) --
The status of the media capture pipeline.
SinkType (string) --
Destination type to which the media artifacts are saved. You must use an S3 Bucket.
SinkArn (string) --
ARN of the destination to which the media artifacts are saved.
CreatedTimestamp (datetime) --
The time at which the capture pipeline was created, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The time at which the capture pipeline was updated, in ISO 8601 format.
ChimeSdkMeetingConfiguration (dict) --
The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.
SourceConfiguration (dict) --
The source configuration for a specified media capture pipeline.
SelectedVideoStreams (dict) --
The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.
AttendeeIds (list) --
The attendee IDs of the streams selected for a media capture pipeline.
(string) --
ExternalUserIds (list) --
The external user IDs of the streams selected for a media capture pipeline.
(string) --
ArtifactsConfiguration (dict) --
The configuration for the artifacts in an Amazon Chime SDK meeting.
Audio (dict) --
The configuration for the audio artifacts.
MuxType (string) --
The MUX type of the audio artifact configuration object.
Video (dict) --
The configuration for the video artifacts.
State (string) --
Indicates whether the video artifact is enabled or disabled.
MuxType (string) --
The MUX type of the video artifact configuration object.
Content (dict) --
The configuration for the content artifacts.
State (string) --
Indicates whether the content artifact is enabled or disabled.
MuxType (string) --
The MUX type of the artifact configuration.
Creates a SIP media application.
See also: AWS API Documentation
Request Syntax
client.create_sip_media_application(
AwsRegion='string',
Name='string',
Endpoints=[
{
'LambdaArn': 'string'
},
]
)
string
[REQUIRED]
The AWS Region assigned to the SIP media application.
string
[REQUIRED]
The SIP media application name.
list
[REQUIRED]
List of endpoints (Lambda Amazon Resource Names) specified for the SIP media application. Currently, only one endpoint is supported.
(dict) --
The endpoint assigned to the SIP media application.
LambdaArn (string) --
Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.
dict
Response Syntax
{
'SipMediaApplication': {
'SipMediaApplicationId': 'string',
'AwsRegion': 'string',
'Name': 'string',
'Endpoints': [
{
'LambdaArn': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
SipMediaApplication (dict) --
The SIP media application details.
SipMediaApplicationId (string) --
The SIP media application ID.
AwsRegion (string) --
The AWS Region in which the SIP media application is created.
Name (string) --
The name of the SIP media application.
Endpoints (list) --
List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.
(dict) --
The endpoint assigned to the SIP media application.
LambdaArn (string) --
Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.
CreatedTimestamp (datetime) --
The SIP media application creation timestamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The SIP media application updated timestamp, in ISO 8601 format.
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.
See also: AWS API Documentation
Request Syntax
client.create_app_instance(
Name='string',
Metadata='string',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the AppInstance.
string
The metadata of the AppInstance. Limited to a 1KB string in UTF-8.
string
[REQUIRED]
The ClientRequestToken of the AppInstance.
This field is autopopulated if not provided.
list
Tags assigned to the AppInstance.
(dict) --
Describes a tag applied to a resource.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag.
dict
Response Syntax
{
'AppInstanceArn': 'string'
}
Response Structure
(dict) --
AppInstanceArn (string) --
The Amazon Resource Number (ARN) of the AppInstance.
Applies the specified tags to the specified Amazon Chime SDK meeting resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The resource ARN.
list
[REQUIRED]
The tag key-value pairs.
(dict) --
Describes a tag applied to a resource.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag.
None
Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
See also: AWS API Documentation
Request Syntax
client.create_channel(
AppInstanceArn='string',
Name='string',
Mode='UNRESTRICTED'|'RESTRICTED',
Privacy='PUBLIC'|'PRIVATE',
Metadata='string',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel request.
string
[REQUIRED]
The name of the channel.
string
The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.
string
The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.
string
The metadata of the creation request. Limited to 1KB and UTF-8.
string
[REQUIRED]
The client token for the request. An Idempotency token.
This field is autopopulated if not provided.
list
The tags for the creation request.
(dict) --
Describes a tag applied to a resource.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelArn': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
Deletes the streaming configurations of an AppInstance.
See also: AWS API Documentation
Request Syntax
client.delete_app_instance_streaming_configurations(
AppInstanceArn='string'
)
string
[REQUIRED]
The ARN of the streaming configurations being deleted.
None
Gets the retention settings for an AppInstance.
See also: AWS API Documentation
Request Syntax
client.get_app_instance_retention_settings(
AppInstanceArn='string'
)
string
[REQUIRED]
The ARN of the AppInstance.
dict
Response Syntax
{
'AppInstanceRetentionSettings': {
'ChannelRetentionSettings': {
'RetentionDays': 123
}
},
'InitiateDeletionTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
AppInstanceRetentionSettings (dict) --
The retention settings for the AppInstance.
ChannelRetentionSettings (dict) --
The length of time in days to retain the messages in a channel.
RetentionDays (integer) --
The time in days to retain the messages in a channel.
InitiateDeletionTimestamp (datetime) --
The timestamp representing the time at which the specified items are retained, in Epoch Seconds.
Applies the specified tags to the specified Amazon Chime attendee.
See also: AWS API Documentation
Request Syntax
client.tag_attendee(
MeetingId='string',
AttendeeId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Chime SDK meeting ID.
string
[REQUIRED]
The Amazon Chime SDK attendee ID.
list
[REQUIRED]
The tag key-value pairs.
(dict) --
Describes a tag applied to a resource.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag.
None
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.
See also: AWS API Documentation
Request Syntax
client.create_voice_connector_group(
Name='string',
VoiceConnectorItems=[
{
'VoiceConnectorId': 'string',
'Priority': 123
},
]
)
string
[REQUIRED]
The name of the Amazon Chime Voice Connector group.
list
The Amazon Chime Voice Connectors to route inbound calls to.
(dict) --
For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
VoiceConnectorId (string) -- [REQUIRED]
The Amazon Chime Voice Connector ID.
Priority (integer) -- [REQUIRED]
The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
dict
Response Syntax
{
'VoiceConnectorGroup': {
'VoiceConnectorGroupId': 'string',
'Name': 'string',
'VoiceConnectorItems': [
{
'VoiceConnectorId': 'string',
'Priority': 123
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'VoiceConnectorGroupArn': 'string'
}
}
Response Structure
(dict) --
VoiceConnectorGroup (dict) --
The Amazon Chime Voice Connector group details.
VoiceConnectorGroupId (string) --
The Amazon Chime Voice Connector group ID.
Name (string) --
The name of the Amazon Chime Voice Connector group.
VoiceConnectorItems (list) --
The Amazon Chime Voice Connectors to which to route inbound calls.
(dict) --
For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
VoiceConnectorId (string) --
The Amazon Chime Voice Connector ID.
Priority (integer) --
The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
CreatedTimestamp (datetime) --
The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
VoiceConnectorGroupArn (string) --
The ARN of the specified Amazon Chime Voice Connector group.
The details of the endpoint for the messaging session.
See also: AWS API Documentation
Request Syntax
client.get_messaging_session_endpoint()
dict
Response Syntax
{
'Endpoint': {
'Url': 'string'
}
}
Response Structure
(dict) --
Endpoint (dict) --
The endpoint returned in the response.
Url (string) --
The endpoint to which you establish a websocket connection.
Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
See also: AWS API Documentation
Request Syntax
client.list_voice_connectors(
NextToken='string',
MaxResults=123
)
string
The token to use to retrieve the next page of results.
integer
The maximum number of results to return in a single call.
dict
Response Syntax
{
'VoiceConnectors': [
{
'VoiceConnectorId': 'string',
'AwsRegion': 'us-east-1'|'us-west-2',
'Name': 'string',
'OutboundHostName': 'string',
'RequireEncryption': True|False,
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'VoiceConnectorArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
VoiceConnectors (list) --
The details of the Amazon Chime Voice Connectors.
(dict) --
The Amazon Chime Voice Connector configuration, including outbound host name and encryption settings.
VoiceConnectorId (string) --
The Amazon Chime Voice Connector ID.
AwsRegion (string) --
The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.
Name (string) --
The name of the Amazon Chime Voice Connector.
OutboundHostName (string) --
The outbound host name for the Amazon Chime Voice Connector.
RequireEncryption (boolean) --
Designates whether encryption is required for the Amazon Chime Voice Connector.
CreatedTimestamp (datetime) --
The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
VoiceConnectorArn (string) --
The ARN of the specified Amazon Chime Voice Connector.
NextToken (string) --
The token to use to retrieve the next page of results.
Returns the full details of an AppInstanceUser.
See also: AWS API Documentation
Request Syntax
client.describe_app_instance_user(
AppInstanceUserArn='string'
)
string
[REQUIRED]
The ARN of the AppInstanceUser.
dict
Response Syntax
{
'AppInstanceUser': {
'AppInstanceUserArn': 'string',
'Name': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'Metadata': 'string',
'LastUpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
AppInstanceUser (dict) --
The name of the AppInstanceUser.
AppInstanceUserArn (string) --
The ARN of the AppInstanceUser.
Name (string) --
The name of the AppInstanceUser.
CreatedTimestamp (datetime) --
The time at which the AppInstanceUser was created.
Metadata (string) --
The metadata of the AppInstanceUser.
LastUpdatedTimestamp (datetime) --
The time at which the AppInstanceUser was last updated.
Returns the details of a channel based on the membership of the specified AppInstanceUser.
See also: AWS API Documentation
Request Syntax
client.describe_channel_membership_for_app_instance_user(
ChannelArn='string',
AppInstanceUserArn='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel to which the user belongs.
string
[REQUIRED]
The ARN of the user in a channel.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelMembership': {
'ChannelSummary': {
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'LastMessageTimestamp': datetime(2015, 1, 1)
},
'AppInstanceUserMembershipSummary': {
'Type': 'DEFAULT'|'HIDDEN',
'ReadMarkerTimestamp': datetime(2015, 1, 1)
}
}
}
Response Structure
(dict) --
ChannelMembership (dict) --
The channel to which a user belongs.
ChannelSummary (dict) --
Summary of the details of a Channel.
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The privacy setting of the channel.
Metadata (string) --
The metadata of the channel.
LastMessageTimestamp (datetime) --
The time at which the last message in a channel was sent.
AppInstanceUserMembershipSummary (dict) --
Summary of the membership details of an AppInstanceUser.
Type (string) --
The type of ChannelMembership.
ReadMarkerTimestamp (datetime) --
The time at which a message was last read.
Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
See also: AWS API Documentation
Request Syntax
client.get_sip_media_application(
SipMediaApplicationId='string'
)
string
[REQUIRED]
The SIP media application ID.
dict
Response Syntax
{
'SipMediaApplication': {
'SipMediaApplicationId': 'string',
'AwsRegion': 'string',
'Name': 'string',
'Endpoints': [
{
'LambdaArn': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
SipMediaApplication (dict) --
The SIP media application details.
SipMediaApplicationId (string) --
The SIP media application ID.
AwsRegion (string) --
The AWS Region in which the SIP media application is created.
Name (string) --
The name of the SIP media application.
Endpoints (list) --
List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.
(dict) --
The endpoint assigned to the SIP media application.
LambdaArn (string) --
Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.
CreatedTimestamp (datetime) --
The SIP media application creation timestamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The SIP media application updated timestamp, in ISO 8601 format.
Returns the full details of an AppInstance.
See also: AWS API Documentation
Request Syntax
client.describe_app_instance(
AppInstanceArn='string'
)
string
[REQUIRED]
The ARN of the AppInstance.
dict
Response Syntax
{
'AppInstance': {
'AppInstanceArn': 'string',
'Name': 'string',
'Metadata': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
AppInstance (dict) --
The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance. All timestamps use epoch milliseconds.
AppInstanceArn (string) --
The ARN of the messaging instance.
Name (string) --
The name of an AppInstance.
Metadata (string) --
The metadata of an AppInstance.
CreatedTimestamp (datetime) --
The time at which an AppInstance was created. In epoch milliseconds.
LastUpdatedTimestamp (datetime) --
The time an AppInstance was last updated. In epoch milliseconds.
Deletes the termination settings for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.delete_voice_connector_termination(
VoiceConnectorId='string'
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
None
Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
See also: AWS API Documentation
Request Syntax
client.create_proxy_session(
VoiceConnectorId='string',
ParticipantPhoneNumbers=[
'string',
],
Name='string',
ExpiryMinutes=123,
Capabilities=[
'Voice'|'SMS',
],
NumberSelectionBehavior='PreferSticky'|'AvoidSticky',
GeoMatchLevel='Country'|'AreaCode',
GeoMatchParams={
'Country': 'string',
'AreaCode': 'string'
}
)
string
[REQUIRED]
The Amazon Chime voice connector ID.
list
[REQUIRED]
The participant phone numbers.
(string) --
string
The name of the proxy session.
integer
The number of minutes allowed for the proxy session.
list
[REQUIRED]
The proxy session capabilities.
(string) --
string
The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
string
The preference for matching the country or area code of the proxy phone number with that of the first participant.
dict
The country and area code for the proxy phone number.
Country (string) -- [REQUIRED]
The country.
AreaCode (string) -- [REQUIRED]
The area code.
dict
Response Syntax
{
'ProxySession': {
'VoiceConnectorId': 'string',
'ProxySessionId': 'string',
'Name': 'string',
'Status': 'Open'|'InProgress'|'Closed',
'ExpiryMinutes': 123,
'Capabilities': [
'Voice'|'SMS',
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'EndedTimestamp': datetime(2015, 1, 1),
'Participants': [
{
'PhoneNumber': 'string',
'ProxyPhoneNumber': 'string'
},
],
'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
'GeoMatchLevel': 'Country'|'AreaCode',
'GeoMatchParams': {
'Country': 'string',
'AreaCode': 'string'
}
}
}
Response Structure
(dict) --
ProxySession (dict) --
The proxy session details.
VoiceConnectorId (string) --
The Amazon Chime voice connector ID.
ProxySessionId (string) --
The proxy session ID.
Name (string) --
The name of the proxy session.
Status (string) --
The status of the proxy session.
ExpiryMinutes (integer) --
The number of minutes allowed for the proxy session.
Capabilities (list) --
The proxy session capabilities.
(string) --
CreatedTimestamp (datetime) --
The created time stamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated time stamp, in ISO 8601 format.
EndedTimestamp (datetime) --
The ended time stamp, in ISO 8601 format.
Participants (list) --
The proxy session participants.
(dict) --
The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.
PhoneNumber (string) --
The participant's phone number.
ProxyPhoneNumber (string) --
The participant's proxy phone number.
NumberSelectionBehavior (string) --
The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
GeoMatchLevel (string) --
The preference for matching the country or area code of the proxy phone number with that of the first participant.
GeoMatchParams (dict) --
The country and area code for the proxy phone number.
Country (string) --
The country.
AreaCode (string) --
The area code.
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.
See also: AWS API Documentation
Request Syntax
client.create_channel_membership(
ChannelArn='string',
MemberArn='string',
Type='DEFAULT'|'HIDDEN',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel to which you're adding users.
string
[REQUIRED]
The ARN of the member you want to add to the channel.
string
[REQUIRED]
The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelArn': 'string',
'Member': {
'Arn': 'string',
'Name': 'string'
}
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
Member (dict) --
The ARN and metadata of the member being added.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
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.
See also: AWS API Documentation
Request Syntax
client.get_attendee(
MeetingId='string',
AttendeeId='string'
)
string
[REQUIRED]
The Amazon Chime SDK meeting ID.
string
[REQUIRED]
The Amazon Chime SDK attendee ID.
dict
Response Syntax
{
'Attendee': {
'ExternalUserId': 'string',
'AttendeeId': 'string',
'JoinToken': 'string'
}
}
Response Structure
(dict) --
Attendee (dict) --
The Amazon Chime SDK attendee information.
ExternalUserId (string) --
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
AttendeeId (string) --
The Amazon Chime SDK attendee ID.
JoinToken (string) --
The join token used by the Amazon Chime SDK attendee.
Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.
See also: AWS API Documentation
Request Syntax
client.create_sip_rule(
Name='string',
TriggerType='ToPhoneNumber'|'RequestUriHostname',
TriggerValue='string',
Disabled=True|False,
TargetApplications=[
{
'SipMediaApplicationId': 'string',
'Priority': 123,
'AwsRegion': 'string'
},
]
)
string
[REQUIRED]
The name of the SIP rule.
string
[REQUIRED]
The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
string
[REQUIRED]
If TriggerType is RequestUriHostname, the value can be the outbound host name of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.
boolean
Enables or disables a rule. You must disable rules before you can delete them.
list
[REQUIRED]
List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.
(dict) --
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
SipMediaApplicationId (string) --
The SIP media application ID.
Priority (integer) --
Priority of the SIP media application in the target list.
AwsRegion (string) --
The AWS Region of the target application.
dict
Response Syntax
{
'SipRule': {
'SipRuleId': 'string',
'Name': 'string',
'Disabled': True|False,
'TriggerType': 'ToPhoneNumber'|'RequestUriHostname',
'TriggerValue': 'string',
'TargetApplications': [
{
'SipMediaApplicationId': 'string',
'Priority': 123,
'AwsRegion': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
SipRule (dict) --
Returns the SIP rule information, including the rule ID, triggers, and target applications.
SipRuleId (string) --
The SIP rule ID.
Name (string) --
The name of the SIP rule.
Disabled (boolean) --
Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
TriggerType (string) --
The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
TriggerValue (string) --
If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.
TargetApplications (list) --
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
(dict) --
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
SipMediaApplicationId (string) --
The SIP media application ID.
Priority (integer) --
Priority of the SIP media application in the target list.
AwsRegion (string) --
The AWS Region of the target application.
CreatedTimestamp (datetime) --
The time at which the SIP rule was created, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The time at which the SIP rule was last updated, in ISO 8601 format.
Deletes the specified proxy session from the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.delete_proxy_session(
VoiceConnectorId='string',
ProxySessionId='string'
)
string
[REQUIRED]
The Amazon Chime voice connector ID.
string
[REQUIRED]
The proxy session ID.
None
Adds a specified number of users to a channel.
See also: AWS API Documentation
Request Syntax
client.batch_create_channel_membership(
ChannelArn='string',
Type='DEFAULT'|'HIDDEN',
MemberArns=[
'string',
],
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel to which you're adding users.
string
The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.
list
[REQUIRED]
The ARNs of the members you want to add to the channel.
(string) --
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'BatchChannelMemberships': {
'InvitedBy': {
'Arn': 'string',
'Name': 'string'
},
'Type': 'DEFAULT'|'HIDDEN',
'Members': [
{
'Arn': 'string',
'Name': 'string'
},
],
'ChannelArn': 'string'
},
'Errors': [
{
'MemberArn': 'string',
'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
BatchChannelMemberships (dict) --
The list of channel memberships in the response.
InvitedBy (dict) --
The identifier of the member who invited another member.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Type (string) --
The membership types set for the channel users.
Members (list) --
The users successfully added to the request.
(dict) --
The details of a user.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
ChannelArn (string) --
The ARN of the channel to which you're adding users.
Errors (list) --
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.
(dict) --
A list of failed member ARNs, error codes, and error messages.
MemberArn (string) --
The ARN of the member that the service couldn't add.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
Returns a list of the administrators in the AppInstance.
See also: AWS API Documentation
Request Syntax
client.list_app_instance_admins(
AppInstanceArn='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ARN of the AppInstance.
integer
The maximum number of administrators that you want to return.
string
The token returned from previous API requests until the number of administrators is reached.
dict
Response Syntax
{
'AppInstanceArn': 'string',
'AppInstanceAdmins': [
{
'Admin': {
'Arn': 'string',
'Name': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AppInstanceArn (string) --
The ARN of the AppInstance.
AppInstanceAdmins (list) --
The information for each administrator.
(dict) --
Summary of the details of an AppInstanceAdmin.
Admin (dict) --
The details of the AppInstanceAdmin.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
NextToken (string) --
The token returned from previous API requests until the number of administrators is reached.
Lists the tags applied to an Amazon Chime SDK attendee resource.
See also: AWS API Documentation
Request Syntax
client.list_attendee_tags(
MeetingId='string',
AttendeeId='string'
)
string
[REQUIRED]
The Amazon Chime SDK meeting ID.
string
[REQUIRED]
The Amazon Chime SDK attendee ID.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Tags (list) --
A list of tag key-value pairs.
(dict) --
Describes a tag applied to a resource.
Key (string) --
The key of the tag.
Value (string) --
The value of the tag.
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.
See also: AWS API Documentation
Request Syntax
client.create_voice_connector(
Name='string',
AwsRegion='us-east-1'|'us-west-2',
RequireEncryption=True|False
)
string
[REQUIRED]
The name of the Amazon Chime Voice Connector.
string
The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1 .
boolean
[REQUIRED]
When enabled, requires encryption for the Amazon Chime Voice Connector.
dict
Response Syntax
{
'VoiceConnector': {
'VoiceConnectorId': 'string',
'AwsRegion': 'us-east-1'|'us-west-2',
'Name': 'string',
'OutboundHostName': 'string',
'RequireEncryption': True|False,
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'VoiceConnectorArn': 'string'
}
}
Response Structure
(dict) --
VoiceConnector (dict) --
The Amazon Chime Voice Connector details.
VoiceConnectorId (string) --
The Amazon Chime Voice Connector ID.
AwsRegion (string) --
The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.
Name (string) --
The name of the Amazon Chime Voice Connector.
OutboundHostName (string) --
The outbound host name for the Amazon Chime Voice Connector.
RequireEncryption (boolean) --
Designates whether encryption is required for the Amazon Chime Voice Connector.
CreatedTimestamp (datetime) --
The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
VoiceConnectorArn (string) --
The ARN of the specified Amazon Chime Voice Connector.
Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.get_voice_connector_emergency_calling_configuration(
VoiceConnectorId='string'
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
dict
Response Syntax
{
'EmergencyCallingConfiguration': {
'DNIS': [
{
'EmergencyPhoneNumber': 'string',
'TestPhoneNumber': 'string',
'CallingCountry': 'string'
},
]
}
}
Response Structure
(dict) --
EmergencyCallingConfiguration (dict) --
The emergency calling configuration details.
DNIS (list) --
The Dialed Number Identification Service (DNIS) emergency calling configuration details.
(dict) --
The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.
EmergencyPhoneNumber (string) --
The DNIS phone number to route emergency calls to, in E.164 format.
TestPhoneNumber (string) --
The DNIS phone number to route test emergency calls to, in E.164 format.
CallingCountry (string) --
The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.
Deletes the streaming configuration for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.delete_voice_connector_streaming_configuration(
VoiceConnectorId='string'
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
None
Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.
See also: AWS API Documentation
Request Syntax
client.create_app_instance_user(
AppInstanceArn='string',
AppInstanceUserId='string',
Name='string',
Metadata='string',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ARN of the AppInstance request.
string
[REQUIRED]
The user ID of the AppInstance.
string
[REQUIRED]
The user's name.
string
The request's metadata. Limited to a 1KB string in UTF-8.
string
[REQUIRED]
The token assigned to the user requesting an AppInstance.
This field is autopopulated if not provided.
list
Tags assigned to the AppInstanceUser.
(dict) --
Describes a tag applied to a resource.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) -- [REQUIRED]
The value of the tag.
dict
Response Syntax
{
'AppInstanceUserArn': 'string'
}
Response Structure
(dict) --
AppInstanceUserArn (string) --
The user's ARN.
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.
See also: AWS API Documentation
Request Syntax
client.create_channel_ban(
ChannelArn='string',
MemberArn='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the ban request.
string
[REQUIRED]
The ARN of the member being banned.
string
The AppInstanceUserArn of the user that makes the API call.
dict
Response Syntax
{
'ChannelArn': 'string',
'Member': {
'Arn': 'string',
'Name': 'string'
}
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the response to the ban request.
Member (dict) --
The ChannelArn and BannedIdentity of the member in the ban response.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.
See also: AWS API Documentation
Request Syntax
client.delete_channel_message(
ChannelArn='string',
MessageId='string',
ChimeBearer='string'
)
string
[REQUIRED]
The ARN of the channel.
string
[REQUIRED]
The ID of the message being deleted.
string
The AppInstanceUserArn of the user that makes the API call.
None
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.
See also: AWS API Documentation
Request Syntax
client.put_voice_connector_streaming_configuration(
VoiceConnectorId='string',
StreamingConfiguration={
'DataRetentionInHours': 123,
'Disabled': True|False,
'StreamingNotificationTargets': [
{
'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
},
]
}
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
dict
[REQUIRED]
The streaming configuration details to add.
DataRetentionInHours (integer) -- [REQUIRED]
The retention period, in hours, for the Amazon Kinesis data.
Disabled (boolean) --
When true, media streaming to Amazon Kinesis is turned off.
StreamingNotificationTargets (list) --
The streaming notification targets.
(dict) --
The targeted recipient for a streaming configuration notification.
NotificationTarget (string) -- [REQUIRED]
The streaming notification target.
dict
Response Syntax
{
'StreamingConfiguration': {
'DataRetentionInHours': 123,
'Disabled': True|False,
'StreamingNotificationTargets': [
{
'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
},
]
}
}
Response Structure
(dict) --
StreamingConfiguration (dict) --
The updated streaming configuration details.
DataRetentionInHours (integer) --
The retention period, in hours, for the Amazon Kinesis data.
Disabled (boolean) --
When true, media streaming to Amazon Kinesis is turned off.
StreamingNotificationTargets (list) --
The streaming notification targets.
(dict) --
The targeted recipient for a streaming configuration notification.
NotificationTarget (string) --
The streaming notification target.