{ "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.chimesdkidentity#AllowMessages": { "type": "enum", "members": { "ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } } } }, "com.amazonaws.chimesdkidentity#AppInstance": { "type": "structure", "members": { "AppInstanceArn": { "target": "com.amazonaws.chimesdkidentity#ChimeArn", "traits": { "smithy.api#documentation": "
The ARN of the messaging instance.
" } }, "Name": { "target": "com.amazonaws.chimesdkidentity#NonEmptyResourceName", "traits": { "smithy.api#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\n application.
The AppInstanceAdmin data.
The ARN of the AppInstance for which the user is an administrator.
The time at which an administrator was created.
" } } }, "traits": { "smithy.api#documentation": "The name and ARN of the admin for the AppInstance.
The details of the AppInstanceAdmin.
Summary of the details of an AppInstanceAdmin.
The ARN of the AppInstanceBot.
" } }, "Name": { "target": "com.amazonaws.chimesdkidentity#ResourceName", "traits": { "smithy.api#documentation": "The name of the AppInstanceBot.
" } }, "Configuration": { "target": "com.amazonaws.chimesdkidentity#Configuration", "traits": { "smithy.api#documentation": "The data processing instructions for an AppInstanceBot.
" } }, "CreatedTimestamp": { "target": "com.amazonaws.chimesdkidentity#Timestamp", "traits": { "smithy.api#documentation": "The time at which the AppInstanceBot was created.
The time at which the AppInstanceBot was last updated.
The metadata for an AppInstanceBot.
" } } }, "traits": { "smithy.api#documentation": "An Amazon Lex V2 chat bot created under an AppInstance.
The ARN of the AppInstanceBot.
" } }, "Name": { "target": "com.amazonaws.chimesdkidentity#ResourceName", "traits": { "smithy.api#documentation": "The name of the AppInstanceBox.
" } }, "Metadata": { "target": "com.amazonaws.chimesdkidentity#Metadata", "traits": { "smithy.api#documentation": "The metadata of the AppInstanceBot.
" } } }, "traits": { "smithy.api#documentation": "High-level information about an AppInstanceBot.
" } }, "com.amazonaws.chimesdkidentity#AppInstanceList": { "type": "list", "member": { "target": "com.amazonaws.chimesdkidentity#AppInstanceSummary" } }, "com.amazonaws.chimesdkidentity#AppInstanceRetentionSettings": { "type": "structure", "members": { "ChannelRetentionSettings": { "target": "com.amazonaws.chimesdkidentity#ChannelRetentionSettings", "traits": { "smithy.api#documentation": "The length of time in days to retain the messages in a channel.
" } } }, "traits": { "smithy.api#documentation": "The details of the data-retention settings for an AppInstance.
The 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 interval after which an AppInstanceUser is automatically deleted.
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": { "target": "com.amazonaws.chimesdkidentity#EndpointAttributes", "traits": { "smithy.api#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. \n NONE indicates the endpoint will receive no messages.
A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:
\n ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.
\n INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be \n conveyed through EndpointStatusReason.
\n INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token
\n INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input \n 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. \n 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.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.chimesdkidentity#ChannelRetentionSettings": { "type": "structure", "members": { "RetentionDays": { "target": "com.amazonaws.chimesdkidentity#RetentionDays", "traits": { "smithy.api#documentation": "The time in days to retain the messages in a channel.
" } } }, "traits": { "smithy.api#documentation": "The details of the retention settings for a channel.
" } }, "com.amazonaws.chimesdkidentity#ChimeArn": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 1600 }, "smithy.api#pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" } }, "com.amazonaws.chimesdkidentity#ChimeIdentityService": { "type": "service", "version": "2021-04-20", "operations": [ { "target": "com.amazonaws.chimesdkidentity#CreateAppInstance" }, { "target": "com.amazonaws.chimesdkidentity#CreateAppInstanceAdmin" }, { "target": "com.amazonaws.chimesdkidentity#CreateAppInstanceBot" }, { "target": "com.amazonaws.chimesdkidentity#CreateAppInstanceUser" }, { "target": "com.amazonaws.chimesdkidentity#DeleteAppInstance" }, { "target": "com.amazonaws.chimesdkidentity#DeleteAppInstanceAdmin" }, { "target": "com.amazonaws.chimesdkidentity#DeleteAppInstanceBot" }, { "target": "com.amazonaws.chimesdkidentity#DeleteAppInstanceUser" }, { "target": "com.amazonaws.chimesdkidentity#DeregisterAppInstanceUserEndpoint" }, { "target": "com.amazonaws.chimesdkidentity#DescribeAppInstance" }, { "target": "com.amazonaws.chimesdkidentity#DescribeAppInstanceAdmin" }, { "target": "com.amazonaws.chimesdkidentity#DescribeAppInstanceBot" }, { "target": "com.amazonaws.chimesdkidentity#DescribeAppInstanceUser" }, { "target": "com.amazonaws.chimesdkidentity#DescribeAppInstanceUserEndpoint" }, { "target": "com.amazonaws.chimesdkidentity#GetAppInstanceRetentionSettings" }, { "target": "com.amazonaws.chimesdkidentity#ListAppInstanceAdmins" }, { "target": "com.amazonaws.chimesdkidentity#ListAppInstanceBots" }, { "target": "com.amazonaws.chimesdkidentity#ListAppInstances" }, { "target": "com.amazonaws.chimesdkidentity#ListAppInstanceUserEndpoints" }, { "target": "com.amazonaws.chimesdkidentity#ListAppInstanceUsers" }, { "target": "com.amazonaws.chimesdkidentity#ListTagsForResource" }, { "target": "com.amazonaws.chimesdkidentity#PutAppInstanceRetentionSettings" }, { "target": "com.amazonaws.chimesdkidentity#PutAppInstanceUserExpirationSettings" }, { "target": "com.amazonaws.chimesdkidentity#RegisterAppInstanceUserEndpoint" }, { "target": "com.amazonaws.chimesdkidentity#TagResource" }, { "target": "com.amazonaws.chimesdkidentity#UntagResource" }, { "target": "com.amazonaws.chimesdkidentity#UpdateAppInstance" }, { "target": "com.amazonaws.chimesdkidentity#UpdateAppInstanceBot" }, { "target": "com.amazonaws.chimesdkidentity#UpdateAppInstanceUser" }, { "target": "com.amazonaws.chimesdkidentity#UpdateAppInstanceUserEndpoint" } ], "traits": { "aws.api#service": { "sdkId": "Chime SDK Identity", "arnNamespace": "chime", "cloudFormationName": "ChimeSDKIdentity", "cloudTrailEventSource": "chimesdkidentity.amazonaws.com", "endpointPrefix": "identity-chime" }, "aws.auth#sigv4": { "name": "chime" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "The Amazon Chime SDK Identity APIs in this section allow software developers to create\n and manage unique instances of their messaging applications. These APIs provide the\n overarching framework for creating and sending messages. For more information about the\n identity APIs, refer to Amazon Chime SDK identity.
", "smithy.api#title": "Amazon Chime SDK Identity", "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": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "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://identity-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://identity-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://identity-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://identity-chime.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "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": "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://identity-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://identity-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://identity-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://identity-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 eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://identity-chime.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://identity-chime.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://identity-chime-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://identity-chime-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://identity-chime.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://identity-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://identity-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://identity-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://identity-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://identity-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://identity-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://identity-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://identity-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://identity-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://identity-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://identity-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://identity-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.chimesdkidentity#ClientRequestToken": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 64 }, "smithy.api#pattern": "^[-_a-zA-Z0-9]*$" } }, "com.amazonaws.chimesdkidentity#Configuration": { "type": "structure", "members": { "Lex": { "target": "com.amazonaws.chimesdkidentity#LexConfiguration", "traits": { "smithy.api#documentation": "The configuration for an Amazon Lex V2 bot.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A structure that contains configuration data.
" } }, "com.amazonaws.chimesdkidentity#ConflictException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.chimesdkidentity#ErrorCode" }, "Message": { "target": "com.amazonaws.chimesdkidentity#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.chimesdkidentity#CreateAppInstance": { "type": "operation", "input": { "target": "com.amazonaws.chimesdkidentity#CreateAppInstanceRequest" }, "output": { "target": "com.amazonaws.chimesdkidentity#CreateAppInstanceResponse" }, "errors": [ { "target": "com.amazonaws.chimesdkidentity#BadRequestException" }, { "target": "com.amazonaws.chimesdkidentity#ConflictException" }, { "target": "com.amazonaws.chimesdkidentity#ForbiddenException" }, { "target": "com.amazonaws.chimesdkidentity#ResourceLimitExceededException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" }, { "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" }, { "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Creates an Amazon Chime SDK messaging AppInstance under an AWS account.\n Only SDK messaging customers use this API. CreateAppInstance supports\n idempotency behavior as described in the AWS API Standard.
identity
", "smithy.api#http": { "method": "POST", "uri": "/app-instances", "code": 201 } } }, "com.amazonaws.chimesdkidentity#CreateAppInstanceAdmin": { "type": "operation", "input": { "target": "com.amazonaws.chimesdkidentity#CreateAppInstanceAdminRequest" }, "output": { "target": "com.amazonaws.chimesdkidentity#CreateAppInstanceAdminResponse" }, "errors": [ { "target": "com.amazonaws.chimesdkidentity#BadRequestException" }, { "target": "com.amazonaws.chimesdkidentity#ConflictException" }, { "target": "com.amazonaws.chimesdkidentity#ForbiddenException" }, { "target": "com.amazonaws.chimesdkidentity#ResourceLimitExceededException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" }, { "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" }, { "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Promotes an AppInstanceUser or AppInstanceBot to an \n AppInstanceAdmin. The\n promoted entity can perform the following actions.
\n ChannelModerator actions across all channels in the\n AppInstance.
\n DeleteChannelMessage actions.
Only an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin\n role.
The ARN of the administrator of the current AppInstance.
The ARN of the AppInstance.
The ARN and name of the administrator, the ARN of the AppInstance, and the created and \n last-updated timestamps. All timestamps use epoch milliseconds.
The ARN of the of the admin for the AppInstance.
Creates a bot under an Amazon Chime AppInstance. The request consists of a \n unique Configuration and Name for that bot.
The ARN of the AppInstance request.
The user's name.
" } }, "Metadata": { "target": "com.amazonaws.chimesdkidentity#Metadata", "traits": { "smithy.api#documentation": "The request metadata. Limited to a 1KB string in UTF-8.
" } }, "ClientRequestToken": { "target": "com.amazonaws.chimesdkidentity#ClientRequestToken", "traits": { "smithy.api#documentation": "The unique ID for the client making the request. Use different tokens for different AppInstanceBots.
The tags assigned to the AppInstanceBot.
Configuration information about the Amazon Lex V2 V2 bot.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chimesdkidentity#CreateAppInstanceBotResponse": { "type": "structure", "members": { "AppInstanceBotArn": { "target": "com.amazonaws.chimesdkidentity#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the AppinstanceBot.
The name of the AppInstance.
The metadata of the AppInstance. Limited to a 1KB string in UTF-8.
The unique ID of the request. Use different tokens to create different AppInstances.
Tags assigned to the AppInstance.
The Amazon Resource Number (ARN) of the AppInstance.
Creates a user under an Amazon Chime AppInstance. The request consists of a\n unique appInstanceUserId and Name for that user.
The ARN of the AppInstance request.
The user ID of the AppInstance.
The user's name.
", "smithy.api#required": {} } }, "Metadata": { "target": "com.amazonaws.chimesdkidentity#Metadata", "traits": { "smithy.api#documentation": "The request's metadata. Limited to a 1KB string in UTF-8.
" } }, "ClientRequestToken": { "target": "com.amazonaws.chimesdkidentity#ClientRequestToken", "traits": { "smithy.api#documentation": "The unique ID of the request. Use different tokens to request additional AppInstances.
Tags assigned to the AppInstanceUser.
Settings that control the interval after which the AppInstanceUser is automatically deleted.
The user's ARN.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chimesdkidentity#DeleteAppInstance": { "type": "operation", "input": { "target": "com.amazonaws.chimesdkidentity#DeleteAppInstanceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.chimesdkidentity#BadRequestException" }, { "target": "com.amazonaws.chimesdkidentity#ForbiddenException" }, { "target": "com.amazonaws.chimesdkidentity#ResourceLimitExceededException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" }, { "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" }, { "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Deletes an AppInstance and all associated data asynchronously.
Demotes an AppInstanceAdmin to an AppInstanceUser or \n AppInstanceBot. This action\n does not delete the user.
The ARN of the AppInstance's administrator.
The ARN of the AppInstance.
Deletes an AppInstanceBot.
The ARN of the AppInstanceBot being deleted.
The ARN of the AppInstance.
Deletes an AppInstanceUser.
The ARN of the user request being deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chimesdkidentity#DeregisterAppInstanceUserEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.chimesdkidentity#DeregisterAppInstanceUserEndpointRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.chimesdkidentity#BadRequestException" }, { "target": "com.amazonaws.chimesdkidentity#ForbiddenException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" }, { "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" }, { "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Deregisters an AppInstanceUserEndpoint.
The ARN of the AppInstanceUser.
The unique identifier of the AppInstanceUserEndpoint.
Returns the full details of an AppInstance.
Returns the full details of an AppInstanceAdmin.
The ARN of the AppInstanceAdmin.
The ARN of the AppInstance.
The ARN and name of the AppInstanceUser, the ARN of the\n AppInstance, and the created and last-updated timestamps. All timestamps\n use epoch milliseconds.
The AppInstanceBot's information.
The ARN of the AppInstanceBot.
The detials of the AppInstanceBot.
The ARN of the AppInstance.
The ARN, metadata, created and last-updated timestamps, and the name of the\n AppInstance. All timestamps use epoch milliseconds.
Returns the full details of an AppInstanceUser.
Returns the full details of an AppInstanceUserEndpoint.
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, \n 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.
", "smithy.api#required": {} } }, "VoipDeviceToken": { "target": "com.amazonaws.chimesdkidentity#NonEmptySensitiveString1600", "traits": { "smithy.api#documentation": "The VOIP device token for the APNS and APNS_SANDBOX endpoint types.
" } } }, "traits": { "smithy.api#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:
\n ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.
\n INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive\n message. When INACTIVE, the corresponding reason will be conveyed through\n EndpointStatusReason.
\n INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token
\n INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.
The period in days after which an AppInstanceUser will be automatically deleted.
Specifies the conditions under which an AppInstanceUser will expire.
Determines the interval after which an AppInstanceUser is automatically deleted.
The client is permanently forbidden from making the request.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.chimesdkidentity#GetAppInstanceRetentionSettings": { "type": "operation", "input": { "target": "com.amazonaws.chimesdkidentity#GetAppInstanceRetentionSettingsRequest" }, "output": { "target": "com.amazonaws.chimesdkidentity#GetAppInstanceRetentionSettingsResponse" }, "errors": [ { "target": "com.amazonaws.chimesdkidentity#BadRequestException" }, { "target": "com.amazonaws.chimesdkidentity#ForbiddenException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" }, { "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" }, { "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Gets the retention settings for an AppInstance.
The ARN of the AppInstance.
The retention settings for the AppInstance.
The timestamp representing the time at which the specified items are retained, in Epoch\n Seconds.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chimesdkidentity#Identity": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.chimesdkidentity#ChimeArn", "traits": { "smithy.api#documentation": "The ARN in an Identity.
" } }, "Name": { "target": "com.amazonaws.chimesdkidentity#ResourceName", "traits": { "smithy.api#documentation": "The name in an Identity.
" } } }, "traits": { "smithy.api#documentation": "The details of a user or bot.
" } }, "com.amazonaws.chimesdkidentity#InvokedBy": { "type": "structure", "members": { "StandardMessages": { "target": "com.amazonaws.chimesdkidentity#StandardMessages", "traits": { "smithy.api#documentation": "Sets standard messages as the bot trigger. For standard messages:
\n\n ALL: The bot processes all standard messages.
\n AUTO: The bot responds to ALL messages when the channel has one other non-hidden member, and responds to MENTIONS when the \n channel has more than one other non-hidden member.
\n MENTIONS: The bot processes all standard messages that have a message attribute with CHIME.mentions and a \n value of the bot ARN.
\n NONE: The bot processes no standard messages.
Sets targeted messages as the bot trigger. For targeted messages:
\n\n ALL: The bot processes all TargetedMessages sent to it. The bot then responds with a targeted message back to the sender.\n
\n NONE: The bot processes no targeted messages.
Specifies the type of message that triggers a bot.
" } }, "com.amazonaws.chimesdkidentity#LexBotAliasArn": { "type": "string", "traits": { "smithy.api#length": { "min": 15, "max": 2048 }, "smithy.api#pattern": "^arn:aws:lex:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:bot-alias/[A-Z0-9]{10}/[A-Z0-9]{10}$" } }, "com.amazonaws.chimesdkidentity#LexConfiguration": { "type": "structure", "members": { "RespondsTo": { "target": "com.amazonaws.chimesdkidentity#RespondsTo", "traits": { "smithy.api#documentation": "\n Deprecated. Use InvokedBy instead.
Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.
" } }, "InvokedBy": { "target": "com.amazonaws.chimesdkidentity#InvokedBy", "traits": { "smithy.api#documentation": "Specifies the type of message that triggers a bot.
" } }, "LexBotAliasArn": { "target": "com.amazonaws.chimesdkidentity#LexBotAliasArn", "traits": { "smithy.api#documentation": "The ARN of the Amazon Lex V2 bot's alias. The ARN uses this format: \n arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS\n
Identifies the Amazon Lex V2 bot's language and locale. The string must match one of the \n supported locales in Amazon Lex V2. All of the intents, slot types, and slots used in the bot must have the same \n locale. For more information, see Supported languages in the Amazon Lex V2 Developer Guide.
", "smithy.api#required": {} } }, "WelcomeIntent": { "target": "com.amazonaws.chimesdkidentity#LexIntentName", "traits": { "smithy.api#documentation": "The name of the welcome intent configured in the Amazon Lex V2 bot.
" } } }, "traits": { "smithy.api#documentation": "The configuration for an Amazon Lex V2 bot.
" } }, "com.amazonaws.chimesdkidentity#LexIntentName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^([A-Za-z]_?)+$" } }, "com.amazonaws.chimesdkidentity#ListAppInstanceAdmins": { "type": "operation", "input": { "target": "com.amazonaws.chimesdkidentity#ListAppInstanceAdminsRequest" }, "output": { "target": "com.amazonaws.chimesdkidentity#ListAppInstanceAdminsResponse" }, "errors": [ { "target": "com.amazonaws.chimesdkidentity#BadRequestException" }, { "target": "com.amazonaws.chimesdkidentity#ForbiddenException" }, { "target": "com.amazonaws.chimesdkidentity#ResourceLimitExceededException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" }, { "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" }, { "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Returns a list of the administrators in the AppInstance.
The ARN of the AppInstance.
The maximum number of administrators that you want to return.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chimesdkidentity#NextToken", "traits": { "smithy.api#documentation": "The token returned from previous API requests until the number of administrators is\n reached.
", "smithy.api#httpQuery": "next-token" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chimesdkidentity#ListAppInstanceAdminsResponse": { "type": "structure", "members": { "AppInstanceArn": { "target": "com.amazonaws.chimesdkidentity#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the AppInstance.
The information for each administrator.
" } }, "NextToken": { "target": "com.amazonaws.chimesdkidentity#NextToken", "traits": { "smithy.api#documentation": "The token returned from previous API requests until the number of administrators is\n reached.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chimesdkidentity#ListAppInstanceBots": { "type": "operation", "input": { "target": "com.amazonaws.chimesdkidentity#ListAppInstanceBotsRequest" }, "output": { "target": "com.amazonaws.chimesdkidentity#ListAppInstanceBotsResponse" }, "errors": [ { "target": "com.amazonaws.chimesdkidentity#BadRequestException" }, { "target": "com.amazonaws.chimesdkidentity#ForbiddenException" }, { "target": "com.amazonaws.chimesdkidentity#ResourceLimitExceededException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" }, { "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" }, { "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists all AppInstanceBots created under a single AppInstance.
The ARN of the AppInstance.
The maximum number of requests to return.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chimesdkidentity#NextToken", "traits": { "smithy.api#documentation": "The token passed by previous API calls until all requested bots are returned.
", "smithy.api#httpQuery": "next-token" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chimesdkidentity#ListAppInstanceBotsResponse": { "type": "structure", "members": { "AppInstanceArn": { "target": "com.amazonaws.chimesdkidentity#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the AppInstance.
" } }, "AppInstanceBots": { "target": "com.amazonaws.chimesdkidentity#AppInstanceBotList", "traits": { "smithy.api#documentation": "The information for each requested AppInstanceBot.
The token passed by previous API calls until all requested bots are returned.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chimesdkidentity#ListAppInstanceUserEndpoints": { "type": "operation", "input": { "target": "com.amazonaws.chimesdkidentity#ListAppInstanceUserEndpointsRequest" }, "output": { "target": "com.amazonaws.chimesdkidentity#ListAppInstanceUserEndpointsResponse" }, "errors": [ { "target": "com.amazonaws.chimesdkidentity#BadRequestException" }, { "target": "com.amazonaws.chimesdkidentity#ForbiddenException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" }, { "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" }, { "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.
The ARN of the AppInstanceUser.
The maximum number of endpoints that you want to return.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chimesdkidentity#NextToken", "traits": { "smithy.api#documentation": "The token passed by previous API calls until all requested endpoints are returned.
", "smithy.api#httpQuery": "next-token" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chimesdkidentity#ListAppInstanceUserEndpointsResponse": { "type": "structure", "members": { "AppInstanceUserEndpoints": { "target": "com.amazonaws.chimesdkidentity#AppInstanceUserEndpointSummaryList", "traits": { "smithy.api#documentation": "The information for each requested AppInstanceUserEndpoint.
The token passed by previous API calls until all requested endpoints are returned.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chimesdkidentity#ListAppInstanceUsers": { "type": "operation", "input": { "target": "com.amazonaws.chimesdkidentity#ListAppInstanceUsersRequest" }, "output": { "target": "com.amazonaws.chimesdkidentity#ListAppInstanceUsersResponse" }, "errors": [ { "target": "com.amazonaws.chimesdkidentity#BadRequestException" }, { "target": "com.amazonaws.chimesdkidentity#ForbiddenException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" }, { "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" }, { "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "List all AppInstanceUsers created under a single\n AppInstance.
The ARN of the AppInstance.
The maximum number of requests that you want returned.
", "smithy.api#httpQuery": "max-results" } }, "NextToken": { "target": "com.amazonaws.chimesdkidentity#NextToken", "traits": { "smithy.api#documentation": "The token passed by previous API calls until all requested users are returned.
", "smithy.api#httpQuery": "next-token" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chimesdkidentity#ListAppInstanceUsersResponse": { "type": "structure", "members": { "AppInstanceArn": { "target": "com.amazonaws.chimesdkidentity#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the AppInstance.
The information for each requested AppInstanceUser.
The token passed by previous API calls until all requested users are returned.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chimesdkidentity#ListAppInstances": { "type": "operation", "input": { "target": "com.amazonaws.chimesdkidentity#ListAppInstancesRequest" }, "output": { "target": "com.amazonaws.chimesdkidentity#ListAppInstancesResponse" }, "errors": [ { "target": "com.amazonaws.chimesdkidentity#BadRequestException" }, { "target": "com.amazonaws.chimesdkidentity#ForbiddenException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" }, { "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" }, { "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Lists all Amazon Chime AppInstances created under a single AWS\n account.
The maximum number of AppInstances that you want to return.
The token passed by previous API requests until you reach the maximum number of\n AppInstances.
The information for each AppInstance.
The token passed by previous API requests until the maximum number of\n AppInstances is reached.
Lists the tags applied to an Amazon Chime SDK identity resource.
", "smithy.api#http": { "method": "GET", "uri": "/tags", "code": 200 } } }, "com.amazonaws.chimesdkidentity#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.chimesdkidentity#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the resource.
", "smithy.api#httpQuery": "arn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chimesdkidentity#ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.chimesdkidentity#TagList", "traits": { "smithy.api#documentation": "The tag key-value pairs.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chimesdkidentity#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.chimesdkidentity#Metadata": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": ".*", "smithy.api#sensitive": {} } }, "com.amazonaws.chimesdkidentity#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 }, "smithy.api#pattern": ".*", "smithy.api#sensitive": {} } }, "com.amazonaws.chimesdkidentity#NonEmptyResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*$", "smithy.api#sensitive": {} } }, "com.amazonaws.chimesdkidentity#NonEmptySensitiveString1600": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1600 }, "smithy.api#pattern": ".*", "smithy.api#sensitive": {} } }, "com.amazonaws.chimesdkidentity#NotFoundException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.chimesdkidentity#ErrorCode" }, "Message": { "target": "com.amazonaws.chimesdkidentity#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.chimesdkidentity#PutAppInstanceRetentionSettings": { "type": "operation", "input": { "target": "com.amazonaws.chimesdkidentity#PutAppInstanceRetentionSettingsRequest" }, "output": { "target": "com.amazonaws.chimesdkidentity#PutAppInstanceRetentionSettingsResponse" }, "errors": [ { "target": "com.amazonaws.chimesdkidentity#BadRequestException" }, { "target": "com.amazonaws.chimesdkidentity#ForbiddenException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" }, { "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" }, { "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Sets the amount of time in days that a given AppInstance retains\n data.
The ARN of the AppInstance.
The time in days to retain data. Data type: number.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chimesdkidentity#PutAppInstanceRetentionSettingsResponse": { "type": "structure", "members": { "AppInstanceRetentionSettings": { "target": "com.amazonaws.chimesdkidentity#AppInstanceRetentionSettings", "traits": { "smithy.api#documentation": "The time in days to retain data. Data type: number.
" } }, "InitiateDeletionTimestamp": { "target": "com.amazonaws.chimesdkidentity#Timestamp", "traits": { "smithy.api#documentation": "The time at which the API deletes data.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chimesdkidentity#PutAppInstanceUserExpirationSettings": { "type": "operation", "input": { "target": "com.amazonaws.chimesdkidentity#PutAppInstanceUserExpirationSettingsRequest" }, "output": { "target": "com.amazonaws.chimesdkidentity#PutAppInstanceUserExpirationSettingsResponse" }, "errors": [ { "target": "com.amazonaws.chimesdkidentity#BadRequestException" }, { "target": "com.amazonaws.chimesdkidentity#ConflictException" }, { "target": "com.amazonaws.chimesdkidentity#ForbiddenException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" }, { "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" }, { "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Sets the number of days before the AppInstanceUser is automatically deleted.
A background process deletes expired AppInstanceUsers within 6 hours of expiration. \n Actual deletion times may vary.
Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update \n their expiration settings. The system honors the new settings.
The ARN of the AppInstanceUser.
Settings that control the interval after which an AppInstanceUser is automatically deleted.
The ARN of the AppInstanceUser.
Settings that control the interval after which an AppInstanceUser is automatically deleted.
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.
The ARN of the AppInstanceUser.
The name of the AppInstanceUserEndpoint.
The type of the AppInstanceUserEndpoint. Supported types:
\n APNS: The mobile notification service for an Apple device.
\n APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.
\n 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.
", "smithy.api#required": {} } }, "EndpointAttributes": { "target": "com.amazonaws.chimesdkidentity#EndpointAttributes", "traits": { "smithy.api#documentation": "The attributes of an Endpoint.
The unique ID assigned to the request. Use different tokens to register other endpoints.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "AllowMessages": { "target": "com.amazonaws.chimesdkidentity#AllowMessages", "traits": { "smithy.api#documentation": "Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. \n NONE indicates the endpoint receives no messages.
The ARN of the AppInstanceUser.
The unique identifier of the AppInstanceUserEndpoint.
The request exceeds the resource limit.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.chimesdkidentity#ResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*$", "smithy.api#sensitive": {} } }, "com.amazonaws.chimesdkidentity#RespondsTo": { "type": "enum", "members": { "STANDARD_MESSAGES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STANDARD_MESSAGES" } } } }, "com.amazonaws.chimesdkidentity#RetentionDays": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 5475 } } }, "com.amazonaws.chimesdkidentity#SensitiveChimeArn": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 1600 }, "smithy.api#pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", "smithy.api#sensitive": {} } }, "com.amazonaws.chimesdkidentity#SensitiveString1600": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1600 }, "smithy.api#pattern": ".*", "smithy.api#sensitive": {} } }, "com.amazonaws.chimesdkidentity#ServiceFailureException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.chimesdkidentity#ErrorCode" }, "Message": { "target": "com.amazonaws.chimesdkidentity#String" } }, "traits": { "smithy.api#documentation": "The service encountered an unexpected error.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chimesdkidentity#ServiceUnavailableException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.chimesdkidentity#ErrorCode" }, "Message": { "target": "com.amazonaws.chimesdkidentity#String" } }, "traits": { "smithy.api#documentation": "The service is currently unavailable.
", "smithy.api#error": "server", "smithy.api#httpError": 503 } }, "com.amazonaws.chimesdkidentity#StandardMessages": { "type": "enum", "members": { "AUTO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AUTO" } }, "ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL" } }, "MENTIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MENTIONS" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } } } }, "com.amazonaws.chimesdkidentity#String": { "type": "string" }, "com.amazonaws.chimesdkidentity#String1600": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1600 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.chimesdkidentity#String64": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 64 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.chimesdkidentity#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.chimesdkidentity#TagKey", "traits": { "smithy.api#documentation": "The key in a tag.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.chimesdkidentity#TagValue", "traits": { "smithy.api#documentation": "The value in a tag.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A tag object containing a key-value pair.
" } }, "com.amazonaws.chimesdkidentity#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#sensitive": {} } }, "com.amazonaws.chimesdkidentity#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.chimesdkidentity#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.chimesdkidentity#TagList": { "type": "list", "member": { "target": "com.amazonaws.chimesdkidentity#Tag" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.chimesdkidentity#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.chimesdkidentity#TagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.chimesdkidentity#BadRequestException" }, { "target": "com.amazonaws.chimesdkidentity#ForbiddenException" }, { "target": "com.amazonaws.chimesdkidentity#ResourceLimitExceededException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" }, { "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" }, { "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Applies the specified tags to the specified Amazon Chime SDK identity resource.
", "smithy.api#http": { "method": "POST", "uri": "/tags?operation=tag-resource", "code": 204 } } }, "com.amazonaws.chimesdkidentity#TagResourceRequest": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.chimesdkidentity#ChimeArn", "traits": { "smithy.api#documentation": "The resource ARN.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.chimesdkidentity#TagList", "traits": { "smithy.api#documentation": "The tag key-value pairs.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chimesdkidentity#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#sensitive": {} } }, "com.amazonaws.chimesdkidentity#TargetedMessages": { "type": "enum", "members": { "ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } } } }, "com.amazonaws.chimesdkidentity#ThrottledClientException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.chimesdkidentity#ErrorCode" }, "Message": { "target": "com.amazonaws.chimesdkidentity#String" } }, "traits": { "smithy.api#documentation": "The client exceeded its request rate limit.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.chimesdkidentity#Timestamp": { "type": "timestamp" }, "com.amazonaws.chimesdkidentity#UnauthorizedClientException": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.chimesdkidentity#ErrorCode" }, "Message": { "target": "com.amazonaws.chimesdkidentity#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.chimesdkidentity#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.chimesdkidentity#UntagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.chimesdkidentity#BadRequestException" }, { "target": "com.amazonaws.chimesdkidentity#ForbiddenException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" }, { "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" }, { "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Removes the specified tags from the specified Amazon Chime SDK identity resource.
", "smithy.api#http": { "method": "POST", "uri": "/tags?operation=untag-resource", "code": 204 } } }, "com.amazonaws.chimesdkidentity#UntagResourceRequest": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.chimesdkidentity#ChimeArn", "traits": { "smithy.api#documentation": "The resource ARN.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.chimesdkidentity#TagKeyList", "traits": { "smithy.api#documentation": "The tag keys.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chimesdkidentity#UpdateAppInstance": { "type": "operation", "input": { "target": "com.amazonaws.chimesdkidentity#UpdateAppInstanceRequest" }, "output": { "target": "com.amazonaws.chimesdkidentity#UpdateAppInstanceResponse" }, "errors": [ { "target": "com.amazonaws.chimesdkidentity#BadRequestException" }, { "target": "com.amazonaws.chimesdkidentity#ConflictException" }, { "target": "com.amazonaws.chimesdkidentity#ForbiddenException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" }, { "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" }, { "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" }, { "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" } ], "traits": { "smithy.api#documentation": "Updates AppInstance metadata.
Updates the name and metadata of an AppInstanceBot.
The ARN of the AppInstanceBot.
The name of the AppInstanceBot.
The metadata of the AppInstanceBot.
The configuration for the bot update.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chimesdkidentity#UpdateAppInstanceBotResponse": { "type": "structure", "members": { "AppInstanceBotArn": { "target": "com.amazonaws.chimesdkidentity#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the AppInstanceBot.
The ARN of the AppInstance.
The name that you want to change.
", "smithy.api#required": {} } }, "Metadata": { "target": "com.amazonaws.chimesdkidentity#Metadata", "traits": { "smithy.api#documentation": "The metadata that you want to change.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chimesdkidentity#UpdateAppInstanceResponse": { "type": "structure", "members": { "AppInstanceArn": { "target": "com.amazonaws.chimesdkidentity#ChimeArn", "traits": { "smithy.api#documentation": "The ARN of the AppInstance.
Updates the details of an AppInstanceUser. You can update names and\n metadata.
Updates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage values.
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. \n 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.