You don't have permissions to perform the requested operation.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.chime#Account": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The AWS account ID.
", "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The Amazon Chime account name.
", "smithy.api#required": {} } }, "AccountType": { "target": "com.amazonaws.chime#AccountType", "traits": { "smithy.api#documentation": "The Amazon Chime account type. For more information about different account types, see Managing Your\n Amazon Chime Accounts in the Amazon Chime Administration\n Guide.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The Amazon Chime account creation timestamp, in ISO 8601 format.
" } }, "DefaultLicense": { "target": "com.amazonaws.chime#License", "traits": { "smithy.api#documentation": "The default license for the Amazon Chime account.
" } }, "SupportedLicenses": { "target": "com.amazonaws.chime#LicenseList", "traits": { "smithy.api#documentation": "Supported licenses for the Amazon Chime account.
" } }, "SigninDelegateGroups": { "target": "com.amazonaws.chime#SigninDelegateGroupList", "traits": { "smithy.api#documentation": "The sign-in delegate groups associated with the account.
" } } }, "traits": { "smithy.api#documentation": "The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.
" } }, "com.amazonaws.chime#AccountList": { "type": "list", "member": { "target": "com.amazonaws.chime#Account" } }, "com.amazonaws.chime#AccountName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.chime#AccountSettings": { "type": "structure", "members": { "DisableRemoteControl": { "target": "com.amazonaws.chime#Boolean", "traits": { "smithy.api#documentation": "Setting that stops or starts remote control of shared screens during meetings.
" } }, "EnableDialOut": { "target": "com.amazonaws.chime#Boolean", "traits": { "smithy.api#documentation": "Setting that allows meeting participants to choose the Call me at a\n phone number option. For more information, see Join a Meeting\n without the Amazon Chime App.
" } } }, "traits": { "smithy.api#documentation": "Settings related to the Amazon Chime account. This includes settings that start or stop\n remote control of shared screens, or start or stop the dial-out option in the Amazon\n Chime web application. For more information about these settings, see Use the Policies\n Page in the Amazon Chime Administration Guide.
" } }, "com.amazonaws.chime#AccountType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Team", "name": "Team" }, { "value": "EnterpriseDirectory", "name": "EnterpriseDirectory" }, { "value": "EnterpriseLWA", "name": "EnterpriseLWA" }, { "value": "EnterpriseOIDC", "name": "EnterpriseOIDC" } ] } }, "com.amazonaws.chime#AlexaForBusinessMetadata": { "type": "structure", "members": { "IsAlexaForBusinessEnabled": { "target": "com.amazonaws.chime#Boolean", "traits": { "smithy.api#documentation": "Starts or stops Alexa for Business.
" } }, "AlexaForBusinessRoomArn": { "target": "com.amazonaws.chime#SensitiveString", "traits": { "smithy.api#documentation": "The ARN of the room resource.
" } } }, "traits": { "smithy.api#documentation": "The Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa for Business with a device.
" } }, "com.amazonaws.chime#Alpha2CountryCode": { "type": "string", "traits": { "smithy.api#pattern": "[A-Z]{2}" } }, "com.amazonaws.chime#AppInstance": { "type": "structure", "members": { "AppInstanceArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the messaging instance.
" } }, "Name": { "target": "com.amazonaws.chime#NonEmptyResourceName", "traits": { "smithy.api#documentation": "The name of an AppInstance.
The metadata of an AppInstance.
The time at which an AppInstance was created. In epoch milliseconds.
The time an AppInstance was last updated. In epoch milliseconds.
The details of an AppInstance, an instance of an Amazon Chime SDK messaging application.
The AppInstanceAdmin data.
The ARN of the AppInstance for which the user is an administrator.
The time at which an administrator was created.
" } } }, "traits": { "smithy.api#documentation": "The details of an AppInstanceAdmin.
The details of the AppInstanceAdmin.
Summary of the details of an AppInstanceAdmin.
The length of time in days to retain the messages in a channel.
" } } }, "traits": { "smithy.api#documentation": "The details of the data-retention settings for an AppInstance.
The type of data to be streamed.
", "smithy.api#required": {} } }, "ResourceArn": { "target": "com.amazonaws.chime#Arn", "traits": { "smithy.api#documentation": "The resource ARN.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The details of the streaming configuration of an AppInstance.
The AppInstance ARN.
The name of the AppInstance.
The metadata of the AppInstance.
Summary of the data for an AppInstance.
The ARN of the AppInstanceUser.
The name of the AppInstanceUser.
The time at which the AppInstanceUser was created.
The metadata of the AppInstanceUser.
The time at which the AppInstanceUser was last updated.
The details of an AppInstanceUser.
The type of ChannelMembership.
The time at which a message was last read.
" } } }, "traits": { "smithy.api#documentation": "Summary of the membership details of an AppInstanceUser.
The ARN of the AppInstanceUser.
The name of an AppInstanceUser.
The metadata of the AppInstanceUser.
Summary of the details of an AppInstanceUser.
Associates a phone number with the specified Amazon Chime user.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/users/{UserId}?operation=associate-phone-number", "code": 200 } } }, "com.amazonaws.chime#AssociatePhoneNumberWithUserRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The user ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "E164PhoneNumber": { "target": "com.amazonaws.chime#E164PhoneNumber", "traits": { "smithy.api#documentation": "The phone number, in E.164 format.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#AssociatePhoneNumberWithUserResponse": { "type": "structure", "members": {} }, "com.amazonaws.chime#AssociatePhoneNumbersWithVoiceConnector": { "type": "operation", "input": { "target": "com.amazonaws.chime#AssociatePhoneNumbersWithVoiceConnectorRequest" }, "output": { "target": "com.amazonaws.chime#AssociatePhoneNumbersWithVoiceConnectorResponse" }, "errors": [ { "target": "com.amazonaws.chime#AccessDeniedException" }, { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Associates phone numbers with the specified Amazon Chime Voice Connector.
", "smithy.api#http": { "method": "POST", "uri": "/voice-connectors/{VoiceConnectorId}?operation=associate-phone-numbers", "code": 200 } } }, "com.amazonaws.chime#AssociatePhoneNumbersWithVoiceConnectorGroup": { "type": "operation", "input": { "target": "com.amazonaws.chime#AssociatePhoneNumbersWithVoiceConnectorGroupRequest" }, "output": { "target": "com.amazonaws.chime#AssociatePhoneNumbersWithVoiceConnectorGroupResponse" }, "errors": [ { "target": "com.amazonaws.chime#AccessDeniedException" }, { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Associates phone numbers with the specified Amazon Chime Voice Connector group.
", "smithy.api#http": { "method": "POST", "uri": "/voice-connector-groups/{VoiceConnectorGroupId}?operation=associate-phone-numbers", "code": 200 } } }, "com.amazonaws.chime#AssociatePhoneNumbersWithVoiceConnectorGroupRequest": { "type": "structure", "members": { "VoiceConnectorGroupId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector group ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "E164PhoneNumbers": { "target": "com.amazonaws.chime#E164PhoneNumberList", "traits": { "smithy.api#documentation": "List of phone numbers, in E.164 format.
", "smithy.api#required": {} } }, "ForceAssociate": { "target": "com.amazonaws.chime#NullableBoolean", "traits": { "smithy.api#documentation": "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.
" } } } }, "com.amazonaws.chime#AssociatePhoneNumbersWithVoiceConnectorGroupResponse": { "type": "structure", "members": { "PhoneNumberErrors": { "target": "com.amazonaws.chime#PhoneNumberErrorList", "traits": { "smithy.api#documentation": "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.
" } } } }, "com.amazonaws.chime#AssociatePhoneNumbersWithVoiceConnectorRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "E164PhoneNumbers": { "target": "com.amazonaws.chime#E164PhoneNumberList", "traits": { "smithy.api#documentation": "List of phone numbers, in E.164 format.
", "smithy.api#required": {} } }, "ForceAssociate": { "target": "com.amazonaws.chime#NullableBoolean", "traits": { "smithy.api#documentation": "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.
" } } } }, "com.amazonaws.chime#AssociatePhoneNumbersWithVoiceConnectorResponse": { "type": "structure", "members": { "PhoneNumberErrors": { "target": "com.amazonaws.chime#PhoneNumberErrorList", "traits": { "smithy.api#documentation": "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 \n error messages.
" } } } }, "com.amazonaws.chime#AssociateSigninDelegateGroupsWithAccount": { "type": "operation", "input": { "target": "com.amazonaws.chime#AssociateSigninDelegateGroupsWithAccountRequest" }, "output": { "target": "com.amazonaws.chime#AssociateSigninDelegateGroupsWithAccountResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Associates the specified sign-in delegate groups with the specified Amazon Chime account.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}?operation=associate-signin-delegate-groups", "code": 200 } } }, "com.amazonaws.chime#AssociateSigninDelegateGroupsWithAccountRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SigninDelegateGroups": { "target": "com.amazonaws.chime#SigninDelegateGroupList", "traits": { "smithy.api#documentation": "The sign-in delegate groups.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#AssociateSigninDelegateGroupsWithAccountResponse": { "type": "structure", "members": {} }, "com.amazonaws.chime#Attendee": { "type": "structure", "members": { "ExternalUserId": { "target": "com.amazonaws.chime#ExternalUserIdType", "traits": { "smithy.api#documentation": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
" } }, "AttendeeId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK attendee ID.
" } }, "JoinToken": { "target": "com.amazonaws.chime#JoinTokenString", "traits": { "smithy.api#documentation": "The join token used by the Amazon Chime SDK attendee.
" } } }, "traits": { "smithy.api#documentation": "\nAn Amazon Chime SDK meeting attendee. Includes a unique \nAttendeeId\nand \nJoinToken\n. The \nJoinToken\nallows a client to authenticate and join as the specified attendee. The \nJoinToken\nexpires when the meeting ends or when \nDeleteAttendee\nis called. After that, the attendee is unable to join the meeting.\n
We recommend securely transferring each JoinToken from your server application\n to the client so that no other client has access to the token except for the one\n authorized to represent the attendee.
The input parameters don't match the service's restrictions.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.chime#BatchChannelMemberships": { "type": "structure", "members": { "InvitedBy": { "target": "com.amazonaws.chime#Identity" }, "Type": { "target": "com.amazonaws.chime#ChannelMembershipType", "traits": { "smithy.api#documentation": "The membership types set for the channel users.
" } }, "Members": { "target": "com.amazonaws.chime#Members", "traits": { "smithy.api#documentation": "The users successfully added to the request.
" } }, "ChannelArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the channel to which you're adding users.
" } } }, "traits": { "smithy.api#documentation": "The membership information, including member ARNs, the channel ARN, and membership types.
" } }, "com.amazonaws.chime#BatchCreateAttendee": { "type": "operation", "input": { "target": "com.amazonaws.chime#BatchCreateAttendeeRequest" }, "output": { "target": "com.amazonaws.chime#BatchCreateAttendeeResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "\nCreates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see \nUsing the Amazon Chime SDK\nin the \nAmazon Chime Developer Guide. \n
", "smithy.api#http": { "method": "POST", "uri": "/meetings/{MeetingId}/attendees?operation=batch-create", "code": 201 } } }, "com.amazonaws.chime#BatchCreateAttendeeErrorList": { "type": "list", "member": { "target": "com.amazonaws.chime#CreateAttendeeError" } }, "com.amazonaws.chime#BatchCreateAttendeeRequest": { "type": "structure", "members": { "MeetingId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Attendees": { "target": "com.amazonaws.chime#CreateAttendeeRequestItemList", "traits": { "smithy.api#documentation": "The request containing the attendees to create.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#BatchCreateAttendeeResponse": { "type": "structure", "members": { "Attendees": { "target": "com.amazonaws.chime#AttendeeList", "traits": { "smithy.api#documentation": "The attendee information, including attendees IDs and join tokens.
" } }, "Errors": { "target": "com.amazonaws.chime#BatchCreateAttendeeErrorList", "traits": { "smithy.api#documentation": "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.
" } } } }, "com.amazonaws.chime#BatchCreateChannelMembership": { "type": "operation", "input": { "target": "com.amazonaws.chime#BatchCreateChannelMembershipRequest" }, "output": { "target": "com.amazonaws.chime#BatchCreateChannelMembershipResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Adds a specified number of users to a channel.
", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, "smithy.api#http": { "method": "POST", "uri": "/channels/{ChannelArn}/memberships?operation=batch-create", "code": 200 } } }, "com.amazonaws.chime#BatchCreateChannelMembershipError": { "type": "structure", "members": { "MemberArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the member that the service couldn't add.
" } }, "ErrorCode": { "target": "com.amazonaws.chime#ErrorCode", "traits": { "smithy.api#documentation": "The error code.
" } }, "ErrorMessage": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The error message.
" } } }, "traits": { "smithy.api#documentation": "A list of failed member ARNs, error codes, and error messages.
" } }, "com.amazonaws.chime#BatchCreateChannelMembershipErrors": { "type": "list", "member": { "target": "com.amazonaws.chime#BatchCreateChannelMembershipError" } }, "com.amazonaws.chime#BatchCreateChannelMembershipRequest": { "type": "structure", "members": { "ChannelArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the channel to which you're adding users.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.chime#ChannelMembershipType", "traits": { "smithy.api#documentation": "The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of \n ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals \n HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.
The ARNs of the members you want to add to the channel.
", "smithy.api#required": {} } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The list of channel memberships in the response.
" } }, "Errors": { "target": "com.amazonaws.chime#BatchCreateChannelMembershipErrors", "traits": { "smithy.api#documentation": "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.
" } } } }, "com.amazonaws.chime#BatchCreateRoomMembership": { "type": "operation", "input": { "target": "com.amazonaws.chime#BatchCreateRoomMembershipRequest" }, "output": { "target": "com.amazonaws.chime#BatchCreateRoomMembershipResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/rooms/{RoomId}/memberships?operation=batch-create", "code": 201 } } }, "com.amazonaws.chime#BatchCreateRoomMembershipRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RoomId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The room ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MembershipItemList": { "target": "com.amazonaws.chime#MembershipItemList", "traits": { "smithy.api#documentation": "The list of membership items.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#BatchCreateRoomMembershipResponse": { "type": "structure", "members": { "Errors": { "target": "com.amazonaws.chime#MemberErrorList", "traits": { "smithy.api#documentation": "If the action fails for one or more of the member IDs in the request, a list of the member IDs is returned, along with error codes and error messages.
" } } } }, "com.amazonaws.chime#BatchDeletePhoneNumber": { "type": "operation", "input": { "target": "com.amazonaws.chime#BatchDeletePhoneNumberRequest" }, "output": { "target": "com.amazonaws.chime#BatchDeletePhoneNumberResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "\nMoves phone numbers into the \nDeletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.\n
\n\n\nPhone numbers remain in the \nDeletion queue for 7 days before they are deleted permanently.\n
", "smithy.api#http": { "method": "POST", "uri": "/phone-numbers?operation=batch-delete", "code": 200 } } }, "com.amazonaws.chime#BatchDeletePhoneNumberRequest": { "type": "structure", "members": { "PhoneNumberIds": { "target": "com.amazonaws.chime#NonEmptyStringList", "traits": { "smithy.api#documentation": "List of phone number IDs.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#BatchDeletePhoneNumberResponse": { "type": "structure", "members": { "PhoneNumberErrors": { "target": "com.amazonaws.chime#PhoneNumberErrorList", "traits": { "smithy.api#documentation": "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.
" } } } }, "com.amazonaws.chime#BatchSuspendUser": { "type": "operation", "input": { "target": "com.amazonaws.chime#BatchSuspendUserRequest" }, "output": { "target": "com.amazonaws.chime#BatchSuspendUserResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime\n account. For more information about different account types, see Managing Your\n Amazon Chime Accounts in the Amazon Chime Administration\n Guide.
Users suspended from a Team account are disassociated from the account,but they\n can continue to use Amazon Chime as free users. To remove the suspension from suspended\n Team account users, invite them to the Team account again.\n You can use the InviteUsers action to do so.
Users suspended from an EnterpriseLWA account are immediately signed out of\n Amazon Chime and can no longer sign in. To remove the suspension from suspended\n EnterpriseLWA account users, use the BatchUnsuspendUser action.
\nTo sign out users without suspending them, use the \nLogoutUser\naction.\n
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/users?operation=suspend", "code": 200 } } }, "com.amazonaws.chime#BatchSuspendUserRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserIdList": { "target": "com.amazonaws.chime#UserIdList", "traits": { "smithy.api#documentation": "The request containing the user IDs to suspend.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#BatchSuspendUserResponse": { "type": "structure", "members": { "UserErrors": { "target": "com.amazonaws.chime#UserErrorList", "traits": { "smithy.api#documentation": "If the BatchSuspendUser action fails for one or more of the user IDs in the\n request, a list of the user IDs is returned, along with error codes and error messages.
" } } } }, "com.amazonaws.chime#BatchUnsuspendUser": { "type": "operation", "input": { "target": "com.amazonaws.chime#BatchUnsuspendUserRequest" }, "output": { "target": "com.amazonaws.chime#BatchUnsuspendUserResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Removes the suspension from up to 50 previously suspended users for the specified Amazon\n Chime EnterpriseLWA account. Only users on EnterpriseLWA\n accounts can be unsuspended using this action. For more information about different\n account types, see Managing Your Amazon Chime Accounts in the\n Amazon Chime Administration Guide.
\nPreviously suspended users who are unsuspended using this action are returned to \nRegistered\nstatus. Users who are not previously suspended are ignored.\n
The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserIdList": { "target": "com.amazonaws.chime#UserIdList", "traits": { "smithy.api#documentation": "The request containing the user IDs to unsuspend.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#BatchUnsuspendUserResponse": { "type": "structure", "members": { "UserErrors": { "target": "com.amazonaws.chime#UserErrorList", "traits": { "smithy.api#documentation": "If the BatchUnsuspendUser action fails for one or more of the user IDs in the\n request, a list of the user IDs is returned, along with error codes and error messages.
" } } } }, "com.amazonaws.chime#BatchUpdatePhoneNumber": { "type": "operation", "input": { "target": "com.amazonaws.chime#BatchUpdatePhoneNumberRequest" }, "output": { "target": "com.amazonaws.chime#BatchUpdatePhoneNumberResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Updates phone number product types or calling names. You can update one attribute at a time for each \n UpdatePhoneNumberRequestItem. For example, you can update the product type or the calling name.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For\n numbers outside the\n US,\n you must use the Amazon Chime SIP Media Application Dial-In product type.
\n \nUpdates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you \n can request another update.
", "smithy.api#http": { "method": "POST", "uri": "/phone-numbers?operation=batch-update", "code": 200 } } }, "com.amazonaws.chime#BatchUpdatePhoneNumberRequest": { "type": "structure", "members": { "UpdatePhoneNumberRequestItems": { "target": "com.amazonaws.chime#UpdatePhoneNumberRequestItemList", "traits": { "smithy.api#documentation": "The request containing the phone number IDs and product types or calling names to update.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#BatchUpdatePhoneNumberResponse": { "type": "structure", "members": { "PhoneNumberErrors": { "target": "com.amazonaws.chime#PhoneNumberErrorList", "traits": { "smithy.api#documentation": "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.
" } } } }, "com.amazonaws.chime#BatchUpdateUser": { "type": "operation", "input": { "target": "com.amazonaws.chime#BatchUpdateUserRequest" }, "output": { "target": "com.amazonaws.chime#BatchUpdateUserResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "\nUpdates user details within the \nUpdateUserRequestItem\nobject for up to 20 users for the specified Amazon Chime account.\nCurrently, only LicenseType\nupdates are supported for this action.\n
The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UpdateUserRequestItems": { "target": "com.amazonaws.chime#UpdateUserRequestItemList", "traits": { "smithy.api#documentation": "The request containing the user IDs and details to update.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#BatchUpdateUserResponse": { "type": "structure", "members": { "UserErrors": { "target": "com.amazonaws.chime#UserErrorList", "traits": { "smithy.api#documentation": "If the BatchUpdateUser action fails for one or more of the user IDs in the\n request, a list of the user IDs is returned, along with error codes and error messages.
" } } } }, "com.amazonaws.chime#Boolean": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.chime#Bot": { "type": "structure", "members": { "BotId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The bot ID.
" } }, "UserId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The unique ID for the bot user.
" } }, "DisplayName": { "target": "com.amazonaws.chime#SensitiveString", "traits": { "smithy.api#documentation": "The bot display name.
" } }, "BotType": { "target": "com.amazonaws.chime#BotType", "traits": { "smithy.api#documentation": "The bot type.
" } }, "Disabled": { "target": "com.amazonaws.chime#NullableBoolean", "traits": { "smithy.api#documentation": "When true, the bot is stopped from running in your account.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The bot creation timestamp, in ISO 8601 format.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The updated bot timestamp, in ISO 8601 format.
" } }, "BotEmail": { "target": "com.amazonaws.chime#SensitiveString", "traits": { "smithy.api#documentation": "The bot email address.
" } }, "SecurityToken": { "target": "com.amazonaws.chime#SensitiveString", "traits": { "smithy.api#documentation": "The security token used to authenticate Amazon Chime with the outgoing event endpoint.
" } } }, "traits": { "smithy.api#documentation": "A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.
" } }, "com.amazonaws.chime#BotList": { "type": "list", "member": { "target": "com.amazonaws.chime#Bot" } }, "com.amazonaws.chime#BotType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ChatBot", "name": "ChatBot" } ] } }, "com.amazonaws.chime#BusinessCallingSettings": { "type": "structure", "members": { "CdrBucket": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The Amazon S3 bucket designated for call detail record storage.
" } } }, "traits": { "smithy.api#documentation": "The Amazon Chime Business Calling settings for the administrator's AWS account. Includes any\n Amazon S3 buckets designated for storing call detail records.
" } }, "com.amazonaws.chime#CallingName": { "type": "string", "traits": { "smithy.api#pattern": "^$|^[a-zA-Z0-9 ]{2,15}$", "smithy.api#sensitive": {} } }, "com.amazonaws.chime#CallingNameStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Unassigned", "name": "Unassigned" }, { "value": "UpdateInProgress", "name": "UpdateInProgress" }, { "value": "UpdateSucceeded", "name": "UpdateSucceeded" }, { "value": "UpdateFailed", "name": "UpdateFailed" } ] } }, "com.amazonaws.chime#CallingRegion": { "type": "string" }, "com.amazonaws.chime#CallingRegionList": { "type": "list", "member": { "target": "com.amazonaws.chime#CallingRegion" } }, "com.amazonaws.chime#Capability": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Voice", "name": "Voice" }, { "value": "SMS", "name": "SMS" } ] } }, "com.amazonaws.chime#CapabilityList": { "type": "list", "member": { "target": "com.amazonaws.chime#Capability" } }, "com.amazonaws.chime#Channel": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.chime#NonEmptyResourceName", "traits": { "smithy.api#documentation": "The name of the channel.
" } }, "ChannelArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the channel.
" } }, "Mode": { "target": "com.amazonaws.chime#ChannelMode", "traits": { "smithy.api#documentation": "The mode of the channel.
" } }, "Privacy": { "target": "com.amazonaws.chime#ChannelPrivacy", "traits": { "smithy.api#documentation": "The channel's privacy setting.
" } }, "Metadata": { "target": "com.amazonaws.chime#Metadata", "traits": { "smithy.api#documentation": "The channel's metadata.
" } }, "CreatedBy": { "target": "com.amazonaws.chime#Identity", "traits": { "smithy.api#documentation": "The AppInstanceUser who created the channel.
The time at which the AppInstanceUser created the channel.
The time at which a member sent the last message in the channel.
" } }, "LastUpdatedTimestamp": { "target": "com.amazonaws.chime#Timestamp", "traits": { "smithy.api#documentation": "The time at which a channel was last updated.
" } } }, "traits": { "smithy.api#documentation": "The details of a channel.
" } }, "com.amazonaws.chime#ChannelBan": { "type": "structure", "members": { "Member": { "target": "com.amazonaws.chime#Identity", "traits": { "smithy.api#documentation": "The member being banned from the channel.
" } }, "ChannelArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the channel from which a member is being banned.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.chime#Timestamp", "traits": { "smithy.api#documentation": "The time at which the ban was created.
" } }, "CreatedBy": { "target": "com.amazonaws.chime#Identity", "traits": { "smithy.api#documentation": "The AppInstanceUser who created the ban.
The details of a channel ban.
" } }, "com.amazonaws.chime#ChannelBanSummary": { "type": "structure", "members": { "Member": { "target": "com.amazonaws.chime#Identity", "traits": { "smithy.api#documentation": "The member being banned from a channel.
" } } }, "traits": { "smithy.api#documentation": "Summary of the details of a ChannelBan.
The identifier of the member who invited another member.
" } }, "Type": { "target": "com.amazonaws.chime#ChannelMembershipType", "traits": { "smithy.api#documentation": "The membership type set for the channel member.
" } }, "Member": { "target": "com.amazonaws.chime#Identity", "traits": { "smithy.api#documentation": "The data of the channel member.
" } }, "ChannelArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the member's channel.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.chime#Timestamp", "traits": { "smithy.api#documentation": "The time at which the channel membership was created.
" } }, "LastUpdatedTimestamp": { "target": "com.amazonaws.chime#Timestamp", "traits": { "smithy.api#documentation": "The time at which a channel membership was last updated.
" } } }, "traits": { "smithy.api#documentation": "The details of a channel member.
" } }, "com.amazonaws.chime#ChannelMembershipForAppInstanceUserSummary": { "type": "structure", "members": { "ChannelSummary": { "target": "com.amazonaws.chime#ChannelSummary" }, "AppInstanceUserMembershipSummary": { "target": "com.amazonaws.chime#AppInstanceUserMembershipSummary", "traits": { "smithy.api#documentation": "Returns the channel membership data for an AppInstance.
Summary of the channel membership details of an AppInstanceUser.
A member's summary data.
" } } }, "traits": { "smithy.api#documentation": "Summary of the details of a ChannelMembership.
The ARN of the channel.
" } }, "MessageId": { "target": "com.amazonaws.chime#MessageId", "traits": { "smithy.api#documentation": "The ID of a message.
" } }, "Content": { "target": "com.amazonaws.chime#Content", "traits": { "smithy.api#documentation": "The message content.
" } }, "Metadata": { "target": "com.amazonaws.chime#Metadata", "traits": { "smithy.api#documentation": "The message metadata.
" } }, "Type": { "target": "com.amazonaws.chime#ChannelMessageType", "traits": { "smithy.api#documentation": "The message type.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.chime#Timestamp", "traits": { "smithy.api#documentation": "The time at which the message was created.
" } }, "LastEditedTimestamp": { "target": "com.amazonaws.chime#Timestamp", "traits": { "smithy.api#documentation": "The time at which a message was edited.
" } }, "LastUpdatedTimestamp": { "target": "com.amazonaws.chime#Timestamp", "traits": { "smithy.api#documentation": "The time at which a message was updated.
" } }, "Sender": { "target": "com.amazonaws.chime#Identity", "traits": { "smithy.api#documentation": "The message sender.
" } }, "Redacted": { "target": "com.amazonaws.chime#NonNullableBoolean", "traits": { "smithy.api#documentation": "Hides the content of a message.
" } }, "Persistence": { "target": "com.amazonaws.chime#ChannelMessagePersistenceType", "traits": { "smithy.api#documentation": "The persistence setting for a channel message.
" } } }, "traits": { "smithy.api#documentation": "The details of a message in a channel.
" } }, "com.amazonaws.chime#ChannelMessagePersistenceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "PERSISTENT", "name": "PERSISTENT" }, { "value": "NON_PERSISTENT", "name": "NON_PERSISTENT" } ] } }, "com.amazonaws.chime#ChannelMessageSummary": { "type": "structure", "members": { "MessageId": { "target": "com.amazonaws.chime#MessageId", "traits": { "smithy.api#documentation": "The ID of the message.
" } }, "Content": { "target": "com.amazonaws.chime#Content", "traits": { "smithy.api#documentation": "The content of the message.
" } }, "Metadata": { "target": "com.amazonaws.chime#Metadata", "traits": { "smithy.api#documentation": "The metadata of the message.
" } }, "Type": { "target": "com.amazonaws.chime#ChannelMessageType", "traits": { "smithy.api#documentation": "The type of message.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.chime#Timestamp", "traits": { "smithy.api#documentation": "The time at which the message summary was created.
" } }, "LastUpdatedTimestamp": { "target": "com.amazonaws.chime#Timestamp", "traits": { "smithy.api#documentation": "The time at which a message was last updated.
" } }, "LastEditedTimestamp": { "target": "com.amazonaws.chime#Timestamp", "traits": { "smithy.api#documentation": "The time at which a message was last edited.
" } }, "Sender": { "target": "com.amazonaws.chime#Identity", "traits": { "smithy.api#documentation": "The message sender.
" } }, "Redacted": { "target": "com.amazonaws.chime#NonNullableBoolean", "traits": { "smithy.api#documentation": "Indicates whether a message was redacted.
" } } }, "traits": { "smithy.api#documentation": "Summary of the messages in a Channel.
Summary of the details of a moderated channel.
" } }, "com.amazonaws.chime#ChannelModeratedByAppInstanceUserSummaryList": { "type": "list", "member": { "target": "com.amazonaws.chime#ChannelModeratedByAppInstanceUserSummary" } }, "com.amazonaws.chime#ChannelModerator": { "type": "structure", "members": { "Moderator": { "target": "com.amazonaws.chime#Identity", "traits": { "smithy.api#documentation": "The moderator's data.
" } }, "ChannelArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the moderator's channel.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.chime#Timestamp", "traits": { "smithy.api#documentation": "The time at which the moderator was created.
" } }, "CreatedBy": { "target": "com.amazonaws.chime#Identity", "traits": { "smithy.api#documentation": "The AppInstanceUser who created the moderator.
The details of a channel moderator.
" } }, "com.amazonaws.chime#ChannelModeratorSummary": { "type": "structure", "members": { "Moderator": { "target": "com.amazonaws.chime#Identity", "traits": { "smithy.api#documentation": "The data for a moderator.
" } } }, "traits": { "smithy.api#documentation": "Summary of the details of a ChannelModerator.
The time in days to retain the messages in a channel.
" } } }, "traits": { "smithy.api#documentation": "The details of the retention settings for a channel.
" } }, "com.amazonaws.chime#ChannelSummary": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.chime#NonEmptyResourceName", "traits": { "smithy.api#documentation": "The name of the channel.
" } }, "ChannelArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the channel.
" } }, "Mode": { "target": "com.amazonaws.chime#ChannelMode", "traits": { "smithy.api#documentation": "The mode of the channel.
" } }, "Privacy": { "target": "com.amazonaws.chime#ChannelPrivacy", "traits": { "smithy.api#documentation": "The privacy setting of the channel.
" } }, "Metadata": { "target": "com.amazonaws.chime#Metadata", "traits": { "smithy.api#documentation": "The metadata of the channel.
" } }, "LastMessageTimestamp": { "target": "com.amazonaws.chime#Timestamp", "traits": { "smithy.api#documentation": "The time at which the last message in a channel was sent.
" } } }, "traits": { "smithy.api#documentation": "Summary of the details of a Channel.
The request could not be processed because of conflict in the current state of the\n resource.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.chime#Content": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 4096 }, "smithy.api#pattern": "[\\s\\S]*", "smithy.api#sensitive": {} } }, "com.amazonaws.chime#ConversationRetentionSettings": { "type": "structure", "members": { "RetentionDays": { "target": "com.amazonaws.chime#RetentionDays", "traits": { "smithy.api#documentation": "The number of days for which to retain conversation messages.
" } } }, "traits": { "smithy.api#documentation": "The retention settings that determine how long to retain conversation messages for an Amazon Chime Enterprise account.
" } }, "com.amazonaws.chime#Country": { "type": "string", "traits": { "smithy.api#pattern": "^$|^[A-Z]{2,2}$" } }, "com.amazonaws.chime#CountryList": { "type": "list", "member": { "target": "com.amazonaws.chime#Country" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.chime#CpsLimit": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.chime#CreateAccount": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreateAccountRequest" }, "output": { "target": "com.amazonaws.chime#CreateAccountResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Creates an Amazon Chime account under the administrator's AWS account. Only Team\n account types are currently supported for this action. For more information about\n different account types, see Managing Your Amazon Chime Accounts in the\n Amazon Chime Administration Guide.
The name of the Amazon Chime account.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#CreateAccountResponse": { "type": "structure", "members": { "Account": { "target": "com.amazonaws.chime#Account", "traits": { "smithy.api#documentation": "The Amazon Chime account details.
" } } } }, "com.amazonaws.chime#CreateAppInstance": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreateAppInstanceRequest" }, "output": { "target": "com.amazonaws.chime#CreateAppInstanceResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. \nCreateAppInstance supports idempotency behavior as described in the AWS API Standard.
Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions. \n
\n ChannelModerator actions across all channels in the AppInstance.
\n DeleteChannelMessage actions.
Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.
The ARN of the administrator of the current AppInstance.
The ARN of the AppInstance.
The name and ARN of the admin for the AppInstance.
The ARN of the of the admin for the AppInstance.
The name of the AppInstance.
The metadata of the AppInstance. Limited to a 1KB string in UTF-8.
The ClientRequestToken of the AppInstance.
Tags assigned to the AppInstanceUser.
The Amazon Resource Number (ARN) of the AppInstance.
Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and \nName for that user.
The ARN of the AppInstance request.
The user ID of the AppInstance.
The user's name.
", "smithy.api#required": {} } }, "Metadata": { "target": "com.amazonaws.chime#Metadata", "traits": { "smithy.api#documentation": "The request's metadata. Limited to a 1KB string in UTF-8.
" } }, "ClientRequestToken": { "target": "com.amazonaws.chime#ClientRequestToken", "traits": { "smithy.api#documentation": "The token assigned to the user requesting an AppInstance.
Tags assigned to the AppInstanceUser.
The user's ARN.
" } } } }, "com.amazonaws.chime#CreateAttendee": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreateAttendeeRequest" }, "output": { "target": "com.amazonaws.chime#CreateAttendeeResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "\nCreates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see \nUsing the Amazon Chime SDK\nin the \nAmazon Chime Developer Guide.\n
", "smithy.api#http": { "method": "POST", "uri": "/meetings/{MeetingId}/attendees", "code": 201 } } }, "com.amazonaws.chime#CreateAttendeeError": { "type": "structure", "members": { "ExternalUserId": { "target": "com.amazonaws.chime#ExternalUserIdType", "traits": { "smithy.api#documentation": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
" } }, "ErrorCode": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The error code.
" } }, "ErrorMessage": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The error message.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.chime#CreateAttendeeRequest": { "type": "structure", "members": { "MeetingId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ExternalUserId": { "target": "com.amazonaws.chime#ExternalUserIdType", "traits": { "smithy.api#documentation": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.chime#AttendeeTagList", "traits": { "smithy.api#documentation": "The tag key-value pairs.
" } } } }, "com.amazonaws.chime#CreateAttendeeRequestItem": { "type": "structure", "members": { "ExternalUserId": { "target": "com.amazonaws.chime#ExternalUserIdType", "traits": { "smithy.api#documentation": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.chime#AttendeeTagList", "traits": { "smithy.api#documentation": "The tag key-value pairs.
" } } }, "traits": { "smithy.api#documentation": "The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.
" } }, "com.amazonaws.chime#CreateAttendeeRequestItemList": { "type": "list", "member": { "target": "com.amazonaws.chime#CreateAttendeeRequestItem" } }, "com.amazonaws.chime#CreateAttendeeResponse": { "type": "structure", "members": { "Attendee": { "target": "com.amazonaws.chime#Attendee", "traits": { "smithy.api#documentation": "The attendee information, including attendee ID and join token.
" } } } }, "com.amazonaws.chime#CreateBot": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreateBotRequest" }, "output": { "target": "com.amazonaws.chime#CreateBotResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Creates a bot for an Amazon Chime Enterprise account.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/bots", "code": 201 } } }, "com.amazonaws.chime#CreateBotRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DisplayName": { "target": "com.amazonaws.chime#SensitiveString", "traits": { "smithy.api#documentation": "The bot display name.
", "smithy.api#required": {} } }, "Domain": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The domain of the Amazon Chime Enterprise account.
" } } } }, "com.amazonaws.chime#CreateBotResponse": { "type": "structure", "members": { "Bot": { "target": "com.amazonaws.chime#Bot", "traits": { "smithy.api#documentation": "The bot details.
" } } } }, "com.amazonaws.chime#CreateChannel": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreateChannelRequest" }, "output": { "target": "com.amazonaws.chime#CreateChannelResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Creates a channel to which you can add users and send messages.
\n\n\n Restriction: You can't change a channel's privacy.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
Permanently bans a member from a channel. Moderators can't add banned members to a channel.\n To undo a ban, you first have to DeleteChannelBan, and then\n CreateChannelMembership. Bans are cleaned up when you delete users or\n channels.
If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
The ARN of the ban request.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MemberArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the member being banned.
", "smithy.api#required": {} } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the response to the ban request.
" } }, "Member": { "target": "com.amazonaws.chime#Identity", "traits": { "smithy.api#documentation": "The ChannelArn and BannedIdentity of the member in the ban response.
Adds a user to a channel. The InvitedBy response field is derived from the\n request header. A channel member can:
List messages
\nSend messages
\nReceive messages
\nEdit their own messages
\nLeave the channel
\nPrivacy settings impact this action as follows:
\n\nPublic Channels: You do not need to be a member to list messages, but you must be a member to send messages.
\nPrivate Channels: You must be a member to list or send messages.
\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
The ARN of the channel to which you're adding users.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MemberArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the member you want to add to the channel.
", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.chime#ChannelMembershipType", "traits": { "smithy.api#documentation": "The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of \nListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals \nHIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.
The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
" } }, "Member": { "target": "com.amazonaws.chime#Identity", "traits": { "smithy.api#documentation": "The ARN and metadata of the member being added.
" } } } }, "com.amazonaws.chime#CreateChannelModerator": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreateChannelModeratorRequest" }, "output": { "target": "com.amazonaws.chime#CreateChannelModeratorResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Creates a new ChannelModerator. A channel moderator can:
Add and remove other members of the channel.
\nAdd and remove other moderators of the channel.
\nAdd and remove user bans for the channel.
\nRedact messages in the channel.
\nList messages in the channel.
\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
The ARN of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ChannelModeratorArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the moderator.
", "smithy.api#required": {} } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
" } }, "ChannelModerator": { "target": "com.amazonaws.chime#Identity", "traits": { "smithy.api#documentation": "The ARNs of the channel and the moderator.
" } } } }, "com.amazonaws.chime#CreateChannelRequest": { "type": "structure", "members": { "AppInstanceArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the channel request.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.chime#NonEmptyResourceName", "traits": { "smithy.api#documentation": "The name of the channel.
", "smithy.api#required": {} } }, "Mode": { "target": "com.amazonaws.chime#ChannelMode", "traits": { "smithy.api#documentation": "The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves \n and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.
The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. \n Public channels are discoverable by anyone in the AppInstance.
The metadata of the creation request. Limited to 1KB and UTF-8.
" } }, "ClientRequestToken": { "target": "com.amazonaws.chime#ClientRequestToken", "traits": { "smithy.api#documentation": "The client token for the request. An Idempotency token.
The tags for the creation request.
" } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
" } } } }, "com.amazonaws.chime#CreateMeeting": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreateMeetingRequest" }, "output": { "target": "com.amazonaws.chime#CreateMeetingResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "\nCreates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see \nAmazon Chime SDK Media Regions\nin the \nAmazon Chime Developer Guide\n. For more information about the Amazon Chime SDK, see \nUsing the Amazon Chime SDK\nin the \nAmazon Chime Developer Guide\n.\n
", "smithy.api#http": { "method": "POST", "uri": "/meetings", "code": 201 } } }, "com.amazonaws.chime#CreateMeetingDialOut": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreateMeetingDialOutRequest" }, "output": { "target": "com.amazonaws.chime#CreateMeetingDialOutResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public \n switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.
\n\nTo play welcome audio or implement an interactive voice response (IVR), use the \nCreateSipMediaApplicationCall action with the corresponding SIP media application ID.
The Amazon Chime SDK meeting ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "FromPhoneNumber": { "target": "com.amazonaws.chime#E164PhoneNumber", "traits": { "smithy.api#documentation": "Phone number used as the caller ID when the remote party receives a call.
", "smithy.api#required": {} } }, "ToPhoneNumber": { "target": "com.amazonaws.chime#E164PhoneNumber", "traits": { "smithy.api#documentation": "Phone number called when inviting someone to a meeting.
", "smithy.api#required": {} } }, "JoinToken": { "target": "com.amazonaws.chime#JoinTokenString", "traits": { "smithy.api#documentation": "Token used by the Amazon Chime SDK attendee. Call the \n CreateAttendee action to \n get a join token.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#CreateMeetingDialOutResponse": { "type": "structure", "members": { "TransactionId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "Unique ID that tracks API calls.
" } } } }, "com.amazonaws.chime#CreateMeetingRequest": { "type": "structure", "members": { "ClientRequestToken": { "target": "com.amazonaws.chime#ClientRequestToken", "traits": { "smithy.api#documentation": "The unique identifier for the client request. Use a different token for different meetings.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "ExternalMeetingId": { "target": "com.amazonaws.chime#ExternalMeetingIdType", "traits": { "smithy.api#documentation": "The external meeting ID.
" } }, "MeetingHostId": { "target": "com.amazonaws.chime#ExternalUserIdType", "traits": { "smithy.api#documentation": "Reserved.
" } }, "MediaRegion": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "\nThe Region in which to create the meeting. Default: us-east-1.\n
\nAvailable values: \naf-south-1\n, \nap-northeast-1\n, \nap-northeast-2\n, \nap-south-1\n, \nap-southeast-1\n, \nap-southeast-2\n, \nca-central-1\n, \neu-central-1\n, \neu-north-1\n, \neu-south-1\n, \neu-west-1\n, \neu-west-2\n, \neu-west-3\n, \nsa-east-1\n, \nus-east-1\n, \nus-east-2\n, \nus-west-1\n, \nus-west-2\n.\n
The tag key-value pairs.
" } }, "NotificationsConfiguration": { "target": "com.amazonaws.chime#MeetingNotificationConfiguration", "traits": { "smithy.api#documentation": "The configuration for resource targets to receive notifications when meeting and attendee events occur.
" } } } }, "com.amazonaws.chime#CreateMeetingResponse": { "type": "structure", "members": { "Meeting": { "target": "com.amazonaws.chime#Meeting", "traits": { "smithy.api#documentation": "\nThe meeting information, including the meeting ID and \nMediaPlacement\n.\n
\nCreates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see \nAmazon Chime SDK Media Regions\nin the \nAmazon Chime Developer Guide\n. For more information about the Amazon Chime SDK, see \nUsing the Amazon Chime SDK\nin the \nAmazon Chime Developer Guide\n.\n
", "smithy.api#http": { "method": "POST", "uri": "/meetings?operation=create-attendees", "code": 201 } } }, "com.amazonaws.chime#CreateMeetingWithAttendeesRequest": { "type": "structure", "members": { "ClientRequestToken": { "target": "com.amazonaws.chime#ClientRequestToken", "traits": { "smithy.api#documentation": "The unique identifier for the client request. Use a different token for different meetings.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "ExternalMeetingId": { "target": "com.amazonaws.chime#ExternalMeetingIdType", "traits": { "smithy.api#documentation": "The external meeting ID.
" } }, "MeetingHostId": { "target": "com.amazonaws.chime#ExternalUserIdType", "traits": { "smithy.api#documentation": "Reserved.
" } }, "MediaRegion": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "\nThe Region in which to create the meeting. Default: us-east-1\n.\n
\nAvailable values: \naf-south-1\n, \nap-northeast-1\n, \nap-northeast-2\n, \nap-south-1\n, \nap-southeast-1\n, \nap-southeast-2\n, \nca-central-1\n, \neu-central-1\n, \neu-north-1\n, \neu-south-1\n, \neu-west-1\n, \neu-west-2\n, \neu-west-3\n, \nsa-east-1\n, \nus-east-1\n, \nus-east-2\n, \nus-west-1\n, \nus-west-2\n.\n
The tag key-value pairs.
" } }, "NotificationsConfiguration": { "target": "com.amazonaws.chime#MeetingNotificationConfiguration" }, "Attendees": { "target": "com.amazonaws.chime#CreateMeetingWithAttendeesRequestItemList", "traits": { "smithy.api#documentation": "The request containing the attendees to create.
" } } } }, "com.amazonaws.chime#CreateMeetingWithAttendeesRequestItemList": { "type": "list", "member": { "target": "com.amazonaws.chime#CreateAttendeeRequestItem" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.chime#CreateMeetingWithAttendeesResponse": { "type": "structure", "members": { "Meeting": { "target": "com.amazonaws.chime#Meeting" }, "Attendees": { "target": "com.amazonaws.chime#AttendeeList", "traits": { "smithy.api#documentation": "The attendee information, including attendees IDs and join tokens.
" } }, "Errors": { "target": "com.amazonaws.chime#BatchCreateAttendeeErrorList", "traits": { "smithy.api#documentation": "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.
" } } } }, "com.amazonaws.chime#CreatePhoneNumberOrder": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreatePhoneNumberOrderRequest" }, "output": { "target": "com.amazonaws.chime#CreatePhoneNumberOrderResponse" }, "errors": [ { "target": "com.amazonaws.chime#AccessDeniedException" }, { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot\n use the Amazon Chime Business Calling product type. For numbers outside the\n US,\n you must use the Amazon Chime SIP Media Application Dial-In product type.
", "smithy.api#http": { "method": "POST", "uri": "/phone-number-orders", "code": 201 } } }, "com.amazonaws.chime#CreatePhoneNumberOrderRequest": { "type": "structure", "members": { "ProductType": { "target": "com.amazonaws.chime#PhoneNumberProductType", "traits": { "smithy.api#documentation": "The phone number product type.
", "smithy.api#required": {} } }, "E164PhoneNumbers": { "target": "com.amazonaws.chime#E164PhoneNumberList", "traits": { "smithy.api#documentation": "List of phone numbers, in E.164 format.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#CreatePhoneNumberOrderResponse": { "type": "structure", "members": { "PhoneNumberOrder": { "target": "com.amazonaws.chime#PhoneNumberOrder", "traits": { "smithy.api#documentation": "The phone number order details.
" } } } }, "com.amazonaws.chime#CreateProxySession": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreateProxySessionRequest" }, "output": { "target": "com.amazonaws.chime#CreateProxySessionResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
", "smithy.api#http": { "method": "POST", "uri": "/voice-connectors/{VoiceConnectorId}/proxy-sessions", "code": 201 } } }, "com.amazonaws.chime#CreateProxySessionRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString128", "traits": { "smithy.api#documentation": "The Amazon Chime voice connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ParticipantPhoneNumbers": { "target": "com.amazonaws.chime#ParticipantPhoneNumberList", "traits": { "smithy.api#documentation": "The participant phone numbers.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.chime#ProxySessionNameString", "traits": { "smithy.api#documentation": "The name of the proxy session.
" } }, "ExpiryMinutes": { "target": "com.amazonaws.chime#PositiveInteger", "traits": { "smithy.api#documentation": "The number of minutes allowed for the proxy session.
" } }, "Capabilities": { "target": "com.amazonaws.chime#CapabilityList", "traits": { "smithy.api#documentation": "The proxy session capabilities.
", "smithy.api#required": {} } }, "NumberSelectionBehavior": { "target": "com.amazonaws.chime#NumberSelectionBehavior", "traits": { "smithy.api#documentation": "The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
" } }, "GeoMatchLevel": { "target": "com.amazonaws.chime#GeoMatchLevel", "traits": { "smithy.api#documentation": "The preference for matching the country or area code of the proxy phone number with that of the first participant.
" } }, "GeoMatchParams": { "target": "com.amazonaws.chime#GeoMatchParams", "traits": { "smithy.api#documentation": "The country and area code for the proxy phone number.
" } } } }, "com.amazonaws.chime#CreateProxySessionResponse": { "type": "structure", "members": { "ProxySession": { "target": "com.amazonaws.chime#ProxySession", "traits": { "smithy.api#documentation": "The proxy session details.
" } } } }, "com.amazonaws.chime#CreateRoom": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreateRoomRequest" }, "output": { "target": "com.amazonaws.chime#CreateRoomResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Creates a chat room for the specified Amazon Chime Enterprise account.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/rooms", "code": 201 } } }, "com.amazonaws.chime#CreateRoomMembership": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreateRoomMembershipRequest" }, "output": { "target": "com.amazonaws.chime#CreateRoomMembershipResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/rooms/{RoomId}/memberships", "code": 201 } } }, "com.amazonaws.chime#CreateRoomMembershipRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RoomId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The room ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MemberId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime member ID (user ID or bot ID).
", "smithy.api#required": {} } }, "Role": { "target": "com.amazonaws.chime#RoomMembershipRole", "traits": { "smithy.api#documentation": "The role of the member.
" } } } }, "com.amazonaws.chime#CreateRoomMembershipResponse": { "type": "structure", "members": { "RoomMembership": { "target": "com.amazonaws.chime#RoomMembership", "traits": { "smithy.api#documentation": "The room membership details.
" } } } }, "com.amazonaws.chime#CreateRoomRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.chime#SensitiveString", "traits": { "smithy.api#documentation": "The room name.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.chime#ClientRequestToken", "traits": { "smithy.api#documentation": "The idempotency token for the request.
", "smithy.api#idempotencyToken": {} } } } }, "com.amazonaws.chime#CreateRoomResponse": { "type": "structure", "members": { "Room": { "target": "com.amazonaws.chime#Room", "traits": { "smithy.api#documentation": "The room details.
" } } } }, "com.amazonaws.chime#CreateSipMediaApplication": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreateSipMediaApplicationRequest" }, "output": { "target": "com.amazonaws.chime#CreateSipMediaApplicationResponse" }, "errors": [ { "target": "com.amazonaws.chime#AccessDeniedException" }, { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Creates a SIP media application.
", "smithy.api#http": { "method": "POST", "uri": "/sip-media-applications", "code": 201 } } }, "com.amazonaws.chime#CreateSipMediaApplicationCall": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreateSipMediaApplicationCallRequest" }, "output": { "target": "com.amazonaws.chime#CreateSipMediaApplicationCallResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified \nsipMediaApplicationId.
The phone number that a user calls from. This is a phone number in your Amazon Chime phone number inventory.
", "smithy.api#required": {} } }, "ToPhoneNumber": { "target": "com.amazonaws.chime#E164PhoneNumber", "traits": { "smithy.api#documentation": "The phone number that the service should call.
", "smithy.api#required": {} } }, "SipMediaApplicationId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The ID of the SIP media application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#CreateSipMediaApplicationCallResponse": { "type": "structure", "members": { "SipMediaApplicationCall": { "target": "com.amazonaws.chime#SipMediaApplicationCall", "traits": { "smithy.api#documentation": "The actual call.
" } } } }, "com.amazonaws.chime#CreateSipMediaApplicationRequest": { "type": "structure", "members": { "AwsRegion": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The AWS Region assigned to the SIP media application.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.chime#SipMediaApplicationName", "traits": { "smithy.api#documentation": "The SIP media application name.
", "smithy.api#required": {} } }, "Endpoints": { "target": "com.amazonaws.chime#SipMediaApplicationEndpointList", "traits": { "smithy.api#documentation": "List of endpoints (Lambda Amazon Resource Names) specified for the SIP media application. Currently, only one endpoint is supported.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#CreateSipMediaApplicationResponse": { "type": "structure", "members": { "SipMediaApplication": { "target": "com.amazonaws.chime#SipMediaApplication", "traits": { "smithy.api#documentation": "The SIP media application details.
" } } } }, "com.amazonaws.chime#CreateSipRule": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreateSipRuleRequest" }, "output": { "target": "com.amazonaws.chime#CreateSipRuleResponse" }, "errors": [ { "target": "com.amazonaws.chime#AccessDeniedException" }, { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.
", "smithy.api#http": { "method": "POST", "uri": "/sip-rules", "code": 201 } } }, "com.amazonaws.chime#CreateSipRuleRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.chime#SipRuleName", "traits": { "smithy.api#documentation": "The name of the SIP rule.
", "smithy.api#required": {} } }, "TriggerType": { "target": "com.amazonaws.chime#SipRuleTriggerType", "traits": { "smithy.api#documentation": "The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
If TriggerType is RequestUriHostname, the value can be the outbound\n host name of an Amazon Chime Voice Connector. If TriggerType is\n ToPhoneNumber, the value can be a customer-owned phone number in the\n E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP \n request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the \n ToPhoneNumber value.
Enables or disables a rule. You must disable rules before you can delete them.
" } }, "TargetApplications": { "target": "com.amazonaws.chime#SipRuleTargetApplicationList", "traits": { "smithy.api#documentation": "List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#CreateSipRuleResponse": { "type": "structure", "members": { "SipRule": { "target": "com.amazonaws.chime#SipRule", "traits": { "smithy.api#documentation": "Returns the SIP rule information, including the rule ID, triggers, and target applications.
" } } } }, "com.amazonaws.chime#CreateUser": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreateUserRequest" }, "output": { "target": "com.amazonaws.chime#CreateUserResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Creates a user under the specified Amazon Chime account.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/users?operation=create", "code": 201 } } }, "com.amazonaws.chime#CreateUserRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The user name.
" } }, "Email": { "target": "com.amazonaws.chime#EmailAddress", "traits": { "smithy.api#documentation": "The user's email address.
" } }, "UserType": { "target": "com.amazonaws.chime#UserType", "traits": { "smithy.api#documentation": "The user type.
" } } } }, "com.amazonaws.chime#CreateUserResponse": { "type": "structure", "members": { "User": { "target": "com.amazonaws.chime#User" } } }, "com.amazonaws.chime#CreateVoiceConnector": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreateVoiceConnectorRequest" }, "output": { "target": "com.amazonaws.chime#CreateVoiceConnectorResponse" }, "errors": [ { "target": "com.amazonaws.chime#AccessDeniedException" }, { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "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.
\n\n\nEnabling \nCreateVoiceConnectorRequest$RequireEncryption\nconfigures 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.\n
", "smithy.api#http": { "method": "POST", "uri": "/voice-connectors", "code": 201 } } }, "com.amazonaws.chime#CreateVoiceConnectorGroup": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreateVoiceConnectorGroupRequest" }, "output": { "target": "com.amazonaws.chime#CreateVoiceConnectorGroupResponse" }, "errors": [ { "target": "com.amazonaws.chime#AccessDeniedException" }, { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can\n associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by\n including VoiceConnectorItems in the request.
You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This\n creates a fault tolerant mechanism for fallback in case of availability events.
", "smithy.api#http": { "method": "POST", "uri": "/voice-connector-groups", "code": 201 } } }, "com.amazonaws.chime#CreateVoiceConnectorGroupRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.chime#VoiceConnectorGroupName", "traits": { "smithy.api#documentation": "The name of the Amazon Chime Voice Connector group.
", "smithy.api#required": {} } }, "VoiceConnectorItems": { "target": "com.amazonaws.chime#VoiceConnectorItemList", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connectors to route inbound calls to.
" } } } }, "com.amazonaws.chime#CreateVoiceConnectorGroupResponse": { "type": "structure", "members": { "VoiceConnectorGroup": { "target": "com.amazonaws.chime#VoiceConnectorGroup", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector group details.
" } } } }, "com.amazonaws.chime#CreateVoiceConnectorRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.chime#VoiceConnectorName", "traits": { "smithy.api#documentation": "The name of the Amazon Chime Voice Connector.
", "smithy.api#required": {} } }, "AwsRegion": { "target": "com.amazonaws.chime#VoiceConnectorAwsRegion", "traits": { "smithy.api#documentation": "\nThe AWS Region in which the Amazon Chime Voice Connector is created. Default value: \nus-east-1\n.\n
When enabled, requires encryption for the Amazon Chime Voice Connector.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#CreateVoiceConnectorResponse": { "type": "structure", "members": { "VoiceConnector": { "target": "com.amazonaws.chime#VoiceConnector", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector details.
" } } } }, "com.amazonaws.chime#Credential": { "type": "structure", "members": { "Username": { "target": "com.amazonaws.chime#SensitiveString", "traits": { "smithy.api#documentation": "The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII\n format.
" } }, "Password": { "target": "com.amazonaws.chime#SensitiveString", "traits": { "smithy.api#documentation": "The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.
" } } }, "traits": { "smithy.api#documentation": "The SIP credentials used to authenticate requests to your Amazon Chime Voice Connector.
" } }, "com.amazonaws.chime#CredentialList": { "type": "list", "member": { "target": "com.amazonaws.chime#Credential" } }, "com.amazonaws.chime#DNISEmergencyCallingConfiguration": { "type": "structure", "members": { "EmergencyPhoneNumber": { "target": "com.amazonaws.chime#E164PhoneNumber", "traits": { "smithy.api#documentation": "The DNIS phone number to route emergency calls to, in E.164 format.
", "smithy.api#required": {} } }, "TestPhoneNumber": { "target": "com.amazonaws.chime#E164PhoneNumber", "traits": { "smithy.api#documentation": "The DNIS phone number to route test emergency calls to, in E.164 format.
" } }, "CallingCountry": { "target": "com.amazonaws.chime#Alpha2CountryCode", "traits": { "smithy.api#documentation": "The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.
" } }, "com.amazonaws.chime#DNISEmergencyCallingConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.chime#DNISEmergencyCallingConfiguration" } }, "com.amazonaws.chime#DataRetentionInHours": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0 } } }, "com.amazonaws.chime#DeleteAccount": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteAccountRequest" }, "output": { "target": "com.amazonaws.chime#DeleteAccountResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" }, { "target": "com.amazonaws.chime#UnprocessableEntityException" } ], "traits": { "smithy.api#documentation": "Deletes the specified Amazon Chime account. You must suspend all users before deleting\n Team account. You can use the BatchSuspendUser action\n to dodo.
For EnterpriseLWA and EnterpriseAD accounts, you must release the\n claimed domains for your Amazon Chime account before deletion. As soon as you release\n the domain, all users under that account are suspended.
Deleted accounts appear in your Disabled accounts list for 90 days. To restore\n deleted account from your Disabled accounts list, you must contact AWS\n Support.
After 90 days, deleted accounts are permanently removed from your \nDisabled accounts list.
The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeleteAccountResponse": { "type": "structure", "members": {} }, "com.amazonaws.chime#DeleteAppInstance": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteAppInstanceRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Deletes an AppInstance and all associated data asynchronously.
Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.
The ARN of the AppInstance's administrator.
The ARN of the AppInstance.
The ARN of the AppInstance.
Deletes the streaming configurations of an AppInstance.
The ARN of the streaming configurations being deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeleteAppInstanceUser": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteAppInstanceUserRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Deletes an AppInstanceUser.
The ARN of the user request being deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeleteAttendee": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteAttendeeRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their \nJoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see \nUsing the Amazon Chime SDK\nin the Amazon Chime Developer Guide.
The Amazon Chime SDK meeting ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AttendeeId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK attendee ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeleteChannel": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteChannelRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
Removes a user from a channel's ban list.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
The ARN of the channel from which the AppInstanceUser was banned.
The ARN of the AppInstanceUser that you want to reinstate.
The AppInstanceUserArn of the user that makes the API call.
Removes a member from a channel.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
The ARN of the channel from which you want to remove the user.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MemberArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the member that you're removing from the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
Deletes a channel message. Only admins can perform this action. Deletion makes messages\n inaccessible immediately. A background process deletes any revisions created by\n UpdateChannelMessage.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
The ARN of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MessageId": { "target": "com.amazonaws.chime#MessageId", "traits": { "smithy.api#documentation": "The ID of the message being deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
Deletes a channel moderator.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
The ARN of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ChannelModeratorArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the moderator being deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel being deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
Deletes the events configuration that allows a bot to receive outgoing events.
", "smithy.api#http": { "method": "DELETE", "uri": "/accounts/{AccountId}/bots/{BotId}/events-configuration", "code": 204 } } }, "com.amazonaws.chime#DeleteEventsConfigurationRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BotId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The bot ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeleteMeeting": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteMeetingRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from \n joining the meeting. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK in the \n Amazon Chime Developer Guide.
", "smithy.api#http": { "method": "DELETE", "uri": "/meetings/{MeetingId}", "code": 204 } } }, "com.amazonaws.chime#DeleteMeetingRequest": { "type": "structure", "members": { "MeetingId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeletePhoneNumber": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeletePhoneNumberRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Moves the specified phone number into the Deletion\n queue. A phone number must be disassociated from any\n users or Amazon Chime Voice Connectors before it can be deleted.
\n\nDeleted phone numbers remain in the \nDeletion queue\nfor 7 days before they are deleted permanently.
", "smithy.api#http": { "method": "DELETE", "uri": "/phone-numbers/{PhoneNumberId}", "code": 204 } } }, "com.amazonaws.chime#DeletePhoneNumberRequest": { "type": "structure", "members": { "PhoneNumberId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The phone number ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeleteProxySession": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteProxySessionRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Deletes the specified proxy session from the specified Amazon Chime Voice Connector.
", "smithy.api#http": { "method": "DELETE", "uri": "/voice-connectors/{VoiceConnectorId}/proxy-sessions/{ProxySessionId}", "code": 204 } } }, "com.amazonaws.chime#DeleteProxySessionRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString128", "traits": { "smithy.api#documentation": "The Amazon Chime voice connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ProxySessionId": { "target": "com.amazonaws.chime#NonEmptyString128", "traits": { "smithy.api#documentation": "The proxy session ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeleteRoom": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteRoomRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Deletes a chat room in an Amazon Chime Enterprise account.
", "smithy.api#http": { "method": "DELETE", "uri": "/accounts/{AccountId}/rooms/{RoomId}", "code": 204 } } }, "com.amazonaws.chime#DeleteRoomMembership": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteRoomMembershipRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Removes a member from a chat room in an Amazon Chime Enterprise account.
", "smithy.api#http": { "method": "DELETE", "uri": "/accounts/{AccountId}/rooms/{RoomId}/memberships/{MemberId}", "code": 204 } } }, "com.amazonaws.chime#DeleteRoomMembershipRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RoomId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The room ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MemberId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The member ID (user ID or bot ID).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeleteRoomRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RoomId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The chat room ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeleteSipMediaApplication": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteSipMediaApplicationRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Deletes a SIP media application.
", "smithy.api#http": { "method": "DELETE", "uri": "/sip-media-applications/{SipMediaApplicationId}", "code": 204 } } }, "com.amazonaws.chime#DeleteSipMediaApplicationRequest": { "type": "structure", "members": { "SipMediaApplicationId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The SIP media application ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeleteSipRule": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteSipRuleRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Deletes a SIP rule. You must disable a SIP rule before you can delete it.
", "smithy.api#http": { "method": "DELETE", "uri": "/sip-rules/{SipRuleId}", "code": 204 } } }, "com.amazonaws.chime#DeleteSipRuleRequest": { "type": "structure", "members": { "SipRuleId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The SIP rule ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeleteVoiceConnector": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteVoiceConnectorRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the\n Amazon Chime Voice Connector must be disassociated from it before it can be\n deleted.
", "smithy.api#http": { "method": "DELETE", "uri": "/voice-connectors/{VoiceConnectorId}", "code": 204 } } }, "com.amazonaws.chime#DeleteVoiceConnectorEmergencyCallingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteVoiceConnectorEmergencyCallingConfigurationRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.
", "smithy.api#http": { "method": "DELETE", "uri": "/voice-connectors/{VoiceConnectorId}/emergency-calling-configuration", "code": 204 } } }, "com.amazonaws.chime#DeleteVoiceConnectorEmergencyCallingConfigurationRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeleteVoiceConnectorGroup": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteVoiceConnectorGroupRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Deletes the specified Amazon Chime Voice Connector group. Any \nVoiceConnectorItems\nand phone numbers associated with the group must be removed before it can be deleted.
The Amazon Chime Voice Connector group ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeleteVoiceConnectorOrigination": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteVoiceConnectorOriginationRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Deletes the origination settings for the specified Amazon Chime Voice Connector.
\n\nIf emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.
\nThe Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeleteVoiceConnectorProxy": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteVoiceConnectorProxyRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Deletes the proxy configuration from the specified Amazon Chime Voice Connector.
", "smithy.api#http": { "method": "DELETE", "uri": "/voice-connectors/{VoiceConnectorId}/programmable-numbers/proxy", "code": 204 } } }, "com.amazonaws.chime#DeleteVoiceConnectorProxyRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString128", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeleteVoiceConnectorRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeleteVoiceConnectorStreamingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteVoiceConnectorStreamingConfigurationRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Deletes the streaming configuration for the specified Amazon Chime Voice Connector.
", "smithy.api#http": { "method": "DELETE", "uri": "/voice-connectors/{VoiceConnectorId}/streaming-configuration", "code": 204 } } }, "com.amazonaws.chime#DeleteVoiceConnectorStreamingConfigurationRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeleteVoiceConnectorTermination": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteVoiceConnectorTerminationRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Deletes the termination settings for the specified Amazon Chime Voice Connector.
\n\nIf emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.
\nDeletes the specified SIP credentials used by your equipment to authenticate during call termination.
", "smithy.api#http": { "method": "POST", "uri": "/voice-connectors/{VoiceConnectorId}/termination/credentials?operation=delete", "code": 204 } } }, "com.amazonaws.chime#DeleteVoiceConnectorTerminationCredentialsRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Usernames": { "target": "com.amazonaws.chime#SensitiveStringList", "traits": { "smithy.api#documentation": "The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#DeleteVoiceConnectorTerminationRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DescribeAppInstance": { "type": "operation", "input": { "target": "com.amazonaws.chime#DescribeAppInstanceRequest" }, "output": { "target": "com.amazonaws.chime#DescribeAppInstanceResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Returns the full details of an AppInstance.
Returns the full details of an AppInstanceAdmin.
The ARN of the AppInstanceAdmin.
The ARN of the AppInstance.
The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the created and\n last-updated timestamps. All timestamps use epoch milliseconds.
The ARN of the AppInstance.
The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance. All\n timestamps use epoch milliseconds.
\nReturns the full details of an \nAppInstanceUser\n.\n
The ARN of the AppInstanceUser.
The name of the AppInstanceUser.
Returns the full details of a channel in an Amazon Chime AppInstance.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
Returns the full details of a channel ban.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
The ARN of the channel from which the user is banned.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MemberArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the member being banned.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The details of\n the ban.
" } } } }, "com.amazonaws.chime#DescribeChannelMembership": { "type": "operation", "input": { "target": "com.amazonaws.chime#DescribeChannelMembershipRequest" }, "output": { "target": "com.amazonaws.chime#DescribeChannelMembershipResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Returns the full details of a user's channel membership.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
\nReturns the details of a channel based on the membership of the specified AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
The ARN of the channel to which the user belongs.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AppInstanceUserArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the user in a channel.
", "smithy.api#httpQuery": "app-instance-user-arn", "smithy.api#required": {} } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The channel to which a user belongs.
" } } } }, "com.amazonaws.chime#DescribeChannelMembershipRequest": { "type": "structure", "members": { "ChannelArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MemberArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the member.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The details of the membership.
" } } } }, "com.amazonaws.chime#DescribeChannelModeratedByAppInstanceUser": { "type": "operation", "input": { "target": "com.amazonaws.chime#DescribeChannelModeratedByAppInstanceUserRequest" }, "output": { "target": "com.amazonaws.chime#DescribeChannelModeratedByAppInstanceUserResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Returns the full details of a channel moderated by the specified AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
The ARN of the moderated channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AppInstanceUserArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the AppInstanceUser in the moderated channel.
The AppInstanceUserArn of the user that makes the API call.
The moderated channel.
" } } } }, "com.amazonaws.chime#DescribeChannelModerator": { "type": "operation", "input": { "target": "com.amazonaws.chime#DescribeChannelModeratorRequest" }, "output": { "target": "com.amazonaws.chime#DescribeChannelModeratorResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Returns the full details of a single ChannelModerator.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
The ARN of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ChannelModeratorArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the channel moderator.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The details of the channel moderator.
" } } } }, "com.amazonaws.chime#DescribeChannelRequest": { "type": "structure", "members": { "ChannelArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The channel details.
" } } } }, "com.amazonaws.chime#DisassociatePhoneNumberFromUser": { "type": "operation", "input": { "target": "com.amazonaws.chime#DisassociatePhoneNumberFromUserRequest" }, "output": { "target": "com.amazonaws.chime#DisassociatePhoneNumberFromUserResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Disassociates the primary provisioned phone number from the specified Amazon Chime\n user.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/users/{UserId}?operation=disassociate-phone-number", "code": 200 } } }, "com.amazonaws.chime#DisassociatePhoneNumberFromUserRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The user ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#DisassociatePhoneNumberFromUserResponse": { "type": "structure", "members": {} }, "com.amazonaws.chime#DisassociatePhoneNumbersFromVoiceConnector": { "type": "operation", "input": { "target": "com.amazonaws.chime#DisassociatePhoneNumbersFromVoiceConnectorRequest" }, "output": { "target": "com.amazonaws.chime#DisassociatePhoneNumbersFromVoiceConnectorResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
", "smithy.api#http": { "method": "POST", "uri": "/voice-connectors/{VoiceConnectorId}?operation=disassociate-phone-numbers", "code": 200 } } }, "com.amazonaws.chime#DisassociatePhoneNumbersFromVoiceConnectorGroup": { "type": "operation", "input": { "target": "com.amazonaws.chime#DisassociatePhoneNumbersFromVoiceConnectorGroupRequest" }, "output": { "target": "com.amazonaws.chime#DisassociatePhoneNumbersFromVoiceConnectorGroupResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
", "smithy.api#http": { "method": "POST", "uri": "/voice-connector-groups/{VoiceConnectorGroupId}?operation=disassociate-phone-numbers", "code": 200 } } }, "com.amazonaws.chime#DisassociatePhoneNumbersFromVoiceConnectorGroupRequest": { "type": "structure", "members": { "VoiceConnectorGroupId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector group ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "E164PhoneNumbers": { "target": "com.amazonaws.chime#E164PhoneNumberList", "traits": { "smithy.api#documentation": "List of phone numbers, in E.164 format.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#DisassociatePhoneNumbersFromVoiceConnectorGroupResponse": { "type": "structure", "members": { "PhoneNumberErrors": { "target": "com.amazonaws.chime#PhoneNumberErrorList", "traits": { "smithy.api#documentation": "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.
" } } } }, "com.amazonaws.chime#DisassociatePhoneNumbersFromVoiceConnectorRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "E164PhoneNumbers": { "target": "com.amazonaws.chime#E164PhoneNumberList", "traits": { "smithy.api#documentation": "List of phone numbers, in E.164 format.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#DisassociatePhoneNumbersFromVoiceConnectorResponse": { "type": "structure", "members": { "PhoneNumberErrors": { "target": "com.amazonaws.chime#PhoneNumberErrorList", "traits": { "smithy.api#documentation": "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.
" } } } }, "com.amazonaws.chime#DisassociateSigninDelegateGroupsFromAccount": { "type": "operation", "input": { "target": "com.amazonaws.chime#DisassociateSigninDelegateGroupsFromAccountRequest" }, "output": { "target": "com.amazonaws.chime#DisassociateSigninDelegateGroupsFromAccountResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}?operation=disassociate-signin-delegate-groups", "code": 200 } } }, "com.amazonaws.chime#DisassociateSigninDelegateGroupsFromAccountRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "GroupNames": { "target": "com.amazonaws.chime#NonEmptyStringList", "traits": { "smithy.api#documentation": "The sign-in delegate group names.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#DisassociateSigninDelegateGroupsFromAccountResponse": { "type": "structure", "members": {} }, "com.amazonaws.chime#E164PhoneNumber": { "type": "string", "traits": { "smithy.api#pattern": "^\\+?[1-9]\\d{1,14}$", "smithy.api#sensitive": {} } }, "com.amazonaws.chime#E164PhoneNumberList": { "type": "list", "member": { "target": "com.amazonaws.chime#E164PhoneNumber" } }, "com.amazonaws.chime#EmailAddress": { "type": "string", "traits": { "smithy.api#pattern": ".+@.+\\..+", "smithy.api#sensitive": {} } }, "com.amazonaws.chime#EmailStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "NotSent", "name": "NotSent" }, { "value": "Sent", "name": "Sent" }, { "value": "Failed", "name": "Failed" } ] } }, "com.amazonaws.chime#EmergencyCallingConfiguration": { "type": "structure", "members": { "DNIS": { "target": "com.amazonaws.chime#DNISEmergencyCallingConfigurationList", "traits": { "smithy.api#documentation": "The Dialed Number Identification Service (DNIS) emergency calling configuration details.
" } } }, "traits": { "smithy.api#documentation": "The emergency calling configuration details associated with an Amazon Chime Voice Connector.
" } }, "com.amazonaws.chime#ErrorCode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "BadRequest", "name": "BadRequest" }, { "value": "Conflict", "name": "Conflict" }, { "value": "Forbidden", "name": "Forbidden" }, { "value": "NotFound", "name": "NotFound" }, { "value": "PreconditionFailed", "name": "PreconditionFailed" }, { "value": "ResourceLimitExceeded", "name": "ResourceLimitExceeded" }, { "value": "ServiceFailure", "name": "ServiceFailure" }, { "value": "AccessDenied", "name": "AccessDenied" }, { "value": "ServiceUnavailable", "name": "ServiceUnavailable" }, { "value": "Throttled", "name": "Throttled" }, { "value": "Throttling", "name": "Throttling" }, { "value": "Unauthorized", "name": "Unauthorized" }, { "value": "Unprocessable", "name": "Unprocessable" }, { "value": "VoiceConnectorGroupAssociationsExist", "name": "VoiceConnectorGroupAssociationsExist" }, { "value": "PhoneNumberAssociationsExist", "name": "PhoneNumberAssociationsExist" } ] } }, "com.amazonaws.chime#EventsConfiguration": { "type": "structure", "members": { "BotId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The bot ID.
" } }, "OutboundEventsHTTPSEndpoint": { "target": "com.amazonaws.chime#SensitiveString", "traits": { "smithy.api#documentation": "HTTPS endpoint that allows a bot to receive outgoing events.
" } }, "LambdaFunctionArn": { "target": "com.amazonaws.chime#SensitiveString", "traits": { "smithy.api#documentation": "Lambda function ARN that allows a bot to receive outgoing events.
" } } }, "traits": { "smithy.api#documentation": "The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.
" } }, "com.amazonaws.chime#ExternalMeetingIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 64 }, "smithy.api#sensitive": {} } }, "com.amazonaws.chime#ExternalUserIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 64 }, "smithy.api#sensitive": {} } }, "com.amazonaws.chime#ForbiddenException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.chime#ErrorCode" }, "Message": { "target": "com.amazonaws.chime#String" } }, "traits": { "smithy.api#documentation": "The client is permanently forbidden from making the request.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.chime#FunctionArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 10000 }, "smithy.api#pattern": "arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?", "smithy.api#sensitive": {} } }, "com.amazonaws.chime#GeoMatchLevel": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Country", "name": "Country" }, { "value": "AreaCode", "name": "AreaCode" } ] } }, "com.amazonaws.chime#GeoMatchParams": { "type": "structure", "members": { "Country": { "target": "com.amazonaws.chime#Country", "traits": { "smithy.api#documentation": "The country.
", "smithy.api#required": {} } }, "AreaCode": { "target": "com.amazonaws.chime#AreaCode", "traits": { "smithy.api#documentation": "The area code.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The country and area code for a proxy phone number in a proxy phone session.
" } }, "com.amazonaws.chime#GetAccount": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetAccountRequest" }, "output": { "target": "com.amazonaws.chime#GetAccountResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Retrieves details for the specified Amazon Chime account, such as account type and supported\n licenses.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AccountId}", "code": 200 } } }, "com.amazonaws.chime#GetAccountRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetAccountResponse": { "type": "structure", "members": { "Account": { "target": "com.amazonaws.chime#Account", "traits": { "smithy.api#documentation": "The Amazon Chime account details.
" } } } }, "com.amazonaws.chime#GetAccountSettings": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetAccountSettingsRequest" }, "output": { "target": "com.amazonaws.chime#GetAccountSettingsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Retrieves account settings for the specified Amazon Chime account ID, such as remote control\n and dialout settings. For more information about these settings, see Use the Policies\n Page in the Amazon Chime Administration Guide.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AccountId}/settings", "code": 200 } } }, "com.amazonaws.chime#GetAccountSettingsRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetAccountSettingsResponse": { "type": "structure", "members": { "AccountSettings": { "target": "com.amazonaws.chime#AccountSettings", "traits": { "smithy.api#documentation": "The Amazon Chime account settings.
" } } } }, "com.amazonaws.chime#GetAppInstanceRetentionSettings": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetAppInstanceRetentionSettingsRequest" }, "output": { "target": "com.amazonaws.chime#GetAppInstanceRetentionSettingsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Gets the retention settings for an AppInstance.
The ARN of the AppInstance.
The retention settings for the AppInstance.
The timestamp representing the time at which the specified items are retained, in Epoch Seconds.
" } } } }, "com.amazonaws.chime#GetAppInstanceStreamingConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetAppInstanceStreamingConfigurationsRequest" }, "output": { "target": "com.amazonaws.chime#GetAppInstanceStreamingConfigurationsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Gets the streaming settings for an AppInstance.
The ARN of the AppInstance.
The streaming settings.
" } } } }, "com.amazonaws.chime#GetAttendee": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetAttendeeRequest" }, "output": { "target": "com.amazonaws.chime#GetAttendeeResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "\nGets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see \nUsing the Amazon Chime SDK\nin the \nAmazon Chime Developer Guide\n.\n
", "smithy.api#http": { "method": "GET", "uri": "/meetings/{MeetingId}/attendees/{AttendeeId}", "code": 200 } } }, "com.amazonaws.chime#GetAttendeeRequest": { "type": "structure", "members": { "MeetingId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AttendeeId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK attendee ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetAttendeeResponse": { "type": "structure", "members": { "Attendee": { "target": "com.amazonaws.chime#Attendee", "traits": { "smithy.api#documentation": "The Amazon Chime SDK attendee information.
" } } } }, "com.amazonaws.chime#GetBot": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetBotRequest" }, "output": { "target": "com.amazonaws.chime#GetBotResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AccountId}/bots/{BotId}", "code": 200 } } }, "com.amazonaws.chime#GetBotRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BotId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The bot ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetBotResponse": { "type": "structure", "members": { "Bot": { "target": "com.amazonaws.chime#Bot", "traits": { "smithy.api#documentation": "The chat bot details.
" } } } }, "com.amazonaws.chime#GetChannelMessage": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetChannelMessageRequest" }, "output": { "target": "com.amazonaws.chime#GetChannelMessageResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Gets the full details of a channel message.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the \n value in the header.
The ARN of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MessageId": { "target": "com.amazonaws.chime#MessageId", "traits": { "smithy.api#documentation": "The ID of the message.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The details of and content in the message.
" } } } }, "com.amazonaws.chime#GetEventsConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetEventsConfigurationRequest" }, "output": { "target": "com.amazonaws.chime#GetEventsConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AccountId}/bots/{BotId}/events-configuration", "code": 200 } } }, "com.amazonaws.chime#GetEventsConfigurationRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BotId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The bot ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetEventsConfigurationResponse": { "type": "structure", "members": { "EventsConfiguration": { "target": "com.amazonaws.chime#EventsConfiguration", "traits": { "smithy.api#documentation": "The events configuration details.
" } } } }, "com.amazonaws.chime#GetGlobalSettings": { "type": "operation", "output": { "target": "com.amazonaws.chime#GetGlobalSettingsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business\n Calling and Amazon Chime Voice Connector settings.
", "smithy.api#http": { "method": "GET", "uri": "/settings", "code": 200 } } }, "com.amazonaws.chime#GetGlobalSettingsResponse": { "type": "structure", "members": { "BusinessCalling": { "target": "com.amazonaws.chime#BusinessCallingSettings", "traits": { "smithy.api#documentation": "The Amazon Chime Business Calling settings.
" } }, "VoiceConnector": { "target": "com.amazonaws.chime#VoiceConnectorSettings", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector settings.
" } } } }, "com.amazonaws.chime#GetMeeting": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetMeetingRequest" }, "output": { "target": "com.amazonaws.chime#GetMeetingResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "\nGets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see \nUsing the Amazon Chime SDK\nin the \nAmazon Chime Developer Guide\n.\n
", "smithy.api#http": { "method": "GET", "uri": "/meetings/{MeetingId}", "code": 200 } } }, "com.amazonaws.chime#GetMeetingRequest": { "type": "structure", "members": { "MeetingId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetMeetingResponse": { "type": "structure", "members": { "Meeting": { "target": "com.amazonaws.chime#Meeting", "traits": { "smithy.api#documentation": "The Amazon Chime SDK meeting information.
" } } } }, "com.amazonaws.chime#GetMessagingSessionEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetMessagingSessionEndpointRequest" }, "output": { "target": "com.amazonaws.chime#GetMessagingSessionEndpointResponse" }, "errors": [ { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "The details of the endpoint for the messaging session.
", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, "smithy.api#http": { "method": "GET", "uri": "/endpoints/messaging-session", "code": 200 } } }, "com.amazonaws.chime#GetMessagingSessionEndpointRequest": { "type": "structure", "members": {} }, "com.amazonaws.chime#GetMessagingSessionEndpointResponse": { "type": "structure", "members": { "Endpoint": { "target": "com.amazonaws.chime#MessagingSessionEndpoint", "traits": { "smithy.api#documentation": "The endpoint returned in the response.
" } } } }, "com.amazonaws.chime#GetPhoneNumber": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetPhoneNumberRequest" }, "output": { "target": "com.amazonaws.chime#GetPhoneNumberResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
", "smithy.api#http": { "method": "GET", "uri": "/phone-numbers/{PhoneNumberId}", "code": 200 } } }, "com.amazonaws.chime#GetPhoneNumberOrder": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetPhoneNumberOrderRequest" }, "output": { "target": "com.amazonaws.chime#GetPhoneNumberOrderResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Retrieves details for the specified phone number order, such as the order creation timestamp, phone\n numbers in E.164 format, product type, and order status.
", "smithy.api#http": { "method": "GET", "uri": "/phone-number-orders/{PhoneNumberOrderId}", "code": 200 } } }, "com.amazonaws.chime#GetPhoneNumberOrderRequest": { "type": "structure", "members": { "PhoneNumberOrderId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The ID for the phone number order.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetPhoneNumberOrderResponse": { "type": "structure", "members": { "PhoneNumberOrder": { "target": "com.amazonaws.chime#PhoneNumberOrder", "traits": { "smithy.api#documentation": "The phone number order details.
" } } } }, "com.amazonaws.chime#GetPhoneNumberRequest": { "type": "structure", "members": { "PhoneNumberId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The phone number ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetPhoneNumberResponse": { "type": "structure", "members": { "PhoneNumber": { "target": "com.amazonaws.chime#PhoneNumber", "traits": { "smithy.api#documentation": "The phone number details.
" } } } }, "com.amazonaws.chime#GetPhoneNumberSettings": { "type": "operation", "output": { "target": "com.amazonaws.chime#GetPhoneNumberSettingsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
", "smithy.api#http": { "method": "GET", "uri": "/settings/phone-number", "code": 200 } } }, "com.amazonaws.chime#GetPhoneNumberSettingsResponse": { "type": "structure", "members": { "CallingName": { "target": "com.amazonaws.chime#CallingName", "traits": { "smithy.api#documentation": "The default outbound calling name for the account.
" } }, "CallingNameUpdatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The updated outbound calling name timestamp, in ISO 8601 format.
" } } } }, "com.amazonaws.chime#GetProxySession": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetProxySessionRequest" }, "output": { "target": "com.amazonaws.chime#GetProxySessionResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Gets the specified proxy session details for the specified Amazon Chime Voice Connector.
", "smithy.api#http": { "method": "GET", "uri": "/voice-connectors/{VoiceConnectorId}/proxy-sessions/{ProxySessionId}", "code": 200 } } }, "com.amazonaws.chime#GetProxySessionRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString128", "traits": { "smithy.api#documentation": "The Amazon Chime voice connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ProxySessionId": { "target": "com.amazonaws.chime#NonEmptyString128", "traits": { "smithy.api#documentation": "The proxy session ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetProxySessionResponse": { "type": "structure", "members": { "ProxySession": { "target": "com.amazonaws.chime#ProxySession", "traits": { "smithy.api#documentation": "The proxy session details.
" } } } }, "com.amazonaws.chime#GetRetentionSettings": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetRetentionSettingsRequest" }, "output": { "target": "com.amazonaws.chime#GetRetentionSettingsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "\nGets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see \nManaging Chat Retention Policies\nin the \nAmazon Chime Administration Guide\n.\n
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AccountId}/retention-settings", "code": 200 } } }, "com.amazonaws.chime#GetRetentionSettingsRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetRetentionSettingsResponse": { "type": "structure", "members": { "RetentionSettings": { "target": "com.amazonaws.chime#RetentionSettings", "traits": { "smithy.api#documentation": "The retention settings.
" } }, "InitiateDeletionTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.
" } } } }, "com.amazonaws.chime#GetRoom": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetRoomRequest" }, "output": { "target": "com.amazonaws.chime#GetRoomResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AccountId}/rooms/{RoomId}", "code": 200 } } }, "com.amazonaws.chime#GetRoomRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RoomId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The room ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetRoomResponse": { "type": "structure", "members": { "Room": { "target": "com.amazonaws.chime#Room", "traits": { "smithy.api#documentation": "The room details.
" } } } }, "com.amazonaws.chime#GetSipMediaApplication": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetSipMediaApplicationRequest" }, "output": { "target": "com.amazonaws.chime#GetSipMediaApplicationResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
", "smithy.api#http": { "method": "GET", "uri": "/sip-media-applications/{SipMediaApplicationId}", "code": 200 } } }, "com.amazonaws.chime#GetSipMediaApplicationLoggingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetSipMediaApplicationLoggingConfigurationRequest" }, "output": { "target": "com.amazonaws.chime#GetSipMediaApplicationLoggingConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Returns the logging configuration for the specified SIP media application.
", "smithy.api#http": { "method": "GET", "uri": "/sip-media-applications/{SipMediaApplicationId}/logging-configuration", "code": 200 } } }, "com.amazonaws.chime#GetSipMediaApplicationLoggingConfigurationRequest": { "type": "structure", "members": { "SipMediaApplicationId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The SIP media application ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetSipMediaApplicationLoggingConfigurationResponse": { "type": "structure", "members": { "SipMediaApplicationLoggingConfiguration": { "target": "com.amazonaws.chime#SipMediaApplicationLoggingConfiguration", "traits": { "smithy.api#documentation": "The actual logging configuration.
" } } } }, "com.amazonaws.chime#GetSipMediaApplicationRequest": { "type": "structure", "members": { "SipMediaApplicationId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The SIP media application ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetSipMediaApplicationResponse": { "type": "structure", "members": { "SipMediaApplication": { "target": "com.amazonaws.chime#SipMediaApplication", "traits": { "smithy.api#documentation": "The SIP media application details.
" } } } }, "com.amazonaws.chime#GetSipRule": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetSipRuleRequest" }, "output": { "target": "com.amazonaws.chime#GetSipRuleResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
", "smithy.api#http": { "method": "GET", "uri": "/sip-rules/{SipRuleId}", "code": 200 } } }, "com.amazonaws.chime#GetSipRuleRequest": { "type": "structure", "members": { "SipRuleId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The SIP rule ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetSipRuleResponse": { "type": "structure", "members": { "SipRule": { "target": "com.amazonaws.chime#SipRule", "traits": { "smithy.api#documentation": "The SIP rule details.
" } } } }, "com.amazonaws.chime#GetUser": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetUserRequest" }, "output": { "target": "com.amazonaws.chime#GetUserResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.
\n\n\nTo retrieve user details with an email address instead of a user ID, use the \nListUsers\naction, and then filter by email address.\n
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AccountId}/users/{UserId}", "code": 200 } } }, "com.amazonaws.chime#GetUserRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The user ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetUserResponse": { "type": "structure", "members": { "User": { "target": "com.amazonaws.chime#User", "traits": { "smithy.api#documentation": "The user details.
" } } } }, "com.amazonaws.chime#GetUserSettings": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetUserSettingsRequest" }, "output": { "target": "com.amazonaws.chime#GetUserSettingsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Retrieves settings for the specified user ID, such as any associated phone number settings.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AccountId}/users/{UserId}/settings", "code": 200 } } }, "com.amazonaws.chime#GetUserSettingsRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The user ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetUserSettingsResponse": { "type": "structure", "members": { "UserSettings": { "target": "com.amazonaws.chime#UserSettings", "traits": { "smithy.api#documentation": "The user settings.
" } } } }, "com.amazonaws.chime#GetVoiceConnector": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetVoiceConnectorRequest" }, "output": { "target": "com.amazonaws.chime#GetVoiceConnectorResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
", "smithy.api#http": { "method": "GET", "uri": "/voice-connectors/{VoiceConnectorId}", "code": 200 } } }, "com.amazonaws.chime#GetVoiceConnectorEmergencyCallingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetVoiceConnectorEmergencyCallingConfigurationRequest" }, "output": { "target": "com.amazonaws.chime#GetVoiceConnectorEmergencyCallingConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.
", "smithy.api#http": { "method": "GET", "uri": "/voice-connectors/{VoiceConnectorId}/emergency-calling-configuration", "code": 200 } } }, "com.amazonaws.chime#GetVoiceConnectorEmergencyCallingConfigurationRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetVoiceConnectorEmergencyCallingConfigurationResponse": { "type": "structure", "members": { "EmergencyCallingConfiguration": { "target": "com.amazonaws.chime#EmergencyCallingConfiguration", "traits": { "smithy.api#documentation": "The emergency calling configuration details.
" } } } }, "com.amazonaws.chime#GetVoiceConnectorGroup": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetVoiceConnectorGroupRequest" }, "output": { "target": "com.amazonaws.chime#GetVoiceConnectorGroupResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "\nRetrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated \nVoiceConnectorItems\n.\n
The Amazon Chime Voice Connector group ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetVoiceConnectorGroupResponse": { "type": "structure", "members": { "VoiceConnectorGroup": { "target": "com.amazonaws.chime#VoiceConnectorGroup", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector group details.
" } } } }, "com.amazonaws.chime#GetVoiceConnectorLoggingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetVoiceConnectorLoggingConfigurationRequest" }, "output": { "target": "com.amazonaws.chime#GetVoiceConnectorLoggingConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#http": { "method": "GET", "uri": "/voice-connectors/{VoiceConnectorId}/logging-configuration", "code": 200 } } }, "com.amazonaws.chime#GetVoiceConnectorLoggingConfigurationRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetVoiceConnectorLoggingConfigurationResponse": { "type": "structure", "members": { "LoggingConfiguration": { "target": "com.amazonaws.chime#LoggingConfiguration", "traits": { "smithy.api#documentation": "The logging configuration details.
" } } } }, "com.amazonaws.chime#GetVoiceConnectorOrigination": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetVoiceConnectorOriginationRequest" }, "output": { "target": "com.amazonaws.chime#GetVoiceConnectorOriginationResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Retrieves origination setting details for the specified Amazon Chime Voice Connector.
", "smithy.api#http": { "method": "GET", "uri": "/voice-connectors/{VoiceConnectorId}/origination", "code": 200 } } }, "com.amazonaws.chime#GetVoiceConnectorOriginationRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetVoiceConnectorOriginationResponse": { "type": "structure", "members": { "Origination": { "target": "com.amazonaws.chime#Origination", "traits": { "smithy.api#documentation": "The origination setting details.
" } } } }, "com.amazonaws.chime#GetVoiceConnectorProxy": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetVoiceConnectorProxyRequest" }, "output": { "target": "com.amazonaws.chime#GetVoiceConnectorProxyResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Gets the proxy configuration details for the specified Amazon Chime Voice Connector.
", "smithy.api#http": { "method": "GET", "uri": "/voice-connectors/{VoiceConnectorId}/programmable-numbers/proxy", "code": 200 } } }, "com.amazonaws.chime#GetVoiceConnectorProxyRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString128", "traits": { "smithy.api#documentation": "The Amazon Chime voice connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetVoiceConnectorProxyResponse": { "type": "structure", "members": { "Proxy": { "target": "com.amazonaws.chime#Proxy", "traits": { "smithy.api#documentation": "The proxy configuration details.
" } } } }, "com.amazonaws.chime#GetVoiceConnectorRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetVoiceConnectorResponse": { "type": "structure", "members": { "VoiceConnector": { "target": "com.amazonaws.chime#VoiceConnector", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector details.
" } } } }, "com.amazonaws.chime#GetVoiceConnectorStreamingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetVoiceConnectorStreamingConfigurationRequest" }, "output": { "target": "com.amazonaws.chime#GetVoiceConnectorStreamingConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector.\n Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows\n the retention period, in hours, for the Amazon Kinesis data.
", "smithy.api#http": { "method": "GET", "uri": "/voice-connectors/{VoiceConnectorId}/streaming-configuration", "code": 200 } } }, "com.amazonaws.chime#GetVoiceConnectorStreamingConfigurationRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetVoiceConnectorStreamingConfigurationResponse": { "type": "structure", "members": { "StreamingConfiguration": { "target": "com.amazonaws.chime#StreamingConfiguration", "traits": { "smithy.api#documentation": "The streaming configuration details.
" } } } }, "com.amazonaws.chime#GetVoiceConnectorTermination": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetVoiceConnectorTerminationRequest" }, "output": { "target": "com.amazonaws.chime#GetVoiceConnectorTerminationResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Retrieves termination setting details for the specified Amazon Chime Voice Connector.
", "smithy.api#http": { "method": "GET", "uri": "/voice-connectors/{VoiceConnectorId}/termination", "code": 200 } } }, "com.amazonaws.chime#GetVoiceConnectorTerminationHealth": { "type": "operation", "input": { "target": "com.amazonaws.chime#GetVoiceConnectorTerminationHealthRequest" }, "output": { "target": "com.amazonaws.chime#GetVoiceConnectorTerminationHealthResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Retrieves information about the last time a SIP OPTIONS ping was received from\n your SIP infrastructure for the specified Amazon Chime Voice Connector.
The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetVoiceConnectorTerminationHealthResponse": { "type": "structure", "members": { "TerminationHealth": { "target": "com.amazonaws.chime#TerminationHealth", "traits": { "smithy.api#documentation": "The termination health details.
" } } } }, "com.amazonaws.chime#GetVoiceConnectorTerminationRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#GetVoiceConnectorTerminationResponse": { "type": "structure", "members": { "Termination": { "target": "com.amazonaws.chime#Termination", "traits": { "smithy.api#documentation": "The termination setting details.
" } } } }, "com.amazonaws.chime#GuidString": { "type": "string", "traits": { "smithy.api#pattern": "[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}" } }, "com.amazonaws.chime#Identity": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN in an Identity.
" } }, "Name": { "target": "com.amazonaws.chime#ResourceName", "traits": { "smithy.api#documentation": "The name in an Identity.
" } } }, "traits": { "smithy.api#documentation": "The details of a user.
" } }, "com.amazonaws.chime#Integer": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.chime#Invite": { "type": "structure", "members": { "InviteId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The invite ID.
" } }, "Status": { "target": "com.amazonaws.chime#InviteStatus", "traits": { "smithy.api#documentation": "The status of the invite.
" } }, "EmailAddress": { "target": "com.amazonaws.chime#EmailAddress", "traits": { "smithy.api#documentation": "The email address to which the invite is sent.
" } }, "EmailStatus": { "target": "com.amazonaws.chime#EmailStatus", "traits": { "smithy.api#documentation": "The status of the invite email.
" } } }, "traits": { "smithy.api#documentation": "Invitation object returned after emailing users to invite them to join the Amazon Chime\n Team account.
Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime\n Team account. Only Team account types are currently\n supported for this action.
The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserEmailList": { "target": "com.amazonaws.chime#UserEmailList", "traits": { "smithy.api#documentation": "The user email addresses to which to send the email invitation.
", "smithy.api#required": {} } }, "UserType": { "target": "com.amazonaws.chime#UserType", "traits": { "smithy.api#documentation": "The user type.
" } } } }, "com.amazonaws.chime#InviteUsersResponse": { "type": "structure", "members": { "Invites": { "target": "com.amazonaws.chime#InviteList", "traits": { "smithy.api#documentation": "The email invitation details.
" } } } }, "com.amazonaws.chime#Iso8601Timestamp": { "type": "timestamp", "traits": { "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.chime#JoinTokenString": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 2048 }, "smithy.api#pattern": "^[a-zA-Z0-9+/]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.chime#License": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Basic", "name": "Basic" }, { "value": "Plus", "name": "Plus" }, { "value": "Pro", "name": "Pro" }, { "value": "ProTrial", "name": "ProTrial" } ] } }, "com.amazonaws.chime#LicenseList": { "type": "list", "member": { "target": "com.amazonaws.chime#License" } }, "com.amazonaws.chime#ListAccounts": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListAccountsRequest" }, "output": { "target": "com.amazonaws.chime#ListAccountsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts\n by account name prefix. To find out which Amazon Chime account a user belongs to, you can\n filter by the user's email address, which returns one account result.
", "smithy.api#http": { "method": "GET", "uri": "/accounts", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.chime#ListAccountsRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.chime#AccountName", "traits": { "smithy.api#documentation": "Amazon Chime account name prefix with which to filter results.
", "smithy.api#httpQuery": "name" } }, "UserEmail": { "target": "com.amazonaws.chime#EmailAddress", "traits": { "smithy.api#documentation": "User email address with which to filter results.
", "smithy.api#httpQuery": "user-email" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
", "smithy.api#httpQuery": "next-token" } }, "MaxResults": { "target": "com.amazonaws.chime#ProfileServiceMaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call. Defaults to 100.
", "smithy.api#httpQuery": "max-results" } } } }, "com.amazonaws.chime#ListAccountsResponse": { "type": "structure", "members": { "Accounts": { "target": "com.amazonaws.chime#AccountList", "traits": { "smithy.api#documentation": "List of Amazon Chime accounts and account details.
" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
" } } } }, "com.amazonaws.chime#ListAppInstanceAdmins": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListAppInstanceAdminsRequest" }, "output": { "target": "com.amazonaws.chime#ListAppInstanceAdminsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Returns a list of the administrators in the AppInstance.
The ARN of the AppInstance.
The maximum number of administrators that you want to return.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { "smithy.api#documentation": "The token returned from previous API requests until the number of administrators is reached.
", "smithy.api#httpQuery": "next-token" } } } }, "com.amazonaws.chime#ListAppInstanceAdminsResponse": { "type": "structure", "members": { "AppInstanceArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the AppInstance.
The information for each administrator.
" } }, "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { "smithy.api#documentation": "The token returned from previous API requests until the number of administrators is reached.
" } } } }, "com.amazonaws.chime#ListAppInstanceUsers": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListAppInstanceUsersRequest" }, "output": { "target": "com.amazonaws.chime#ListAppInstanceUsersResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "\nList all \nAppInstanceUsers\ncreated under a single AppInstance.\n
The ARN of the AppInstance.
The maximum number of requests that you want returned.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { "smithy.api#documentation": "The token passed by previous API calls until all requested users are returned.
", "smithy.api#httpQuery": "next-token" } } } }, "com.amazonaws.chime#ListAppInstanceUsersResponse": { "type": "structure", "members": { "AppInstanceArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the AppInstance.
The information for each requested AppInstanceUser.
The token passed by previous API calls until all requested users are returned.
" } } } }, "com.amazonaws.chime#ListAppInstances": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListAppInstancesRequest" }, "output": { "target": "com.amazonaws.chime#ListAppInstancesResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists all Amazon Chime AppInstances created under a single AWS account.
The maximum number of AppInstances that you want to return.
The token passed by previous API requests until you reach the maximum number of AppInstances.
The information for each AppInstance.
The token passed by previous API requests until the maximum number of AppInstances is reached.
Lists the tags applied to an Amazon Chime SDK attendee resource.
", "smithy.api#http": { "method": "GET", "uri": "/meetings/{MeetingId}/attendees/{AttendeeId}/tags", "code": 200 } } }, "com.amazonaws.chime#ListAttendeeTagsRequest": { "type": "structure", "members": { "MeetingId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AttendeeId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK attendee ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#ListAttendeeTagsResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.chime#TagList", "traits": { "smithy.api#documentation": "A list of tag key-value pairs.
" } } } }, "com.amazonaws.chime#ListAttendees": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListAttendeesRequest" }, "output": { "target": "com.amazonaws.chime#ListAttendeesResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "\nLists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see \nUsing the Amazon Chime SDK\nin the \nAmazon Chime Developer Guide\n.\n
", "smithy.api#http": { "method": "GET", "uri": "/meetings/{MeetingId}/attendees", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.chime#ListAttendeesRequest": { "type": "structure", "members": { "MeetingId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
", "smithy.api#httpQuery": "next-token" } }, "MaxResults": { "target": "com.amazonaws.chime#ResultMax", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call.
", "smithy.api#httpQuery": "max-results" } } } }, "com.amazonaws.chime#ListAttendeesResponse": { "type": "structure", "members": { "Attendees": { "target": "com.amazonaws.chime#AttendeeList", "traits": { "smithy.api#documentation": "The Amazon Chime SDK attendee information.
" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
" } } } }, "com.amazonaws.chime#ListBots": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListBotsRequest" }, "output": { "target": "com.amazonaws.chime#ListBotsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AccountId}/bots", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.chime#ListBotsRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.chime#ResultMax", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call. The default is 10.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
", "smithy.api#httpQuery": "next-token" } } } }, "com.amazonaws.chime#ListBotsResponse": { "type": "structure", "members": { "Bots": { "target": "com.amazonaws.chime#BotList", "traits": { "smithy.api#documentation": "List of bots and bot details.
" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
" } } } }, "com.amazonaws.chime#ListChannelBans": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListChannelBansRequest" }, "output": { "target": "com.amazonaws.chime#ListChannelBansResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists all the users banned from a particular channel.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
The ARN of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.chime#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of bans that you want returned.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { "smithy.api#documentation": "The token passed by previous API calls until all requested bans are returned.
", "smithy.api#httpQuery": "next-token" } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
" } }, "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { "smithy.api#documentation": "The token passed by previous API calls until all requested bans are returned.
" } }, "ChannelBans": { "target": "com.amazonaws.chime#ChannelBanSummaryList", "traits": { "smithy.api#documentation": "The information for each requested ban.
" } } } }, "com.amazonaws.chime#ListChannelMemberships": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListChannelMembershipsRequest" }, "output": { "target": "com.amazonaws.chime#ListChannelMembershipsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists all channel memberships in a channel.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
Lists all channels that a particular AppInstanceUser is a part of. Only an\n AppInstanceAdmin can call the API with a user ARN that is not their\n own.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
The ARN of the AppInstanceUsers
The maximum number of users that you want returned.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { "smithy.api#documentation": "The token returned from previous API requests until the number of channel memberships is reached.
", "smithy.api#httpQuery": "next-token" } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The token passed by previous API calls until all requested users are returned.
" } }, "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { "smithy.api#documentation": "The token passed by previous API calls until all requested users are returned.
" } } } }, "com.amazonaws.chime#ListChannelMembershipsRequest": { "type": "structure", "members": { "ChannelArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The maximum number of channel memberships that you want returned.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.chime#ChannelMembershipType", "traits": { "smithy.api#documentation": "The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of \n ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals \n HIDDEN. Otherwise hidden members are not returned.
The maximum number of channel memberships that you want returned.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { "smithy.api#documentation": "The token passed by previous API calls until all requested channel memberships are returned.
", "smithy.api#httpQuery": "next-token" } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
" } }, "ChannelMemberships": { "target": "com.amazonaws.chime#ChannelMembershipSummaryList", "traits": { "smithy.api#documentation": "The information for the requested channel memberships.
" } }, "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { "smithy.api#documentation": "The token passed by previous API calls until all requested channel memberships are returned.
" } } } }, "com.amazonaws.chime#ListChannelMessages": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListChannelMessagesRequest" }, "output": { "target": "com.amazonaws.chime#ListChannelMessagesResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "List all the messages in a channel. Returns a paginated list of ChannelMessages.\n By default, sorted by creation timestamp in descending\n order.
Redacted messages appear in the results as empty, since they are only redacted, not deleted.\n Deleted messages do not appear in the results. This action always returns the latest\n version of an edited message.
\nAlso, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the \n value in the header.
The ARN of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SortOrder": { "target": "com.amazonaws.chime#SortOrder", "traits": { "smithy.api#documentation": "The order in which you want messages sorted. Default is Descending, based on time created.
", "smithy.api#httpQuery": "sort-order" } }, "NotBefore": { "target": "com.amazonaws.chime#Timestamp", "traits": { "smithy.api#documentation": "The initial or starting time stamp for your requested messages.
", "smithy.api#httpQuery": "not-before" } }, "NotAfter": { "target": "com.amazonaws.chime#Timestamp", "traits": { "smithy.api#documentation": "The final or ending time stamp for your requested messages.
", "smithy.api#httpQuery": "not-after" } }, "MaxResults": { "target": "com.amazonaws.chime#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of messages that you want returned.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { "smithy.api#documentation": "The token passed by previous API calls until all requested messages are returned.
", "smithy.api#httpQuery": "next-token" } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel containing the requested messages.
" } }, "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { "smithy.api#documentation": "The token passed by previous API calls until all requested messages are returned.
" } }, "ChannelMessages": { "target": "com.amazonaws.chime#ChannelMessageSummaryList", "traits": { "smithy.api#documentation": "The information about, and content of, each requested message.
" } } } }, "com.amazonaws.chime#ListChannelModerators": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListChannelModeratorsRequest" }, "output": { "target": "com.amazonaws.chime#ListChannelModeratorsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists all the moderators for a channel.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
The ARN of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.chime#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of moderators that you want returned.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { "smithy.api#documentation": "The token passed by previous API calls until all requested moderators are returned.
", "smithy.api#httpQuery": "next-token" } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
" } }, "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { "smithy.api#documentation": "The token passed by previous API calls until all requested moderators are returned.
" } }, "ChannelModerators": { "target": "com.amazonaws.chime#ChannelModeratorSummaryList", "traits": { "smithy.api#documentation": "The information about and names of each moderator.
" } } } }, "com.amazonaws.chime#ListChannels": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListChannelsRequest" }, "output": { "target": "com.amazonaws.chime#ListChannelsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
\n\n\n Functionality & restrictions\n
\nUse privacy = PUBLIC to retrieve all public channels in the account.
Only an AppInstanceAdmin can set privacy = PRIVATE to list the\n private channels in an account.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
A list of the channels moderated by an AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
The ARN of the user in the moderated channel.
", "smithy.api#httpQuery": "app-instance-user-arn" } }, "MaxResults": { "target": "com.amazonaws.chime#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of channels in the request.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { "smithy.api#documentation": "The token returned from previous API requests until the number of channels moderated by the user is reached.
", "smithy.api#httpQuery": "next-token" } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The moderated channels in the request.
" } }, "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { "smithy.api#documentation": "The token returned from previous API requests until the number of channels moderated by the user is reached.
" } } } }, "com.amazonaws.chime#ListChannelsRequest": { "type": "structure", "members": { "AppInstanceArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the AppInstance.
The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an \n AppInstanceAdmin can retrieve private channels.\n
The maximum number of channels that you want to return.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { "smithy.api#documentation": "The token passed by previous API calls until all requested channels are returned.
", "smithy.api#httpQuery": "next-token" } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The information about each channel.
" } }, "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { "smithy.api#documentation": "The token returned from previous API requests until the number of channels is reached.
" } } } }, "com.amazonaws.chime#ListMeetingTags": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListMeetingTagsRequest" }, "output": { "target": "com.amazonaws.chime#ListMeetingTagsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists the tags applied to an Amazon Chime SDK meeting resource.
", "smithy.api#http": { "method": "GET", "uri": "/meetings/{MeetingId}/tags", "code": 200 } } }, "com.amazonaws.chime#ListMeetingTagsRequest": { "type": "structure", "members": { "MeetingId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#ListMeetingTagsResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.chime#TagList", "traits": { "smithy.api#documentation": "A list of tag key-value pairs.
" } } } }, "com.amazonaws.chime#ListMeetings": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListMeetingsRequest" }, "output": { "target": "com.amazonaws.chime#ListMeetingsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "\nLists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see \nUsing the Amazon Chime SDK\nin the \nAmazon Chime Developer Guide\n.\n
", "smithy.api#http": { "method": "GET", "uri": "/meetings", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.chime#ListMeetingsRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
", "smithy.api#httpQuery": "next-token" } }, "MaxResults": { "target": "com.amazonaws.chime#ResultMax", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call.
", "smithy.api#httpQuery": "max-results" } } } }, "com.amazonaws.chime#ListMeetingsResponse": { "type": "structure", "members": { "Meetings": { "target": "com.amazonaws.chime#MeetingList", "traits": { "smithy.api#documentation": "The Amazon Chime SDK meeting information.
" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
" } } } }, "com.amazonaws.chime#ListPhoneNumberOrders": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListPhoneNumberOrdersRequest" }, "output": { "target": "com.amazonaws.chime#ListPhoneNumberOrdersResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists the phone number orders for the administrator's Amazon Chime account.
", "smithy.api#http": { "method": "GET", "uri": "/phone-number-orders", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.chime#ListPhoneNumberOrdersRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
", "smithy.api#httpQuery": "next-token" } }, "MaxResults": { "target": "com.amazonaws.chime#ResultMax", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call.
", "smithy.api#httpQuery": "max-results" } } } }, "com.amazonaws.chime#ListPhoneNumberOrdersResponse": { "type": "structure", "members": { "PhoneNumberOrders": { "target": "com.amazonaws.chime#PhoneNumberOrderList", "traits": { "smithy.api#documentation": "The phone number order details.
" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
" } } } }, "com.amazonaws.chime#ListPhoneNumbers": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListPhoneNumbersRequest" }, "output": { "target": "com.amazonaws.chime#ListPhoneNumbersResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
", "smithy.api#http": { "method": "GET", "uri": "/phone-numbers", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.chime#ListPhoneNumbersRequest": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.chime#PhoneNumberStatus", "traits": { "smithy.api#documentation": "The phone number status.
", "smithy.api#httpQuery": "status" } }, "ProductType": { "target": "com.amazonaws.chime#PhoneNumberProductType", "traits": { "smithy.api#documentation": "The phone number product type.
", "smithy.api#httpQuery": "product-type" } }, "FilterName": { "target": "com.amazonaws.chime#PhoneNumberAssociationName", "traits": { "smithy.api#documentation": "The filter to use to limit the number of results.
", "smithy.api#httpQuery": "filter-name" } }, "FilterValue": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The value to use for the filter.
", "smithy.api#httpQuery": "filter-value" } }, "MaxResults": { "target": "com.amazonaws.chime#ResultMax", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
", "smithy.api#httpQuery": "next-token" } } } }, "com.amazonaws.chime#ListPhoneNumbersResponse": { "type": "structure", "members": { "PhoneNumbers": { "target": "com.amazonaws.chime#PhoneNumberList", "traits": { "smithy.api#documentation": "The phone number details.
" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
" } } } }, "com.amazonaws.chime#ListProxySessions": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListProxySessionsRequest" }, "output": { "target": "com.amazonaws.chime#ListProxySessionsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists the proxy sessions for the specified Amazon Chime Voice Connector.
", "smithy.api#http": { "method": "GET", "uri": "/voice-connectors/{VoiceConnectorId}/proxy-sessions", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.chime#ListProxySessionsRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString128", "traits": { "smithy.api#documentation": "The Amazon Chime voice connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.chime#ProxySessionStatus", "traits": { "smithy.api#documentation": "The proxy session status.
", "smithy.api#httpQuery": "status" } }, "NextToken": { "target": "com.amazonaws.chime#NextTokenString", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
", "smithy.api#httpQuery": "next-token" } }, "MaxResults": { "target": "com.amazonaws.chime#ResultMax", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call.
", "smithy.api#httpQuery": "max-results" } } } }, "com.amazonaws.chime#ListProxySessionsResponse": { "type": "structure", "members": { "ProxySessions": { "target": "com.amazonaws.chime#ProxySessions", "traits": { "smithy.api#documentation": "The proxy session details.
" } }, "NextToken": { "target": "com.amazonaws.chime#NextTokenString", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
" } } } }, "com.amazonaws.chime#ListRoomMemberships": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListRoomMembershipsRequest" }, "output": { "target": "com.amazonaws.chime#ListRoomMembershipsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists the membership details for the specified room in an Amazon Chime Enterprise account,\n such as the members' IDs, email addresses, and names.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AccountId}/rooms/{RoomId}/memberships", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.chime#ListRoomMembershipsRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RoomId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The room ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.chime#ResultMax", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
", "smithy.api#httpQuery": "next-token" } } } }, "com.amazonaws.chime#ListRoomMembershipsResponse": { "type": "structure", "members": { "RoomMemberships": { "target": "com.amazonaws.chime#RoomMembershipList", "traits": { "smithy.api#documentation": "The room membership details.
" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
" } } } }, "com.amazonaws.chime#ListRooms": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListRoomsRequest" }, "output": { "target": "com.amazonaws.chime#ListRoomsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AccountId}/rooms", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.chime#ListRoomsRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MemberId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The member ID (user ID or bot ID).
", "smithy.api#httpQuery": "member-id" } }, "MaxResults": { "target": "com.amazonaws.chime#ResultMax", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
", "smithy.api#httpQuery": "next-token" } } } }, "com.amazonaws.chime#ListRoomsResponse": { "type": "structure", "members": { "Rooms": { "target": "com.amazonaws.chime#RoomList", "traits": { "smithy.api#documentation": "The room details.
" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
" } } } }, "com.amazonaws.chime#ListSipMediaApplications": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListSipMediaApplicationsRequest" }, "output": { "target": "com.amazonaws.chime#ListSipMediaApplicationsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists the SIP media applications under the administrator's AWS account.
", "smithy.api#http": { "method": "GET", "uri": "/sip-media-applications", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.chime#ListSipMediaApplicationsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.chime#ResultMax", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call. Defaults to 100.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chime#NextTokenString", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
", "smithy.api#httpQuery": "next-token" } } } }, "com.amazonaws.chime#ListSipMediaApplicationsResponse": { "type": "structure", "members": { "SipMediaApplications": { "target": "com.amazonaws.chime#SipMediaApplicationList", "traits": { "smithy.api#documentation": "List of SIP media applications and application details.
" } }, "NextToken": { "target": "com.amazonaws.chime#NextTokenString", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
" } } } }, "com.amazonaws.chime#ListSipRules": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListSipRulesRequest" }, "output": { "target": "com.amazonaws.chime#ListSipRulesResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists the SIP rules under the administrator's AWS account.
", "smithy.api#http": { "method": "GET", "uri": "/sip-rules", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.chime#ListSipRulesRequest": { "type": "structure", "members": { "SipMediaApplicationId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The SIP media application ID.
", "smithy.api#httpQuery": "sip-media-application" } }, "MaxResults": { "target": "com.amazonaws.chime#ResultMax", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call. Defaults to 100.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chime#NextTokenString", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
", "smithy.api#httpQuery": "next-token" } } } }, "com.amazonaws.chime#ListSipRulesResponse": { "type": "structure", "members": { "SipRules": { "target": "com.amazonaws.chime#SipRuleList", "traits": { "smithy.api#documentation": "List of SIP rules and rule details.
" } }, "NextToken": { "target": "com.amazonaws.chime#NextTokenString", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
" } } } }, "com.amazonaws.chime#ListSupportedPhoneNumberCountries": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListSupportedPhoneNumberCountriesRequest" }, "output": { "target": "com.amazonaws.chime#ListSupportedPhoneNumberCountriesResponse" }, "errors": [ { "target": "com.amazonaws.chime#AccessDeniedException" }, { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists supported phone number countries.
", "smithy.api#http": { "method": "GET", "uri": "/phone-number-countries", "code": 200 } } }, "com.amazonaws.chime#ListSupportedPhoneNumberCountriesRequest": { "type": "structure", "members": { "ProductType": { "target": "com.amazonaws.chime#PhoneNumberProductType", "traits": { "smithy.api#documentation": "The phone number product type.
", "smithy.api#httpQuery": "product-type", "smithy.api#required": {} } } } }, "com.amazonaws.chime#ListSupportedPhoneNumberCountriesResponse": { "type": "structure", "members": { "PhoneNumberCountries": { "target": "com.amazonaws.chime#PhoneNumberCountriesList", "traits": { "smithy.api#documentation": "The supported phone number countries.
" } } } }, "com.amazonaws.chime#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.chime#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists the tags applied to an Amazon Chime SDK meeting resource.
", "smithy.api#http": { "method": "GET", "uri": "/tags", "code": 200 } } }, "com.amazonaws.chime#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.chime#Arn", "traits": { "smithy.api#documentation": "The resource ARN.
", "smithy.api#httpQuery": "arn", "smithy.api#required": {} } } } }, "com.amazonaws.chime#ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.chime#TagList", "traits": { "smithy.api#documentation": "A list of tag-key value pairs.
" } } } }, "com.amazonaws.chime#ListUsers": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListUsersRequest" }, "output": { "target": "com.amazonaws.chime#ListUsersResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists the users that belong to the specified Amazon Chime account. You can specify an email\n address to list only the user that the email address belongs to.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AccountId}/users", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.chime#ListUsersRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserEmail": { "target": "com.amazonaws.chime#EmailAddress", "traits": { "smithy.api#documentation": "Optional. The user email address used to filter results. Maximum 1.
", "smithy.api#httpQuery": "user-email" } }, "UserType": { "target": "com.amazonaws.chime#UserType", "traits": { "smithy.api#documentation": "The user type.
", "smithy.api#httpQuery": "user-type" } }, "MaxResults": { "target": "com.amazonaws.chime#ProfileServiceMaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call. Defaults to 100.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
", "smithy.api#httpQuery": "next-token" } } } }, "com.amazonaws.chime#ListUsersResponse": { "type": "structure", "members": { "Users": { "target": "com.amazonaws.chime#UserList", "traits": { "smithy.api#documentation": "List of users and user details.
" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
" } } } }, "com.amazonaws.chime#ListVoiceConnectorGroups": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListVoiceConnectorGroupsRequest" }, "output": { "target": "com.amazonaws.chime#ListVoiceConnectorGroupsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.
", "smithy.api#http": { "method": "GET", "uri": "/voice-connector-groups", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.chime#ListVoiceConnectorGroupsRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
", "smithy.api#httpQuery": "next-token" } }, "MaxResults": { "target": "com.amazonaws.chime#ResultMax", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call.
", "smithy.api#httpQuery": "max-results" } } } }, "com.amazonaws.chime#ListVoiceConnectorGroupsResponse": { "type": "structure", "members": { "VoiceConnectorGroups": { "target": "com.amazonaws.chime#VoiceConnectorGroupList", "traits": { "smithy.api#documentation": "The details of the Amazon Chime Voice Connector groups.
" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
" } } } }, "com.amazonaws.chime#ListVoiceConnectorTerminationCredentials": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListVoiceConnectorTerminationCredentialsRequest" }, "output": { "target": "com.amazonaws.chime#ListVoiceConnectorTerminationCredentialsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists the SIP credentials for the specified Amazon Chime Voice Connector.
", "smithy.api#http": { "method": "GET", "uri": "/voice-connectors/{VoiceConnectorId}/termination/credentials", "code": 200 } } }, "com.amazonaws.chime#ListVoiceConnectorTerminationCredentialsRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#ListVoiceConnectorTerminationCredentialsResponse": { "type": "structure", "members": { "Usernames": { "target": "com.amazonaws.chime#SensitiveStringList", "traits": { "smithy.api#documentation": "A list of user names.
" } } } }, "com.amazonaws.chime#ListVoiceConnectors": { "type": "operation", "input": { "target": "com.amazonaws.chime#ListVoiceConnectorsRequest" }, "output": { "target": "com.amazonaws.chime#ListVoiceConnectorsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
", "smithy.api#http": { "method": "GET", "uri": "/voice-connectors", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.chime#ListVoiceConnectorsRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
", "smithy.api#httpQuery": "next-token" } }, "MaxResults": { "target": "com.amazonaws.chime#ResultMax", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call.
", "smithy.api#httpQuery": "max-results" } } } }, "com.amazonaws.chime#ListVoiceConnectorsResponse": { "type": "structure", "members": { "VoiceConnectors": { "target": "com.amazonaws.chime#VoiceConnectorList", "traits": { "smithy.api#documentation": "The details of the Amazon Chime Voice Connectors.
" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results.
" } } } }, "com.amazonaws.chime#LoggingConfiguration": { "type": "structure", "members": { "EnableSIPLogs": { "target": "com.amazonaws.chime#Boolean", "traits": { "smithy.api#documentation": "When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
" } } }, "traits": { "smithy.api#documentation": "The logging configuration associated with an Amazon Chime Voice Connector. Specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
" } }, "com.amazonaws.chime#LogoutUser": { "type": "operation", "input": { "target": "com.amazonaws.chime#LogoutUserRequest" }, "output": { "target": "com.amazonaws.chime#LogoutUserResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Logs out the specified user from all of the devices they are currently logged into.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/users/{UserId}?operation=logout", "code": 204 } } }, "com.amazonaws.chime#LogoutUserRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The user ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#LogoutUserResponse": { "type": "structure", "members": {} }, "com.amazonaws.chime#MaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.chime#MediaPlacement": { "type": "structure", "members": { "AudioHostUrl": { "target": "com.amazonaws.chime#UriType", "traits": { "smithy.api#documentation": "The audio host URL.
" } }, "AudioFallbackUrl": { "target": "com.amazonaws.chime#UriType", "traits": { "smithy.api#documentation": "The audio fallback URL.
" } }, "ScreenDataUrl": { "target": "com.amazonaws.chime#UriType", "traits": { "smithy.api#documentation": "The screen data URL.
" } }, "ScreenSharingUrl": { "target": "com.amazonaws.chime#UriType", "traits": { "smithy.api#documentation": "The screen sharing URL.
" } }, "ScreenViewingUrl": { "target": "com.amazonaws.chime#UriType", "traits": { "smithy.api#documentation": "The screen viewing URL.
" } }, "SignalingUrl": { "target": "com.amazonaws.chime#UriType", "traits": { "smithy.api#documentation": "The signaling URL.
" } }, "TurnControlUrl": { "target": "com.amazonaws.chime#UriType", "traits": { "smithy.api#documentation": "The turn control URL.
" } } }, "traits": { "smithy.api#documentation": "A set of endpoints used by clients to connect to the media service group for a Amazon Chime SDK meeting.
" } }, "com.amazonaws.chime#Meeting": { "type": "structure", "members": { "MeetingId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
" } }, "ExternalMeetingId": { "target": "com.amazonaws.chime#ExternalMeetingIdType", "traits": { "smithy.api#documentation": "The external meeting ID.
" } }, "MediaPlacement": { "target": "com.amazonaws.chime#MediaPlacement", "traits": { "smithy.api#documentation": "The media placement for the meeting.
" } }, "MediaRegion": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The Region in which you create the meeting. Available values: af-south-1, ap-northeast-1, \n ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, \n eu-central-1, eu-north-1, eu-south-1,\n eu-west-1, eu-west-2, eu-west-3,\n sa-east-1, us-east-1, us-east-2,\n us-west-1, us-west-2.
A meeting created using the Amazon Chime SDK.
" } }, "com.amazonaws.chime#MeetingList": { "type": "list", "member": { "target": "com.amazonaws.chime#Meeting" } }, "com.amazonaws.chime#MeetingNotificationConfiguration": { "type": "structure", "members": { "SnsTopicArn": { "target": "com.amazonaws.chime#Arn", "traits": { "smithy.api#documentation": "The SNS topic ARN.
" } }, "SqsQueueArn": { "target": "com.amazonaws.chime#Arn", "traits": { "smithy.api#documentation": "The SQS queue ARN.
" } } }, "traits": { "smithy.api#documentation": " The resource target configurations for receiving Amazon Chime SDK meeting and attendee event\n notifications. The Amazon Chime SDK supports resource targets located in the US East (N.\n Virginia) AWS Region (us-east-1).
The member ID (user ID or bot ID).
" } }, "MemberType": { "target": "com.amazonaws.chime#MemberType", "traits": { "smithy.api#documentation": "The member type.
" } }, "Email": { "target": "com.amazonaws.chime#SensitiveString", "traits": { "smithy.api#documentation": "The member email address.
" } }, "FullName": { "target": "com.amazonaws.chime#SensitiveString", "traits": { "smithy.api#documentation": "The member name.
" } }, "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
" } } }, "traits": { "smithy.api#documentation": "The member details, such as email address, name, member ID, and member type.
" } }, "com.amazonaws.chime#MemberArns": { "type": "list", "member": { "target": "com.amazonaws.chime#ChimeArn" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.chime#MemberError": { "type": "structure", "members": { "MemberId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The member ID.
" } }, "ErrorCode": { "target": "com.amazonaws.chime#ErrorCode", "traits": { "smithy.api#documentation": "The error code.
" } }, "ErrorMessage": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The error message.
" } } }, "traits": { "smithy.api#documentation": "The list of errors returned when a member action results in an error.
" } }, "com.amazonaws.chime#MemberErrorList": { "type": "list", "member": { "target": "com.amazonaws.chime#MemberError" } }, "com.amazonaws.chime#MemberType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "User", "name": "User" }, { "value": "Bot", "name": "Bot" }, { "value": "Webhook", "name": "Webhook" } ] } }, "com.amazonaws.chime#Members": { "type": "list", "member": { "target": "com.amazonaws.chime#Identity" } }, "com.amazonaws.chime#MembershipItem": { "type": "structure", "members": { "MemberId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The member ID.
" } }, "Role": { "target": "com.amazonaws.chime#RoomMembershipRole", "traits": { "smithy.api#documentation": "The member role.
" } } }, "traits": { "smithy.api#documentation": "Membership details, such as member ID and member role.
" } }, "com.amazonaws.chime#MembershipItemList": { "type": "list", "member": { "target": "com.amazonaws.chime#MembershipItem" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.chime#MessageId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[-_a-zA-Z0-9]*" } }, "com.amazonaws.chime#MessagingSessionEndpoint": { "type": "structure", "members": { "Url": { "target": "com.amazonaws.chime#UrlType", "traits": { "smithy.api#documentation": "The endpoint to which you establish a websocket connection.
" } } }, "traits": { "smithy.api#documentation": "The websocket endpoint used to connect to Amazon Chime SDK messaging.
" } }, "com.amazonaws.chime#Metadata": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": ".*", "smithy.api#sensitive": {} } }, "com.amazonaws.chime#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 }, "smithy.api#pattern": ".*", "smithy.api#sensitive": {} } }, "com.amazonaws.chime#NextTokenString": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 65535 } } }, "com.amazonaws.chime#NonEmptyContent": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#pattern": "[\\s\\S]*", "smithy.api#sensitive": {} } }, "com.amazonaws.chime#NonEmptyResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*", "smithy.api#sensitive": {} } }, "com.amazonaws.chime#NonEmptyString": { "type": "string", "traits": { "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.chime#NonEmptyString128": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.chime#NonEmptyStringList": { "type": "list", "member": { "target": "com.amazonaws.chime#String" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.chime#NonNullableBoolean": { "type": "boolean" }, "com.amazonaws.chime#NotFoundException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.chime#ErrorCode" }, "Message": { "target": "com.amazonaws.chime#String" } }, "traits": { "smithy.api#documentation": "One or more of the resources in the request does not exist in the system.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.chime#NotificationTarget": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "EventBridge", "name": "EventBridge" }, { "value": "SNS", "name": "SNS" }, { "value": "SQS", "name": "SQS" } ] } }, "com.amazonaws.chime#NullableBoolean": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.chime#NumberSelectionBehavior": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "PreferSticky", "name": "PreferSticky" }, { "value": "AvoidSticky", "name": "AvoidSticky" } ] } }, "com.amazonaws.chime#OrderedPhoneNumber": { "type": "structure", "members": { "E164PhoneNumber": { "target": "com.amazonaws.chime#E164PhoneNumber", "traits": { "smithy.api#documentation": "The phone number, in E.164 format.
" } }, "Status": { "target": "com.amazonaws.chime#OrderedPhoneNumberStatus", "traits": { "smithy.api#documentation": "The phone number status.
" } } }, "traits": { "smithy.api#documentation": "A phone number for which an order has been placed.
" } }, "com.amazonaws.chime#OrderedPhoneNumberList": { "type": "list", "member": { "target": "com.amazonaws.chime#OrderedPhoneNumber" } }, "com.amazonaws.chime#OrderedPhoneNumberStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Processing", "name": "Processing" }, { "value": "Acquired", "name": "Acquired" }, { "value": "Failed", "name": "Failed" } ] } }, "com.amazonaws.chime#Origination": { "type": "structure", "members": { "Routes": { "target": "com.amazonaws.chime#OriginationRouteList", "traits": { "smithy.api#documentation": "The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1.\n Maximum value of 20.
" } }, "Disabled": { "target": "com.amazonaws.chime#Boolean", "traits": { "smithy.api#documentation": "When origination settings are disabled, inbound calls are not enabled for your Amazon Chime\n Voice Connector.
" } } }, "traits": { "smithy.api#documentation": "Origination settings enable your SIP hosts to receive inbound calls using your Amazon Chime\n Voice Connector.
" } }, "com.amazonaws.chime#OriginationRoute": { "type": "structure", "members": { "Host": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The FQDN or IP address to contact for origination traffic.
" } }, "Port": { "target": "com.amazonaws.chime#Port", "traits": { "smithy.api#documentation": "The designated origination route port. Defaults to 5060.
" } }, "Protocol": { "target": "com.amazonaws.chime#OriginationRouteProtocol", "traits": { "smithy.api#documentation": "The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.
" } }, "Priority": { "target": "com.amazonaws.chime#OriginationRoutePriority", "traits": { "smithy.api#documentation": "The priority associated with the host, with 1 being the highest priority. Higher priority\n hosts are attempted first.
" } }, "Weight": { "target": "com.amazonaws.chime#OriginationRouteWeight", "traits": { "smithy.api#documentation": "The weight associated with the host. If hosts are equal in priority, calls are redistributed among\n them based on their relative weight.
" } } }, "traits": { "smithy.api#documentation": "Origination routes define call distribution properties for your SIP hosts to receive inbound\n calls using your Amazon Chime Voice Connector. Limit: Ten origination routes for each\n Amazon Chime Voice Connector.
" } }, "com.amazonaws.chime#OriginationRouteList": { "type": "list", "member": { "target": "com.amazonaws.chime#OriginationRoute" } }, "com.amazonaws.chime#OriginationRoutePriority": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.chime#OriginationRouteProtocol": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "TCP", "name": "TCP" }, { "value": "UDP", "name": "UDP" } ] } }, "com.amazonaws.chime#OriginationRouteWeight": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.chime#Participant": { "type": "structure", "members": { "PhoneNumber": { "target": "com.amazonaws.chime#E164PhoneNumber", "traits": { "smithy.api#documentation": "The participant's phone number.
" } }, "ProxyPhoneNumber": { "target": "com.amazonaws.chime#E164PhoneNumber", "traits": { "smithy.api#documentation": "The participant's proxy phone number.
" } } }, "traits": { "smithy.api#documentation": "The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.
" } }, "com.amazonaws.chime#ParticipantPhoneNumberList": { "type": "list", "member": { "target": "com.amazonaws.chime#E164PhoneNumber" }, "traits": { "smithy.api#length": { "min": 2, "max": 2 } } }, "com.amazonaws.chime#Participants": { "type": "list", "member": { "target": "com.amazonaws.chime#Participant" } }, "com.amazonaws.chime#PhoneNumber": { "type": "structure", "members": { "PhoneNumberId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The phone number ID.
" } }, "E164PhoneNumber": { "target": "com.amazonaws.chime#E164PhoneNumber", "traits": { "smithy.api#documentation": "The phone number, in E.164 format.
" } }, "Country": { "target": "com.amazonaws.chime#Alpha2CountryCode", "traits": { "smithy.api#documentation": "The phone number country. Format: ISO 3166-1 alpha-2.
" } }, "Type": { "target": "com.amazonaws.chime#PhoneNumberType", "traits": { "smithy.api#documentation": "The phone number type.
" } }, "ProductType": { "target": "com.amazonaws.chime#PhoneNumberProductType", "traits": { "smithy.api#documentation": "The phone number product type.
" } }, "Status": { "target": "com.amazonaws.chime#PhoneNumberStatus", "traits": { "smithy.api#documentation": "The phone number status.
" } }, "Capabilities": { "target": "com.amazonaws.chime#PhoneNumberCapabilities", "traits": { "smithy.api#documentation": "The phone number capabilities.
" } }, "Associations": { "target": "com.amazonaws.chime#PhoneNumberAssociationList", "traits": { "smithy.api#documentation": "The phone number associations.
" } }, "CallingName": { "target": "com.amazonaws.chime#CallingName", "traits": { "smithy.api#documentation": "The outbound calling name associated with the phone number.
" } }, "CallingNameStatus": { "target": "com.amazonaws.chime#CallingNameStatus", "traits": { "smithy.api#documentation": "The outbound calling name status.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The phone number creation timestamp, in ISO 8601 format.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The updated phone number timestamp, in ISO 8601 format.
" } }, "DeletionTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The deleted phone number timestamp, in ISO 8601 format.
" } } }, "traits": { "smithy.api#documentation": "A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice\n Connector.
" } }, "com.amazonaws.chime#PhoneNumberAssociation": { "type": "structure", "members": { "Value": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "Contains the ID for the entity specified in Name.
" } }, "Name": { "target": "com.amazonaws.chime#PhoneNumberAssociationName", "traits": { "smithy.api#documentation": "Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector\n ID, or Amazon Chime Voice Connector group ID.
" } }, "AssociatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The timestamp of the phone number association, in ISO 8601 format.
" } } }, "traits": { "smithy.api#documentation": "The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, Amazon\n Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.
" } }, "com.amazonaws.chime#PhoneNumberAssociationList": { "type": "list", "member": { "target": "com.amazonaws.chime#PhoneNumberAssociation" } }, "com.amazonaws.chime#PhoneNumberAssociationName": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "AccountId", "name": "AccountId" }, { "value": "UserId", "name": "UserId" }, { "value": "VoiceConnectorId", "name": "VoiceConnectorId" }, { "value": "VoiceConnectorGroupId", "name": "VoiceConnectorGroupId" }, { "value": "SipRuleId", "name": "SipRuleId" } ] } }, "com.amazonaws.chime#PhoneNumberCapabilities": { "type": "structure", "members": { "InboundCall": { "target": "com.amazonaws.chime#NullableBoolean", "traits": { "smithy.api#documentation": "Allows or denies inbound calling for the specified phone number.
" } }, "OutboundCall": { "target": "com.amazonaws.chime#NullableBoolean", "traits": { "smithy.api#documentation": "Allows or denies outbound calling for the specified phone number.
" } }, "InboundSMS": { "target": "com.amazonaws.chime#NullableBoolean", "traits": { "smithy.api#documentation": "Allows or denies inbound SMS messaging for the specified phone number.
" } }, "OutboundSMS": { "target": "com.amazonaws.chime#NullableBoolean", "traits": { "smithy.api#documentation": "Allows or denies outbound SMS messaging for the specified phone number.
" } }, "InboundMMS": { "target": "com.amazonaws.chime#NullableBoolean", "traits": { "smithy.api#documentation": "Allows or denies inbound MMS messaging for the specified phone number.
" } }, "OutboundMMS": { "target": "com.amazonaws.chime#NullableBoolean", "traits": { "smithy.api#documentation": "Allows or denies outbound MMS messaging for the specified phone number.
" } } }, "traits": { "smithy.api#documentation": "The phone number capabilities for Amazon Chime Business Calling phone numbers, such as enabled\n inbound and outbound calling and text messaging.
" } }, "com.amazonaws.chime#PhoneNumberCountriesList": { "type": "list", "member": { "target": "com.amazonaws.chime#PhoneNumberCountry" } }, "com.amazonaws.chime#PhoneNumberCountry": { "type": "structure", "members": { "CountryCode": { "target": "com.amazonaws.chime#Alpha2CountryCode", "traits": { "smithy.api#documentation": "The phone number country code. Format: ISO 3166-1 alpha-2.
" } }, "SupportedPhoneNumberTypes": { "target": "com.amazonaws.chime#PhoneNumberTypeList", "traits": { "smithy.api#documentation": "The supported phone number types.
" } } }, "traits": { "smithy.api#documentation": "The phone number country.
" } }, "com.amazonaws.chime#PhoneNumberError": { "type": "structure", "members": { "PhoneNumberId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The phone number ID for which the action failed.
" } }, "ErrorCode": { "target": "com.amazonaws.chime#ErrorCode", "traits": { "smithy.api#documentation": "The error code.
" } }, "ErrorMessage": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The error message.
" } } }, "traits": { "smithy.api#documentation": "If the phone number action fails for one or more of the phone numbers in the request, a list of\n the phone numbers is returned, along with error codes and error messages.
" } }, "com.amazonaws.chime#PhoneNumberErrorList": { "type": "list", "member": { "target": "com.amazonaws.chime#PhoneNumberError" } }, "com.amazonaws.chime#PhoneNumberList": { "type": "list", "member": { "target": "com.amazonaws.chime#PhoneNumber" } }, "com.amazonaws.chime#PhoneNumberMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 500 } } }, "com.amazonaws.chime#PhoneNumberOrder": { "type": "structure", "members": { "PhoneNumberOrderId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The phone number order ID.
" } }, "ProductType": { "target": "com.amazonaws.chime#PhoneNumberProductType", "traits": { "smithy.api#documentation": "The phone number order product type.
" } }, "Status": { "target": "com.amazonaws.chime#PhoneNumberOrderStatus", "traits": { "smithy.api#documentation": "The status of the phone number order.
" } }, "OrderedPhoneNumbers": { "target": "com.amazonaws.chime#OrderedPhoneNumberList", "traits": { "smithy.api#documentation": "The ordered phone number details, such as the phone number in E.164 format and the phone\n number status.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The phone number order creation time stamp, in ISO 8601 format.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The updated phone number order time stamp, in ISO 8601 format.
" } } }, "traits": { "smithy.api#documentation": "The details of a phone number order created for Amazon Chime.
" } }, "com.amazonaws.chime#PhoneNumberOrderList": { "type": "list", "member": { "target": "com.amazonaws.chime#PhoneNumberOrder" } }, "com.amazonaws.chime#PhoneNumberOrderStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Processing", "name": "Processing" }, { "value": "Successful", "name": "Successful" }, { "value": "Failed", "name": "Failed" }, { "value": "Partial", "name": "Partial" } ] } }, "com.amazonaws.chime#PhoneNumberProductType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "BusinessCalling", "name": "BusinessCalling" }, { "value": "VoiceConnector", "name": "VoiceConnector" }, { "value": "SipMediaApplicationDialIn", "name": "SipMediaApplicationDialIn" } ] } }, "com.amazonaws.chime#PhoneNumberStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "AcquireInProgress", "name": "AcquireInProgress" }, { "value": "AcquireFailed", "name": "AcquireFailed" }, { "value": "Unassigned", "name": "Unassigned" }, { "value": "Assigned", "name": "Assigned" }, { "value": "ReleaseInProgress", "name": "ReleaseInProgress" }, { "value": "DeleteInProgress", "name": "DeleteInProgress" }, { "value": "ReleaseFailed", "name": "ReleaseFailed" }, { "value": "DeleteFailed", "name": "DeleteFailed" } ] } }, "com.amazonaws.chime#PhoneNumberType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Local", "name": "Local" }, { "value": "TollFree", "name": "TollFree" } ] } }, "com.amazonaws.chime#PhoneNumberTypeList": { "type": "list", "member": { "target": "com.amazonaws.chime#PhoneNumberType" } }, "com.amazonaws.chime#Port": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 65535 } } }, "com.amazonaws.chime#PositiveInteger": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.chime#ProfileServiceMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 200 } } }, "com.amazonaws.chime#Proxy": { "type": "structure", "members": { "DefaultSessionExpiryMinutes": { "target": "com.amazonaws.chime#Integer", "traits": { "smithy.api#documentation": "The default number of minutes allowed for proxy sessions.
" } }, "Disabled": { "target": "com.amazonaws.chime#Boolean", "traits": { "smithy.api#documentation": "When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
" } }, "FallBackPhoneNumber": { "target": "com.amazonaws.chime#E164PhoneNumber", "traits": { "smithy.api#documentation": "The phone number to route calls to after a proxy session expires.
" } }, "PhoneNumberCountries": { "target": "com.amazonaws.chime#StringList", "traits": { "smithy.api#documentation": "The countries for proxy phone numbers to be selected from.
" } } }, "traits": { "smithy.api#documentation": "The proxy configuration for an Amazon Chime Voice Connector.
" } }, "com.amazonaws.chime#ProxySession": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString128", "traits": { "smithy.api#documentation": "The Amazon Chime voice connector ID.
" } }, "ProxySessionId": { "target": "com.amazonaws.chime#NonEmptyString128", "traits": { "smithy.api#documentation": "The proxy session ID.
" } }, "Name": { "target": "com.amazonaws.chime#String128", "traits": { "smithy.api#documentation": "The name of the proxy session.
" } }, "Status": { "target": "com.amazonaws.chime#ProxySessionStatus", "traits": { "smithy.api#documentation": "The status of the proxy session.
" } }, "ExpiryMinutes": { "target": "com.amazonaws.chime#PositiveInteger", "traits": { "smithy.api#documentation": "The number of minutes allowed for the proxy session.
" } }, "Capabilities": { "target": "com.amazonaws.chime#CapabilityList", "traits": { "smithy.api#documentation": "The proxy session capabilities.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The created time stamp, in ISO 8601 format.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The updated time stamp, in ISO 8601 format.
" } }, "EndedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The ended time stamp, in ISO 8601 format.
" } }, "Participants": { "target": "com.amazonaws.chime#Participants", "traits": { "smithy.api#documentation": "The proxy session participants.
" } }, "NumberSelectionBehavior": { "target": "com.amazonaws.chime#NumberSelectionBehavior", "traits": { "smithy.api#documentation": "The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
" } }, "GeoMatchLevel": { "target": "com.amazonaws.chime#GeoMatchLevel", "traits": { "smithy.api#documentation": "The preference for matching the country or area code of the proxy phone number with that of the first participant.
" } }, "GeoMatchParams": { "target": "com.amazonaws.chime#GeoMatchParams", "traits": { "smithy.api#documentation": "The country and area code for the proxy phone number.
" } } }, "traits": { "smithy.api#documentation": "The proxy session for an Amazon Chime Voice Connector.
" } }, "com.amazonaws.chime#ProxySessionNameString": { "type": "string", "traits": { "smithy.api#pattern": "^$|^[a-zA-Z0-9 ]{0,30}$", "smithy.api#sensitive": {} } }, "com.amazonaws.chime#ProxySessionStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Open", "name": "Open" }, { "value": "InProgress", "name": "InProgress" }, { "value": "Closed", "name": "Closed" } ] } }, "com.amazonaws.chime#ProxySessions": { "type": "list", "member": { "target": "com.amazonaws.chime#ProxySession" } }, "com.amazonaws.chime#PutAppInstanceRetentionSettings": { "type": "operation", "input": { "target": "com.amazonaws.chime#PutAppInstanceRetentionSettingsRequest" }, "output": { "target": "com.amazonaws.chime#PutAppInstanceRetentionSettingsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Sets the amount of time in days that a given AppInstance retains data.
The ARN of the AppInstance.
The time in days to retain data. Data type: number.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#PutAppInstanceRetentionSettingsResponse": { "type": "structure", "members": { "AppInstanceRetentionSettings": { "target": "com.amazonaws.chime#AppInstanceRetentionSettings", "traits": { "smithy.api#documentation": "The time in days to retain data. Data type: number.
" } }, "InitiateDeletionTimestamp": { "target": "com.amazonaws.chime#Timestamp", "traits": { "smithy.api#documentation": "The time at which the API deletes data.
" } } } }, "com.amazonaws.chime#PutAppInstanceStreamingConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.chime#PutAppInstanceStreamingConfigurationsRequest" }, "output": { "target": "com.amazonaws.chime#PutAppInstanceStreamingConfigurationsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "The data streaming configurations of an AppInstance.
The ARN of the AppInstance.
The streaming configurations set for an AppInstance.
The streaming configurations of an AppInstance.
Creates an events configuration that allows a bot to receive outgoing events sent by Amazon\n Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information,\n see Bot.
", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AccountId}/bots/{BotId}/events-configuration", "code": 201 } } }, "com.amazonaws.chime#PutEventsConfigurationRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BotId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The bot ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "OutboundEventsHTTPSEndpoint": { "target": "com.amazonaws.chime#SensitiveString", "traits": { "smithy.api#documentation": "HTTPS endpoint that allows the bot to receive outgoing events.
" } }, "LambdaFunctionArn": { "target": "com.amazonaws.chime#SensitiveString", "traits": { "smithy.api#documentation": "Lambda function ARN that allows the bot to receive outgoing events.
" } } } }, "com.amazonaws.chime#PutEventsConfigurationResponse": { "type": "structure", "members": { "EventsConfiguration": { "target": "com.amazonaws.chime#EventsConfiguration" } } }, "com.amazonaws.chime#PutRetentionSettings": { "type": "operation", "input": { "target": "com.amazonaws.chime#PutRetentionSettingsRequest" }, "output": { "target": "com.amazonaws.chime#PutRetentionSettingsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "\nPuts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see \nLogging Amazon Chime API Calls with AWS CloudTrail\nin the \nAmazon Chime Administration Guide\n.\n
\n\n\nTo turn off existing retention settings, remove the number of days from the corresponding \nRetentionDays\nfield in the \nRetentionSettings\nobject. For more information about retention settings, see \nManaging Chat Retention Policies\nin the \nAmazon Chime Administration Guide\n.\n
", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AccountId}/retention-settings", "code": 204 } } }, "com.amazonaws.chime#PutRetentionSettingsRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RetentionSettings": { "target": "com.amazonaws.chime#RetentionSettings", "traits": { "smithy.api#documentation": "The retention settings.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#PutRetentionSettingsResponse": { "type": "structure", "members": { "RetentionSettings": { "target": "com.amazonaws.chime#RetentionSettings", "traits": { "smithy.api#documentation": "The retention settings.
" } }, "InitiateDeletionTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.
" } } } }, "com.amazonaws.chime#PutSipMediaApplicationLoggingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chime#PutSipMediaApplicationLoggingConfigurationRequest" }, "output": { "target": "com.amazonaws.chime#PutSipMediaApplicationLoggingConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Updates the logging configuration for the specified SIP media application.
", "smithy.api#http": { "method": "PUT", "uri": "/sip-media-applications/{SipMediaApplicationId}/logging-configuration", "code": 200 } } }, "com.amazonaws.chime#PutSipMediaApplicationLoggingConfigurationRequest": { "type": "structure", "members": { "SipMediaApplicationId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The SIP media application ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SipMediaApplicationLoggingConfiguration": { "target": "com.amazonaws.chime#SipMediaApplicationLoggingConfiguration", "traits": { "smithy.api#documentation": "The actual logging configuration.
" } } } }, "com.amazonaws.chime#PutSipMediaApplicationLoggingConfigurationResponse": { "type": "structure", "members": { "SipMediaApplicationLoggingConfiguration": { "target": "com.amazonaws.chime#SipMediaApplicationLoggingConfiguration" } } }, "com.amazonaws.chime#PutVoiceConnectorEmergencyCallingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chime#PutVoiceConnectorEmergencyCallingConfigurationRequest" }, "output": { "target": "com.amazonaws.chime#PutVoiceConnectorEmergencyCallingConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#http": { "method": "PUT", "uri": "/voice-connectors/{VoiceConnectorId}/emergency-calling-configuration", "code": 200 } } }, "com.amazonaws.chime#PutVoiceConnectorEmergencyCallingConfigurationRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "EmergencyCallingConfiguration": { "target": "com.amazonaws.chime#EmergencyCallingConfiguration", "traits": { "smithy.api#documentation": "The emergency calling configuration details.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#PutVoiceConnectorEmergencyCallingConfigurationResponse": { "type": "structure", "members": { "EmergencyCallingConfiguration": { "target": "com.amazonaws.chime#EmergencyCallingConfiguration", "traits": { "smithy.api#documentation": "The emergency calling configuration details.
" } } } }, "com.amazonaws.chime#PutVoiceConnectorLoggingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chime#PutVoiceConnectorLoggingConfigurationRequest" }, "output": { "target": "com.amazonaws.chime#PutVoiceConnectorLoggingConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#http": { "method": "PUT", "uri": "/voice-connectors/{VoiceConnectorId}/logging-configuration", "code": 200 } } }, "com.amazonaws.chime#PutVoiceConnectorLoggingConfigurationRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LoggingConfiguration": { "target": "com.amazonaws.chime#LoggingConfiguration", "traits": { "smithy.api#documentation": "The logging configuration details to add.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#PutVoiceConnectorLoggingConfigurationResponse": { "type": "structure", "members": { "LoggingConfiguration": { "target": "com.amazonaws.chime#LoggingConfiguration", "traits": { "smithy.api#documentation": "The updated logging configuration details.
" } } } }, "com.amazonaws.chime#PutVoiceConnectorOrigination": { "type": "operation", "input": { "target": "com.amazonaws.chime#PutVoiceConnectorOriginationRequest" }, "output": { "target": "com.amazonaws.chime#PutVoiceConnectorOriginationResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Adds origination settings for the specified Amazon Chime Voice Connector.
\n\nIf emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.
\nThe Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Origination": { "target": "com.amazonaws.chime#Origination", "traits": { "smithy.api#documentation": "The origination setting details to add.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#PutVoiceConnectorOriginationResponse": { "type": "structure", "members": { "Origination": { "target": "com.amazonaws.chime#Origination", "traits": { "smithy.api#documentation": "The updated origination setting details.
" } } } }, "com.amazonaws.chime#PutVoiceConnectorProxy": { "type": "operation", "input": { "target": "com.amazonaws.chime#PutVoiceConnectorProxyRequest" }, "output": { "target": "com.amazonaws.chime#PutVoiceConnectorProxyResponse" }, "errors": [ { "target": "com.amazonaws.chime#AccessDeniedException" }, { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.
", "smithy.api#http": { "method": "PUT", "uri": "/voice-connectors/{VoiceConnectorId}/programmable-numbers/proxy", "code": 200 } } }, "com.amazonaws.chime#PutVoiceConnectorProxyRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString128", "traits": { "smithy.api#documentation": "The Amazon Chime voice connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DefaultSessionExpiryMinutes": { "target": "com.amazonaws.chime#Integer", "traits": { "smithy.api#documentation": "The default number of minutes allowed for proxy sessions.
", "smithy.api#required": {} } }, "PhoneNumberPoolCountries": { "target": "com.amazonaws.chime#CountryList", "traits": { "smithy.api#documentation": "The countries for proxy phone numbers to be selected from.
", "smithy.api#required": {} } }, "FallBackPhoneNumber": { "target": "com.amazonaws.chime#E164PhoneNumber", "traits": { "smithy.api#documentation": "The phone number to route calls to after a proxy session expires.
" } }, "Disabled": { "target": "com.amazonaws.chime#Boolean", "traits": { "smithy.api#documentation": "When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
" } } } }, "com.amazonaws.chime#PutVoiceConnectorProxyResponse": { "type": "structure", "members": { "Proxy": { "target": "com.amazonaws.chime#Proxy", "traits": { "smithy.api#documentation": "The proxy configuration details.
" } } } }, "com.amazonaws.chime#PutVoiceConnectorStreamingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chime#PutVoiceConnectorStreamingConfigurationRequest" }, "output": { "target": "com.amazonaws.chime#PutVoiceConnectorStreamingConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming\n configuration specifies whether media streaming is enabled for sending to Indonesians.\n It also sets the retention period, in hours, for the Amazon Kinesis data.
", "smithy.api#http": { "method": "PUT", "uri": "/voice-connectors/{VoiceConnectorId}/streaming-configuration", "code": 200 } } }, "com.amazonaws.chime#PutVoiceConnectorStreamingConfigurationRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "StreamingConfiguration": { "target": "com.amazonaws.chime#StreamingConfiguration", "traits": { "smithy.api#documentation": "The streaming configuration details to add.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#PutVoiceConnectorStreamingConfigurationResponse": { "type": "structure", "members": { "StreamingConfiguration": { "target": "com.amazonaws.chime#StreamingConfiguration", "traits": { "smithy.api#documentation": "The updated streaming configuration details.
" } } } }, "com.amazonaws.chime#PutVoiceConnectorTermination": { "type": "operation", "input": { "target": "com.amazonaws.chime#PutVoiceConnectorTerminationRequest" }, "output": { "target": "com.amazonaws.chime#PutVoiceConnectorTerminationResponse" }, "errors": [ { "target": "com.amazonaws.chime#AccessDeniedException" }, { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Adds termination settings for the specified Amazon Chime Voice Connector.
\n\nIf emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.
\nAdds termination SIP credentials for the specified Amazon Chime Voice Connector.
", "smithy.api#http": { "method": "POST", "uri": "/voice-connectors/{VoiceConnectorId}/termination/credentials?operation=put", "code": 204 } } }, "com.amazonaws.chime#PutVoiceConnectorTerminationCredentialsRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Credentials": { "target": "com.amazonaws.chime#CredentialList", "traits": { "smithy.api#documentation": "The termination SIP credentials.
" } } } }, "com.amazonaws.chime#PutVoiceConnectorTerminationRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Termination": { "target": "com.amazonaws.chime#Termination", "traits": { "smithy.api#documentation": "The termination setting details to add.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#PutVoiceConnectorTerminationResponse": { "type": "structure", "members": { "Termination": { "target": "com.amazonaws.chime#Termination", "traits": { "smithy.api#documentation": "The updated termination setting details.
" } } } }, "com.amazonaws.chime#RedactChannelMessage": { "type": "operation", "input": { "target": "com.amazonaws.chime#RedactChannelMessageRequest" }, "output": { "target": "com.amazonaws.chime#RedactChannelMessageResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "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.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
The ARN of the channel containing the messages that you want to redact.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MessageId": { "target": "com.amazonaws.chime#MessageId", "traits": { "smithy.api#documentation": "The ID of the message being redacted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel containing the messages that you want to redact.
" } }, "MessageId": { "target": "com.amazonaws.chime#MessageId", "traits": { "smithy.api#documentation": "The ID of the message being redacted.
" } } } }, "com.amazonaws.chime#RedactConversationMessage": { "type": "operation", "input": { "target": "com.amazonaws.chime#RedactConversationMessageRequest" }, "output": { "target": "com.amazonaws.chime#RedactConversationMessageResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Redacts the specified message from the specified Amazon Chime conversation.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/conversations/{ConversationId}/messages/{MessageId}?operation=redact", "code": 200 } } }, "com.amazonaws.chime#RedactConversationMessageRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ConversationId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The conversation ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MessageId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The message ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#RedactConversationMessageResponse": { "type": "structure", "members": {} }, "com.amazonaws.chime#RedactRoomMessage": { "type": "operation", "input": { "target": "com.amazonaws.chime#RedactRoomMessageRequest" }, "output": { "target": "com.amazonaws.chime#RedactRoomMessageResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Redacts the specified message from the specified Amazon Chime channel.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/rooms/{RoomId}/messages/{MessageId}?operation=redact", "code": 200 } } }, "com.amazonaws.chime#RedactRoomMessageRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RoomId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The room ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MessageId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The message ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#RedactRoomMessageResponse": { "type": "structure", "members": {} }, "com.amazonaws.chime#RegenerateSecurityToken": { "type": "operation", "input": { "target": "com.amazonaws.chime#RegenerateSecurityTokenRequest" }, "output": { "target": "com.amazonaws.chime#RegenerateSecurityTokenResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Regenerates the security token for a bot.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/bots/{BotId}?operation=regenerate-security-token", "code": 200 } } }, "com.amazonaws.chime#RegenerateSecurityTokenRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BotId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The bot ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#RegenerateSecurityTokenResponse": { "type": "structure", "members": { "Bot": { "target": "com.amazonaws.chime#Bot" } } }, "com.amazonaws.chime#RegistrationStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Unregistered", "name": "Unregistered" }, { "value": "Registered", "name": "Registered" }, { "value": "Suspended", "name": "Suspended" } ] } }, "com.amazonaws.chime#ResetPersonalPIN": { "type": "operation", "input": { "target": "com.amazonaws.chime#ResetPersonalPINRequest" }, "output": { "target": "com.amazonaws.chime#ResetPersonalPINResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns\n the User object with the updated personal meeting PIN.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/users/{UserId}?operation=reset-personal-pin", "code": 200 } } }, "com.amazonaws.chime#ResetPersonalPINRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The user ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#ResetPersonalPINResponse": { "type": "structure", "members": { "User": { "target": "com.amazonaws.chime#User", "traits": { "smithy.api#documentation": "The user details and new personal meeting PIN.
" } } } }, "com.amazonaws.chime#ResourceLimitExceededException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.chime#ErrorCode" }, "Message": { "target": "com.amazonaws.chime#String" } }, "traits": { "smithy.api#documentation": "The request exceeds the resource limit.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.chime#ResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*", "smithy.api#sensitive": {} } }, "com.amazonaws.chime#RestorePhoneNumber": { "type": "operation", "input": { "target": "com.amazonaws.chime#RestorePhoneNumberRequest" }, "output": { "target": "com.amazonaws.chime#RestorePhoneNumberResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Moves a phone number from the Deletion queue back into the\n phone number Inventory.
", "smithy.api#http": { "method": "POST", "uri": "/phone-numbers/{PhoneNumberId}?operation=restore", "code": 200 } } }, "com.amazonaws.chime#RestorePhoneNumberRequest": { "type": "structure", "members": { "PhoneNumberId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The phone number.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.chime#RestorePhoneNumberResponse": { "type": "structure", "members": { "PhoneNumber": { "target": "com.amazonaws.chime#PhoneNumber", "traits": { "smithy.api#documentation": "The phone number details.
" } } } }, "com.amazonaws.chime#ResultMax": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 99 } } }, "com.amazonaws.chime#RetentionDays": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 5475 } } }, "com.amazonaws.chime#RetentionSettings": { "type": "structure", "members": { "RoomRetentionSettings": { "target": "com.amazonaws.chime#RoomRetentionSettings", "traits": { "smithy.api#documentation": "The chat room retention settings.
" } }, "ConversationRetentionSettings": { "target": "com.amazonaws.chime#ConversationRetentionSettings", "traits": { "smithy.api#documentation": "The chat conversation retention settings.
" } } }, "traits": { "smithy.api#documentation": "The retention settings for an Amazon Chime Enterprise account that determine how long to retain items such as chat-room messages and chat-conversation messages.
" } }, "com.amazonaws.chime#Room": { "type": "structure", "members": { "RoomId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The room ID.
" } }, "Name": { "target": "com.amazonaws.chime#SensitiveString", "traits": { "smithy.api#documentation": "The room name.
" } }, "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
" } }, "CreatedBy": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The identifier of the room creator.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The room creation timestamp, in ISO 8601 format.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The room update timestamp, in ISO 8601 format.
" } } }, "traits": { "smithy.api#documentation": "The Amazon Chime chat room details.
" } }, "com.amazonaws.chime#RoomList": { "type": "list", "member": { "target": "com.amazonaws.chime#Room" } }, "com.amazonaws.chime#RoomMembership": { "type": "structure", "members": { "RoomId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The room ID.
" } }, "Member": { "target": "com.amazonaws.chime#Member" }, "Role": { "target": "com.amazonaws.chime#RoomMembershipRole", "traits": { "smithy.api#documentation": "The membership role.
" } }, "InvitedBy": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The identifier of the user that invited the room member.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The room membership update timestamp, in ISO 8601 format.
" } } }, "traits": { "smithy.api#documentation": "The room membership details.
" } }, "com.amazonaws.chime#RoomMembershipList": { "type": "list", "member": { "target": "com.amazonaws.chime#RoomMembership" } }, "com.amazonaws.chime#RoomMembershipRole": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Administrator", "name": "Administrator" }, { "value": "Member", "name": "Member" } ] } }, "com.amazonaws.chime#RoomRetentionSettings": { "type": "structure", "members": { "RetentionDays": { "target": "com.amazonaws.chime#RetentionDays", "traits": { "smithy.api#documentation": "The number of days for which to retain chat-room messages.
" } } }, "traits": { "smithy.api#documentation": "The retention settings that determine how long to retain chat-room messages for an Amazon Chime Enterprise account.
" } }, "com.amazonaws.chime#SearchAvailablePhoneNumbers": { "type": "operation", "input": { "target": "com.amazonaws.chime#SearchAvailablePhoneNumbersRequest" }, "output": { "target": "com.amazonaws.chime#SearchAvailablePhoneNumbersResponse" }, "errors": [ { "target": "com.amazonaws.chime#AccessDeniedException" }, { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Searches for phone numbers that can be ordered. For\n US\n numbers, provide at least one of the following search filters: AreaCode,\n City, State, or TollFreePrefix. If you\n provide City, you must also provide State. Numbers outside the\n US\n only support the PhoneNumberType filter, which you must use.
The area code used to filter results. Only applies to the\n US.
", "smithy.api#httpQuery": "area-code" } }, "City": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The city used to filter results. Only applies to the\n US.
", "smithy.api#httpQuery": "city" } }, "Country": { "target": "com.amazonaws.chime#Alpha2CountryCode", "traits": { "smithy.api#documentation": "The country used to filter results. Defaults to the\n US\n Format: ISO 3166-1 alpha-2.
", "smithy.api#httpQuery": "country" } }, "State": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The state used to filter results. Required only if you provide City. Only\n applies to the\n US.
The toll-free prefix that you use to filter results. Only applies to the\n US.
", "smithy.api#httpQuery": "toll-free-prefix" } }, "PhoneNumberType": { "target": "com.amazonaws.chime#PhoneNumberType", "traits": { "smithy.api#documentation": "The phone number type used to filter results. Required for\n non-US\n numbers.
", "smithy.api#httpQuery": "phone-number-type" } }, "MaxResults": { "target": "com.amazonaws.chime#PhoneNumberMaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token used to retrieve the next page of results.
", "smithy.api#httpQuery": "next-token" } } } }, "com.amazonaws.chime#SearchAvailablePhoneNumbersResponse": { "type": "structure", "members": { "E164PhoneNumbers": { "target": "com.amazonaws.chime#E164PhoneNumberList", "traits": { "smithy.api#documentation": "List of phone numbers, in E.164 format.
" } }, "NextToken": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The token used to retrieve the next page of search results.
" } } } }, "com.amazonaws.chime#SendChannelMessage": { "type": "operation", "input": { "target": "com.amazonaws.chime#SendChannelMessageRequest" }, "output": { "target": "com.amazonaws.chime#SendChannelMessageResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Sends a message to a particular channel that the member is a part of.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of \n data and no metadata.
The ARN of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Content": { "target": "com.amazonaws.chime#NonEmptyContent", "traits": { "smithy.api#documentation": "The content of the message.
", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.chime#ChannelMessageType", "traits": { "smithy.api#documentation": "The type of message, STANDARD or CONTROL.
Boolean that controls whether the message is persisted on the back end. Required.
", "smithy.api#required": {} } }, "Metadata": { "target": "com.amazonaws.chime#Metadata", "traits": { "smithy.api#documentation": "The optional metadata for each message.
" } }, "ClientRequestToken": { "target": "com.amazonaws.chime#ClientRequestToken", "traits": { "smithy.api#documentation": "The Idempotency token for each client request.
The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
" } }, "MessageId": { "target": "com.amazonaws.chime#MessageId", "traits": { "smithy.api#documentation": "The ID string assigned to each message.
" } } } }, "com.amazonaws.chime#SensitiveString": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.chime#SensitiveStringList": { "type": "list", "member": { "target": "com.amazonaws.chime#SensitiveString" } }, "com.amazonaws.chime#ServiceFailureException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.chime#ErrorCode" }, "Message": { "target": "com.amazonaws.chime#String" } }, "traits": { "smithy.api#documentation": "The service encountered an unexpected error.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chime#ServiceUnavailableException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.chime#ErrorCode" }, "Message": { "target": "com.amazonaws.chime#String" } }, "traits": { "smithy.api#documentation": "The service is currently unavailable.
", "smithy.api#error": "server", "smithy.api#httpError": 503 } }, "com.amazonaws.chime#SigninDelegateGroup": { "type": "structure", "members": { "GroupName": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The group name.
" } } }, "traits": { "smithy.api#documentation": "An Active Directory (AD) group whose members are granted permission to act as delegates.
" } }, "com.amazonaws.chime#SigninDelegateGroupList": { "type": "list", "member": { "target": "com.amazonaws.chime#SigninDelegateGroup" } }, "com.amazonaws.chime#SipApplicationPriority": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.chime#SipMediaApplication": { "type": "structure", "members": { "SipMediaApplicationId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The SIP media application ID.
" } }, "AwsRegion": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The AWS Region in which the SIP media application is created.
" } }, "Name": { "target": "com.amazonaws.chime#SipMediaApplicationName", "traits": { "smithy.api#documentation": "The name of the SIP media application.
" } }, "Endpoints": { "target": "com.amazonaws.chime#SipMediaApplicationEndpointList", "traits": { "smithy.api#documentation": "List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The SIP media application creation timestamp, in ISO 8601 format.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The SIP media application updated timestamp, in ISO 8601 format.
" } } }, "traits": { "smithy.api#documentation": "The details of the SIP media application, including name and endpoints. An AWS account can have multiple SIP media applications.
" } }, "com.amazonaws.chime#SipMediaApplicationCall": { "type": "structure", "members": { "TransactionId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The transaction ID of a call.
" } } }, "traits": { "smithy.api#documentation": "A Call instance for a SIP media application.
Valid Amazon Resource Name (ARN) of the Lambda function. The function must be created in the same AWS Region as the SIP media application.
" } } }, "traits": { "smithy.api#documentation": "The endpoint assigned to the SIP media application.
" } }, "com.amazonaws.chime#SipMediaApplicationEndpointList": { "type": "list", "member": { "target": "com.amazonaws.chime#SipMediaApplicationEndpoint" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.chime#SipMediaApplicationList": { "type": "list", "member": { "target": "com.amazonaws.chime#SipMediaApplication" } }, "com.amazonaws.chime#SipMediaApplicationLoggingConfiguration": { "type": "structure", "members": { "EnableSipMediaApplicationMessageLogs": { "target": "com.amazonaws.chime#Boolean", "traits": { "smithy.api#documentation": "Enables application message logs for the SIP media application.
" } } }, "traits": { "smithy.api#documentation": "Logging configuration of the SIP media application.
" } }, "com.amazonaws.chime#SipMediaApplicationName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.chime#SipRule": { "type": "structure", "members": { "SipRuleId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The SIP rule ID.
" } }, "Name": { "target": "com.amazonaws.chime#SipRuleName", "traits": { "smithy.api#documentation": "The name of the SIP rule.
" } }, "Disabled": { "target": "com.amazonaws.chime#Boolean", "traits": { "smithy.api#documentation": "Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
" } }, "TriggerType": { "target": "com.amazonaws.chime#SipRuleTriggerType", "traits": { "smithy.api#documentation": "The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or \n ToPhoneNumber.
If TriggerType is RequestUriHostname, then the value can be the\n outbound host name of the Amazon Chime Voice Connector. If TriggerType is\n ToPhoneNumber, then the value can be a customer-owned phone number in\n E164 format. SipRule is triggered when a SIP rule requests host name or\n ToPhoneNumber matches in the incoming SIP request.
Target SIP media application and other details, such as priority and AWS Region, to be\n specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The time at which the SIP rule was created, in ISO 8601 format.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The time at which the SIP rule was last updated, in ISO 8601 format.
" } } }, "traits": { "smithy.api#documentation": "The SIP rule details, including name, triggers, and target applications. An AWS account can have multiple SIP rules.
" } }, "com.amazonaws.chime#SipRuleList": { "type": "list", "member": { "target": "com.amazonaws.chime#SipRule" } }, "com.amazonaws.chime#SipRuleName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.chime#SipRuleTargetApplication": { "type": "structure", "members": { "SipMediaApplicationId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The SIP media application ID.
" } }, "Priority": { "target": "com.amazonaws.chime#SipApplicationPriority", "traits": { "smithy.api#documentation": "Priority of the SIP media application in the target list.
" } }, "AwsRegion": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The AWS Region of the target application.
" } } }, "traits": { "smithy.api#documentation": "Target SIP media application and other details, such as priority and AWS Region, to be\n specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
" } }, "com.amazonaws.chime#SipRuleTargetApplicationList": { "type": "list", "member": { "target": "com.amazonaws.chime#SipRuleTargetApplication" }, "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.chime#SipRuleTriggerType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ToPhoneNumber", "name": "ToPhoneNumber" }, { "value": "RequestUriHostname", "name": "RequestUriHostname" } ] } }, "com.amazonaws.chime#SortOrder": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ASCENDING", "name": "ASCENDING" }, { "value": "DESCENDING", "name": "DESCENDING" } ] } }, "com.amazonaws.chime#StreamingConfiguration": { "type": "structure", "members": { "DataRetentionInHours": { "target": "com.amazonaws.chime#DataRetentionInHours", "traits": { "smithy.api#documentation": "The retention period, in hours, for the Amazon Kinesis data.
", "smithy.api#required": {} } }, "Disabled": { "target": "com.amazonaws.chime#Boolean", "traits": { "smithy.api#documentation": "When true, media streaming to Amazon Kinesis is turned off.
" } }, "StreamingNotificationTargets": { "target": "com.amazonaws.chime#StreamingNotificationTargetList", "traits": { "smithy.api#documentation": "The streaming notification targets.
" } } }, "traits": { "smithy.api#documentation": "The streaming configuration associated with an Amazon Chime Voice Connector. Specifies whether\n media streaming is enabled for sending to Amazon Kinesis, and shows the retention period\n for the Amazon Kinesis data, in hours.
" } }, "com.amazonaws.chime#StreamingNotificationTarget": { "type": "structure", "members": { "NotificationTarget": { "target": "com.amazonaws.chime#NotificationTarget", "traits": { "smithy.api#documentation": "The streaming notification target.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The targeted recipient for a streaming configuration notification.
" } }, "com.amazonaws.chime#StreamingNotificationTargetList": { "type": "list", "member": { "target": "com.amazonaws.chime#StreamingNotificationTarget" }, "traits": { "smithy.api#length": { "min": 1, "max": 3 } } }, "com.amazonaws.chime#String": { "type": "string" }, "com.amazonaws.chime#String128": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 } } }, "com.amazonaws.chime#StringList": { "type": "list", "member": { "target": "com.amazonaws.chime#String" } }, "com.amazonaws.chime#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.chime#TagKey", "traits": { "smithy.api#documentation": "The key of the tag.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.chime#TagValue", "traits": { "smithy.api#documentation": "The value of the tag.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes a tag applied to a resource.
" } }, "com.amazonaws.chime#TagAttendee": { "type": "operation", "input": { "target": "com.amazonaws.chime#TagAttendeeRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Applies the specified tags to the specified Amazon Chime SDK attendee.
", "smithy.api#http": { "method": "POST", "uri": "/meetings/{MeetingId}/attendees/{AttendeeId}/tags?operation=add", "code": 204 } } }, "com.amazonaws.chime#TagAttendeeRequest": { "type": "structure", "members": { "MeetingId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AttendeeId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK attendee ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.chime#AttendeeTagList", "traits": { "smithy.api#documentation": "The tag key-value pairs.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#sensitive": {} } }, "com.amazonaws.chime#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.chime#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.chime#TagList": { "type": "list", "member": { "target": "com.amazonaws.chime#Tag" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.chime#TagMeeting": { "type": "operation", "input": { "target": "com.amazonaws.chime#TagMeetingRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Applies the specified tags to the specified Amazon Chime SDK meeting.
", "smithy.api#http": { "method": "POST", "uri": "/meetings/{MeetingId}/tags?operation=add", "code": 204 } } }, "com.amazonaws.chime#TagMeetingRequest": { "type": "structure", "members": { "MeetingId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.chime#MeetingTagList", "traits": { "smithy.api#documentation": "The tag key-value pairs.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.chime#TagResourceRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Applies the specified tags to the specified Amazon Chime SDK meeting resource.
", "smithy.api#http": { "method": "POST", "uri": "/tags?operation=tag-resource", "code": 204 } } }, "com.amazonaws.chime#TagResourceRequest": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.chime#Arn", "traits": { "smithy.api#documentation": "The resource ARN.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.chime#TagList", "traits": { "smithy.api#documentation": "The tag key-value pairs.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#sensitive": {} } }, "com.amazonaws.chime#TelephonySettings": { "type": "structure", "members": { "InboundCalling": { "target": "com.amazonaws.chime#Boolean", "traits": { "smithy.api#documentation": "Allows or denies inbound calling.
", "smithy.api#required": {} } }, "OutboundCalling": { "target": "com.amazonaws.chime#Boolean", "traits": { "smithy.api#documentation": "Allows or denies outbound calling.
", "smithy.api#required": {} } }, "SMS": { "target": "com.amazonaws.chime#Boolean", "traits": { "smithy.api#documentation": "Allows or denies SMS messaging.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Settings that allow management of telephony permissions for an Amazon Chime user, such as\n inbound and outbound calling and text messaging.
" } }, "com.amazonaws.chime#Termination": { "type": "structure", "members": { "CpsLimit": { "target": "com.amazonaws.chime#CpsLimit", "traits": { "smithy.api#documentation": "The limit on calls per second. Max value based on account service quota. Default value of\n 1.
" } }, "DefaultPhoneNumber": { "target": "com.amazonaws.chime#E164PhoneNumber", "traits": { "smithy.api#documentation": "The default caller ID phone number.
" } }, "CallingRegions": { "target": "com.amazonaws.chime#CallingRegionList", "traits": { "smithy.api#documentation": "The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
" } }, "CidrAllowedList": { "target": "com.amazonaws.chime#StringList", "traits": { "smithy.api#documentation": "The IP addresses allowed to make calls, in CIDR format. Required.
" } }, "Disabled": { "target": "com.amazonaws.chime#Boolean", "traits": { "smithy.api#documentation": "When termination settings are disabled, outbound calls can not be made.
" } } }, "traits": { "smithy.api#documentation": "Termination settings enable your SIP hosts to make outbound calls using your Amazon Chime\n Voice Connector.
" } }, "com.amazonaws.chime#TerminationHealth": { "type": "structure", "members": { "Timestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The timestamp, in ISO 8601 format.
" } }, "Source": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The source IP address.
" } } }, "traits": { "smithy.api#documentation": "The termination health details, including the source IP address and timestamp of the last\n successful SIP OPTIONS message from your SIP infrastructure.
The client exceeded its request rate limit.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.chime#Timestamp": { "type": "timestamp" }, "com.amazonaws.chime#TollFreePrefix": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 3 }, "smithy.api#pattern": "^8(00|33|44|55|66|77|88)$" } }, "com.amazonaws.chime#UCBuzzConsoleService": { "type": "service", "version": "2018-05-01", "operations": [ { "target": "com.amazonaws.chime#AssociatePhoneNumbersWithVoiceConnector" }, { "target": "com.amazonaws.chime#AssociatePhoneNumbersWithVoiceConnectorGroup" }, { "target": "com.amazonaws.chime#AssociatePhoneNumberWithUser" }, { "target": "com.amazonaws.chime#AssociateSigninDelegateGroupsWithAccount" }, { "target": "com.amazonaws.chime#BatchCreateAttendee" }, { "target": "com.amazonaws.chime#BatchCreateChannelMembership" }, { "target": "com.amazonaws.chime#BatchCreateRoomMembership" }, { "target": "com.amazonaws.chime#BatchDeletePhoneNumber" }, { "target": "com.amazonaws.chime#BatchSuspendUser" }, { "target": "com.amazonaws.chime#BatchUnsuspendUser" }, { "target": "com.amazonaws.chime#BatchUpdatePhoneNumber" }, { "target": "com.amazonaws.chime#BatchUpdateUser" }, { "target": "com.amazonaws.chime#CreateAccount" }, { "target": "com.amazonaws.chime#CreateAppInstance" }, { "target": "com.amazonaws.chime#CreateAppInstanceAdmin" }, { "target": "com.amazonaws.chime#CreateAppInstanceUser" }, { "target": "com.amazonaws.chime#CreateAttendee" }, { "target": "com.amazonaws.chime#CreateBot" }, { "target": "com.amazonaws.chime#CreateChannel" }, { "target": "com.amazonaws.chime#CreateChannelBan" }, { "target": "com.amazonaws.chime#CreateChannelMembership" }, { "target": "com.amazonaws.chime#CreateChannelModerator" }, { "target": "com.amazonaws.chime#CreateMeeting" }, { "target": "com.amazonaws.chime#CreateMeetingDialOut" }, { "target": "com.amazonaws.chime#CreateMeetingWithAttendees" }, { "target": "com.amazonaws.chime#CreatePhoneNumberOrder" }, { "target": "com.amazonaws.chime#CreateProxySession" }, { "target": "com.amazonaws.chime#CreateRoom" }, { "target": "com.amazonaws.chime#CreateRoomMembership" }, { "target": "com.amazonaws.chime#CreateSipMediaApplication" }, { "target": "com.amazonaws.chime#CreateSipMediaApplicationCall" }, { "target": "com.amazonaws.chime#CreateSipRule" }, { "target": "com.amazonaws.chime#CreateUser" }, { "target": "com.amazonaws.chime#CreateVoiceConnector" }, { "target": "com.amazonaws.chime#CreateVoiceConnectorGroup" }, { "target": "com.amazonaws.chime#DeleteAccount" }, { "target": "com.amazonaws.chime#DeleteAppInstance" }, { "target": "com.amazonaws.chime#DeleteAppInstanceAdmin" }, { "target": "com.amazonaws.chime#DeleteAppInstanceStreamingConfigurations" }, { "target": "com.amazonaws.chime#DeleteAppInstanceUser" }, { "target": "com.amazonaws.chime#DeleteAttendee" }, { "target": "com.amazonaws.chime#DeleteChannel" }, { "target": "com.amazonaws.chime#DeleteChannelBan" }, { "target": "com.amazonaws.chime#DeleteChannelMembership" }, { "target": "com.amazonaws.chime#DeleteChannelMessage" }, { "target": "com.amazonaws.chime#DeleteChannelModerator" }, { "target": "com.amazonaws.chime#DeleteEventsConfiguration" }, { "target": "com.amazonaws.chime#DeleteMeeting" }, { "target": "com.amazonaws.chime#DeletePhoneNumber" }, { "target": "com.amazonaws.chime#DeleteProxySession" }, { "target": "com.amazonaws.chime#DeleteRoom" }, { "target": "com.amazonaws.chime#DeleteRoomMembership" }, { "target": "com.amazonaws.chime#DeleteSipMediaApplication" }, { "target": "com.amazonaws.chime#DeleteSipRule" }, { "target": "com.amazonaws.chime#DeleteVoiceConnector" }, { "target": "com.amazonaws.chime#DeleteVoiceConnectorEmergencyCallingConfiguration" }, { "target": "com.amazonaws.chime#DeleteVoiceConnectorGroup" }, { "target": "com.amazonaws.chime#DeleteVoiceConnectorOrigination" }, { "target": "com.amazonaws.chime#DeleteVoiceConnectorProxy" }, { "target": "com.amazonaws.chime#DeleteVoiceConnectorStreamingConfiguration" }, { "target": "com.amazonaws.chime#DeleteVoiceConnectorTermination" }, { "target": "com.amazonaws.chime#DeleteVoiceConnectorTerminationCredentials" }, { "target": "com.amazonaws.chime#DescribeAppInstance" }, { "target": "com.amazonaws.chime#DescribeAppInstanceAdmin" }, { "target": "com.amazonaws.chime#DescribeAppInstanceUser" }, { "target": "com.amazonaws.chime#DescribeChannel" }, { "target": "com.amazonaws.chime#DescribeChannelBan" }, { "target": "com.amazonaws.chime#DescribeChannelMembership" }, { "target": "com.amazonaws.chime#DescribeChannelMembershipForAppInstanceUser" }, { "target": "com.amazonaws.chime#DescribeChannelModeratedByAppInstanceUser" }, { "target": "com.amazonaws.chime#DescribeChannelModerator" }, { "target": "com.amazonaws.chime#DisassociatePhoneNumberFromUser" }, { "target": "com.amazonaws.chime#DisassociatePhoneNumbersFromVoiceConnector" }, { "target": "com.amazonaws.chime#DisassociatePhoneNumbersFromVoiceConnectorGroup" }, { "target": "com.amazonaws.chime#DisassociateSigninDelegateGroupsFromAccount" }, { "target": "com.amazonaws.chime#GetAccount" }, { "target": "com.amazonaws.chime#GetAccountSettings" }, { "target": "com.amazonaws.chime#GetAppInstanceRetentionSettings" }, { "target": "com.amazonaws.chime#GetAppInstanceStreamingConfigurations" }, { "target": "com.amazonaws.chime#GetAttendee" }, { "target": "com.amazonaws.chime#GetBot" }, { "target": "com.amazonaws.chime#GetChannelMessage" }, { "target": "com.amazonaws.chime#GetEventsConfiguration" }, { "target": "com.amazonaws.chime#GetGlobalSettings" }, { "target": "com.amazonaws.chime#GetMeeting" }, { "target": "com.amazonaws.chime#GetMessagingSessionEndpoint" }, { "target": "com.amazonaws.chime#GetPhoneNumber" }, { "target": "com.amazonaws.chime#GetPhoneNumberOrder" }, { "target": "com.amazonaws.chime#GetPhoneNumberSettings" }, { "target": "com.amazonaws.chime#GetProxySession" }, { "target": "com.amazonaws.chime#GetRetentionSettings" }, { "target": "com.amazonaws.chime#GetRoom" }, { "target": "com.amazonaws.chime#GetSipMediaApplication" }, { "target": "com.amazonaws.chime#GetSipMediaApplicationLoggingConfiguration" }, { "target": "com.amazonaws.chime#GetSipRule" }, { "target": "com.amazonaws.chime#GetUser" }, { "target": "com.amazonaws.chime#GetUserSettings" }, { "target": "com.amazonaws.chime#GetVoiceConnector" }, { "target": "com.amazonaws.chime#GetVoiceConnectorEmergencyCallingConfiguration" }, { "target": "com.amazonaws.chime#GetVoiceConnectorGroup" }, { "target": "com.amazonaws.chime#GetVoiceConnectorLoggingConfiguration" }, { "target": "com.amazonaws.chime#GetVoiceConnectorOrigination" }, { "target": "com.amazonaws.chime#GetVoiceConnectorProxy" }, { "target": "com.amazonaws.chime#GetVoiceConnectorStreamingConfiguration" }, { "target": "com.amazonaws.chime#GetVoiceConnectorTermination" }, { "target": "com.amazonaws.chime#GetVoiceConnectorTerminationHealth" }, { "target": "com.amazonaws.chime#InviteUsers" }, { "target": "com.amazonaws.chime#ListAccounts" }, { "target": "com.amazonaws.chime#ListAppInstanceAdmins" }, { "target": "com.amazonaws.chime#ListAppInstances" }, { "target": "com.amazonaws.chime#ListAppInstanceUsers" }, { "target": "com.amazonaws.chime#ListAttendees" }, { "target": "com.amazonaws.chime#ListAttendeeTags" }, { "target": "com.amazonaws.chime#ListBots" }, { "target": "com.amazonaws.chime#ListChannelBans" }, { "target": "com.amazonaws.chime#ListChannelMemberships" }, { "target": "com.amazonaws.chime#ListChannelMembershipsForAppInstanceUser" }, { "target": "com.amazonaws.chime#ListChannelMessages" }, { "target": "com.amazonaws.chime#ListChannelModerators" }, { "target": "com.amazonaws.chime#ListChannels" }, { "target": "com.amazonaws.chime#ListChannelsModeratedByAppInstanceUser" }, { "target": "com.amazonaws.chime#ListMeetings" }, { "target": "com.amazonaws.chime#ListMeetingTags" }, { "target": "com.amazonaws.chime#ListPhoneNumberOrders" }, { "target": "com.amazonaws.chime#ListPhoneNumbers" }, { "target": "com.amazonaws.chime#ListProxySessions" }, { "target": "com.amazonaws.chime#ListRoomMemberships" }, { "target": "com.amazonaws.chime#ListRooms" }, { "target": "com.amazonaws.chime#ListSipMediaApplications" }, { "target": "com.amazonaws.chime#ListSipRules" }, { "target": "com.amazonaws.chime#ListSupportedPhoneNumberCountries" }, { "target": "com.amazonaws.chime#ListTagsForResource" }, { "target": "com.amazonaws.chime#ListUsers" }, { "target": "com.amazonaws.chime#ListVoiceConnectorGroups" }, { "target": "com.amazonaws.chime#ListVoiceConnectors" }, { "target": "com.amazonaws.chime#ListVoiceConnectorTerminationCredentials" }, { "target": "com.amazonaws.chime#LogoutUser" }, { "target": "com.amazonaws.chime#PutAppInstanceRetentionSettings" }, { "target": "com.amazonaws.chime#PutAppInstanceStreamingConfigurations" }, { "target": "com.amazonaws.chime#PutEventsConfiguration" }, { "target": "com.amazonaws.chime#PutRetentionSettings" }, { "target": "com.amazonaws.chime#PutSipMediaApplicationLoggingConfiguration" }, { "target": "com.amazonaws.chime#PutVoiceConnectorEmergencyCallingConfiguration" }, { "target": "com.amazonaws.chime#PutVoiceConnectorLoggingConfiguration" }, { "target": "com.amazonaws.chime#PutVoiceConnectorOrigination" }, { "target": "com.amazonaws.chime#PutVoiceConnectorProxy" }, { "target": "com.amazonaws.chime#PutVoiceConnectorStreamingConfiguration" }, { "target": "com.amazonaws.chime#PutVoiceConnectorTermination" }, { "target": "com.amazonaws.chime#PutVoiceConnectorTerminationCredentials" }, { "target": "com.amazonaws.chime#RedactChannelMessage" }, { "target": "com.amazonaws.chime#RedactConversationMessage" }, { "target": "com.amazonaws.chime#RedactRoomMessage" }, { "target": "com.amazonaws.chime#RegenerateSecurityToken" }, { "target": "com.amazonaws.chime#ResetPersonalPIN" }, { "target": "com.amazonaws.chime#RestorePhoneNumber" }, { "target": "com.amazonaws.chime#SearchAvailablePhoneNumbers" }, { "target": "com.amazonaws.chime#SendChannelMessage" }, { "target": "com.amazonaws.chime#TagAttendee" }, { "target": "com.amazonaws.chime#TagMeeting" }, { "target": "com.amazonaws.chime#TagResource" }, { "target": "com.amazonaws.chime#UntagAttendee" }, { "target": "com.amazonaws.chime#UntagMeeting" }, { "target": "com.amazonaws.chime#UntagResource" }, { "target": "com.amazonaws.chime#UpdateAccount" }, { "target": "com.amazonaws.chime#UpdateAccountSettings" }, { "target": "com.amazonaws.chime#UpdateAppInstance" }, { "target": "com.amazonaws.chime#UpdateAppInstanceUser" }, { "target": "com.amazonaws.chime#UpdateBot" }, { "target": "com.amazonaws.chime#UpdateChannel" }, { "target": "com.amazonaws.chime#UpdateChannelMessage" }, { "target": "com.amazonaws.chime#UpdateChannelReadMarker" }, { "target": "com.amazonaws.chime#UpdateGlobalSettings" }, { "target": "com.amazonaws.chime#UpdatePhoneNumber" }, { "target": "com.amazonaws.chime#UpdatePhoneNumberSettings" }, { "target": "com.amazonaws.chime#UpdateProxySession" }, { "target": "com.amazonaws.chime#UpdateRoom" }, { "target": "com.amazonaws.chime#UpdateRoomMembership" }, { "target": "com.amazonaws.chime#UpdateSipMediaApplication" }, { "target": "com.amazonaws.chime#UpdateSipRule" }, { "target": "com.amazonaws.chime#UpdateUser" }, { "target": "com.amazonaws.chime#UpdateUserSettings" }, { "target": "com.amazonaws.chime#UpdateVoiceConnector" }, { "target": "com.amazonaws.chime#UpdateVoiceConnectorGroup" } ], "traits": { "aws.api#service": { "sdkId": "Chime", "arnNamespace": "chime", "cloudFormationName": "Chime", "cloudTrailEventSource": "chime.amazonaws.com", "endpointPrefix": "chime" }, "aws.auth#sigv4": { "name": "chime" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "The Amazon Chime API (application programming interface) is designed for developers to\n perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice\n Connectors. This guide provides detailed information about the Amazon Chime API,\n including operations, types, inputs and outputs, and error codes. It also includes some\n server-side API actions to use with the Amazon Chime SDK. For more information about the\n Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the Amazon Chime Developer Guide.
\nYou can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the \n AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.
\n\nYou don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the \nAWS Developer Center.\n
\nUse your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see \nInstalling the AWS Command Line Interface\nin the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the \nAmazon Chime commands in the \n AWS CLI Command Reference.\n
\nIf you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see \nSignature Version 4 Signing Process\nin the Amazon Web Services General Reference.
\n\nWhen making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.
Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see \nIdentity and Access Management for Amazon Chime\nin the Amazon Chime Administration Guide.
", "smithy.api#title": "Amazon Chime" } }, "com.amazonaws.chime#UnauthorizedClientException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.chime#ErrorCode" }, "Message": { "target": "com.amazonaws.chime#String" } }, "traits": { "smithy.api#documentation": "The client is not currently authorized to make the request.
", "smithy.api#error": "client", "smithy.api#httpError": 401 } }, "com.amazonaws.chime#UnprocessableEntityException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.chime#ErrorCode" }, "Message": { "target": "com.amazonaws.chime#String" } }, "traits": { "smithy.api#documentation": "The request was well-formed but was unable to be followed due to semantic errors.
", "smithy.api#error": "client", "smithy.api#httpError": 422 } }, "com.amazonaws.chime#UntagAttendee": { "type": "operation", "input": { "target": "com.amazonaws.chime#UntagAttendeeRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Untags the specified tags from the specified Amazon Chime SDK attendee.
", "smithy.api#http": { "method": "POST", "uri": "/meetings/{MeetingId}/attendees/{AttendeeId}/tags?operation=delete", "code": 204 } } }, "com.amazonaws.chime#UntagAttendeeRequest": { "type": "structure", "members": { "MeetingId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AttendeeId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK attendee ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.chime#AttendeeTagKeyList", "traits": { "smithy.api#documentation": "The tag keys.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#UntagMeeting": { "type": "operation", "input": { "target": "com.amazonaws.chime#UntagMeetingRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Untags the specified tags from the specified Amazon Chime SDK meeting.
", "smithy.api#http": { "method": "POST", "uri": "/meetings/{MeetingId}/tags?operation=delete", "code": 204 } } }, "com.amazonaws.chime#UntagMeetingRequest": { "type": "structure", "members": { "MeetingId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "The Amazon Chime SDK meeting ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.chime#MeetingTagKeyList", "traits": { "smithy.api#documentation": "The tag keys.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.chime#UntagResourceRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Untags the specified tags from the specified Amazon Chime SDK meeting resource.
", "smithy.api#http": { "method": "POST", "uri": "/tags?operation=untag-resource", "code": 204 } } }, "com.amazonaws.chime#UntagResourceRequest": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.chime#Arn", "traits": { "smithy.api#documentation": "The resource ARN.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.chime#TagKeyList", "traits": { "smithy.api#documentation": "The tag keys.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#UpdateAccount": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdateAccountRequest" }, "output": { "target": "com.amazonaws.chime#UpdateAccountResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Updates account details for the specified Amazon Chime account. Currently, only account name\n updates are supported for this action.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}", "code": 200 } } }, "com.amazonaws.chime#UpdateAccountRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.chime#AccountName", "traits": { "smithy.api#documentation": "The new name for the specified Amazon Chime account.
" } } } }, "com.amazonaws.chime#UpdateAccountResponse": { "type": "structure", "members": { "Account": { "target": "com.amazonaws.chime#Account", "traits": { "smithy.api#documentation": "The updated Amazon Chime account details.
" } } } }, "com.amazonaws.chime#UpdateAccountSettings": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdateAccountSettingsRequest" }, "output": { "target": "com.amazonaws.chime#UpdateAccountSettingsResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Updates the settings for the specified Amazon Chime account. You can update settings for\n remote control of shared screens, or for the dial-out option. For more information about\n these settings, see Use\n the Policies Page in the Amazon Chime Administration\n Guide.
", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AccountId}/settings", "code": 204 } } }, "com.amazonaws.chime#UpdateAccountSettingsRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AccountSettings": { "target": "com.amazonaws.chime#AccountSettings", "traits": { "smithy.api#documentation": "The Amazon Chime account settings to update.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#UpdateAccountSettingsResponse": { "type": "structure", "members": {} }, "com.amazonaws.chime#UpdateAppInstance": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdateAppInstanceRequest" }, "output": { "target": "com.amazonaws.chime#UpdateAppInstanceResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Updates AppInstance metadata.
The ARN of the AppInstance.
The name that you want to change.
", "smithy.api#required": {} } }, "Metadata": { "target": "com.amazonaws.chime#Metadata", "traits": { "smithy.api#documentation": "The metadata that you want to change.
" } } } }, "com.amazonaws.chime#UpdateAppInstanceResponse": { "type": "structure", "members": { "AppInstanceArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the AppInstance.
Updates the details of an AppInstanceUser. You can update names and metadata.
The ARN of the AppInstanceUser.
The name of the AppInstanceUser.
The metadata of the AppInstanceUser.
The ARN of the AppInstanceUser.
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/bots/{BotId}", "code": 200 } } }, "com.amazonaws.chime#UpdateBotRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BotId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The bot ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Disabled": { "target": "com.amazonaws.chime#NullableBoolean", "traits": { "smithy.api#documentation": "When true, stops the specified bot from running in your account.
" } } } }, "com.amazonaws.chime#UpdateBotResponse": { "type": "structure", "members": { "Bot": { "target": "com.amazonaws.chime#Bot", "traits": { "smithy.api#documentation": "The updated bot details.
" } } } }, "com.amazonaws.chime#UpdateChannel": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdateChannelRequest" }, "output": { "target": "com.amazonaws.chime#UpdateChannelResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Update a channel's attributes.
\n\n Restriction: You can't change a channel's privacy.\n
\n\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
Updates the content of a message.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
The ARN of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MessageId": { "target": "com.amazonaws.chime#MessageId", "traits": { "smithy.api#documentation": "The ID string of the message being updated.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Content": { "target": "com.amazonaws.chime#Content", "traits": { "smithy.api#documentation": "The content of the message being updated.
" } }, "Metadata": { "target": "com.amazonaws.chime#Metadata", "traits": { "smithy.api#documentation": "The metadata of the message being updated.
" } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
" } }, "MessageId": { "target": "com.amazonaws.chime#MessageId", "traits": { "smithy.api#documentation": "The ID string of the message being updated.
" } } } }, "com.amazonaws.chime#UpdateChannelReadMarker": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdateChannelReadMarkerRequest" }, "output": { "target": "com.amazonaws.chime#UpdateChannelReadMarkerResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "The details of the time when a user last read messages in a channel.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.
The ARN of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
" } } } }, "com.amazonaws.chime#UpdateChannelRequest": { "type": "structure", "members": { "ChannelArn": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.chime#NonEmptyResourceName", "traits": { "smithy.api#documentation": "The name of the channel.
", "smithy.api#required": {} } }, "Mode": { "target": "com.amazonaws.chime#ChannelMode", "traits": { "smithy.api#documentation": "The mode of the update request.
", "smithy.api#required": {} } }, "Metadata": { "target": "com.amazonaws.chime#Metadata", "traits": { "smithy.api#documentation": "The metadata for the update request.
" } }, "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
" } } } }, "com.amazonaws.chime#UpdateGlobalSettings": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdateGlobalSettingsRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
", "smithy.api#http": { "method": "PUT", "uri": "/settings", "code": 204 } } }, "com.amazonaws.chime#UpdateGlobalSettingsRequest": { "type": "structure", "members": { "BusinessCalling": { "target": "com.amazonaws.chime#BusinessCallingSettings", "traits": { "smithy.api#documentation": "The Amazon Chime Business Calling settings.
", "smithy.api#required": {} } }, "VoiceConnector": { "target": "com.amazonaws.chime#VoiceConnectorSettings", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector settings.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#UpdatePhoneNumber": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdatePhoneNumberRequest" }, "output": { "target": "com.amazonaws.chime#UpdatePhoneNumberResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number \n detail at a time. For example, you can update either the product type or the calling name in one action.
\n \nFor toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the \n Amazon Chime SIP Media Application Dial-In product type.
\n \nUpdates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you \n can request another update.
", "smithy.api#http": { "method": "POST", "uri": "/phone-numbers/{PhoneNumberId}", "code": 200 } } }, "com.amazonaws.chime#UpdatePhoneNumberRequest": { "type": "structure", "members": { "PhoneNumberId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The phone number ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ProductType": { "target": "com.amazonaws.chime#PhoneNumberProductType", "traits": { "smithy.api#documentation": "The product type.
" } }, "CallingName": { "target": "com.amazonaws.chime#CallingName", "traits": { "smithy.api#documentation": "The outbound calling name associated with the phone number.
" } } } }, "com.amazonaws.chime#UpdatePhoneNumberRequestItem": { "type": "structure", "members": { "PhoneNumberId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The phone number ID to update.
", "smithy.api#required": {} } }, "ProductType": { "target": "com.amazonaws.chime#PhoneNumberProductType", "traits": { "smithy.api#documentation": "The product type to update.
" } }, "CallingName": { "target": "com.amazonaws.chime#CallingName", "traits": { "smithy.api#documentation": "The outbound calling name to update.
" } } }, "traits": { "smithy.api#documentation": "The phone number ID, product type, or calling name fields to update, used with the \nBatchUpdatePhoneNumber and UpdatePhoneNumber actions.
" } }, "com.amazonaws.chime#UpdatePhoneNumberRequestItemList": { "type": "list", "member": { "target": "com.amazonaws.chime#UpdatePhoneNumberRequestItem" } }, "com.amazonaws.chime#UpdatePhoneNumberResponse": { "type": "structure", "members": { "PhoneNumber": { "target": "com.amazonaws.chime#PhoneNumber", "traits": { "smithy.api#documentation": "The updated phone number details.
" } } } }, "com.amazonaws.chime#UpdatePhoneNumberSettings": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdatePhoneNumberSettingsRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Updates the phone number settings for the administrator's AWS account, such as the default\n outbound calling name. You can update the default outbound calling name once every seven\n days. Outbound calling names can take up to 72 hours to update.
", "smithy.api#http": { "method": "PUT", "uri": "/settings/phone-number", "code": 204 } } }, "com.amazonaws.chime#UpdatePhoneNumberSettingsRequest": { "type": "structure", "members": { "CallingName": { "target": "com.amazonaws.chime#CallingName", "traits": { "smithy.api#documentation": "The default outbound calling name for the account.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#UpdateProxySession": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdateProxySessionRequest" }, "output": { "target": "com.amazonaws.chime#UpdateProxySessionResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Updates the specified proxy session details, such as voice or SMS capabilities.
", "smithy.api#http": { "method": "POST", "uri": "/voice-connectors/{VoiceConnectorId}/proxy-sessions/{ProxySessionId}", "code": 201 } } }, "com.amazonaws.chime#UpdateProxySessionRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString128", "traits": { "smithy.api#documentation": "The Amazon Chime voice connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ProxySessionId": { "target": "com.amazonaws.chime#NonEmptyString128", "traits": { "smithy.api#documentation": "The proxy session ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Capabilities": { "target": "com.amazonaws.chime#CapabilityList", "traits": { "smithy.api#documentation": "The proxy session capabilities.
", "smithy.api#required": {} } }, "ExpiryMinutes": { "target": "com.amazonaws.chime#PositiveInteger", "traits": { "smithy.api#documentation": "The number of minutes allowed for the proxy session.
" } } } }, "com.amazonaws.chime#UpdateProxySessionResponse": { "type": "structure", "members": { "ProxySession": { "target": "com.amazonaws.chime#ProxySession", "traits": { "smithy.api#documentation": "The proxy session details.
" } } } }, "com.amazonaws.chime#UpdateRoom": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdateRoomRequest" }, "output": { "target": "com.amazonaws.chime#UpdateRoomResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/rooms/{RoomId}", "code": 200 } } }, "com.amazonaws.chime#UpdateRoomMembership": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdateRoomMembershipRequest" }, "output": { "target": "com.amazonaws.chime#UpdateRoomMembershipResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Updates room membership details, such as the member role, for a room in an Amazon Chime\n Enterprise account. The member role designates whether the member is a chat room\n administrator or a general chat room member. The member role can be updated only for\n user IDs.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/rooms/{RoomId}/memberships/{MemberId}", "code": 200 } } }, "com.amazonaws.chime#UpdateRoomMembershipRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RoomId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The room ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MemberId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The member ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Role": { "target": "com.amazonaws.chime#RoomMembershipRole", "traits": { "smithy.api#documentation": "The role of the member.
" } } } }, "com.amazonaws.chime#UpdateRoomMembershipResponse": { "type": "structure", "members": { "RoomMembership": { "target": "com.amazonaws.chime#RoomMembership", "traits": { "smithy.api#documentation": "The room membership details.
" } } } }, "com.amazonaws.chime#UpdateRoomRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RoomId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The room ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.chime#SensitiveString", "traits": { "smithy.api#documentation": "The room name.
" } } } }, "com.amazonaws.chime#UpdateRoomResponse": { "type": "structure", "members": { "Room": { "target": "com.amazonaws.chime#Room", "traits": { "smithy.api#documentation": "The room details.
" } } } }, "com.amazonaws.chime#UpdateSipMediaApplication": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdateSipMediaApplicationRequest" }, "output": { "target": "com.amazonaws.chime#UpdateSipMediaApplicationResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Updates the details of the specified SIP media application.
", "smithy.api#http": { "method": "PUT", "uri": "/sip-media-applications/{SipMediaApplicationId}", "code": 200 } } }, "com.amazonaws.chime#UpdateSipMediaApplicationRequest": { "type": "structure", "members": { "SipMediaApplicationId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The SIP media application ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.chime#SipMediaApplicationName", "traits": { "smithy.api#documentation": "The new name for the specified SIP media application.
" } }, "Endpoints": { "target": "com.amazonaws.chime#SipMediaApplicationEndpointList", "traits": { "smithy.api#documentation": "The new set of endpoints for the specified SIP media application.
" } } } }, "com.amazonaws.chime#UpdateSipMediaApplicationResponse": { "type": "structure", "members": { "SipMediaApplication": { "target": "com.amazonaws.chime#SipMediaApplication", "traits": { "smithy.api#documentation": "The updated SIP media application details.
" } } } }, "com.amazonaws.chime#UpdateSipRule": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdateSipRuleRequest" }, "output": { "target": "com.amazonaws.chime#UpdateSipRuleResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ResourceLimitExceededException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Updates the details of the specified SIP rule.
", "smithy.api#http": { "method": "PUT", "uri": "/sip-rules/{SipRuleId}", "code": 202 } } }, "com.amazonaws.chime#UpdateSipRuleRequest": { "type": "structure", "members": { "SipRuleId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The SIP rule ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.chime#SipRuleName", "traits": { "smithy.api#documentation": "The new name for the specified SIP rule.
", "smithy.api#required": {} } }, "Disabled": { "target": "com.amazonaws.chime#NullableBoolean", "traits": { "smithy.api#documentation": "The new value specified to indicate whether the rule is disabled.
" } }, "TargetApplications": { "target": "com.amazonaws.chime#SipRuleTargetApplicationList", "traits": { "smithy.api#documentation": "The new value of the list of target applications.
" } } } }, "com.amazonaws.chime#UpdateSipRuleResponse": { "type": "structure", "members": { "SipRule": { "target": "com.amazonaws.chime#SipRule", "traits": { "smithy.api#documentation": "Updated SIP rule details.
" } } } }, "com.amazonaws.chime#UpdateUser": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdateUserRequest" }, "output": { "target": "com.amazonaws.chime#UpdateUserResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "\nUpdates user details for a specified user ID. Currently, only \nLicenseType\nupdates are supported for this action.\n
The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The user ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LicenseType": { "target": "com.amazonaws.chime#License", "traits": { "smithy.api#documentation": "The user license type to update. This must be a supported license type for the Amazon Chime\n account that the user belongs to.
" } }, "UserType": { "target": "com.amazonaws.chime#UserType", "traits": { "smithy.api#documentation": "The user type.
" } }, "AlexaForBusinessMetadata": { "target": "com.amazonaws.chime#AlexaForBusinessMetadata", "traits": { "smithy.api#documentation": "The Alexa for Business metadata.
" } } } }, "com.amazonaws.chime#UpdateUserRequestItem": { "type": "structure", "members": { "UserId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The user ID.
", "smithy.api#required": {} } }, "LicenseType": { "target": "com.amazonaws.chime#License", "traits": { "smithy.api#documentation": "The user license type.
" } }, "UserType": { "target": "com.amazonaws.chime#UserType", "traits": { "smithy.api#documentation": "The user type.
" } }, "AlexaForBusinessMetadata": { "target": "com.amazonaws.chime#AlexaForBusinessMetadata", "traits": { "smithy.api#documentation": "The Alexa for Business metadata.
" } } }, "traits": { "smithy.api#documentation": "The user ID and user fields to update, used with the \nBatchUpdateUser action.
" } }, "com.amazonaws.chime#UpdateUserRequestItemList": { "type": "list", "member": { "target": "com.amazonaws.chime#UpdateUserRequestItem" }, "traits": { "smithy.api#length": { "min": 0, "max": 20 } } }, "com.amazonaws.chime#UpdateUserResponse": { "type": "structure", "members": { "User": { "target": "com.amazonaws.chime#User", "traits": { "smithy.api#documentation": "The updated user details.
" } } } }, "com.amazonaws.chime#UpdateUserSettings": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdateUserSettingsRequest" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Updates the settings for the specified user, such as phone number settings.
", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AccountId}/users/{UserId}/settings", "code": 204 } } }, "com.amazonaws.chime#UpdateUserSettingsRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The user ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "UserSettings": { "target": "com.amazonaws.chime#UserSettings", "traits": { "smithy.api#documentation": "The user settings to update.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#UpdateVoiceConnector": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdateVoiceConnectorRequest" }, "output": { "target": "com.amazonaws.chime#UpdateVoiceConnectorResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Updates details for the specified Amazon Chime Voice Connector.
", "smithy.api#http": { "method": "PUT", "uri": "/voice-connectors/{VoiceConnectorId}", "code": 200 } } }, "com.amazonaws.chime#UpdateVoiceConnectorGroup": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdateVoiceConnectorGroupRequest" }, "output": { "target": "com.amazonaws.chime#UpdateVoiceConnectorGroupResponse" }, "errors": [ { "target": "com.amazonaws.chime#BadRequestException" }, { "target": "com.amazonaws.chime#ConflictException" }, { "target": "com.amazonaws.chime#ForbiddenException" }, { "target": "com.amazonaws.chime#NotFoundException" }, { "target": "com.amazonaws.chime#ServiceFailureException" }, { "target": "com.amazonaws.chime#ServiceUnavailableException" }, { "target": "com.amazonaws.chime#ThrottledClientException" }, { "target": "com.amazonaws.chime#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Updates details of the specified Amazon Chime Voice Connector group, such as the name and\n Amazon Chime Voice Connector priority ranking.
", "smithy.api#http": { "method": "PUT", "uri": "/voice-connector-groups/{VoiceConnectorGroupId}", "code": 202 } } }, "com.amazonaws.chime#UpdateVoiceConnectorGroupRequest": { "type": "structure", "members": { "VoiceConnectorGroupId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector group ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.chime#VoiceConnectorGroupName", "traits": { "smithy.api#documentation": "The name of the Amazon Chime Voice Connector group.
", "smithy.api#required": {} } }, "VoiceConnectorItems": { "target": "com.amazonaws.chime#VoiceConnectorItemList", "traits": { "smithy.api#documentation": "The VoiceConnectorItems to associate with the group.
The updated Amazon Chime Voice Connector group details.
" } } } }, "com.amazonaws.chime#UpdateVoiceConnectorRequest": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.chime#VoiceConnectorName", "traits": { "smithy.api#documentation": "The name of the Amazon Chime Voice Connector.
", "smithy.api#required": {} } }, "RequireEncryption": { "target": "com.amazonaws.chime#Boolean", "traits": { "smithy.api#documentation": "When enabled, requires encryption for the Amazon Chime Voice Connector.
", "smithy.api#required": {} } } } }, "com.amazonaws.chime#UpdateVoiceConnectorResponse": { "type": "structure", "members": { "VoiceConnector": { "target": "com.amazonaws.chime#VoiceConnector", "traits": { "smithy.api#documentation": "The updated Amazon Chime Voice Connector details.
" } } } }, "com.amazonaws.chime#UriType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 4096 } } }, "com.amazonaws.chime#UrlType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 4096 } } }, "com.amazonaws.chime#User": { "type": "structure", "members": { "UserId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The user ID.
", "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The Amazon Chime account ID.
" } }, "PrimaryEmail": { "target": "com.amazonaws.chime#EmailAddress", "traits": { "smithy.api#documentation": "The primary email address of the user.
" } }, "PrimaryProvisionedNumber": { "target": "com.amazonaws.chime#SensitiveString", "traits": { "smithy.api#documentation": "The primary phone number associated with the user.
" } }, "DisplayName": { "target": "com.amazonaws.chime#SensitiveString", "traits": { "smithy.api#documentation": "The display name of the user.
" } }, "LicenseType": { "target": "com.amazonaws.chime#License", "traits": { "smithy.api#documentation": "The license type for the user.
" } }, "UserType": { "target": "com.amazonaws.chime#UserType", "traits": { "smithy.api#documentation": "The user type.
" } }, "UserRegistrationStatus": { "target": "com.amazonaws.chime#RegistrationStatus", "traits": { "smithy.api#documentation": "The user registration status.
" } }, "UserInvitationStatus": { "target": "com.amazonaws.chime#InviteStatus", "traits": { "smithy.api#documentation": "The user invite status.
" } }, "RegisteredOn": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "Date and time when the user is registered, in ISO 8601 format.
" } }, "InvitedOn": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
" } }, "AlexaForBusinessMetadata": { "target": "com.amazonaws.chime#AlexaForBusinessMetadata", "traits": { "smithy.api#documentation": "The Alexa for Business metadata.
" } }, "PersonalPIN": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The user's personal meeting PIN.
" } } }, "traits": { "smithy.api#documentation": "The user on the Amazon Chime account.
" } }, "com.amazonaws.chime#UserEmailList": { "type": "list", "member": { "target": "com.amazonaws.chime#EmailAddress" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.chime#UserError": { "type": "structure", "members": { "UserId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The user ID for which the action failed.
" } }, "ErrorCode": { "target": "com.amazonaws.chime#ErrorCode", "traits": { "smithy.api#documentation": "The error code.
" } }, "ErrorMessage": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The error message.
" } } }, "traits": { "smithy.api#documentation": "The list of errors returned when errors are encountered during the BatchSuspendUser, BatchUnsuspendUser, or BatchUpdateUser actions. This includes user IDs, error codes, and error\n messages.
" } }, "com.amazonaws.chime#UserErrorList": { "type": "list", "member": { "target": "com.amazonaws.chime#UserError" } }, "com.amazonaws.chime#UserId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "[A-Za-z0-9]([A-Za-z0-9\\:\\-\\_\\.\\@]{0,62}[A-Za-z0-9])?", "smithy.api#sensitive": {} } }, "com.amazonaws.chime#UserIdList": { "type": "list", "member": { "target": "com.amazonaws.chime#NonEmptyString" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.chime#UserList": { "type": "list", "member": { "target": "com.amazonaws.chime#User" } }, "com.amazonaws.chime#UserName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": ".*\\S.*", "smithy.api#sensitive": {} } }, "com.amazonaws.chime#UserSettings": { "type": "structure", "members": { "Telephony": { "target": "com.amazonaws.chime#TelephonySettings", "traits": { "smithy.api#documentation": "The telephony settings associated with the user.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Settings associated with an Amazon Chime user, including inbound and outbound calling and text\n messaging.
" } }, "com.amazonaws.chime#UserType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "PrivateUser", "name": "PrivateUser" }, { "value": "SharedDevice", "name": "SharedDevice" } ] } }, "com.amazonaws.chime#VoiceConnector": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
" } }, "AwsRegion": { "target": "com.amazonaws.chime#VoiceConnectorAwsRegion", "traits": { "smithy.api#documentation": "\nThe AWS Region in which the Amazon Chime Voice Connector is created. Default: \nus-east-1.\n
The name of the Amazon Chime Voice Connector.
" } }, "OutboundHostName": { "target": "com.amazonaws.chime#String", "traits": { "smithy.api#documentation": "The outbound host name for the Amazon Chime Voice Connector.
" } }, "RequireEncryption": { "target": "com.amazonaws.chime#Boolean", "traits": { "smithy.api#documentation": "Designates whether encryption is required for the Amazon Chime Voice Connector.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
" } } }, "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector configuration, including outbound host name and encryption\n settings.
" } }, "com.amazonaws.chime#VoiceConnectorAwsRegion": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "us-east-1", "name": "US_EAST_1" }, { "value": "us-west-2", "name": "US_WEST_2" } ] } }, "com.amazonaws.chime#VoiceConnectorGroup": { "type": "structure", "members": { "VoiceConnectorGroupId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector group ID.
" } }, "Name": { "target": "com.amazonaws.chime#VoiceConnectorGroupName", "traits": { "smithy.api#documentation": "The name of the Amazon Chime Voice Connector group.
" } }, "VoiceConnectorItems": { "target": "com.amazonaws.chime#VoiceConnectorItemList", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connectors to which to route inbound calls.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.
" } }, "UpdatedTimestamp": { "target": "com.amazonaws.chime#Iso8601Timestamp", "traits": { "smithy.api#documentation": "The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
" } } }, "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector group configuration, including associated Amazon Chime Voice\n Connectors. You can include Amazon Chime Voice Connectors from different AWS Regions in\n your group. This creates a fault tolerant mechanism for fallback in case of availability\n events.
" } }, "com.amazonaws.chime#VoiceConnectorGroupList": { "type": "list", "member": { "target": "com.amazonaws.chime#VoiceConnectorGroup" } }, "com.amazonaws.chime#VoiceConnectorGroupName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.chime#VoiceConnectorItem": { "type": "structure", "members": { "VoiceConnectorId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector ID.
", "smithy.api#required": {} } }, "Priority": { "target": "com.amazonaws.chime#VoiceConnectorItemPriority", "traits": { "smithy.api#documentation": "The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 \nVoiceConnectorItems\nper Amazon Chime Voice Connector group.
The Amazon S3 bucket designated for call detail record storage.
" } } }, "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector settings. Includes any Amazon S3 buckets designated for\n storing call detail records.
" } } } }