{ "smithy": "2.0", "shapes": { "com.amazonaws.ivschat#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ivschat#ErrorMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.ivschat#AmazonInteractiveVideoServiceChat": { "type": "service", "version": "2020-07-14", "operations": [ { "target": "com.amazonaws.ivschat#CreateChatToken" }, { "target": "com.amazonaws.ivschat#CreateLoggingConfiguration" }, { "target": "com.amazonaws.ivschat#CreateRoom" }, { "target": "com.amazonaws.ivschat#DeleteLoggingConfiguration" }, { "target": "com.amazonaws.ivschat#DeleteMessage" }, { "target": "com.amazonaws.ivschat#DeleteRoom" }, { "target": "com.amazonaws.ivschat#DisconnectUser" }, { "target": "com.amazonaws.ivschat#GetLoggingConfiguration" }, { "target": "com.amazonaws.ivschat#GetRoom" }, { "target": "com.amazonaws.ivschat#ListLoggingConfigurations" }, { "target": "com.amazonaws.ivschat#ListRooms" }, { "target": "com.amazonaws.ivschat#ListTagsForResource" }, { "target": "com.amazonaws.ivschat#SendEvent" }, { "target": "com.amazonaws.ivschat#TagResource" }, { "target": "com.amazonaws.ivschat#UntagResource" }, { "target": "com.amazonaws.ivschat#UpdateLoggingConfiguration" }, { "target": "com.amazonaws.ivschat#UpdateRoom" } ], "traits": { "aws.api#service": { "sdkId": "ivschat", "arnNamespace": "ivschat", "cloudFormationName": "IVSChat", "cloudTrailEventSource": "ivschat.amazonaws.com" }, "aws.auth#sigv4": { "name": "ivschat" }, "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ "Content-Type", "X-Api-Key", "X-Amz-Content-Sha256", "X-Amz-User-Agent", "amz-sdk-invocation-id", "amz-sdk-request" ], "additionalExposedHeaders": [ "x-amzn-errortype", "x-amzn-requestid", "x-amzn-errormessage", "x-amzn-trace-id", "x-amzn-requestid", "x-amz-apigw-id", "date" ] }, "smithy.api#documentation": "

\n Introduction\n

\n

The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat\n resources. You also need to integrate with the Amazon IVS Chat Messaging\n API, to enable users to interact with chat rooms in real time.

\n

The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat\n HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the\n AWS General Reference.

\n

This document describes HTTP operations. There is a separate messaging API\n for managing Chat resources; see the Amazon IVS Chat Messaging API\n Reference.

\n

\n Notes on terminology:\n

\n \n

\n Resources\n

\n

The following resources are part of Amazon IVS Chat:

\n \n

\n Tagging\n

\n

A tag is a metadata label that you assign to an AWS resource. A tag\n comprises a key and a value, both set by you. For\n example, you might set a tag as topic:nature to label a particular video\n category. See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no service-specific\n constraints beyond what is documented there.

\n

Tags can help you identify and organize your AWS resources. For example, you can use the\n same tag for different resources to indicate that they are related. You can also use tags to\n manage access (see Access Tags).

\n

The Amazon IVS Chat API has these tag-related operations: TagResource, UntagResource, and\n ListTagsForResource. The following resource supports tagging: Room.

\n

At most 50 tags can be applied to a resource.

\n

\n API Access Security\n

\n

Your Amazon IVS Chat applications (service applications and clients) must be authenticated\n and authorized to access Amazon IVS Chat resources. Note the differences between these\n concepts:

\n \n

Users (viewers) connect to a room using secure access tokens that you create using the\n CreateChatToken operation through the AWS SDK. You call CreateChatToken for\n every user\u2019s chat session, passing identity and authorization information about the\n user.

\n

\n Signing API Requests\n

\n

HTTP API requests must be signed with an AWS SigV4 signature using your AWS security\n credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the\n underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API\n directly, it\u2019s your responsibility to sign the requests.

\n

You generate a signature using valid AWS credentials for an IAM role that has permission\n to perform the requested action. For example, DeleteMessage requests must be made using an IAM\n role that has the ivschat:DeleteMessage permission.

\n

For more information:

\n \n

\n Amazon Resource Names (ARNs)\n

\n

ARNs uniquely identify AWS resources. An ARN is required when you need to specify a\n resource unambiguously across all of AWS, such as in IAM policies and API calls. For more\n information, see Amazon Resource Names in the AWS General\n Reference.

", "smithy.api#title": "Amazon Interactive Video Service Chat", "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://ivschat-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://ivschat-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://ivschat.{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://ivschat.{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://ivschat-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://ivschat-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://ivschat.{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://ivschat.{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-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ivschat.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ivschat.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://ivschat.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ivschat-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://ivschat-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://ivschat.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://ivschat-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://ivschat-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://ivschat.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://ivschat.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://ivschat-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://ivschat-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://ivschat.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://ivschat.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://ivschat-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://ivschat.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://ivschat-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://ivschat.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.ivschat#BucketName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 63 }, "smithy.api#pattern": "^[a-z0-9-.]+$" } }, "com.amazonaws.ivschat#ChatToken": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.ivschat#ChatTokenAttributes": { "type": "map", "key": { "target": "com.amazonaws.ivschat#String" }, "value": { "target": "com.amazonaws.ivschat#String" }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.ivschat#ChatTokenCapabilities": { "type": "list", "member": { "target": "com.amazonaws.ivschat#ChatTokenCapability" } }, "com.amazonaws.ivschat#ChatTokenCapability": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SEND_MESSAGE", "name": "SEND_MESSAGE" }, { "value": "DISCONNECT_USER", "name": "DISCONNECT_USER" }, { "value": "DELETE_MESSAGE", "name": "DELETE_MESSAGE" } ] } }, "com.amazonaws.ivschat#CloudWatchLogsDestinationConfiguration": { "type": "structure", "members": { "logGroupName": { "target": "com.amazonaws.ivschat#LogGroupName", "traits": { "smithy.api#documentation": "

Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Specifies a CloudWatch Logs location where chat logs will be stored.

" } }, "com.amazonaws.ivschat#ConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ivschat#ErrorMessage", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "com.amazonaws.ivschat#ResourceId", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "resourceType": { "target": "com.amazonaws.ivschat#ResourceType", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.ivschat#CreateChatToken": { "type": "operation", "input": { "target": "com.amazonaws.ivschat#CreateChatTokenRequest" }, "output": { "target": "com.amazonaws.ivschat#CreateChatTokenResponse" }, "errors": [ { "target": "com.amazonaws.ivschat#AccessDeniedException" }, { "target": "com.amazonaws.ivschat#PendingVerification" }, { "target": "com.amazonaws.ivschat#ResourceNotFoundException" }, { "target": "com.amazonaws.ivschat#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates an encrypted token that is used by a chat participant to establish an individual\n WebSocket chat connection to a room. When the token is used to connect to chat, the\n connection is valid for the session duration specified in the request. The token becomes\n invalid at the token-expiration timestamp included in the response.

\n

Use the capabilities field to permit an end user to send messages or\n moderate a room.

\n

The attributes field securely attaches structured data to the chat session; the data is\n included within each message sent by the end user and received by other participants in the\n room. Common use cases for attributes include passing end-user profile data like an icon,\n display name, colors, badges, and other display features.

\n

Encryption keys are owned by Amazon IVS Chat and never used directly by your\n application.

", "smithy.api#http": { "method": "POST", "uri": "/CreateChatToken" } } }, "com.amazonaws.ivschat#CreateChatTokenRequest": { "type": "structure", "members": { "roomIdentifier": { "target": "com.amazonaws.ivschat#RoomIdentifier", "traits": { "smithy.api#documentation": "

Identifier of the room that the client is trying to access. Currently this must be an\n ARN.

", "smithy.api#required": {} } }, "userId": { "target": "com.amazonaws.ivschat#UserID", "traits": { "smithy.api#documentation": "

Application-provided ID that uniquely identifies the user associated with this token.\n This can be any UTF-8 encoded text.

", "smithy.api#required": {} } }, "capabilities": { "target": "com.amazonaws.ivschat#ChatTokenCapabilities", "traits": { "smithy.api#documentation": "

Set of capabilities that the user is allowed to perform in the room. Default: None (the\n capability to view messages is implicitly included in all requests).

" } }, "sessionDurationInMinutes": { "target": "com.amazonaws.ivschat#SessionDurationInMinutes", "traits": { "smithy.api#documentation": "

Session duration (in minutes), after which the session expires. Default: 60 (1\n hour).

" } }, "attributes": { "target": "com.amazonaws.ivschat#ChatTokenAttributes", "traits": { "smithy.api#documentation": "

Application-provided attributes to encode into the token and attach to a chat session.\n Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1\n KB total.

" } } } }, "com.amazonaws.ivschat#CreateChatTokenResponse": { "type": "structure", "members": { "token": { "target": "com.amazonaws.ivschat#ChatToken", "traits": { "smithy.api#documentation": "

The issued client token, encrypted.

" } }, "tokenExpirationTime": { "target": "com.amazonaws.ivschat#Time", "traits": { "smithy.api#documentation": "

Time after which the token is no longer valid and cannot be used to connect to a room.\n This is an ISO 8601 timestamp; note that this is returned as a\n string.

" } }, "sessionExpirationTime": { "target": "com.amazonaws.ivschat#Time", "traits": { "smithy.api#documentation": "

Time after which an end user's session is no longer valid. This is an ISO 8601\n timestamp; note that this is returned as a string.

" } } } }, "com.amazonaws.ivschat#CreateLoggingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.ivschat#CreateLoggingConfigurationRequest" }, "output": { "target": "com.amazonaws.ivschat#CreateLoggingConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.ivschat#AccessDeniedException" }, { "target": "com.amazonaws.ivschat#ConflictException" }, { "target": "com.amazonaws.ivschat#PendingVerification" }, { "target": "com.amazonaws.ivschat#ResourceNotFoundException" }, { "target": "com.amazonaws.ivschat#ServiceQuotaExceededException" }, { "target": "com.amazonaws.ivschat#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a logging configuration that allows clients to store and record sent\n messages.

", "smithy.api#http": { "method": "POST", "uri": "/CreateLoggingConfiguration" } } }, "com.amazonaws.ivschat#CreateLoggingConfigurationRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ivschat#LoggingConfigurationName", "traits": { "smithy.api#documentation": "

Logging-configuration name. The value does not need to be unique.

" } }, "destinationConfiguration": { "target": "com.amazonaws.ivschat#DestinationConfiguration", "traits": { "smithy.api#documentation": "

A complex type that contains a destination configuration for where chat content will be\n logged. There can be only one type of destination (cloudWatchLogs,\n firehose, or s3) in a\n destinationConfiguration.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.ivschat#Tags", "traits": { "smithy.api#documentation": "

Tags to attach to the resource. Array of maps, each of the form string:string\n (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints on tags beyond what is\n documented there.

" } } } }, "com.amazonaws.ivschat#CreateLoggingConfigurationResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivschat#LoggingConfigurationArn", "traits": { "smithy.api#documentation": "

Logging-configuration ARN, assigned by the system.

" } }, "id": { "target": "com.amazonaws.ivschat#LoggingConfigurationID", "traits": { "smithy.api#documentation": "

Logging-configuration ID, generated by the system. This is a relative identifier, the\n part of the ARN that uniquely identifies the logging configuration.

" } }, "createTime": { "target": "com.amazonaws.ivschat#Time", "traits": { "smithy.api#documentation": "

Time when the logging configuration was created. This is an ISO 8601 timestamp;\n note that this is returned as a string.

" } }, "updateTime": { "target": "com.amazonaws.ivschat#Time", "traits": { "smithy.api#documentation": "

Time of the logging configuration\u2019s last update. This is an ISO 8601 timestamp;\n note that this is returned as a string.

" } }, "name": { "target": "com.amazonaws.ivschat#LoggingConfigurationName", "traits": { "smithy.api#documentation": "

Logging-configuration name, from the request (if specified).

" } }, "destinationConfiguration": { "target": "com.amazonaws.ivschat#DestinationConfiguration", "traits": { "smithy.api#documentation": "

A complex type that contains a destination configuration for where chat content will be\n logged, from the request. There is only one type of destination\n (cloudWatchLogs, firehose, or s3) in a\n destinationConfiguration.

" } }, "state": { "target": "com.amazonaws.ivschat#CreateLoggingConfigurationState", "traits": { "smithy.api#documentation": "

The state of the logging configuration. When the state is ACTIVE, the\n configuration is ready to log chat content.

" } }, "tags": { "target": "com.amazonaws.ivschat#Tags", "traits": { "smithy.api#documentation": "

Tags attached to the resource, from the request (if specified). Array of maps, each of\n the form string:string (key:value).

" } } } }, "com.amazonaws.ivschat#CreateLoggingConfigurationState": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACTIVE", "name": "ACTIVE" } ] } }, "com.amazonaws.ivschat#CreateRoom": { "type": "operation", "input": { "target": "com.amazonaws.ivschat#CreateRoomRequest" }, "output": { "target": "com.amazonaws.ivschat#CreateRoomResponse" }, "errors": [ { "target": "com.amazonaws.ivschat#AccessDeniedException" }, { "target": "com.amazonaws.ivschat#ConflictException" }, { "target": "com.amazonaws.ivschat#PendingVerification" }, { "target": "com.amazonaws.ivschat#ResourceNotFoundException" }, { "target": "com.amazonaws.ivschat#ServiceQuotaExceededException" }, { "target": "com.amazonaws.ivschat#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a room that allows clients to connect and pass messages.

", "smithy.api#http": { "method": "POST", "uri": "/CreateRoom" } } }, "com.amazonaws.ivschat#CreateRoomRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ivschat#RoomName", "traits": { "smithy.api#documentation": "

Room name. The value does not need to be unique.

" } }, "maximumMessageRatePerSecond": { "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", "traits": { "smithy.api#documentation": "

Maximum number of messages per second that can be sent to the room (by all clients).\n Default: 10.

" } }, "maximumMessageLength": { "target": "com.amazonaws.ivschat#RoomMaxMessageLength", "traits": { "smithy.api#documentation": "

Maximum number of characters in a single message. Messages are expected to be UTF-8\n encoded and this limit applies specifically to rune/code-point count, not number of bytes.\n Default: 500.

" } }, "messageReviewHandler": { "target": "com.amazonaws.ivschat#MessageReviewHandler", "traits": { "smithy.api#documentation": "

Configuration information for optional review of messages.

" } }, "tags": { "target": "com.amazonaws.ivschat#Tags", "traits": { "smithy.api#documentation": "

Tags to attach to the resource. Array of maps, each of the form string:string\n (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented\n there.

" } }, "loggingConfigurationIdentifiers": { "target": "com.amazonaws.ivschat#LoggingConfigurationIdentifierList", "traits": { "smithy.api#documentation": "

Array of logging-configuration identifiers attached to the room.

" } } } }, "com.amazonaws.ivschat#CreateRoomResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivschat#RoomArn", "traits": { "smithy.api#documentation": "

Room ARN, assigned by the system.

" } }, "id": { "target": "com.amazonaws.ivschat#RoomID", "traits": { "smithy.api#documentation": "

Room ID, generated by the system. This is a relative identifier, the part of the ARN\n that uniquely identifies the room.

" } }, "name": { "target": "com.amazonaws.ivschat#RoomName", "traits": { "smithy.api#documentation": "

Room name, from the request (if specified).

" } }, "createTime": { "target": "com.amazonaws.ivschat#Time", "traits": { "smithy.api#documentation": "

Time when the room was created. This is an ISO 8601 timestamp; note that this\n is returned as a string.

" } }, "updateTime": { "target": "com.amazonaws.ivschat#Time", "traits": { "smithy.api#documentation": "

Time of the room\u2019s last update. This is an ISO 8601 timestamp; note that this\n is returned as a string.

" } }, "maximumMessageRatePerSecond": { "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", "traits": { "smithy.api#documentation": "

Maximum number of messages per second that can be sent to the room (by all clients),\n from the request (if specified).

" } }, "maximumMessageLength": { "target": "com.amazonaws.ivschat#RoomMaxMessageLength", "traits": { "smithy.api#documentation": "

Maximum number of characters in a single message, from the request (if\n specified).

" } }, "messageReviewHandler": { "target": "com.amazonaws.ivschat#MessageReviewHandler", "traits": { "smithy.api#documentation": "

Configuration information for optional review of messages.

" } }, "tags": { "target": "com.amazonaws.ivschat#Tags", "traits": { "smithy.api#documentation": "

Tags attached to the resource, from the request (if specified).

" } }, "loggingConfigurationIdentifiers": { "target": "com.amazonaws.ivschat#LoggingConfigurationIdentifierList", "traits": { "smithy.api#documentation": "

Array of logging configurations attached to the room, from the request (if\n specified).

" } } } }, "com.amazonaws.ivschat#DeleteLoggingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.ivschat#DeleteLoggingConfigurationRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.ivschat#AccessDeniedException" }, { "target": "com.amazonaws.ivschat#ConflictException" }, { "target": "com.amazonaws.ivschat#PendingVerification" }, { "target": "com.amazonaws.ivschat#ResourceNotFoundException" }, { "target": "com.amazonaws.ivschat#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified logging configuration.

", "smithy.api#http": { "method": "POST", "uri": "/DeleteLoggingConfiguration", "code": 204 } } }, "com.amazonaws.ivschat#DeleteLoggingConfigurationRequest": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.ivschat#LoggingConfigurationIdentifier", "traits": { "smithy.api#documentation": "

Identifier of the logging configuration to be deleted.

", "smithy.api#required": {} } } } }, "com.amazonaws.ivschat#DeleteMessage": { "type": "operation", "input": { "target": "com.amazonaws.ivschat#DeleteMessageRequest" }, "output": { "target": "com.amazonaws.ivschat#DeleteMessageResponse" }, "errors": [ { "target": "com.amazonaws.ivschat#AccessDeniedException" }, { "target": "com.amazonaws.ivschat#PendingVerification" }, { "target": "com.amazonaws.ivschat#ResourceNotFoundException" }, { "target": "com.amazonaws.ivschat#ThrottlingException" }, { "target": "com.amazonaws.ivschat#ValidationException" } ], "traits": { "smithy.api#documentation": "

Sends an event to a specific room which directs clients to delete a specific message;\n that is, unrender it from view and delete it from the client\u2019s chat history. This event\u2019s\n EventName is aws:DELETE_MESSAGE. This replicates the \n DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.

", "smithy.api#http": { "method": "POST", "uri": "/DeleteMessage" } } }, "com.amazonaws.ivschat#DeleteMessageRequest": { "type": "structure", "members": { "roomIdentifier": { "target": "com.amazonaws.ivschat#RoomIdentifier", "traits": { "smithy.api#documentation": "

Identifier of the room where the message should be deleted. Currently this must be an\n ARN.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.ivschat#MessageID", "traits": { "smithy.api#documentation": "

ID of the message to be deleted. This is the Id field in the received\n message (see Message\n (Subscribe) in the Chat Messaging API).

", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.ivschat#Reason", "traits": { "smithy.api#documentation": "

Reason for deleting the message.

" } } } }, "com.amazonaws.ivschat#DeleteMessageResponse": { "type": "structure", "members": { "id": { "target": "com.amazonaws.ivschat#ID", "traits": { "smithy.api#documentation": "

Operation identifier, generated by Amazon IVS Chat.

" } } } }, "com.amazonaws.ivschat#DeleteRoom": { "type": "operation", "input": { "target": "com.amazonaws.ivschat#DeleteRoomRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.ivschat#AccessDeniedException" }, { "target": "com.amazonaws.ivschat#PendingVerification" }, { "target": "com.amazonaws.ivschat#ResourceNotFoundException" }, { "target": "com.amazonaws.ivschat#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified room.

", "smithy.api#http": { "method": "POST", "uri": "/DeleteRoom", "code": 204 } } }, "com.amazonaws.ivschat#DeleteRoomRequest": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.ivschat#RoomIdentifier", "traits": { "smithy.api#documentation": "

Identifier of the room to be deleted. Currently this must be an ARN.

", "smithy.api#required": {} } } } }, "com.amazonaws.ivschat#DeliveryStreamName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.ivschat#DestinationConfiguration": { "type": "union", "members": { "s3": { "target": "com.amazonaws.ivschat#S3DestinationConfiguration", "traits": { "smithy.api#documentation": "

An Amazon S3 destination configuration where chat activity will be logged.

" } }, "cloudWatchLogs": { "target": "com.amazonaws.ivschat#CloudWatchLogsDestinationConfiguration", "traits": { "smithy.api#documentation": "

An Amazon CloudWatch Logs destination configuration where chat activity will be\n logged.

" } }, "firehose": { "target": "com.amazonaws.ivschat#FirehoseDestinationConfiguration", "traits": { "smithy.api#documentation": "

An Amazon Kinesis Data Firehose destination configuration where chat activity will be\n logged.

" } } }, "traits": { "smithy.api#documentation": "

A complex type that describes a location where chat logs will be stored. Each member\n represents the configuration of one log destination. For logging, you define only one type of\n destination (for CloudWatch Logs, Kinesis Firehose, or S3).

" } }, "com.amazonaws.ivschat#DisconnectUser": { "type": "operation", "input": { "target": "com.amazonaws.ivschat#DisconnectUserRequest" }, "output": { "target": "com.amazonaws.ivschat#DisconnectUserResponse" }, "errors": [ { "target": "com.amazonaws.ivschat#AccessDeniedException" }, { "target": "com.amazonaws.ivschat#PendingVerification" }, { "target": "com.amazonaws.ivschat#ResourceNotFoundException" }, { "target": "com.amazonaws.ivschat#ThrottlingException" }, { "target": "com.amazonaws.ivschat#ValidationException" } ], "traits": { "smithy.api#documentation": "

Disconnects all connections using a specified user ID from a room. This replicates the\n \n DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.

", "smithy.api#http": { "method": "POST", "uri": "/DisconnectUser" } } }, "com.amazonaws.ivschat#DisconnectUserRequest": { "type": "structure", "members": { "roomIdentifier": { "target": "com.amazonaws.ivschat#RoomIdentifier", "traits": { "smithy.api#documentation": "

Identifier of the room from which the user's clients should be disconnected. Currently\n this must be an ARN.

", "smithy.api#required": {} } }, "userId": { "target": "com.amazonaws.ivschat#UserID", "traits": { "smithy.api#documentation": "

ID of the user (connection) to disconnect from the room.

", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.ivschat#Reason", "traits": { "smithy.api#documentation": "

Reason for disconnecting the user.

" } } } }, "com.amazonaws.ivschat#DisconnectUserResponse": { "type": "structure", "members": {} }, "com.amazonaws.ivschat#ErrorMessage": { "type": "string" }, "com.amazonaws.ivschat#EventAttributes": { "type": "map", "key": { "target": "com.amazonaws.ivschat#String" }, "value": { "target": "com.amazonaws.ivschat#String" } }, "com.amazonaws.ivschat#EventName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.ivschat#FallbackResult": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ALLOW", "name": "ALLOW" }, { "value": "DENY", "name": "DENY" } ] } }, "com.amazonaws.ivschat#FieldName": { "type": "string" }, "com.amazonaws.ivschat#FirehoseDestinationConfiguration": { "type": "structure", "members": { "deliveryStreamName": { "target": "com.amazonaws.ivschat#DeliveryStreamName", "traits": { "smithy.api#documentation": "

Name of the Amazon Kinesis Firehose delivery stream where chat activity will be\n logged.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Specifies a Kinesis Firehose location where chat logs will be stored.

" } }, "com.amazonaws.ivschat#GetLoggingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.ivschat#GetLoggingConfigurationRequest" }, "output": { "target": "com.amazonaws.ivschat#GetLoggingConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.ivschat#AccessDeniedException" }, { "target": "com.amazonaws.ivschat#ResourceNotFoundException" }, { "target": "com.amazonaws.ivschat#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets the specified logging configuration.

", "smithy.api#http": { "method": "POST", "uri": "/GetLoggingConfiguration" } } }, "com.amazonaws.ivschat#GetLoggingConfigurationRequest": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.ivschat#LoggingConfigurationIdentifier", "traits": { "smithy.api#documentation": "

Identifier of the logging configuration to be retrieved.

", "smithy.api#required": {} } } } }, "com.amazonaws.ivschat#GetLoggingConfigurationResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivschat#LoggingConfigurationArn", "traits": { "smithy.api#documentation": "

Logging-configuration ARN, from the request (if identifier was an\n ARN).

" } }, "id": { "target": "com.amazonaws.ivschat#LoggingConfigurationID", "traits": { "smithy.api#documentation": "

Logging-configuration ID, generated by the system. This is a relative identifier, the\n part of the ARN that uniquely identifies the logging configuration.

" } }, "createTime": { "target": "com.amazonaws.ivschat#Time", "traits": { "smithy.api#documentation": "

Time when the logging configuration was created. This is an ISO 8601 timestamp;\n note that this is returned as a string.

" } }, "updateTime": { "target": "com.amazonaws.ivschat#Time", "traits": { "smithy.api#documentation": "

Time of the logging configuration\u2019s last update. This is an ISO 8601 timestamp;\n note that this is returned as a string.

" } }, "name": { "target": "com.amazonaws.ivschat#LoggingConfigurationName", "traits": { "smithy.api#documentation": "

Logging-configuration name. This value does not need to be unique.

" } }, "destinationConfiguration": { "target": "com.amazonaws.ivschat#DestinationConfiguration", "traits": { "smithy.api#documentation": "

A complex type that contains a destination configuration for where chat content will be\n logged. There is only one type of destination (cloudWatchLogs,\n firehose, or s3) in a\n destinationConfiguration.

" } }, "state": { "target": "com.amazonaws.ivschat#LoggingConfigurationState", "traits": { "smithy.api#documentation": "

The state of the logging configuration. When the state is ACTIVE, the\n configuration is ready to log chat content.

" } }, "tags": { "target": "com.amazonaws.ivschat#Tags", "traits": { "smithy.api#documentation": "

Tags attached to the resource. Array of maps, each of the form string:string\n (key:value).

" } } } }, "com.amazonaws.ivschat#GetRoom": { "type": "operation", "input": { "target": "com.amazonaws.ivschat#GetRoomRequest" }, "output": { "target": "com.amazonaws.ivschat#GetRoomResponse" }, "errors": [ { "target": "com.amazonaws.ivschat#AccessDeniedException" }, { "target": "com.amazonaws.ivschat#ResourceNotFoundException" }, { "target": "com.amazonaws.ivschat#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets the specified room.

", "smithy.api#http": { "method": "POST", "uri": "/GetRoom" }, "smithy.api#readonly": {} } }, "com.amazonaws.ivschat#GetRoomRequest": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.ivschat#RoomIdentifier", "traits": { "smithy.api#documentation": "

Identifier of the room for which the configuration is to be retrieved. Currently this\n must be an ARN.

", "smithy.api#required": {} } } } }, "com.amazonaws.ivschat#GetRoomResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivschat#RoomArn", "traits": { "smithy.api#documentation": "

Room ARN, from the request (if identifier was an ARN).

" } }, "id": { "target": "com.amazonaws.ivschat#RoomID", "traits": { "smithy.api#documentation": "

Room ID, generated by the system. This is a relative identifier, the part of the ARN\n that uniquely identifies the room.

" } }, "name": { "target": "com.amazonaws.ivschat#RoomName", "traits": { "smithy.api#documentation": "

Room name. The value does not need to be unique.

" } }, "createTime": { "target": "com.amazonaws.ivschat#Time", "traits": { "smithy.api#documentation": "

Time when the room was created. This is an ISO 8601 timestamp; note that this\n is returned as a string.

" } }, "updateTime": { "target": "com.amazonaws.ivschat#Time", "traits": { "smithy.api#documentation": "

Time of the room\u2019s last update. This is an ISO 8601 timestamp; note that this\n is returned as a string.

" } }, "maximumMessageRatePerSecond": { "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", "traits": { "smithy.api#documentation": "

Maximum number of messages per second that can be sent to the room (by all clients).\n Default: 10.

" } }, "maximumMessageLength": { "target": "com.amazonaws.ivschat#RoomMaxMessageLength", "traits": { "smithy.api#documentation": "

Maximum number of characters in a single message. Messages are expected to be UTF-8\n encoded and this limit applies specifically to rune/code-point count, not number of bytes.\n Default: 500.

" } }, "messageReviewHandler": { "target": "com.amazonaws.ivschat#MessageReviewHandler", "traits": { "smithy.api#documentation": "

Configuration information for optional review of messages.

" } }, "tags": { "target": "com.amazonaws.ivschat#Tags", "traits": { "smithy.api#documentation": "

Tags attached to the resource. Array of maps, each of the form string:string\n (key:value).

" } }, "loggingConfigurationIdentifiers": { "target": "com.amazonaws.ivschat#LoggingConfigurationIdentifierList", "traits": { "smithy.api#documentation": "

Array of logging configurations attached to the room.

" } } } }, "com.amazonaws.ivschat#ID": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^[a-zA-Z0-9]+$" } }, "com.amazonaws.ivschat#InternalServerException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ivschat#ErrorMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.ivschat#LambdaArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 170 }, "smithy.api#pattern": "^$|^arn:aws:lambda:[a-z0-9-]+:[0-9]{12}:function:.+" } }, "com.amazonaws.ivschat#Limit": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.ivschat#ListLoggingConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.ivschat#ListLoggingConfigurationsRequest" }, "output": { "target": "com.amazonaws.ivschat#ListLoggingConfigurationsResponse" }, "errors": [ { "target": "com.amazonaws.ivschat#AccessDeniedException" }, { "target": "com.amazonaws.ivschat#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets summary information about all your logging configurations in the AWS region where\n the API request is processed.

", "smithy.api#http": { "method": "POST", "uri": "/ListLoggingConfigurations" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.ivschat#ListLoggingConfigurationsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.ivschat#PaginationToken", "traits": { "smithy.api#documentation": "

The first logging configurations to retrieve. This is used for pagination; see the\n nextToken response field.

" } }, "maxResults": { "target": "com.amazonaws.ivschat#MaxLoggingConfigurationResults", "traits": { "smithy.api#documentation": "

Maximum number of logging configurations to return. Default: 50.

" } } } }, "com.amazonaws.ivschat#ListLoggingConfigurationsResponse": { "type": "structure", "members": { "loggingConfigurations": { "target": "com.amazonaws.ivschat#LoggingConfigurationList", "traits": { "smithy.api#documentation": "

List of the matching logging configurations (summary information only). There is only\n one type of destination (cloudWatchLogs, firehose, or\n s3) in a destinationConfiguration.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ivschat#PaginationToken", "traits": { "smithy.api#documentation": "

If there are more logging configurations than maxResults, use\n nextToken in the request to get the next set.

" } } } }, "com.amazonaws.ivschat#ListRooms": { "type": "operation", "input": { "target": "com.amazonaws.ivschat#ListRoomsRequest" }, "output": { "target": "com.amazonaws.ivschat#ListRoomsResponse" }, "errors": [ { "target": "com.amazonaws.ivschat#AccessDeniedException" }, { "target": "com.amazonaws.ivschat#ResourceNotFoundException" }, { "target": "com.amazonaws.ivschat#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets summary information about all your rooms in the AWS region where the API request is\n processed. Results are sorted in descending order of updateTime.

", "smithy.api#http": { "method": "POST", "uri": "/ListRooms" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.ivschat#ListRoomsRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ivschat#RoomName", "traits": { "smithy.api#documentation": "

Filters the list to match the specified room name.

" } }, "nextToken": { "target": "com.amazonaws.ivschat#PaginationToken", "traits": { "smithy.api#documentation": "

The first room to retrieve. This is used for pagination; see the nextToken\n response field.

" } }, "maxResults": { "target": "com.amazonaws.ivschat#MaxRoomResults", "traits": { "smithy.api#documentation": "

Maximum number of rooms to return. Default: 50.

" } }, "messageReviewHandlerUri": { "target": "com.amazonaws.ivschat#LambdaArn", "traits": { "smithy.api#documentation": "

Filters the list to match the specified message review handler URI.

" } }, "loggingConfigurationIdentifier": { "target": "com.amazonaws.ivschat#LoggingConfigurationIdentifier", "traits": { "smithy.api#documentation": "

Logging-configuration identifier.

" } } } }, "com.amazonaws.ivschat#ListRoomsResponse": { "type": "structure", "members": { "rooms": { "target": "com.amazonaws.ivschat#RoomList", "traits": { "smithy.api#documentation": "

List of the matching rooms (summary information only).

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ivschat#PaginationToken", "traits": { "smithy.api#documentation": "

If there are more rooms than maxResults, use nextToken in the\n request to get the next set.

" } } } }, "com.amazonaws.ivschat#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.ivschat#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.ivschat#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.ivschat#InternalServerException" }, { "target": "com.amazonaws.ivschat#ResourceNotFoundException" }, { "target": "com.amazonaws.ivschat#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets information about AWS tags for the specified ARN.

", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.ivschat#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.ivschat#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the resource to be retrieved. The ARN must be URL-encoded.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.ivschat#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.ivschat#Tags", "traits": { "smithy.api#documentation": "

Tags attached to the resource. Array of maps, each of the form string:string\n (key:value).

", "smithy.api#required": {} } } } }, "com.amazonaws.ivschat#LogGroupName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" } }, "com.amazonaws.ivschat#LoggingConfigurationArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+$" } }, "com.amazonaws.ivschat#LoggingConfigurationID": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^[a-zA-Z0-9]+$" } }, "com.amazonaws.ivschat#LoggingConfigurationIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+$" } }, "com.amazonaws.ivschat#LoggingConfigurationIdentifierList": { "type": "list", "member": { "target": "com.amazonaws.ivschat#LoggingConfigurationIdentifier" }, "traits": { "smithy.api#length": { "min": 0, "max": 3 } } }, "com.amazonaws.ivschat#LoggingConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.ivschat#LoggingConfigurationSummary" } }, "com.amazonaws.ivschat#LoggingConfigurationName": { "type": "string", "traits": { "smithy.api#length": { "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9-_]*$" } }, "com.amazonaws.ivschat#LoggingConfigurationState": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CREATING", "name": "CREATING" }, { "value": "CREATE_FAILED", "name": "CREATE_FAILED" }, { "value": "DELETING", "name": "DELETING" }, { "value": "DELETE_FAILED", "name": "DELETE_FAILED" }, { "value": "UPDATING", "name": "UPDATING" }, { "value": "UPDATE_FAILED", "name": "UPDATE_FAILED" }, { "value": "ACTIVE", "name": "ACTIVE" } ] } }, "com.amazonaws.ivschat#LoggingConfigurationSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivschat#LoggingConfigurationArn", "traits": { "smithy.api#documentation": "

Logging-configuration ARN.

" } }, "id": { "target": "com.amazonaws.ivschat#LoggingConfigurationID", "traits": { "smithy.api#documentation": "

Logging-configuration ID, generated by the system. This is a relative identifier, the part\n of the ARN that uniquely identifies the room.

" } }, "createTime": { "target": "com.amazonaws.ivschat#Time", "traits": { "smithy.api#documentation": "

Time when the logging configuration was created. This is an ISO 8601 timestamp;\n note that this is returned as a string.

" } }, "updateTime": { "target": "com.amazonaws.ivschat#Time", "traits": { "smithy.api#documentation": "

Time of the logging configuration\u2019s last update. This is an ISO 8601 timestamp;\n note that this is returned as a string.

" } }, "name": { "target": "com.amazonaws.ivschat#LoggingConfigurationName", "traits": { "smithy.api#documentation": "

Logging-configuration name. The value does not need to be unique.

" } }, "destinationConfiguration": { "target": "com.amazonaws.ivschat#DestinationConfiguration", "traits": { "smithy.api#documentation": "

A complex type that contains a destination configuration for where chat content will be\n logged.

" } }, "state": { "target": "com.amazonaws.ivschat#LoggingConfigurationState", "traits": { "smithy.api#documentation": "

The state of the logging configuration. When this is ACTIVE, the\n configuration is ready for logging chat content.

" } }, "tags": { "target": "com.amazonaws.ivschat#Tags", "traits": { "smithy.api#documentation": "

Tags to attach to the resource. Array of maps, each of the form string:string\n (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints on tags beyond what is documented\n there.

" } } }, "traits": { "smithy.api#documentation": "

Summary information about a logging configuration.

" } }, "com.amazonaws.ivschat#MaxLoggingConfigurationResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.ivschat#MaxRoomResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.ivschat#MessageID": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^[a-zA-Z0-9]+$" } }, "com.amazonaws.ivschat#MessageReviewHandler": { "type": "structure", "members": { "uri": { "target": "com.amazonaws.ivschat#LambdaArn", "traits": { "smithy.api#documentation": "

Identifier of the message review handler. Currently this must be an ARN of a lambda\n function.

" } }, "fallbackResult": { "target": "com.amazonaws.ivschat#FallbackResult", "traits": { "smithy.api#documentation": "

Specifies the fallback behavior (whether the message is allowed or denied) if the handler\n does not return a valid response, encounters an error, or times out. (For the timeout period,\n see Service\n Quotas.) If allowed, the message is delivered with returned content to all users\n connected to the room. If denied, the message is not delivered to any user. Default:\n ALLOW.

" } } }, "traits": { "smithy.api#documentation": "

Configuration information for optional message review.

" } }, "com.amazonaws.ivschat#PaginationToken": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.ivschat#PendingVerification": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ivschat#ErrorMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.ivschat#Reason": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.ivschat#ResourceArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+$" } }, "com.amazonaws.ivschat#ResourceId": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9]+$" } }, "com.amazonaws.ivschat#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ivschat#ErrorMessage", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "com.amazonaws.ivschat#ResourceId", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "resourceType": { "target": "com.amazonaws.ivschat#ResourceType", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.ivschat#ResourceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ROOM", "name": "ROOM" } ] } }, "com.amazonaws.ivschat#RoomArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:room/[a-zA-Z0-9-]+$" } }, "com.amazonaws.ivschat#RoomID": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^[a-zA-Z0-9]+$" } }, "com.amazonaws.ivschat#RoomIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:room/[a-zA-Z0-9-]+$" } }, "com.amazonaws.ivschat#RoomList": { "type": "list", "member": { "target": "com.amazonaws.ivschat#RoomSummary" } }, "com.amazonaws.ivschat#RoomMaxMessageLength": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 500 } } }, "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.ivschat#RoomName": { "type": "string", "traits": { "smithy.api#length": { "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9-_]*$" } }, "com.amazonaws.ivschat#RoomSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivschat#RoomArn", "traits": { "smithy.api#documentation": "

Room ARN.

" } }, "id": { "target": "com.amazonaws.ivschat#RoomID", "traits": { "smithy.api#documentation": "

Room ID, generated by the system. This is a relative identifier, the part of the ARN that\n uniquely identifies the room.

" } }, "name": { "target": "com.amazonaws.ivschat#RoomName", "traits": { "smithy.api#documentation": "

Room name. The value does not need to be unique.

" } }, "messageReviewHandler": { "target": "com.amazonaws.ivschat#MessageReviewHandler", "traits": { "smithy.api#documentation": "

Configuration information for optional review of messages.

" } }, "createTime": { "target": "com.amazonaws.ivschat#Time", "traits": { "smithy.api#documentation": "

Time when the room was created. This is an ISO 8601 timestamp; note that this is\n returned as a string.

" } }, "updateTime": { "target": "com.amazonaws.ivschat#Time", "traits": { "smithy.api#documentation": "

Time of the room\u2019s last update. This is an ISO 8601 timestamp; note that this is\n returned as a string.

" } }, "tags": { "target": "com.amazonaws.ivschat#Tags", "traits": { "smithy.api#documentation": "

Tags attached to the resource. Array of maps, each of the form string:string\n (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented\n there.

" } }, "loggingConfigurationIdentifiers": { "target": "com.amazonaws.ivschat#LoggingConfigurationIdentifierList", "traits": { "smithy.api#documentation": "

List of logging-configuration identifiers attached to the room.

" } } }, "traits": { "smithy.api#documentation": "

Summary information about a room.

" } }, "com.amazonaws.ivschat#S3DestinationConfiguration": { "type": "structure", "members": { "bucketName": { "target": "com.amazonaws.ivschat#BucketName", "traits": { "smithy.api#documentation": "

Name of the Amazon S3 bucket where chat activity will be logged.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Specifies an S3 location where chat logs will be stored.

" } }, "com.amazonaws.ivschat#SendEvent": { "type": "operation", "input": { "target": "com.amazonaws.ivschat#SendEventRequest" }, "output": { "target": "com.amazonaws.ivschat#SendEventResponse" }, "errors": [ { "target": "com.amazonaws.ivschat#AccessDeniedException" }, { "target": "com.amazonaws.ivschat#PendingVerification" }, { "target": "com.amazonaws.ivschat#ResourceNotFoundException" }, { "target": "com.amazonaws.ivschat#ThrottlingException" }, { "target": "com.amazonaws.ivschat#ValidationException" } ], "traits": { "smithy.api#documentation": "

Sends an event to a room. Use this within your application\u2019s business logic to send\n events to clients of a room; e.g., to notify clients to change the way the chat UI is\n rendered.

", "smithy.api#http": { "method": "POST", "uri": "/SendEvent" } } }, "com.amazonaws.ivschat#SendEventRequest": { "type": "structure", "members": { "roomIdentifier": { "target": "com.amazonaws.ivschat#RoomIdentifier", "traits": { "smithy.api#documentation": "

Identifier of the room to which the event will be sent. Currently this must be an\n ARN.

", "smithy.api#required": {} } }, "eventName": { "target": "com.amazonaws.ivschat#EventName", "traits": { "smithy.api#documentation": "

Application-defined name of the event to send to clients.

", "smithy.api#required": {} } }, "attributes": { "target": "com.amazonaws.ivschat#EventAttributes", "traits": { "smithy.api#documentation": "

Application-defined metadata to attach to the event sent to clients. The maximum length\n of the metadata is 1 KB total.

" } } } }, "com.amazonaws.ivschat#SendEventResponse": { "type": "structure", "members": { "id": { "target": "com.amazonaws.ivschat#ID", "traits": { "smithy.api#documentation": "

An identifier generated by Amazon IVS Chat. This identifier must be used in subsequent\n operations for this message, such as DeleteMessage.

" } } } }, "com.amazonaws.ivschat#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ivschat#ErrorMessage", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "com.amazonaws.ivschat#ResourceId", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "resourceType": { "target": "com.amazonaws.ivschat#ResourceType", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "limit": { "target": "com.amazonaws.ivschat#Limit", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.ivschat#SessionDurationInMinutes": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 180 } } }, "com.amazonaws.ivschat#String": { "type": "string" }, "com.amazonaws.ivschat#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.ivschat#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.ivschat#TagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.ivschat#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.ivschat#TagResourceRequest" }, "output": { "target": "com.amazonaws.ivschat#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.ivschat#InternalServerException" }, { "target": "com.amazonaws.ivschat#ResourceNotFoundException" }, { "target": "com.amazonaws.ivschat#ValidationException" } ], "traits": { "smithy.api#documentation": "

Adds or updates tags for the AWS resource with the specified ARN.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}" } } }, "com.amazonaws.ivschat#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.ivschat#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the resource to be tagged. The ARN must be URL-encoded.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.ivschat#Tags", "traits": { "smithy.api#documentation": "

Array of tags to be added or updated. Array of maps, each of the form\n string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented\n there.

", "smithy.api#required": {} } } } }, "com.amazonaws.ivschat#TagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.ivschat#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.ivschat#Tags": { "type": "map", "key": { "target": "com.amazonaws.ivschat#TagKey" }, "value": { "target": "com.amazonaws.ivschat#TagValue" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.ivschat#ThrottlingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ivschat#ErrorMessage", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "com.amazonaws.ivschat#ResourceId", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "resourceType": { "target": "com.amazonaws.ivschat#ResourceType", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "limit": { "target": "com.amazonaws.ivschat#Limit", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.ivschat#Time": { "type": "timestamp", "traits": { "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.ivschat#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.ivschat#UntagResourceRequest" }, "output": { "target": "com.amazonaws.ivschat#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.ivschat#InternalServerException" }, { "target": "com.amazonaws.ivschat#ResourceNotFoundException" }, { "target": "com.amazonaws.ivschat#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes tags from the resource with the specified ARN.

", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.ivschat#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.ivschat#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the resource to be untagged. The ARN must be URL-encoded.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.ivschat#TagKeyList", "traits": { "smithy.api#documentation": "

Array of tags to be removed. Array of maps, each of the form string:string\n (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented\n there.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } } }, "com.amazonaws.ivschat#UntagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.ivschat#UpdateLoggingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.ivschat#UpdateLoggingConfigurationRequest" }, "output": { "target": "com.amazonaws.ivschat#UpdateLoggingConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.ivschat#AccessDeniedException" }, { "target": "com.amazonaws.ivschat#ConflictException" }, { "target": "com.amazonaws.ivschat#PendingVerification" }, { "target": "com.amazonaws.ivschat#ResourceNotFoundException" }, { "target": "com.amazonaws.ivschat#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates a specified logging configuration.

", "smithy.api#http": { "method": "POST", "uri": "/UpdateLoggingConfiguration" } } }, "com.amazonaws.ivschat#UpdateLoggingConfigurationRequest": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.ivschat#LoggingConfigurationIdentifier", "traits": { "smithy.api#documentation": "

Identifier of the logging configuration to be updated.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.ivschat#LoggingConfigurationName", "traits": { "smithy.api#documentation": "

Logging-configuration name. The value does not need to be unique.

" } }, "destinationConfiguration": { "target": "com.amazonaws.ivschat#DestinationConfiguration", "traits": { "smithy.api#documentation": "

A complex type that contains a destination configuration for where chat content will be\n logged. There can be only one type of destination (cloudWatchLogs,\n firehose, or s3) in a\n destinationConfiguration.

" } } } }, "com.amazonaws.ivschat#UpdateLoggingConfigurationResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivschat#LoggingConfigurationArn", "traits": { "smithy.api#documentation": "

Logging-configuration ARN, from the request (if identifier was an\n ARN).

" } }, "id": { "target": "com.amazonaws.ivschat#LoggingConfigurationID", "traits": { "smithy.api#documentation": "

Logging-configuration ID, generated by the system. This is a relative identifier, the\n part of the ARN that uniquely identifies the room.

" } }, "createTime": { "target": "com.amazonaws.ivschat#Time", "traits": { "smithy.api#documentation": "

Time when the logging configuration was created. This is an ISO 8601 timestamp;\n note that this is returned as a string.

" } }, "updateTime": { "target": "com.amazonaws.ivschat#Time", "traits": { "smithy.api#documentation": "

Time of the logging configuration\u2019s last update. This is an ISO 8601 timestamp;\n note that this is returned as a string.

" } }, "name": { "target": "com.amazonaws.ivschat#LoggingConfigurationName", "traits": { "smithy.api#documentation": "

Logging-configuration name, from the request (if specified).

" } }, "destinationConfiguration": { "target": "com.amazonaws.ivschat#DestinationConfiguration", "traits": { "smithy.api#documentation": "

A complex type that contains a destination configuration for where chat content will be\n logged, from the request. There is only one type of destination\n (cloudWatchLogs, firehose, or s3) in a\n destinationConfiguration.

" } }, "state": { "target": "com.amazonaws.ivschat#UpdateLoggingConfigurationState", "traits": { "smithy.api#documentation": "

The state of the logging configuration. When the state is ACTIVE, the\n configuration is ready to log chat content.

" } }, "tags": { "target": "com.amazonaws.ivschat#Tags", "traits": { "smithy.api#documentation": "

Tags attached to the resource. Array of maps, each of the form string:string\n (key:value).

" } } } }, "com.amazonaws.ivschat#UpdateLoggingConfigurationState": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACTIVE", "name": "ACTIVE" } ] } }, "com.amazonaws.ivschat#UpdateRoom": { "type": "operation", "input": { "target": "com.amazonaws.ivschat#UpdateRoomRequest" }, "output": { "target": "com.amazonaws.ivschat#UpdateRoomResponse" }, "errors": [ { "target": "com.amazonaws.ivschat#AccessDeniedException" }, { "target": "com.amazonaws.ivschat#PendingVerification" }, { "target": "com.amazonaws.ivschat#ResourceNotFoundException" }, { "target": "com.amazonaws.ivschat#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates a room\u2019s configuration.

", "smithy.api#http": { "method": "POST", "uri": "/UpdateRoom" } } }, "com.amazonaws.ivschat#UpdateRoomRequest": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.ivschat#RoomIdentifier", "traits": { "smithy.api#documentation": "

Identifier of the room to be updated. Currently this must be an ARN.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.ivschat#RoomName", "traits": { "smithy.api#documentation": "

Room name. The value does not need to be unique.

" } }, "maximumMessageRatePerSecond": { "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", "traits": { "smithy.api#documentation": "

Maximum number of messages per second that can be sent to the room (by all clients).\n Default: 10.

" } }, "maximumMessageLength": { "target": "com.amazonaws.ivschat#RoomMaxMessageLength", "traits": { "smithy.api#documentation": "

The maximum number of characters in a single message. Messages are expected to be UTF-8\n encoded and this limit applies specifically to rune/code-point count, not number of bytes.\n Default: 500.

" } }, "messageReviewHandler": { "target": "com.amazonaws.ivschat#MessageReviewHandler", "traits": { "smithy.api#documentation": "

Configuration information for optional review of messages. Specify an empty\n uri string to disassociate a message review handler from the specified\n room.

" } }, "loggingConfigurationIdentifiers": { "target": "com.amazonaws.ivschat#LoggingConfigurationIdentifierList", "traits": { "smithy.api#documentation": "

Array of logging-configuration identifiers attached to the room.

" } } } }, "com.amazonaws.ivschat#UpdateRoomResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivschat#RoomArn", "traits": { "smithy.api#documentation": "

Room ARN, from the request (if identifier was an ARN).

" } }, "id": { "target": "com.amazonaws.ivschat#RoomID", "traits": { "smithy.api#documentation": "

Room ID, generated by the system. This is a relative identifier, the part of the ARN\n that uniquely identifies the room.

" } }, "name": { "target": "com.amazonaws.ivschat#RoomName", "traits": { "smithy.api#documentation": "

Room name, from the request (if specified).

" } }, "createTime": { "target": "com.amazonaws.ivschat#Time", "traits": { "smithy.api#documentation": "

Time when the room was created. This is an ISO 8601 timestamp; note that this\n is returned as a string.

" } }, "updateTime": { "target": "com.amazonaws.ivschat#Time", "traits": { "smithy.api#documentation": "

Time of the room\u2019s last update. This is an ISO 8601 timestamp; note that this\n is returned as a string.

" } }, "maximumMessageRatePerSecond": { "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", "traits": { "smithy.api#documentation": "

Maximum number of messages per second that can be sent to the room (by all clients),\n from the request (if specified).

" } }, "maximumMessageLength": { "target": "com.amazonaws.ivschat#RoomMaxMessageLength", "traits": { "smithy.api#documentation": "

Maximum number of characters in a single message, from the request (if\n specified).

" } }, "messageReviewHandler": { "target": "com.amazonaws.ivschat#MessageReviewHandler", "traits": { "smithy.api#documentation": "

Configuration information for optional review of messages.

" } }, "tags": { "target": "com.amazonaws.ivschat#Tags", "traits": { "smithy.api#documentation": "

Tags attached to the resource. Array of maps, each of the form string:string\n (key:value).

" } }, "loggingConfigurationIdentifiers": { "target": "com.amazonaws.ivschat#LoggingConfigurationIdentifierList", "traits": { "smithy.api#documentation": "

Array of logging configurations attached to the room, from the request (if\n specified).

" } } } }, "com.amazonaws.ivschat#UserID": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#sensitive": {} } }, "com.amazonaws.ivschat#ValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ivschat#ErrorMessage", "traits": { "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.ivschat#ValidationExceptionReason", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "fieldList": { "target": "com.amazonaws.ivschat#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "smithy.api#documentation": "

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ivschat#ValidationExceptionField": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ivschat#FieldName", "traits": { "smithy.api#documentation": "

Name of the field which failed validation.

", "smithy.api#required": {} } }, "message": { "target": "com.amazonaws.ivschat#ErrorMessage", "traits": { "smithy.api#documentation": "

Explanation of the reason for the validation error.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

This object is used in the ValidationException error.

" } }, "com.amazonaws.ivschat#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.ivschat#ValidationExceptionField" } }, "com.amazonaws.ivschat#ValidationExceptionReason": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "UNKNOWN_OPERATION", "name": "UNKNOWN_OPERATION" }, { "value": "FIELD_VALIDATION_FAILED", "name": "FIELD_VALIDATION_FAILED" }, { "value": "OTHER", "name": "OTHER" } ] } } } }