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.
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 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 code
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 code
Integer retentionDays
The number of days for which to retain chat conversation messages.
String name
The name of the Amazon Chime account.
Account account
The Amazon Chime account details.
Attendee attendee
The attendee information, including attendee ID and join token.
Bot bot
The bot details.
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: ap-northeast-1
, ap-southeast-1
, ap-southeast-2
,
ca-central-1
, eu-central-1
, eu-north-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: ap-northeast-1
, ap-southeast-1
, ap-southeast-2
,
ca-central-1
, eu-central-1
, eu-north-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.
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 meetingId
The Amazon Chime SDK meeting ID.
String phoneNumberId
The phone number 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.
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 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.
Attendee attendee
The Amazon Chime SDK attendee information.
Bot bot
The chat bot details.
EventsConfiguration eventsConfiguration
The events configuration details.
BusinessCallingSettings businessCalling
The Amazon Chime Business Calling settings.
VoiceConnectorSettings voiceConnector
The Amazon Chime Voice Connector settings.
String meetingId
The Amazon Chime SDK meeting ID.
Meeting meeting
The Amazon Chime SDK meeting information.
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.
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 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 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 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 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 to create the meeting. Available values: ap-northeast-1
,
ap-southeast-1
, ap-southeast-2
, ca-central-1
, eu-central-1
,
eu-north-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 code
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 distributed among them based on their relative weight.
String phoneNumberId
The phone number ID.
String e164PhoneNumber
The phone number, in E.164 format.
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 timestamp, in ISO 8601 format.
Date updatedTimestamp
The updated phone number order timestamp, 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 timestamp, in ISO 8601 format.
Date updatedTimestamp
The updated timestamp, in ISO 8601 format.
Date endedTimestamp
The ended timestamp, 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 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 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.
String city
The city used to filter results.
String country
The country used to filter results.
String state
The state used to filter results.
String tollFreePrefix
The toll-free prefix that you use to filter results.
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 code
String code
String groupName
The group name.
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
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.
Bot bot
The updated bot details.
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 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 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 timestamp, in ISO 8601 format.
Date updatedTimestamp
The updated Amazon Chime Voice Connector group timestamp, in ISO 8601 format.
String cdrBucket
The Amazon S3 bucket designated for call detail record storage.
Copyright © 2020. All rights reserved.