String code
String awsAccountId
The AWS account ID.
String accountId
The Amazon Chime account ID.
String name
The Amazon Chime account name.
String accountType
The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Date createdTimestamp
The Amazon Chime account creation timestamp, in ISO 8601 format.
String defaultLicense
The default license for the Amazon Chime account.
List<E> supportedLicenses
Supported licenses for the Amazon Chime account.
String accountStatus
The status of the account.
List<E> signinDelegateGroups
The sign-in delegate groups associated with the account.
Boolean disableRemoteControl
Setting that stops or starts remote control of shared screens during meetings.
Boolean enableDialOut
Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App.
String appInstanceArn
The ARN of the messaging instance.
String name
The name of an AppInstance
.
String metadata
The metadata of an AppInstance
.
Date createdTimestamp
The time at which an AppInstance
was created. In epoch milliseconds.
Date lastUpdatedTimestamp
The time an AppInstance
was last updated. In epoch milliseconds.
Identity admin
The details of the AppInstanceAdmin
.
ChannelRetentionSettings channelRetentionSettings
The length of time in days to retain the messages in a channel.
String appInstanceUserArn
The ARN of the AppInstanceUser
.
String name
The name of the AppInstanceUser
.
Date createdTimestamp
The time at which the AppInstanceUser
was created.
String metadata
The metadata of the AppInstanceUser
.
Date lastUpdatedTimestamp
The time at which the AppInstanceUser
was last updated.
AudioArtifactsConfiguration audio
The configuration for the audio artifacts.
VideoArtifactsConfiguration video
The configuration for the video artifacts.
ContentArtifactsConfiguration content
The configuration for the content artifacts.
String voiceConnectorGroupId
The Amazon Chime Voice Connector group ID.
List<E> e164PhoneNumbers
List of phone numbers, in E.164 format.
Boolean forceAssociate
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.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
List<E> e164PhoneNumbers
List of phone numbers, in E.164 format.
Boolean forceAssociate
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.
String externalUserId
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
String attendeeId
The Amazon Chime SDK attendee ID.
String joinToken
The join token used by the Amazon Chime SDK attendee.
String muxType
The MUX type of the audio artifact configuration object.
String code
Identity invitedBy
The identifier of the member who invited another member.
String type
The membership types set for the channel users.
List<E> members
The users successfully added to the request.
String channelArn
The ARN of the channel to which you're adding users.
String channelArn
The ARN of the channel to which you're adding users.
String type
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<E> memberArns
The ARNs of the members you want to add to the channel.
String chimeBearer
The AppInstanceUserArn
of the user that makes the API call.
BatchChannelMemberships batchChannelMemberships
The list of channel memberships in the response.
List<E> errors
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.
List<E> userErrors
If the BatchSuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
List<E> userErrors
If the BatchUnsuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
List<E> userErrors
If the BatchUpdateUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
String botId
The bot ID.
String userId
The unique ID for the bot user.
String displayName
The bot display name.
String botType
The bot type.
Boolean disabled
When true, the bot is stopped from running in your account.
Date createdTimestamp
The bot creation timestamp, in ISO 8601 format.
Date updatedTimestamp
The updated bot timestamp, in ISO 8601 format.
String botEmail
The bot email address.
String securityToken
The security token used to authenticate Amazon Chime with the outgoing event endpoint.
String cdrBucket
The Amazon S3 bucket designated for call detail record storage.
String name
The name of the channel.
String channelArn
The ARN of the channel.
String mode
The mode of the channel.
String privacy
The channel's privacy setting.
String metadata
The channel's metadata.
Identity createdBy
The AppInstanceUser
who created the channel.
Date createdTimestamp
The time at which the AppInstanceUser
created the channel.
Date lastMessageTimestamp
The time at which a member sent the last message in the channel.
Date lastUpdatedTimestamp
The time at which a channel was last updated.
Identity member
The member being banned from the channel.
String channelArn
The ARN of the channel from which a member is being banned.
Date createdTimestamp
The time at which the ban was created.
Identity createdBy
The AppInstanceUser
who created the ban.
Identity member
The member being banned from a channel.
Identity invitedBy
The identifier of the member who invited another member.
String type
The membership type set for the channel member.
Identity member
The data of the channel member.
String channelArn
The ARN of the member's channel.
Date createdTimestamp
The time at which the channel membership was created.
Date lastUpdatedTimestamp
The time at which a channel membership was last updated.
ChannelSummary channelSummary
AppInstanceUserMembershipSummary appInstanceUserMembershipSummary
Identity member
A member's summary data.
String channelArn
The ARN of the channel.
String messageId
The ID of a message.
String content
The message content.
String metadata
The message metadata.
String type
The message type.
Date createdTimestamp
The time at which the message was created.
Date lastEditedTimestamp
The time at which a message was edited.
Date lastUpdatedTimestamp
The time at which a message was updated.
Identity sender
The message sender.
Boolean redacted
Hides the content of a message.
String persistence
The persistence setting for a channel message.
String messageId
The ID of the message.
String content
The content of the message.
String metadata
The metadata of the message.
String type
The type of message.
Date createdTimestamp
The time at which the message summary was created.
Date lastUpdatedTimestamp
The time at which a message was last updated.
Date lastEditedTimestamp
The time at which a message was last edited.
Identity sender
The message sender.
Boolean redacted
Indicates whether a message was redacted.
ChannelSummary channelSummary
Summary of the details of a Channel
.
Identity moderator
The data for a moderator.
Integer retentionDays
The time in days to retain the messages in a channel.
String name
The name of the channel.
String channelArn
The ARN of the channel.
String mode
The mode of the channel.
String privacy
The privacy setting of the channel.
String metadata
The metadata of the channel.
Date lastMessageTimestamp
The time at which the last message in a channel was sent.
SourceConfiguration sourceConfiguration
The source configuration for a specified media capture pipline.
ArtifactsConfiguration artifactsConfiguration
The configuration for the artifacts in an Amazon Chime SDK meeting.
String code
Integer retentionDays
The number of days for which to retain conversation messages.
String name
The name of the Amazon Chime account.
Account account
The Amazon Chime account details.
String appInstanceArn
The Amazon Resource Number (ARN) of the AppInstance
.
String appInstanceArn
The ARN of the AppInstance
request.
String appInstanceUserId
The user ID of the AppInstance
.
String name
The user's name.
String metadata
The request's metadata. Limited to a 1KB string in UTF-8.
String clientRequestToken
The token assigned to the user requesting an AppInstance
.
List<E> tags
Tags assigned to the AppInstanceUser
.
String appInstanceUserArn
The user's ARN.
Attendee attendee
The attendee information, including attendee ID and join token.
Bot bot
The bot details.
String channelArn
The ARN of the channel to which you're adding users.
String memberArn
The ARN of the member you want to add to the channel.
String type
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 chimeBearer
The AppInstanceUserArn
of the user that makes the API call.
String appInstanceArn
The ARN of the channel request.
String name
The name of the channel.
String mode
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 privacy
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 metadata
The metadata of the creation request. Limited to 1KB and UTF-8.
String clientRequestToken
The client token for the request. An Idempotency
token.
List<E> tags
The tags for the creation request.
String chimeBearer
The AppInstanceUserArn
of the user that makes the API call.
String channelArn
The ARN of the channel.
String sourceType
Source type from which the media artifacts will be captured. A Chime SDK Meeting is the only supported source.
String sourceArn
ARN of the source from which the media artifacts are captured.
String sinkType
Destination type to which the media artifacts are saved. You must use an S3 bucket.
String sinkArn
The ARN of the sink type.
String clientRequestToken
The token assigned to the client making the pipeline request.
ChimeSdkMeetingConfiguration chimeSdkMeetingConfiguration
The configuration for a specified media capture pipeline. SourceType
must be
ChimeSdkMeeting
.
MediaCapturePipeline mediaCapturePipeline
A media capture pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media capture pipeline object.
String meetingId
The Amazon Chime SDK meeting ID.
String fromPhoneNumber
Phone number used as the caller ID when the remote party receives a call.
String toPhoneNumber
Phone number called when inviting someone to a meeting.
String joinToken
Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.
String transactionId
Unique ID that tracks API calls.
String clientRequestToken
The unique identifier for the client request. Use a different token for different meetings.
String externalMeetingId
The external meeting ID.
String meetingHostId
Reserved.
String mediaRegion
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<E> tags
The tag key-value pairs.
MeetingNotificationConfiguration notificationsConfiguration
The configuration for resource targets to receive notifications when meeting and attendee events occur.
Meeting meeting
The meeting information, including the meeting ID and MediaPlacement
.
String clientRequestToken
The unique identifier for the client request. Use a different token for different meetings.
String externalMeetingId
The external meeting ID.
String meetingHostId
Reserved.
String mediaRegion
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<E> tags
The tag key-value pairs.
MeetingNotificationConfiguration notificationsConfiguration
List<E> attendees
The request containing the attendees to create.
PhoneNumberOrder phoneNumberOrder
The phone number order details.
String voiceConnectorId
The Amazon Chime voice connector ID.
List<E> participantPhoneNumbers
The participant phone numbers.
String name
The name of the proxy session.
Integer expiryMinutes
The number of minutes allowed for the proxy session.
List<E> capabilities
The proxy session capabilities.
String numberSelectionBehavior
The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
String geoMatchLevel
The preference for matching the country or area code of the proxy phone number with that of the first participant.
GeoMatchParams geoMatchParams
The country and area code for the proxy phone number.
ProxySession proxySession
The proxy session details.
RoomMembership roomMembership
The room membership details.
Room room
The room details.
String fromPhoneNumber
The phone number that a user calls from. This is a phone number in your Amazon Chime phone number inventory.
String toPhoneNumber
The phone number that the service should call.
String sipMediaApplicationId
The ID of the SIP media application.
Map<K,V> sipHeaders
The SIP headers added to an outbound call leg.
SipMediaApplicationCall sipMediaApplicationCall
The actual call.
SipMediaApplication sipMediaApplication
The SIP media application details.
String name
The name of the SIP rule.
String triggerType
The type of trigger assigned to the SIP rule in TriggerValue
, currently
RequestUriHostname
or ToPhoneNumber
.
String triggerValue
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 disabled
Enables or disables a rule. You must disable rules before you can delete them.
List<E> targetApplications
List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.
SipRule sipRule
Returns the SIP rule information, including the rule ID, triggers, and target applications.
User user
VoiceConnectorGroup voiceConnectorGroup
The Amazon Chime Voice Connector group details.
String name
The name of the Amazon Chime Voice Connector.
String awsRegion
The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1
.
Boolean requireEncryption
When enabled, requires encryption for the Amazon Chime Voice Connector.
VoiceConnector voiceConnector
The Amazon Chime Voice Connector details.
String accountId
The Amazon Chime account ID.
String appInstanceArn
The ARN of the AppInstance
.
String appInstanceArn
The ARN of the streaming configurations being deleted.
String appInstanceUserArn
The ARN of the user request being deleted.
String mediaPipelineId
The ID of the media capture pipeline being deleted.
String meetingId
The Amazon Chime SDK meeting ID.
String phoneNumberId
The phone number ID.
String sipMediaApplicationId
The SIP media application ID.
String sipRuleId
The SIP rule ID.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
String voiceConnectorGroupId
The Amazon Chime Voice Connector group ID.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
AppInstanceAdmin appInstanceAdmin
The ARN and name of the AppInstanceUser
, the ARN of the AppInstance
, and the created
and last-updated timestamps. All timestamps use epoch milliseconds.
String appInstanceArn
The ARN of the AppInstance
.
AppInstance appInstance
The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance
. All
timestamps use epoch milliseconds.
String appInstanceUserArn
The ARN of the AppInstanceUser
.
AppInstanceUser appInstanceUser
The name of the AppInstanceUser
.
ChannelBan channelBan
The details of the ban.
ChannelMembershipForAppInstanceUserSummary channelMembership
The channel to which a user belongs.
ChannelMembership channelMembership
The details of the membership.
ChannelModeratedByAppInstanceUserSummary channel
The moderated channel.
ChannelModerator channelModerator
The details of the channel moderator.
Channel channel
The channel details.
String emergencyPhoneNumber
The DNIS phone number to route emergency calls to, in E.164 format.
String testPhoneNumber
The DNIS phone number to route test emergency calls to, in E.164 format.
String callingCountry
The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.
String languageCode
The language code specified for the Amazon Transcribe Medical engine.
String specialty
The specialty specified for the Amazon Transcribe Medical engine.
String type
The type of transcription.
String vocabularyName
The name of the vocabulary passed to Amazon Transcribe Medical.
String region
The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.
String contentIdentificationType
Set this field to PHI
to identify personal health information in the transcription output.
String languageCode
The language code specified for the Amazon Transcribe engine.
String vocabularyFilterMethod
The filtering method passed to Amazon Transcribe.
String vocabularyFilterName
The name of the vocabulary filter passed to Amazon Transcribe.
String vocabularyName
The name of the vocabulary passed to Amazon Transcribe.
String region
The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.
Boolean enablePartialResultsStabilization
Generates partial transcription results that are less likely to change as meeting attendees speak. It does so by only allowing the last few words from the partial results to change.
String partialResultsStability
The stabity level of a partial results transcription. Determines how stable you want the transcription results to be. A higher level means the transcription results are less likely to change.
String contentIdentificationType
Set this field to PII
to identify personal health information in the transcription output.
String contentRedactionType
Set this field to PII
to redact personally identifiable information in the transcription output.
Content redaction is performed only upon complete transcription of the audio segments.
String piiEntityTypes
Lists the PII entity types you want to identify or redact. To specify entity types, you must enable
ContentIdentificationType
or ContentRedactionType
.
PIIEntityTypes
must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER
,
BANK_ROUTING, CREDIT_DEBIT_NUMBER
, CREDIT_DEBIT_CVV
, CREDIT_DEBIT_EXPIRY
,
PIN
, EMAIL
, ADDRESS
, NAME
, PHONE
,
SSN
, and ALL
.
PiiEntityTypes
is an optional parameter with a default value of ALL
.
String languageModelName
The name of the language model used during transcription.
String code
String accountId
The Amazon Chime account ID.
Account account
The Amazon Chime account details.
String accountId
The Amazon Chime account ID.
AccountSettings accountSettings
The Amazon Chime account settings.
String appInstanceArn
The ARN of the AppInstance
.
AppInstanceRetentionSettings appInstanceRetentionSettings
The retention settings for the AppInstance
.
Date initiateDeletionTimestamp
The timestamp representing the time at which the specified items are retained, in Epoch Seconds.
String appInstanceArn
The ARN of the AppInstance
.
Attendee attendee
The Amazon Chime SDK attendee information.
Bot bot
The chat bot details.
ChannelMessage channelMessage
The details of and content in the message.
EventsConfiguration eventsConfiguration
The events configuration details.
BusinessCallingSettings businessCalling
The Amazon Chime Business Calling settings.
VoiceConnectorSettings voiceConnector
The Amazon Chime Voice Connector settings.
String mediaPipelineId
The ID of the pipeline that you want to get.
MediaCapturePipeline mediaCapturePipeline
The media capture pipeline object.
String meetingId
The Amazon Chime SDK meeting ID.
Meeting meeting
The Amazon Chime SDK meeting information.
MessagingSessionEndpoint endpoint
The endpoint returned in the response.
String phoneNumberOrderId
The ID for the phone number order.
PhoneNumberOrder phoneNumberOrder
The phone number order details.
String phoneNumberId
The phone number ID.
PhoneNumber phoneNumber
The phone number details.
ProxySession proxySession
The proxy session details.
String accountId
The Amazon Chime account ID.
RetentionSettings retentionSettings
The retention settings.
Date initiateDeletionTimestamp
The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.
Room room
The room details.
String sipMediaApplicationId
The SIP media application ID.
SipMediaApplicationLoggingConfiguration sipMediaApplicationLoggingConfiguration
The actual logging configuration.
String sipMediaApplicationId
The SIP media application ID.
SipMediaApplication sipMediaApplication
The SIP media application details.
String sipRuleId
The SIP rule ID.
SipRule sipRule
The SIP rule details.
User user
The user details.
UserSettings userSettings
The user settings.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
EmergencyCallingConfiguration emergencyCallingConfiguration
The emergency calling configuration details.
String voiceConnectorGroupId
The Amazon Chime Voice Connector group ID.
VoiceConnectorGroup voiceConnectorGroup
The Amazon Chime Voice Connector group details.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
LoggingConfiguration loggingConfiguration
The logging configuration details.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
Origination origination
The origination setting details.
String voiceConnectorId
The Amazon Chime voice connector ID.
Proxy proxy
The proxy configuration details.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
VoiceConnector voiceConnector
The Amazon Chime Voice Connector details.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
StreamingConfiguration streamingConfiguration
The streaming configuration details.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
TerminationHealth terminationHealth
The termination health details.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
Termination termination
The termination setting details.
String name
Amazon Chime account name prefix with which to filter results.
String userEmail
User email address with which to filter results.
String nextToken
The token to use to retrieve the next page of results.
Integer maxResults
The maximum number of results to return in a single call. Defaults to 100.
String channelArn
The ARN of the channel.
Integer maxResults
The maximum number of bans that you want returned.
String nextToken
The token passed by previous API calls until all requested bans are returned.
String chimeBearer
The AppInstanceUserArn
of the user that makes the API call.
String appInstanceUserArn
The ARN of the AppInstanceUser
s
Integer maxResults
The maximum number of users that you want returned.
String nextToken
The token returned from previous API requests until the number of channel memberships is reached.
String chimeBearer
The AppInstanceUserArn
of the user that makes the API call.
String channelArn
The maximum number of channel memberships that you want returned.
String type
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 maxResults
The maximum number of channel memberships that you want returned.
String nextToken
The token passed by previous API calls until all requested channel memberships are returned.
String chimeBearer
The AppInstanceUserArn
of the user that makes the API call.
String channelArn
The ARN of the channel.
String sortOrder
The order in which you want messages sorted. Default is Descending, based on time created.
Date notBefore
The initial or starting time stamp for your requested messages.
Date notAfter
The final or ending time stamp for your requested messages.
Integer maxResults
The maximum number of messages that you want returned.
String nextToken
The token passed by previous API calls until all requested messages are returned.
String chimeBearer
The AppInstanceUserArn
of the user that makes the API call.
String channelArn
The ARN of the channel.
Integer maxResults
The maximum number of moderators that you want returned.
String nextToken
The token passed by previous API calls until all requested moderators are returned.
String chimeBearer
The AppInstanceUserArn
of the user that makes the API call.
String appInstanceUserArn
The ARN of the user in the moderated channel.
Integer maxResults
The maximum number of channels in the request.
String nextToken
The token returned from previous API requests until the number of channels moderated by the user is reached.
String chimeBearer
The AppInstanceUserArn
of the user that makes the API call.
String appInstanceArn
The ARN of the AppInstance
.
String privacy
The privacy setting. PUBLIC
retrieves all the public channels. PRIVATE
retrieves
private channels. Only an AppInstanceAdmin
can retrieve private channels.
Integer maxResults
The maximum number of channels that you want to return.
String nextToken
The token passed by previous API calls until all requested channels are returned.
String chimeBearer
The AppInstanceUserArn
of the user that makes the API call.
String meetingId
The Amazon Chime SDK meeting ID.
String status
The phone number status.
String productType
The phone number product type.
String filterName
The filter to use to limit the number of results.
String filterValue
The value to use for the filter.
Integer maxResults
The maximum number of results to return in a single call.
String nextToken
The token to use to retrieve the next page of results.
String productType
The phone number product type.
String resourceARN
The resource ARN.
String accountId
The Amazon Chime account ID.
String userEmail
Optional. The user email address used to filter results. Maximum 1.
String userType
The user type.
Integer maxResults
The maximum number of results to return in a single call. Defaults to 100.
String nextToken
The token to use to retrieve the next page of results.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
Boolean enableSIPLogs
When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
String mediaPipelineId
The ID of a media capture pipeline.
String sourceType
Source type from which media artifacts are saved. You must use ChimeMeeting
.
String sourceArn
ARN of the source from which the media artifacts will be saved.
String status
The status of the media capture pipeline.
String sinkType
Destination type to which the media artifacts are saved. You must use an S3 Bucket.
String sinkArn
ARN of the destination to which the media artifacts are saved.
Date createdTimestamp
The time at which the capture pipeline was created, in ISO 8601 format.
Date updatedTimestamp
The time at which the capture pipeline was updated, in ISO 8601 format.
ChimeSdkMeetingConfiguration chimeSdkMeetingConfiguration
The configuration for a specified media capture pipeline. SourceType
must be
ChimeSdkMeeting
.
String audioHostUrl
The audio host URL.
String audioFallbackUrl
The audio fallback URL.
String screenDataUrl
The screen data URL.
String screenSharingUrl
The screen sharing URL.
String screenViewingUrl
The screen viewing URL.
String signalingUrl
The signaling URL.
String turnControlUrl
The turn control URL.
String eventIngestionUrl
The event ingestion URL.
String meetingId
The Amazon Chime SDK meeting ID.
String externalMeetingId
The external meeting ID.
MediaPlacement mediaPlacement
The media placement for the meeting.
String mediaRegion
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
.
String url
The endpoint to which you establish a websocket connection.
String code
List<E> routes
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
.
Boolean disabled
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
.
String host
The FQDN or IP address to contact for origination traffic.
Integer port
The designated origination route port. Defaults to 5060.
String protocol
The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.
Integer priority
The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
Integer weight
The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.
String phoneNumberId
The phone number ID.
String e164PhoneNumber
The phone number, in E.164 format.
String country
The phone number country. Format: ISO 3166-1 alpha-2.
String type
The phone number type.
String productType
The phone number product type.
String status
The phone number status.
PhoneNumberCapabilities capabilities
The phone number capabilities.
List<E> associations
The phone number associations.
String callingName
The outbound calling name associated with the phone number.
String callingNameStatus
The outbound calling name status.
Date createdTimestamp
The phone number creation timestamp, in ISO 8601 format.
Date updatedTimestamp
The updated phone number timestamp, in ISO 8601 format.
Date deletionTimestamp
The deleted phone number timestamp, in ISO 8601 format.
String value
Contains the ID for the entity specified in Name.
String name
Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.
Date associatedTimestamp
The timestamp of the phone number association, in ISO 8601 format.
Boolean inboundCall
Allows or denies inbound calling for the specified phone number.
Boolean outboundCall
Allows or denies outbound calling for the specified phone number.
Boolean inboundSMS
Allows or denies inbound SMS messaging for the specified phone number.
Boolean outboundSMS
Allows or denies outbound SMS messaging for the specified phone number.
Boolean inboundMMS
Allows or denies inbound MMS messaging for the specified phone number.
Boolean outboundMMS
Allows or denies outbound MMS messaging for the specified phone number.
String phoneNumberOrderId
The phone number order ID.
String productType
The phone number order product type.
String status
The status of the phone number order.
List<E> orderedPhoneNumbers
The ordered phone number details, such as the phone number in E.164 format and the phone number status.
Date createdTimestamp
The phone number order creation time stamp, in ISO 8601 format.
Date updatedTimestamp
The updated phone number order time stamp, in ISO 8601 format.
Integer defaultSessionExpiryMinutes
The default number of minutes allowed for proxy sessions.
Boolean disabled
When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
String fallBackPhoneNumber
The phone number to route calls to after a proxy session expires.
List<E> phoneNumberCountries
The countries for proxy phone numbers to be selected from.
String voiceConnectorId
The Amazon Chime voice connector ID.
String proxySessionId
The proxy session ID.
String name
The name of the proxy session.
String status
The status of the proxy session.
Integer expiryMinutes
The number of minutes allowed for the proxy session.
List<E> capabilities
The proxy session capabilities.
Date createdTimestamp
The created time stamp, in ISO 8601 format.
Date updatedTimestamp
The updated time stamp, in ISO 8601 format.
Date endedTimestamp
The ended time stamp, in ISO 8601 format.
List<E> participants
The proxy session participants.
String numberSelectionBehavior
The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
String geoMatchLevel
The preference for matching the country or area code of the proxy phone number with that of the first participant.
GeoMatchParams geoMatchParams
The country and area code for the proxy phone number.
String appInstanceArn
The ARN of the AppInstance
.
AppInstanceRetentionSettings appInstanceRetentionSettings
The time in days to retain data. Data type: number.
AppInstanceRetentionSettings appInstanceRetentionSettings
The time in days to retain data. Data type: number.
Date initiateDeletionTimestamp
The time at which the API deletes data.
String accountId
The Amazon Chime account ID.
String botId
The bot ID.
String outboundEventsHTTPSEndpoint
HTTPS endpoint that allows the bot to receive outgoing events.
String lambdaFunctionArn
Lambda function ARN that allows the bot to receive outgoing events.
EventsConfiguration eventsConfiguration
String accountId
The Amazon Chime account ID.
RetentionSettings retentionSettings
The retention settings.
RetentionSettings retentionSettings
The retention settings.
Date initiateDeletionTimestamp
The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.
String sipMediaApplicationId
The SIP media application ID.
SipMediaApplicationLoggingConfiguration sipMediaApplicationLoggingConfiguration
The actual logging configuration.
SipMediaApplicationLoggingConfiguration sipMediaApplicationLoggingConfiguration
String voiceConnectorId
The Amazon Chime Voice Connector ID.
EmergencyCallingConfiguration emergencyCallingConfiguration
The emergency calling configuration details.
EmergencyCallingConfiguration emergencyCallingConfiguration
The emergency calling configuration details.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
LoggingConfiguration loggingConfiguration
The logging configuration details to add.
LoggingConfiguration loggingConfiguration
The updated logging configuration details.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
Origination origination
The origination setting details to add.
Origination origination
The updated origination setting details.
String voiceConnectorId
The Amazon Chime voice connector ID.
Integer defaultSessionExpiryMinutes
The default number of minutes allowed for proxy sessions.
List<E> phoneNumberPoolCountries
The countries for proxy phone numbers to be selected from.
String fallBackPhoneNumber
The phone number to route calls to after a proxy session expires.
Boolean disabled
When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
Proxy proxy
The proxy configuration details.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
StreamingConfiguration streamingConfiguration
The streaming configuration details to add.
StreamingConfiguration streamingConfiguration
The updated streaming configuration details.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
Termination termination
The termination setting details to add.
Termination termination
The updated termination setting details.
Bot bot
User user
The user details and new personal meeting PIN.
String code
String phoneNumberId
The phone number.
PhoneNumber phoneNumber
The phone number details.
RoomRetentionSettings roomRetentionSettings
The chat room retention settings.
ConversationRetentionSettings conversationRetentionSettings
The chat conversation retention settings.
String roomId
The room ID.
String name
The room name.
String accountId
The Amazon Chime account ID.
String createdBy
The identifier of the room creator.
Date createdTimestamp
The room creation timestamp, in ISO 8601 format.
Date updatedTimestamp
The room update timestamp, in ISO 8601 format.
Integer retentionDays
The number of days for which to retain chat-room messages.
String areaCode
The area code used to filter results. Only applies to the US.
String city
The city used to filter results. Only applies to the US.
String country
The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.
String state
The state used to filter results. Required only if you provide City
. Only applies to the US.
String tollFreePrefix
The toll-free prefix that you use to filter results. Only applies to the US.
String phoneNumberType
The phone number type used to filter results. Required for non-US numbers.
Integer maxResults
The maximum number of results to return in a single call.
String nextToken
The token used to retrieve the next page of results.
String channelArn
The ARN of the channel.
String content
The content of the message.
String type
The type of message, STANDARD
or CONTROL
.
String persistence
Boolean that controls whether the message is persisted on the back end. Required.
String metadata
The optional metadata for each message.
String clientRequestToken
The Idempotency
token for each client request.
String chimeBearer
The AppInstanceUserArn
of the user that makes the API call.
String code
String code
String groupName
The group name.
String sipMediaApplicationId
The SIP media application ID.
String awsRegion
The AWS Region in which the SIP media application is created.
String name
The name of the SIP media application.
List<E> endpoints
List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.
Date createdTimestamp
The SIP media application creation timestamp, in ISO 8601 format.
Date updatedTimestamp
The SIP media application updated timestamp, in ISO 8601 format.
String transactionId
The transaction ID of a call.
String lambdaArn
Valid Amazon Resource Name (ARN) of the Lambda function. The function must be created in the same AWS Region as the SIP media application.
Boolean enableSipMediaApplicationMessageLogs
Enables application message logs for the SIP media application.
String sipRuleId
The SIP rule ID.
String name
The name of the SIP rule.
Boolean disabled
Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
String triggerType
The type of trigger assigned to the SIP rule in TriggerValue
, currently
RequestUriHostname
or ToPhoneNumber
.
String triggerValue
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.
List<E> targetApplications
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.
Date createdTimestamp
The time at which the SIP rule was created, in ISO 8601 format.
Date updatedTimestamp
The time at which the SIP rule was last updated, in ISO 8601 format.
SelectedVideoStreams selectedVideoStreams
The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.
String meetingId
The unique ID of the meeting being transcribed.
TranscriptionConfiguration transcriptionConfiguration
The configuration for the current transcription operation. Must contain EngineTranscribeSettings
or
EngineTranscribeMedicalSettings
.
String meetingId
The unique ID of the meeting for which you stop transcription.
String notificationTarget
The streaming notification target.
Integer cpsLimit
The limit on calls per second. Max value based on account service quota. Default value of 1.
String defaultPhoneNumber
The default caller ID phone number.
List<E> callingRegions
The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
List<E> cidrAllowedList
The IP addresses allowed to make calls, in CIDR format. Required.
Boolean disabled
When termination settings are disabled, outbound calls can not be made.
String code
EngineTranscribeSettings engineTranscribeSettings
The transcription configuration settings passed to Amazon Transcribe.
EngineTranscribeMedicalSettings engineTranscribeMedicalSettings
The transcription configuration settings passed to Amazon Transcribe Medical.
String code
String code
Account account
The updated Amazon Chime account details.
String accountId
The Amazon Chime account ID.
AccountSettings accountSettings
The Amazon Chime account settings to update.
String appInstanceArn
The ARN of the AppInstance
.
String appInstanceUserArn
The ARN of the AppInstanceUser
.
Bot bot
The updated bot details.
String channelArn
The ARN of the channel.
String messageId
The ID string of the message being updated.
String content
The content of the message being updated.
String metadata
The metadata of the message being updated.
String chimeBearer
The AppInstanceUserArn
of the user that makes the API call.
String channelArn
The ARN of the channel.
String channelArn
The ARN of the channel.
BusinessCallingSettings businessCalling
The Amazon Chime Business Calling settings.
VoiceConnectorSettings voiceConnector
The Amazon Chime Voice Connector settings.
PhoneNumber phoneNumber
The updated phone number details.
String callingName
The default outbound calling name for the account.
ProxySession proxySession
The proxy session details.
RoomMembership roomMembership
The room membership details.
Room room
The room details.
String sipMediaApplicationId
The ID of the SIP media application handling the call.
String transactionId
The ID of the call transaction.
Map<K,V> arguments
Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED
event. Can
contain 0-20 key-value pairs.
SipMediaApplicationCall sipMediaApplicationCall
SipMediaApplication sipMediaApplication
The updated SIP media application details.
SipRule sipRule
Updated SIP rule details.
String accountId
The Amazon Chime account ID.
String userId
The user ID.
String licenseType
The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.
String userType
The user type.
AlexaForBusinessMetadata alexaForBusinessMetadata
The Alexa for Business metadata.
String userId
The user ID.
String licenseType
The user license type.
String userType
The user type.
AlexaForBusinessMetadata alexaForBusinessMetadata
The Alexa for Business metadata.
User user
The updated user details.
String accountId
The Amazon Chime account ID.
String userId
The user ID.
UserSettings userSettings
The user settings to update.
VoiceConnectorGroup voiceConnectorGroup
The updated Amazon Chime Voice Connector group details.
VoiceConnector voiceConnector
The updated Amazon Chime Voice Connector details.
String userId
The user ID.
String accountId
The Amazon Chime account ID.
String primaryEmail
The primary email address of the user.
String primaryProvisionedNumber
The primary phone number associated with the user.
String displayName
The display name of the user.
String licenseType
The license type for the user.
String userType
The user type.
String userRegistrationStatus
The user registration status.
String userInvitationStatus
The user invite status.
Date registeredOn
Date and time when the user is registered, in ISO 8601 format.
Date invitedOn
Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
AlexaForBusinessMetadata alexaForBusinessMetadata
The Alexa for Business metadata.
String personalPIN
The user's personal meeting PIN.
TelephonySettings telephony
The telephony settings associated with the user.
String voiceConnectorId
The Amazon Chime Voice Connector ID.
String awsRegion
The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1
.
String name
The name of the Amazon Chime Voice Connector.
String outboundHostName
The outbound host name for the Amazon Chime Voice Connector.
Boolean requireEncryption
Designates whether encryption is required for the Amazon Chime Voice Connector.
Date createdTimestamp
The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
Date updatedTimestamp
The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
String voiceConnectorArn
The ARN of the specified Amazon Chime Voice Connector.
String voiceConnectorGroupId
The Amazon Chime Voice Connector group ID.
String name
The name of the Amazon Chime Voice Connector group.
List<E> voiceConnectorItems
The Amazon Chime Voice Connectors to which to route inbound calls.
Date createdTimestamp
The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.
Date updatedTimestamp
The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
String voiceConnectorGroupArn
The ARN of the specified Amazon Chime Voice Connector group.
String cdrBucket
The Amazon S3 bucket designated for call detail record storage.
Copyright © 2022. All rights reserved.