{ "version":"2.0", "metadata":{ "apiVersion":"2021-04-20", "endpointPrefix":"identity-chime", "protocol":"rest-json", "serviceFullName":"Amazon Chime SDK Identity", "serviceId":"Chime SDK Identity", "signatureVersion":"v4", "signingName":"chime", "uid":"chime-sdk-identity-2021-04-20" }, "operations":{ "CreateAppInstance":{ "name":"CreateAppInstance", "http":{ "method":"POST", "requestUri":"/app-instances", "responseCode":201 }, "input":{"shape":"CreateAppInstanceRequest"}, "output":{"shape":"CreateAppInstanceResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"ForbiddenException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"ThrottledClientException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"
Creates an Amazon Chime SDK messaging AppInstance
under an AWS account. Only SDK messaging customers use this API. CreateAppInstance
supports idempotency behavior as described in the AWS API Standard.
identity
" }, "CreateAppInstanceAdmin":{ "name":"CreateAppInstanceAdmin", "http":{ "method":"POST", "requestUri":"/app-instances/{appInstanceArn}/admins", "responseCode":201 }, "input":{"shape":"CreateAppInstanceAdminRequest"}, "output":{"shape":"CreateAppInstanceAdminResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"ForbiddenException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"ThrottledClientException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"Promotes an AppInstanceUser
to an AppInstanceAdmin
. The promoted user can perform the following actions.
ChannelModerator
actions across all channels in the AppInstance
.
DeleteChannelMessage
actions.
Only an AppInstanceUser
can be promoted to an AppInstanceAdmin
role.
Creates a user under an Amazon Chime AppInstance
. The request consists of a unique appInstanceUserId
and Name
for that user.
Deletes an AppInstance
and all associated data asynchronously.
Demotes an AppInstanceAdmin
to an AppInstanceUser
. This action does not delete the user.
Deletes an AppInstanceUser
.
Deregisters an AppInstanceUserEndpoint
.
Returns the full details of an AppInstance
.
Returns the full details of an AppInstanceAdmin
.
Returns the full details of an AppInstanceUser
.
Returns the full details of an AppInstanceUserEndpoint
.
Gets the retention settings for an AppInstance
.
Returns a list of the administrators in the AppInstance
.
Lists all the AppInstanceUserEndpoints
created under a single AppInstanceUser
.
List all AppInstanceUsers
created under a single AppInstance
.
Lists all Amazon Chime AppInstance
s created under a single AWS account.
Lists the tags applied to an Amazon Chime SDK identity resource.
" }, "PutAppInstanceRetentionSettings":{ "name":"PutAppInstanceRetentionSettings", "http":{ "method":"PUT", "requestUri":"/app-instances/{appInstanceArn}/retention-settings", "responseCode":200 }, "input":{"shape":"PutAppInstanceRetentionSettingsRequest"}, "output":{"shape":"PutAppInstanceRetentionSettingsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"ThrottledClientException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"Sets the amount of time in days that a given AppInstance
retains data.
Registers an endpoint under an Amazon Chime AppInstanceUser
. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.
Applies the specified tags to the specified Amazon Chime SDK identity resource.
" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/tags?operation=untag-resource", "responseCode":204 }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ForbiddenException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ThrottledClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"Removes the specified tags from the specified Amazon Chime SDK identity resource.
" }, "UpdateAppInstance":{ "name":"UpdateAppInstance", "http":{ "method":"PUT", "requestUri":"/app-instances/{appInstanceArn}", "responseCode":200 }, "input":{"shape":"UpdateAppInstanceRequest"}, "output":{"shape":"UpdateAppInstanceResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"ForbiddenException"}, {"shape":"ThrottledClientException"}, {"shape":"UnauthorizedClientException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], "documentation":"Updates AppInstance
metadata.
Updates the details of an AppInstanceUser
. You can update names and metadata.
Updates the details of an AppInstanceUserEndpoint
. You can update the name and AllowMessage
values.
The ARN of the messaging instance.
" }, "Name":{ "shape":"NonEmptyResourceName", "documentation":"The name of an AppInstance
.
The time at which an AppInstance
was created. In epoch milliseconds.
The time an AppInstance
was last updated. In epoch milliseconds.
The metadata of an AppInstance
.
The details of an AppInstance
, an instance of an Amazon Chime SDK messaging application.
The AppInstanceAdmin
data.
The ARN of the AppInstance
for which the user is an administrator.
The time at which an administrator was created.
" } }, "documentation":"The details of an AppInstanceAdmin
.
The details of the AppInstanceAdmin
.
Summary of the details of an AppInstanceAdmin
.
The length of time in days to retain the messages in a channel.
" } }, "documentation":"The details of the data-retention settings for an AppInstance
.
The AppInstance
ARN.
The name of the AppInstance
.
The metadata of the AppInstance
.
Summary of the data for an AppInstance
.
The ARN of the AppInstanceUser
.
The name of the AppInstanceUser
.
The metadata of the AppInstanceUser
.
The time at which the AppInstanceUser
was created.
The time at which the AppInstanceUser
was last updated.
The details of an AppInstanceUser
.
The ARN of the AppInstanceUser
.
The unique identifier of the AppInstanceUserEndpoint
.
The name of the AppInstanceUserEndpoint
.
The type of the AppInstanceUserEndpoint
.
The ARN of the resource to which the endpoint belongs.
" }, "EndpointAttributes":{ "shape":"EndpointAttributes", "documentation":"The attributes of an Endpoint
.
The time at which an AppInstanceUserEndpoint
was created.
The time at which an AppInstanceUserEndpoint
was last updated.
Boolean that controls whether the AppInstanceUserEndpoint
is opted in to receive messages. ALL
indicates the endpoint will receive all messages. NONE
indicates the endpoint will receive no messages.
A read-only field that represents the state of an AppInstanceUserEndpoint
. Supported values:
ACTIVE
: The AppInstanceUserEndpoint
is active and able to receive messages. When ACTIVE
, the EndpointStatusReason
remains empty.
INACTIVE
: The AppInstanceUserEndpoint
is inactive and can't receive message. When INACTIVE
, the corresponding reason will be conveyed through EndpointStatusReason
.
INVALID_DEVICE_TOKEN
indicates that an AppInstanceUserEndpoint
is INACTIVE
due to invalid device token
INVALID_PINPOINT_ARN
indicates that an AppInstanceUserEndpoint
is INACTIVE
due to an invalid pinpoint ARN that was input through the ResourceArn
field.
An endpoint under an Amazon Chime AppInstanceUser
that receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.
The ARN of the AppInstanceUser
.
The unique identifier of the AppInstanceUserEndpoint
.
The name of the AppInstanceUserEndpoint
.
The type of the AppInstanceUserEndpoint
.
BBoolean that controls whether the AppInstanceUserEndpoint
is opted in to receive messages. ALL
indicates the endpoint will receive all messages. NONE
indicates the endpoint will receive no messages.
A read-only field that represent the state of an AppInstanceUserEndpoint
.
Summary of the details of an AppInstanceUserEndpoint
.
The ARN of the AppInstanceUser
.
The name of an AppInstanceUser
.
The metadata of the AppInstanceUser
.
Summary of the details of an AppInstanceUser
.
The input parameters don't match the service's restrictions.
", "error":{"httpStatusCode":400}, "exception":true }, "ChannelRetentionSettings":{ "type":"structure", "members":{ "RetentionDays":{ "shape":"RetentionDays", "documentation":"The time in days to retain the messages in a channel.
" } }, "documentation":"The details of the retention settings for a channel.
" }, "ChimeArn":{ "type":"string", "max":1600, "min":5, "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" }, "ClientRequestToken":{ "type":"string", "max":64, "min":2, "pattern":"[-_a-zA-Z0-9]*", "sensitive":true }, "ConflictException":{ "type":"structure", "members":{ "Code":{"shape":"ErrorCode"}, "Message":{"shape":"String"} }, "documentation":"The request could not be processed because of conflict in the current state of the resource.
", "error":{"httpStatusCode":409}, "exception":true }, "CreateAppInstanceAdminRequest":{ "type":"structure", "required":[ "AppInstanceAdminArn", "AppInstanceArn" ], "members":{ "AppInstanceAdminArn":{ "shape":"ChimeArn", "documentation":"The ARN of the administrator of the current AppInstance
.
The ARN of the AppInstance
.
The name and ARN of the admin for the AppInstance
.
The ARN of the of the admin for the AppInstance
.
The name of the AppInstance
.
The metadata of the AppInstance
. Limited to a 1KB string in UTF-8.
The ClientRequestToken
of the AppInstance
.
Tags assigned to the AppInstanceUser
.
The Amazon Resource Number (ARN) of the AppInstance
.
The ARN of the AppInstance
request.
The user ID of the AppInstance
.
The user's name.
" }, "Metadata":{ "shape":"Metadata", "documentation":"The request's metadata. Limited to a 1KB string in UTF-8.
" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "documentation":"The token assigned to the user requesting an AppInstance
.
Tags assigned to the AppInstanceUser
.
The user's ARN.
" } } }, "DeleteAppInstanceAdminRequest":{ "type":"structure", "required":[ "AppInstanceAdminArn", "AppInstanceArn" ], "members":{ "AppInstanceAdminArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstance
's administrator.
The ARN of the AppInstance
.
The ARN of the AppInstance
.
The ARN of the user request being deleted.
", "location":"uri", "locationName":"appInstanceUserArn" } } }, "DeregisterAppInstanceUserEndpointRequest":{ "type":"structure", "required":[ "AppInstanceUserArn", "EndpointId" ], "members":{ "AppInstanceUserArn":{ "shape":"SensitiveChimeArn", "documentation":"The ARN of the AppInstanceUser
.
The unique identifier of the AppInstanceUserEndpoint
.
The ARN of the AppInstanceAdmin
.
The ARN of the AppInstance
.
The ARN and name of the AppInstanceUser
, the ARN of the AppInstance
, and the created and last-updated timestamps. All timestamps use epoch milliseconds.
The ARN of the AppInstance
.
The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance
. All timestamps use epoch milliseconds.
The ARN of the AppInstanceUser
.
The unique identifier of the AppInstanceUserEndpoint
.
The full details of an AppInstanceUserEndpoint
: the AppInstanceUserArn
, ID, name, type, resource ARN, attributes, allow messages, state, and created and last updated timestamps. All timestamps use epoch milliseconds.
The ARN of the AppInstanceUser
.
The name of the AppInstanceUser
.
The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.
" }, "VoipDeviceToken":{ "shape":"NonEmptySensitiveString1600", "documentation":"The VOIP device token for the APNS and APNS_SANDBOX endpoint types.
" } }, "documentation":"The attributes of an Endpoint
.
Enum that indicates the Status of an AppInstanceUserEndpoint
.
The reason for the EndpointStatus
.
A read-only field that represents the state of an AppInstanceUserEndpoint
. Supported values:
ACTIVE
: The AppInstanceUserEndpoint
is active and able to receive messages. When ACTIVE
, the EndpointStatusReason
remains empty.
INACTIVE
: The AppInstanceUserEndpoint
is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.
INVALID_DEVICE_TOKEN
indicates that an AppInstanceUserEndpoint
is INACTIVE
due to invalid device token
INVALID_PINPOINT_ARN
indicates that an AppInstanceUserEndpoint
is INACTIVE
due to an invalid pinpoint ARN that was input through the ResourceArn
field.
The client is permanently forbidden from making the request.
", "error":{"httpStatusCode":403}, "exception":true }, "GetAppInstanceRetentionSettingsRequest":{ "type":"structure", "required":["AppInstanceArn"], "members":{ "AppInstanceArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstance
.
The retention settings for the AppInstance
.
The timestamp representing the time at which the specified items are retained, in Epoch Seconds.
" } } }, "Identity":{ "type":"structure", "members":{ "Arn":{ "shape":"ChimeArn", "documentation":"The ARN in an Identity.
" }, "Name":{ "shape":"ResourceName", "documentation":"The name in an Identity.
" } }, "documentation":"The details of a user.
" }, "ListAppInstanceAdminsRequest":{ "type":"structure", "required":["AppInstanceArn"], "members":{ "AppInstanceArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstance
.
The maximum number of administrators that you want to return.
", "location":"querystring", "locationName":"max-results" }, "NextToken":{ "shape":"NextToken", "documentation":"The token returned from previous API requests until the number of administrators is reached.
", "location":"querystring", "locationName":"next-token" } } }, "ListAppInstanceAdminsResponse":{ "type":"structure", "members":{ "AppInstanceArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstance
.
The information for each administrator.
" }, "NextToken":{ "shape":"NextToken", "documentation":"The token returned from previous API requests until the number of administrators is reached.
" } } }, "ListAppInstanceUserEndpointsRequest":{ "type":"structure", "required":["AppInstanceUserArn"], "members":{ "AppInstanceUserArn":{ "shape":"SensitiveChimeArn", "documentation":"The ARN of the AppInstanceUser
.
The maximum number of endpoints that you want to return.
", "location":"querystring", "locationName":"max-results" }, "NextToken":{ "shape":"NextToken", "documentation":"The token passed by previous API calls until all requested endpoints are returned.
", "location":"querystring", "locationName":"next-token" } } }, "ListAppInstanceUserEndpointsResponse":{ "type":"structure", "members":{ "AppInstanceUserEndpoints":{ "shape":"AppInstanceUserEndpointSummaryList", "documentation":"The information for each requested AppInstanceUserEndpoint
.
The token passed by previous API calls until all requested endpoints are returned.
" } } }, "ListAppInstanceUsersRequest":{ "type":"structure", "required":["AppInstanceArn"], "members":{ "AppInstanceArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstance
.
The maximum number of requests that you want returned.
", "location":"querystring", "locationName":"max-results" }, "NextToken":{ "shape":"NextToken", "documentation":"The token passed by previous API calls until all requested users are returned.
", "location":"querystring", "locationName":"next-token" } } }, "ListAppInstanceUsersResponse":{ "type":"structure", "members":{ "AppInstanceArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstance
.
The information for each requested AppInstanceUser
.
The token passed by previous API calls until all requested users are returned.
" } } }, "ListAppInstancesRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of AppInstance
s that you want to return.
The token passed by previous API requests until you reach the maximum number of AppInstances
.
The information for each AppInstance
.
The token passed by previous API requests until the maximum number of AppInstance
s is reached.
The ARN of the resource.
", "location":"querystring", "locationName":"arn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagList", "documentation":"The tag key-value pairs.
" } } }, "MaxResults":{ "type":"integer", "max":50, "min":1 }, "Metadata":{ "type":"string", "max":1024, "min":0, "pattern":".*", "sensitive":true }, "NextToken":{ "type":"string", "max":2048, "min":0, "pattern":".*", "sensitive":true }, "NonEmptyResourceName":{ "type":"string", "max":256, "min":1, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*", "sensitive":true }, "NonEmptySensitiveString1600":{ "type":"string", "max":1600, "min":1, "pattern":".*", "sensitive":true }, "PutAppInstanceRetentionSettingsRequest":{ "type":"structure", "required":[ "AppInstanceArn", "AppInstanceRetentionSettings" ], "members":{ "AppInstanceArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstance
.
The time in days to retain data. Data type: number.
" } } }, "PutAppInstanceRetentionSettingsResponse":{ "type":"structure", "members":{ "AppInstanceRetentionSettings":{ "shape":"AppInstanceRetentionSettings", "documentation":"The time in days to retain data. Data type: number.
" }, "InitiateDeletionTimestamp":{ "shape":"Timestamp", "documentation":"The time at which the API deletes data.
" } } }, "RegisterAppInstanceUserEndpointRequest":{ "type":"structure", "required":[ "AppInstanceUserArn", "Type", "ResourceArn", "EndpointAttributes", "ClientRequestToken" ], "members":{ "AppInstanceUserArn":{ "shape":"SensitiveChimeArn", "documentation":"The ARN of the AppInstanceUser
.
The name of the AppInstanceUserEndpoint
.
The type of the AppInstanceUserEndpoint
. Supported types:
APNS
: The mobile notification service for an Apple device.
APNS_SANDBOX
: The sandbox environment of the mobile notification service for an Apple device.
GCM
: The mobile notification service for an Android device.
Populate the ResourceArn
value of each type as PinpointAppArn
.
The ARN of the resource to which the endpoint belongs.
" }, "EndpointAttributes":{ "shape":"EndpointAttributes", "documentation":"The attributes of an Endpoint
.
The idempotency token for each client request.
", "idempotencyToken":true }, "AllowMessages":{ "shape":"AllowMessages", "documentation":"Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL
indicates the endpoint receives all messages. NONE
indicates the endpoint receives no messages.
The ARN of the AppInstanceUser
.
The unique identifier of the AppInstanceUserEndpoint
.
The request exceeds the resource limit.
", "error":{"httpStatusCode":400}, "exception":true }, "ResourceName":{ "type":"string", "max":256, "min":0, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*", "sensitive":true }, "RetentionDays":{ "type":"integer", "max":5475, "min":1 }, "SensitiveChimeArn":{ "type":"string", "max":1600, "min":5, "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "sensitive":true }, "SensitiveString1600":{ "type":"string", "max":1600, "min":0, "pattern":".*", "sensitive":true }, "SensitiveString64":{ "type":"string", "max":64, "min":0, "pattern":".*", "sensitive":true }, "ServiceFailureException":{ "type":"structure", "members":{ "Code":{"shape":"ErrorCode"}, "Message":{"shape":"String"} }, "documentation":"The service encountered an unexpected error.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "ServiceUnavailableException":{ "type":"structure", "members":{ "Code":{"shape":"ErrorCode"}, "Message":{"shape":"String"} }, "documentation":"The service is currently unavailable.
", "error":{"httpStatusCode":503}, "exception":true, "fault":true }, "String":{"type":"string"}, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"The key in a tag.
" }, "Value":{ "shape":"TagValue", "documentation":"The value in a tag.
" } }, "documentation":"A tag object containing a key-value pair.
" }, "TagKey":{ "type":"string", "max":128, "min":1, "sensitive":true }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":1 }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":50, "min":1 }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceARN", "Tags" ], "members":{ "ResourceARN":{ "shape":"ChimeArn", "documentation":"The resource ARN.
" }, "Tags":{ "shape":"TagList", "documentation":"The tag key-value pairs.
" } } }, "TagValue":{ "type":"string", "max":256, "min":1, "sensitive":true }, "ThrottledClientException":{ "type":"structure", "members":{ "Code":{"shape":"ErrorCode"}, "Message":{"shape":"String"} }, "documentation":"The client exceeded its request rate limit.
", "error":{"httpStatusCode":429}, "exception":true }, "Timestamp":{"type":"timestamp"}, "UnauthorizedClientException":{ "type":"structure", "members":{ "Code":{"shape":"ErrorCode"}, "Message":{"shape":"String"} }, "documentation":"The client is not currently authorized to make the request.
", "error":{"httpStatusCode":401}, "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceARN", "TagKeys" ], "members":{ "ResourceARN":{ "shape":"ChimeArn", "documentation":"The resource ARN.
" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"The tag keys.
" } } }, "UpdateAppInstanceRequest":{ "type":"structure", "required":[ "AppInstanceArn", "Name", "Metadata" ], "members":{ "AppInstanceArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstance
.
The name that you want to change.
" }, "Metadata":{ "shape":"Metadata", "documentation":"The metadata that you want to change.
" } } }, "UpdateAppInstanceResponse":{ "type":"structure", "members":{ "AppInstanceArn":{ "shape":"ChimeArn", "documentation":"The ARN of the AppInstance
.
The ARN of the AppInstanceUser
.
The unique identifier of the AppInstanceUserEndpoint
.
The name of the AppInstanceUserEndpoint
.
Boolean that controls whether the AppInstanceUserEndpoint
is opted in to receive messages. ALL
indicates the endpoint will receive all messages. NONE
indicates the endpoint will receive no messages.
The ARN of the AppInstanceUser
.
The unique identifier of the AppInstanceUserEndpoint
.
The ARN of the AppInstanceUser
.
The name of the AppInstanceUser
.
The metadata of the AppInstanceUser
.
The ARN of the AppInstanceUser
.
The Amazon Chime SDK Identity APIs in this section allow software developers to create and manage unique instances of their messaging applications. These APIs provide the overarching framework for creating and sending messages. For more information about the identity APIs, refer to Amazon Chime SDK identity.
" }