{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.chime#AccessDeniedException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.chime#ErrorCode" }, "Message": { "target": "com.amazonaws.chime#String" } }, "traits": { "smithy.api#documentation": "
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 \n Managing Your 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.
" } }, "AccountStatus": { "target": "com.amazonaws.chime#AccountStatus", "traits": { "smithy.api#documentation": "The status of the 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 phone number option. For more information, see \n Join a Meeting 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 Chime web application. For more information about these settings, see \n Use the Policies Page in the Amazon Chime Administration Guide.
" } }, "com.amazonaws.chime#AccountStatus": { "type": "enum", "members": { "Suspended": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Suspended" } }, "Active": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Active" } } } }, "com.amazonaws.chime#AccountType": { "type": "enum", "members": { "Team": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Team" } }, "EnterpriseDirectory": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EnterpriseDirectory" } }, "EnterpriseLWA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EnterpriseLWA" } }, "EnterpriseOIDC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "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#AssociatePhoneNumberWithUser": { "type": "operation", "input": { "target": "com.amazonaws.chime#AssociatePhoneNumberWithUserRequest" }, "output": { "target": "com.amazonaws.chime#AssociatePhoneNumberWithUserResponse" }, "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 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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#AssociatePhoneNumberWithUserResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#AssociateSigninDelegateGroupsWithAccountResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chime#BadRequestException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.chime#ErrorCode" }, "Message": { "target": "com.amazonaws.chime#String" } }, "traits": { "smithy.api#documentation": "The input parameters don't match the service's restrictions.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "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 \n 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": {} } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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\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": {} } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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 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 EnterpriseLWA account users, use the \n BatchUnsuspendUser action.
\nTo sign out users without suspending them, use the \nLogoutUser action.
", "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": {} } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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 account types, see \n \n Managing Your Amazon Chime Accounts\n in the account types, in the Amazon Chime Administration Guide.\n
Previously suspended users who are unsuspended using this action are returned to \nRegistered\nstatus. Users who are not previously suspended are ignored.
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": {} } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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 UpdatePhoneNumberRequestItem. For example, you can update the product type or the calling name.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
\nUpdates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
", "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": {} } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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": "Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.
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": {} } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chime#Boolean": { "type": "boolean" }, "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": "enum", "members": { "ChatBot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "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": "enum", "members": { "Unassigned": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Unassigned" } }, "UpdateInProgress": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdateInProgress" } }, "UpdateSucceeded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdateSucceeded" } }, "UpdateFailed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdateFailed" } } } }, "com.amazonaws.chime#ClientRequestToken": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 64 }, "smithy.api#pattern": "^[-_a-zA-Z0-9]*$", "smithy.api#sensitive": {} } }, "com.amazonaws.chime#ConflictException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.chime#ErrorCode" }, "Message": { "target": "com.amazonaws.chime#String" } }, "traits": { "smithy.api#documentation": "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#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#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 different account types, see \n Managing Your Amazon Chime Accounts in the Amazon Chime \n Administration Guide.
The name of the Amazon Chime account.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#CreateAccountResponse": { "type": "structure", "members": { "Account": { "target": "com.amazonaws.chime#Account", "traits": { "smithy.api#documentation": "The Amazon Chime account details.
" } } }, "traits": { "smithy.api#output": {} } }, "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.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#CreateBotResponse": { "type": "structure", "members": { "Bot": { "target": "com.amazonaws.chime#Bot", "traits": { "smithy.api#documentation": "The bot details.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chime#CreateMeetingDialOut": { "type": "operation", "input": { "target": "com.amazonaws.chime#CreateMeetingDialOutRequest" }, "output": { "target": "com.amazonaws.chime#CreateMeetingDialOutResponse" }, "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": "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.
\nTo play welcome audio or implement an interactive voice response (IVR), use the \nCreateSipMediaApplicationCall action with the corresponding SIP media application ID.
\n This API is not available in a dedicated namespace.\n
\nThe 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 CreateAttendee action to get a join token.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#CreateMeetingDialOutResponse": { "type": "structure", "members": { "TransactionId": { "target": "com.amazonaws.chime#GuidString", "traits": { "smithy.api#documentation": "Unique ID that tracks API calls.
" } } }, "traits": { "smithy.api#output": {} } }, "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 use the Amazon Chime Business Calling product type. \n For numbers outside the U.S., 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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#CreatePhoneNumberOrderResponse": { "type": "structure", "members": { "PhoneNumberOrder": { "target": "com.amazonaws.chime#PhoneNumberOrder", "traits": { "smithy.api#documentation": "The phone number order details.
" } } }, "traits": { "smithy.api#output": {} } }, "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.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#CreateRoomMembershipResponse": { "type": "structure", "members": { "RoomMembership": { "target": "com.amazonaws.chime#RoomMembership", "traits": { "smithy.api#documentation": "The room membership details.
" } } }, "traits": { "smithy.api#output": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#CreateRoomResponse": { "type": "structure", "members": { "Room": { "target": "com.amazonaws.chime#Room", "traits": { "smithy.api#documentation": "The room details.
" } } }, "traits": { "smithy.api#output": {} } }, "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.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#CreateUserResponse": { "type": "structure", "members": { "User": { "target": "com.amazonaws.chime#User", "traits": { "smithy.api#documentation": "The user on the Amazon Chime account.
" } } }, "traits": { "smithy.api#output": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#DeleteAccountResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chime#DeleteEventsConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteEventsConfigurationRequest" }, "output": { "target": "smithy.api#Unit" }, "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#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#DeletePhoneNumber": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeletePhoneNumberRequest" }, "output": { "target": "smithy.api#Unit" }, "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 queue. A\n phone number must be disassociated from any users or Amazon Chime Voice Connectors\n before it can be deleted.
\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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#DeleteRoom": { "type": "operation", "input": { "target": "com.amazonaws.chime#DeleteRoomRequest" }, "output": { "target": "smithy.api#Unit" }, "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" }, "output": { "target": "smithy.api#Unit" }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "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 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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#DisassociatePhoneNumberFromUserResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#DisassociateSigninDelegateGroupsFromAccountResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "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": "enum", "members": { "NotSent": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NotSent" } }, "Sent": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Sent" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } } } }, "com.amazonaws.chime#ErrorCode": { "type": "enum", "members": { "BadRequest": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BadRequest" } }, "Conflict": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Conflict" } }, "Forbidden": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Forbidden" } }, "NotFound": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NotFound" } }, "PreconditionFailed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PreconditionFailed" } }, "ResourceLimitExceeded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ResourceLimitExceeded" } }, "ServiceFailure": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ServiceFailure" } }, "AccessDenied": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AccessDenied" } }, "ServiceUnavailable": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ServiceUnavailable" } }, "Throttled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Throttled" } }, "Throttling": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Throttling" } }, "Unauthorized": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Unauthorized" } }, "Unprocessable": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Unprocessable" } }, "VoiceConnectorGroupAssociationsExist": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VoiceConnectorGroupAssociationsExist" } }, "PhoneNumberAssociationsExist": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "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#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#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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#GetAccountResponse": { "type": "structure", "members": { "Account": { "target": "com.amazonaws.chime#Account", "traits": { "smithy.api#documentation": "The Amazon Chime account details.
" } } }, "traits": { "smithy.api#output": {} } }, "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 \n Use the Policies Page in the Amazon Chime Administration Guide.\n
", "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#GetAccountSettingsResponse": { "type": "structure", "members": { "AccountSettings": { "target": "com.amazonaws.chime#AccountSettings", "traits": { "smithy.api#documentation": "The Amazon Chime account settings.
" } } }, "traits": { "smithy.api#output": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#GetBotResponse": { "type": "structure", "members": { "Bot": { "target": "com.amazonaws.chime#Bot", "traits": { "smithy.api#documentation": "The chat bot details.
" } } }, "traits": { "smithy.api#output": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#GetEventsConfigurationResponse": { "type": "structure", "members": { "EventsConfiguration": { "target": "com.amazonaws.chime#EventsConfiguration", "traits": { "smithy.api#documentation": "The events configuration details.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chime#GetGlobalSettings": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#GetPhoneNumberOrderResponse": { "type": "structure", "members": { "PhoneNumberOrder": { "target": "com.amazonaws.chime#PhoneNumberOrder", "traits": { "smithy.api#documentation": "The phone number order details.
" } } }, "traits": { "smithy.api#output": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#GetPhoneNumberResponse": { "type": "structure", "members": { "PhoneNumber": { "target": "com.amazonaws.chime#PhoneNumber", "traits": { "smithy.api#documentation": "The phone number details.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chime#GetPhoneNumberSettings": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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 in the Amazon Chime Administration Guide.\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": {} } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#GetRoomResponse": { "type": "structure", "members": { "Room": { "target": "com.amazonaws.chime#Room", "traits": { "smithy.api#documentation": "The room details.
" } } }, "traits": { "smithy.api#output": {} } }, "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\nTo retrieve user details with an email address instead of a user ID, use the \nListUsers action, 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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#GetUserResponse": { "type": "structure", "members": { "User": { "target": "com.amazonaws.chime#User", "traits": { "smithy.api#documentation": "The user details.
" } } }, "traits": { "smithy.api#output": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#GetUserSettingsResponse": { "type": "structure", "members": { "UserSettings": { "target": "com.amazonaws.chime#UserSettings", "traits": { "smithy.api#documentation": "The user settings.
" } } }, "traits": { "smithy.api#output": {} } }, "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#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.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#InviteUsersResponse": { "type": "structure", "members": { "Invites": { "target": "com.amazonaws.chime#InviteList", "traits": { "smithy.api#documentation": "The email invitation details.
" } } }, "traits": { "smithy.api#output": {} } }, "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": "enum", "members": { "Basic": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Basic" } }, "Plus": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Plus" } }, "Pro": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Pro" } }, "ProTrial": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "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" } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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" } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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" } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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" } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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" } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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" } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#ListSupportedPhoneNumberCountriesResponse": { "type": "structure", "members": { "PhoneNumberCountries": { "target": "com.amazonaws.chime#PhoneNumberCountriesList", "traits": { "smithy.api#documentation": "The supported phone number countries.
" } } }, "traits": { "smithy.api#output": {} } }, "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" } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#LogoutUserResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chime#Member": { "type": "structure", "members": { "MemberId": { "target": "com.amazonaws.chime#NonEmptyString", "traits": { "smithy.api#documentation": "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#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": "enum", "members": { "User": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "User" } }, "Bot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Bot" } }, "Webhook": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Webhook" } } } }, "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#NonEmptyString": { "type": "string", "traits": { "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#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#NullableBoolean": { "type": "boolean" }, "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": "enum", "members": { "Processing": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Processing" } }, "Acquired": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Acquired" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } } } }, "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": "enum", "members": { "AccountId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AccountId" } }, "UserId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UserId" } }, "VoiceConnectorId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VoiceConnectorId" } }, "VoiceConnectorGroupId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VoiceConnectorGroupId" } }, "SipRuleId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "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#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": "enum", "members": { "Processing": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Processing" } }, "Successful": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Successful" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "Partial": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Partial" } } } }, "com.amazonaws.chime#PhoneNumberProductType": { "type": "enum", "members": { "BusinessCalling": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BusinessCalling" } }, "VoiceConnector": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VoiceConnector" } }, "SipMediaApplicationDialIn": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SipMediaApplicationDialIn" } } } }, "com.amazonaws.chime#PhoneNumberStatus": { "type": "enum", "members": { "AcquireInProgress": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AcquireInProgress" } }, "AcquireFailed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AcquireFailed" } }, "Unassigned": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Unassigned" } }, "Assigned": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Assigned" } }, "ReleaseInProgress": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReleaseInProgress" } }, "DeleteInProgress": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteInProgress" } }, "ReleaseFailed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReleaseFailed" } }, "DeleteFailed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteFailed" } } } }, "com.amazonaws.chime#PhoneNumberType": { "type": "enum", "members": { "Local": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Local" } }, "TollFree": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TollFree" } } } }, "com.amazonaws.chime#PhoneNumberTypeList": { "type": "list", "member": { "target": "com.amazonaws.chime#PhoneNumberType" } }, "com.amazonaws.chime#ProfileServiceMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 200 } } }, "com.amazonaws.chime#PutEventsConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chime#PutEventsConfigurationRequest" }, "output": { "target": "com.amazonaws.chime#PutEventsConfigurationResponse" }, "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": "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.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#PutEventsConfigurationResponse": { "type": "structure", "members": { "EventsConfiguration": { "target": "com.amazonaws.chime#EventsConfiguration", "traits": { "smithy.api#documentation": "The configuration that allows a bot to receive outgoing events. Can be an HTTPS endpoint or an \n AWS Lambda function ARN.
" } } }, "traits": { "smithy.api#output": {} } }, "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 Amazon Chime Administration Guide.
\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 Amazon Chime Administration Guide.
", "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": {} } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#RedactConversationMessageResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#RedactRoomMessageResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#RegenerateSecurityTokenResponse": { "type": "structure", "members": { "Bot": { "target": "com.amazonaws.chime#Bot", "traits": { "smithy.api#documentation": "A resource that allows Enterprise account administrators to configure an interface that receives events from Amazon Chime.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chime#RegistrationStatus": { "type": "enum", "members": { "Unregistered": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Unregistered" } }, "Registered": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Registered" } }, "Suspended": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "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": {} } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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#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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#RestorePhoneNumberResponse": { "type": "structure", "members": { "PhoneNumber": { "target": "com.amazonaws.chime#PhoneNumber", "traits": { "smithy.api#documentation": "The phone number details.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chime#ResultMax": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 99 } } }, "com.amazonaws.chime#RetentionDays": { "type": "integer", "traits": { "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", "traits": { "smithy.api#documentation": "The member details, such as email address, name, member ID, and member type.
" } }, "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": "enum", "members": { "Administrator": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Administrator" } }, "Member": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "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 US numbers, provide at least one of\n the following search filters: AreaCode, City,\n State, or TollFreePrefix. If you provide\n City, you must also provide State. Numbers outside the US only\n support the PhoneNumberType filter, which you must use.
The area code used to filter results. Only applies to the 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 US.
", "smithy.api#httpQuery": "city" } }, "Country": { "target": "com.amazonaws.chime#Alpha2CountryCode", "traits": { "smithy.api#documentation": "The country used to filter results. Defaults to the US 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 applies to the US.
The toll-free prefix that you use to filter results. Only applies to the 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 non-US 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" } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chime#SensitiveString": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "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#String": { "type": "string" }, "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#ThrottledClientException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.chime#ErrorCode" }, "Message": { "target": "com.amazonaws.chime#String" } }, "traits": { "smithy.api#documentation": "The client exceeded its request rate limit.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "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#AssociatePhoneNumberWithUser" }, { "target": "com.amazonaws.chime#AssociateSigninDelegateGroupsWithAccount" }, { "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#CreateBot" }, { "target": "com.amazonaws.chime#CreateMeetingDialOut" }, { "target": "com.amazonaws.chime#CreatePhoneNumberOrder" }, { "target": "com.amazonaws.chime#CreateRoom" }, { "target": "com.amazonaws.chime#CreateRoomMembership" }, { "target": "com.amazonaws.chime#CreateUser" }, { "target": "com.amazonaws.chime#DeleteAccount" }, { "target": "com.amazonaws.chime#DeleteEventsConfiguration" }, { "target": "com.amazonaws.chime#DeletePhoneNumber" }, { "target": "com.amazonaws.chime#DeleteRoom" }, { "target": "com.amazonaws.chime#DeleteRoomMembership" }, { "target": "com.amazonaws.chime#DisassociatePhoneNumberFromUser" }, { "target": "com.amazonaws.chime#DisassociateSigninDelegateGroupsFromAccount" }, { "target": "com.amazonaws.chime#GetAccount" }, { "target": "com.amazonaws.chime#GetAccountSettings" }, { "target": "com.amazonaws.chime#GetBot" }, { "target": "com.amazonaws.chime#GetEventsConfiguration" }, { "target": "com.amazonaws.chime#GetGlobalSettings" }, { "target": "com.amazonaws.chime#GetPhoneNumber" }, { "target": "com.amazonaws.chime#GetPhoneNumberOrder" }, { "target": "com.amazonaws.chime#GetPhoneNumberSettings" }, { "target": "com.amazonaws.chime#GetRetentionSettings" }, { "target": "com.amazonaws.chime#GetRoom" }, { "target": "com.amazonaws.chime#GetUser" }, { "target": "com.amazonaws.chime#GetUserSettings" }, { "target": "com.amazonaws.chime#InviteUsers" }, { "target": "com.amazonaws.chime#ListAccounts" }, { "target": "com.amazonaws.chime#ListBots" }, { "target": "com.amazonaws.chime#ListPhoneNumberOrders" }, { "target": "com.amazonaws.chime#ListPhoneNumbers" }, { "target": "com.amazonaws.chime#ListRoomMemberships" }, { "target": "com.amazonaws.chime#ListRooms" }, { "target": "com.amazonaws.chime#ListSupportedPhoneNumberCountries" }, { "target": "com.amazonaws.chime#ListUsers" }, { "target": "com.amazonaws.chime#LogoutUser" }, { "target": "com.amazonaws.chime#PutEventsConfiguration" }, { "target": "com.amazonaws.chime#PutRetentionSettings" }, { "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#UpdateAccount" }, { "target": "com.amazonaws.chime#UpdateAccountSettings" }, { "target": "com.amazonaws.chime#UpdateBot" }, { "target": "com.amazonaws.chime#UpdateGlobalSettings" }, { "target": "com.amazonaws.chime#UpdatePhoneNumber" }, { "target": "com.amazonaws.chime#UpdatePhoneNumberSettings" }, { "target": "com.amazonaws.chime#UpdateRoom" }, { "target": "com.amazonaws.chime#UpdateRoomMembership" }, { "target": "com.amazonaws.chime#UpdateUser" }, { "target": "com.amazonaws.chime#UpdateUserSettings" } ], "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#deprecated": { "message": "This namespace has been deprecated" }, "smithy.api#documentation": "\n Most of these APIs are no longer supported and will not be updated. We recommend using the latest versions in the \n Amazon Chime SDK API reference, in the Amazon Chime SDK.
\nUsing the latest versions requires migrating to dedicated namespaces. For more information, refer to \n Migrating from the Amazon Chime namespace in the \n Amazon Chime SDK Developer Guide.
\nThe Amazon Chime application programming interface (API) is designed so administrators can\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.
\nYou can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls for Amazon Chime. We recommend using an AWS SDK or the \n AWS CLI. The page for each API action contains a See Also section that includes links to information about using the action with a language-specific \n AWS SDK or the AWS CLI.
\n\n You 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 \n AWS Developer Center.\n
\nUse your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see \n Installing the AWS Command Line Interface\n in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the \n Amazon 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 \n Signature Version 4 Signing Process\n in the Amazon Web Services General Reference.
\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 \n Identity and Access Management for Amazon Chime\n in the Amazon Chime Administration Guide.
", "smithy.api#title": "Amazon Chime", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://chime.us-east-1.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "chime", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://chime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://chime-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://chime.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://chime.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 14, "nodes": "/////wAAAAH/////AAAAAAAAAA0AAAADAAAAAQAAAAQF9eEMAAAAAgAAAAUF9eEMAAAAAwAAAAkAAAAGAAAABQAAAAgAAAAHAAAABwX14QQF9eELAAAABgX14QkF9eEKAAAABAAAAAsAAAAKAAAABQX14QYF9eEIAAAABQAAAAwF9eEHAAAABgX14QUF9eEGAAAAAwX14QEAAAAOAAAABQX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://chime.us-east-1.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "chime", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://chime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://chime-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://chime.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://chime.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region aws-global with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "chime", "signingRegion": "us-east-1" } ] }, "url": "https://chime.us-east-1.amazonaws.com" } }, "params": { "Region": "aws-global", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://chime-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chime-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://chime.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "chime", "signingRegion": "us-east-1" } ] }, "url": "https://chime.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://chime-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chime-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://chime.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chime.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://chime-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chime-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://chime.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chime.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chime-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chime.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chime-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chime.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "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#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 and default license 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.
" } }, "DefaultLicense": { "target": "com.amazonaws.chime#License", "traits": { "smithy.api#documentation": "The default license applied when you add users to an Amazon Chime account.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#UpdateAccountResponse": { "type": "structure", "members": { "Account": { "target": "com.amazonaws.chime#Account", "traits": { "smithy.api#documentation": "The updated Amazon Chime account details.
" } } }, "traits": { "smithy.api#output": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#UpdateAccountSettingsResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chime#UpdateBot": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdateBotRequest" }, "output": { "target": "com.amazonaws.chime#UpdateBotResponse" }, "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 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.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#UpdateBotResponse": { "type": "structure", "members": { "Bot": { "target": "com.amazonaws.chime#Bot", "traits": { "smithy.api#documentation": "The updated bot details.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chime#UpdateGlobalSettings": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdateGlobalSettingsRequest" }, "output": { "target": "smithy.api#Unit" }, "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.
" } }, "VoiceConnector": { "target": "com.amazonaws.chime#VoiceConnectorSettings", "traits": { "smithy.api#documentation": "The Amazon Chime Voice Connector settings.
" } } }, "traits": { "smithy.api#input": {} } }, "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#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 phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.
\nFor toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
\nUpdates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you 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.
" } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chime#UpdatePhoneNumberSettings": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdatePhoneNumberSettingsRequest" }, "output": { "target": "smithy.api#Unit" }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#UpdateRoomMembershipResponse": { "type": "structure", "members": { "RoomMembership": { "target": "com.amazonaws.chime#RoomMembership", "traits": { "smithy.api#documentation": "The room membership details.
" } } }, "traits": { "smithy.api#output": {} } }, "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.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chime#UpdateRoomResponse": { "type": "structure", "members": { "Room": { "target": "com.amazonaws.chime#Room", "traits": { "smithy.api#documentation": "The room details.
" } } }, "traits": { "smithy.api#output": {} } }, "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": "Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.
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.
" } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chime#UpdateUserSettings": { "type": "operation", "input": { "target": "com.amazonaws.chime#UpdateUserSettingsRequest" }, "output": { "target": "smithy.api#Unit" }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "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 \n BatchUpdateUser actions. This includes user IDs, error codes, and error messages.
" } }, "com.amazonaws.chime#UserErrorList": { "type": "list", "member": { "target": "com.amazonaws.chime#UserError" } }, "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#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": "enum", "members": { "PrivateUser": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PrivateUser" } }, "SharedDevice": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SharedDevice" } } } }, "com.amazonaws.chime#VoiceConnectorSettings": { "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 Voice Connector settings. Includes any Amazon S3 buckets designated for\n storing call detail records.
" } } } }