diff --git a/codegen/sdk-codegen/aws-models/bedrock-runtime.json b/codegen/sdk-codegen/aws-models/bedrock-runtime.json index d73d5b706f7..319f345e9b5 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-runtime.json +++ b/codegen/sdk-codegen/aws-models/bedrock-runtime.json @@ -1021,7 +1021,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:inference-profile/[a-zA-Z0-9-:.]+)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)|([a-zA-Z0-9-:.]+)$" } }, "com.amazonaws.bedrockruntime#Converse": { @@ -2968,7 +2968,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:inference-profile/[a-zA-Z0-9-:.]+)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)|([a-zA-Z0-9-:.]+)$" } }, "com.amazonaws.bedrockruntime#InvokeModelRequest": { diff --git a/codegen/sdk-codegen/aws-models/bedrock.json b/codegen/sdk-codegen/aws-models/bedrock.json index aaf59e0fc59..2afed5dcd2f 100644 --- a/codegen/sdk-codegen/aws-models/bedrock.json +++ b/codegen/sdk-codegen/aws-models/bedrock.json @@ -30,6 +30,9 @@ { "target": "com.amazonaws.bedrock#GuardrailsResource" }, + { + "target": "com.amazonaws.bedrock#InferenceProfileResource" + }, { "target": "com.amazonaws.bedrock#LoggingResource" }, @@ -1430,7 +1433,7 @@ "clientRequestToken": { "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n\t Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", "smithy.api#idempotencyToken": {} } } @@ -1770,7 +1773,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a job to invoke a model on multiple prompts (batch inference). Format your data according to Format your inference data and upload it to an Amazon S3 bucket. For more information, see Create a batch inference job.

\n

The response returns a jobArn that you can use to stop or get details about the job. You can check the status of the job by sending a GetModelCustomizationJob request.

", + "smithy.api#documentation": "

Creates a batch inference job to invoke a model on multiple prompts. Format your data according to Format your inference data and upload it to an Amazon S3 bucket. For more information, see Process multiple prompts with batch inference.

\n

The response returns a jobArn that you can use to stop or get details about the job.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1799,7 +1802,7 @@ "clientRequestToken": { "target": "com.amazonaws.bedrock#ModelInvocationIdempotencyToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n\t Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", "smithy.api#idempotencyToken": {} } }, @@ -3754,6 +3757,125 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#GetInferenceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetInferenceProfileRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetInferenceProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about an inference profile. For more information, see the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/inference-profiles/{inferenceProfileIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetInferenceProfileRequest": { + "type": "structure", + "members": { + "inferenceProfileIdentifier": { + "target": "com.amazonaws.bedrock#InferenceProfileIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the inference profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetInferenceProfileResponse": { + "type": "structure", + "members": { + "inferenceProfileName": { + "target": "com.amazonaws.bedrock#InferenceProfileName", + "traits": { + "smithy.api#documentation": "

The name of the inference profile.

", + "smithy.api#required": {} + } + }, + "models": { + "target": "com.amazonaws.bedrock#InferenceProfileModels", + "traits": { + "smithy.api#documentation": "

A list of information about each model in the inference profile.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#InferenceProfileDescription", + "traits": { + "smithy.api#documentation": "

The description of the inference profile.

" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the inference profile was created.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the inference profile was last updated.

" + } + }, + "inferenceProfileArn": { + "target": "com.amazonaws.bedrock#InferenceProfileArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the inference profile.

", + "smithy.api#required": {} + } + }, + "inferenceProfileId": { + "target": "com.amazonaws.bedrock#InferenceProfileId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the inference profile.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#InferenceProfileStatus", + "traits": { + "smithy.api#documentation": "

The status of the inference profile. ACTIVE means that the inference profile is available to use.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrock#InferenceProfileType", + "traits": { + "smithy.api#documentation": "

The type of the inference profile. SYSTEM_DEFINED means that the inference profile is defined by Amazon Bedrock.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrock#GetModelCopyJob": { "type": "operation", "input": { @@ -4294,7 +4416,7 @@ "clientRequestToken": { "target": "com.amazonaws.bedrock#ModelInvocationIdempotencyToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n\t Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

" + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

" } }, "roleArn": { @@ -6067,6 +6189,192 @@ "target": "com.amazonaws.bedrock#ImportedModelSummary" } }, + "com.amazonaws.bedrock#InferenceProfileArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):inference-profile/[a-zA-Z0-9-:.]+$" + } + }, + "com.amazonaws.bedrock#InferenceProfileDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.bedrock#InferenceProfileId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-:.]+$" + } + }, + "com.amazonaws.bedrock#InferenceProfileIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):inference-profile/)?[a-zA-Z0-9-:.]+$" + } + }, + "com.amazonaws.bedrock#InferenceProfileModel": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model.

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

Contains information about a model.

" + } + }, + "com.amazonaws.bedrock#InferenceProfileModels": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#InferenceProfileModel" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#InferenceProfileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^([0-9a-zA-Z][ _-]?)+$" + } + }, + "com.amazonaws.bedrock#InferenceProfileResource": { + "type": "resource", + "identifiers": { + "inferenceProfileIdentifier": { + "target": "com.amazonaws.bedrock#InferenceProfileIdentifier" + } + }, + "read": { + "target": "com.amazonaws.bedrock#GetInferenceProfile" + }, + "list": { + "target": "com.amazonaws.bedrock#ListInferenceProfiles" + } + }, + "com.amazonaws.bedrock#InferenceProfileStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + } + } + }, + "com.amazonaws.bedrock#InferenceProfileSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#InferenceProfileSummary" + } + }, + "com.amazonaws.bedrock#InferenceProfileSummary": { + "type": "structure", + "members": { + "inferenceProfileName": { + "target": "com.amazonaws.bedrock#InferenceProfileName", + "traits": { + "smithy.api#documentation": "

The name of the inference profile.

", + "smithy.api#required": {} + } + }, + "models": { + "target": "com.amazonaws.bedrock#InferenceProfileModels", + "traits": { + "smithy.api#documentation": "

A list of information about each model in the inference profile.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#InferenceProfileDescription", + "traits": { + "smithy.api#documentation": "

The description of the inference profile.

" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the inference profile was created.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the inference profile was last updated.

" + } + }, + "inferenceProfileArn": { + "target": "com.amazonaws.bedrock#InferenceProfileArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the inference profile.

", + "smithy.api#required": {} + } + }, + "inferenceProfileId": { + "target": "com.amazonaws.bedrock#InferenceProfileId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the inference profile.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#InferenceProfileStatus", + "traits": { + "smithy.api#documentation": "

The status of the inference profile. ACTIVE means that the inference profile is available to use.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrock#InferenceProfileType", + "traits": { + "smithy.api#documentation": "

The type of the inference profile. SYSTEM_DEFINED means that the inference profile is defined by Amazon Bedrock.

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

Contains information about an inference profile.

" + } + }, + "com.amazonaws.bedrock#InferenceProfileType": { + "type": "enum", + "members": { + "SYSTEM_DEFINED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM_DEFINED" + } + } + } + }, "com.amazonaws.bedrock#InferenceType": { "type": "enum", "members": { @@ -6687,6 +6995,86 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#ListInferenceProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListInferenceProfilesRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListInferenceProfilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of inference profiles that you can use.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/inference-profiles" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "inferenceProfileSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListInferenceProfilesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListInferenceProfilesResponse": { + "type": "structure", + "members": { + "inferenceProfileSummaries": { + "target": "com.amazonaws.bedrock#InferenceProfileSummaries", + "traits": { + "smithy.api#documentation": "

A list of information about each inference profile that you can use.

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

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrock#ListModelCopyJobs": { "type": "operation", "input": { @@ -8159,7 +8547,7 @@ "clientRequestToken": { "target": "com.amazonaws.bedrock#ModelInvocationIdempotencyToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n\t Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

" + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

" } }, "roleArn": { diff --git a/codegen/sdk-codegen/aws-models/chatbot.json b/codegen/sdk-codegen/aws-models/chatbot.json index 874c61f60e9..1940cb5dca6 100644 --- a/codegen/sdk-codegen/aws-models/chatbot.json +++ b/codegen/sdk-codegen/aws-models/chatbot.json @@ -1,33 +1,5 @@ { "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.chatbot#AccountPreferences": { "type": "structure", @@ -35,18 +7,18 @@ "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + "smithy.api#documentation": "

Enables use of a user role requirement in your chat configuration.

" } }, "TrainingDataCollectionEnabled": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "Turns on training data collection. This helps improve the AWS Chatbot experience by allowing AWS Chatbot to store and use your customer information, such as AWS Chatbot configurations, notifications, user inputs, AWS Chatbot generated responses, and interaction data. This data helps us to continuously improve and develop Artificial Intelligence (AI) technologies. Your data is not shared with any third parties and is protected using sophisticated controls to prevent unauthorized access and misuse. AWS Chatbot does not store or use interactions in chat channels with Amazon Q for training AWS Chatbot’s AI technologies." + "smithy.api#documentation": "

Turns on training data collection.

\n

This helps improve the AWS Chatbot experience by allowing AWS Chatbot to store and use your customer information, such as AWS Chatbot configurations, notifications, user inputs, AWS Chatbot generated responses, and interaction data. This data helps us to continuously improve and develop Artificial Intelligence (AI) technologies. Your data is not shared with any third parties and is protected using sophisticated controls to prevent unauthorized access and misuse. AWS Chatbot does not store or use interactions in chat channels with Amazon Q for training AI technologies for AWS Chatbot.\n

" } } }, "traits": { - "smithy.api#documentation": "Preferences which apply for AWS Chatbot usage in the calling AWS account." + "smithy.api#documentation": "

Preferences related to AWS Chatbot usage in the calling AWS account.

" } }, "com.amazonaws.chatbot#AmazonResourceName": { @@ -98,52 +70,52 @@ "WebhookDescription": { "target": "com.amazonaws.chatbot#ChimeWebhookDescription", "traits": { - "smithy.api#documentation": "Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.", + "smithy.api#documentation": "

A description of the webhook. We recommend using the convention RoomName/WebhookName.

\n

For more information, see Tutorial: Get started with Amazon Chime in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the ChimeWebhookConfiguration.", + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration.

", "smithy.api#required": {} } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { - "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot.", + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

", "smithy.api#required": {} } }, "ConfigurationName": { "target": "com.amazonaws.chatbot#ConfigurationName", "traits": { - "smithy.api#documentation": "The name of the configuration." + "smithy.api#documentation": "

The name of the configuration.

" } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { - "smithy.api#documentation": "Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.Logging levels include ERROR, INFO, or NONE." + "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } }, "Tags": { "target": "com.amazonaws.chatbot#Tags", "traits": { - "smithy.api#documentation": "A list of tags applied to the configuration." + "smithy.api#documentation": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" } } }, "traits": { - "smithy.api#documentation": "An AWS Chatbot configuration for Amazon Chime." + "smithy.api#documentation": "

An AWS Chatbot configuration for Amazon Chime.

" } }, "com.amazonaws.chatbot#ChimeWebhookConfigurationList": { @@ -158,7 +130,8 @@ "smithy.api#length": { "min": 1, "max": 255 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.chatbot#ChimeWebhookUrl": { @@ -168,7 +141,8 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "^https://hooks\\.chime\\.aws/incomingwebhooks/[A-Za-z0-9\\-]+?\\?token=[A-Za-z0-9\\-]+$" + "smithy.api#pattern": "^https://hooks\\.chime\\.aws/incomingwebhooks/[A-Za-z0-9\\-]+?\\?token=[A-Za-z0-9\\-]+$", + "smithy.api#sensitive": {} } }, "com.amazonaws.chatbot#ConfigurationName": { @@ -187,26 +161,26 @@ "TenantId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Teams tenant.", + "smithy.api#documentation": "

The ID of the Microsoft Teams tenant.

", "smithy.api#required": {} } }, "TeamId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.", + "smithy.api#documentation": "

The ID of the Microsoft Teams authorized with AWS Chatbot.

\n

To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "TeamName": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The name of the Microsoft Teams Team." + "smithy.api#documentation": "

The name of the Microsoft Teams Team.

" } } }, "traits": { - "smithy.api#documentation": "A Microsoft Teams team that has been authorized with AWS Chatbot." + "smithy.api#documentation": "

A Microsoft Teams team that is authorized with AWS Chatbot.

" } }, "com.amazonaws.chatbot#ConfiguredTeamsList": { @@ -223,7 +197,7 @@ } }, "traits": { - "smithy.api#documentation": "There was an issue processing your request.", + "smithy.api#documentation": "

There was an issue processing your request.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -254,7 +228,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates Chime Webhook Configuration", + "smithy.api#documentation": "

Creates an AWS Chatbot configuration for Amazon Chime.

", "smithy.api#http": { "method": "POST", "uri": "/create-chime-webhook-configuration", @@ -270,7 +244,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -281,48 +255,48 @@ "WebhookDescription": { "target": "com.amazonaws.chatbot#ChimeWebhookDescription", "traits": { - "smithy.api#documentation": "Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.", + "smithy.api#documentation": "

A description of the webhook. We recommend using the convention RoomName/WebhookName.

\n

For more information, see Tutorial: Get started with Amazon Chime in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "WebhookUrl": { "target": "com.amazonaws.chatbot#ChimeWebhookUrl", "traits": { - "smithy.api#documentation": "URL for the Chime webhook.", + "smithy.api#documentation": "

The URL for the Amazon Chime webhook.

", "smithy.api#required": {} } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { - "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot.", + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

", "smithy.api#required": {} } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "ConfigurationName": { "target": "com.amazonaws.chatbot#ConfigurationName", "traits": { - "smithy.api#documentation": "The name of the configuration.", + "smithy.api#documentation": "

The name of the configuration.

", "smithy.api#required": {} } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { - "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } }, "Tags": { "target": "com.amazonaws.chatbot#Tags", "traits": { - "smithy.api#documentation": "A list of tags to apply to the configuration." + "smithy.api#documentation": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" } } }, @@ -336,7 +310,7 @@ "WebhookConfiguration": { "target": "com.amazonaws.chatbot#ChimeWebhookConfiguration", "traits": { - "smithy.api#documentation": "Chime webhook configuration." + "smithy.api#documentation": "

An Amazon Chime webhook configuration.

" } } }, @@ -370,12 +344,16 @@ } ], "traits": { - "smithy.api#documentation": "Creates MS Teams Channel Configuration", + "smithy.api#documentation": "

Creates an AWS Chatbot configuration for Microsoft Teams.

", "smithy.api#http": { "method": "POST", "uri": "/create-ms-teams-channel-configuration", "code": 201 - } + }, + "smithy.api#suppress": [ + "OperationInputOutputName.input", + "OperationInputOutputName.output" + ] } }, "com.amazonaws.chatbot#CreateSlackChannelConfiguration": { @@ -404,7 +382,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates Slack Channel Configuration", + "smithy.api#documentation": "

Creates an AWS Chatbot confugration for Slack.

", "smithy.api#http": { "method": "POST", "uri": "/create-slack-channel-configuration", @@ -420,7 +398,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -431,65 +409,65 @@ "SlackTeamId": { "target": "com.amazonaws.chatbot#SlackTeamId", "traits": { - "smithy.api#documentation": "The ID of the Slack workspace authorized with AWS Chatbot.", + "smithy.api#documentation": "

The ID of the Slack workspace authorized with AWS Chatbot.

", "smithy.api#required": {} } }, "SlackChannelId": { "target": "com.amazonaws.chatbot#SlackChannelId", "traits": { - "smithy.api#documentation": "The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.", + "smithy.api#documentation": "

The ID of the Slack channel.

\n

To get this ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.\n

", "smithy.api#required": {} } }, "SlackChannelName": { "target": "com.amazonaws.chatbot#SlackChannelDisplayName", "traits": { - "smithy.api#documentation": "The name of the Slack Channel." + "smithy.api#documentation": "

The name of the Slack channel.

" } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { - "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot." + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

" } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "ConfigurationName": { "target": "com.amazonaws.chatbot#ConfigurationName", "traits": { - "smithy.api#documentation": "The name of the configuration.", + "smithy.api#documentation": "

The name of the configuration.

", "smithy.api#required": {} } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { - "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } }, "GuardrailPolicyArns": { "target": "com.amazonaws.chatbot#GuardrailPolicyArnList", "traits": { - "smithy.api#documentation": "The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set." + "smithy.api#documentation": "

The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed AdministratorAccess policy is applied by default if this is not set.\n

" } }, "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + "smithy.api#documentation": "

Enables use of a user role requirement in your chat configuration.

" } }, "Tags": { "target": "com.amazonaws.chatbot#Tags", "traits": { - "smithy.api#documentation": "A list of tags to apply to the configuration." + "smithy.api#documentation": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" } } }, @@ -503,7 +481,7 @@ "ChannelConfiguration": { "target": "com.amazonaws.chatbot#SlackChannelConfiguration", "traits": { - "smithy.api#documentation": "The configuration for a Slack channel configured with AWS Chatbot." + "smithy.api#documentation": "

The configuration for a Slack channel configured with AWS Chatbot.

" } } }, @@ -519,7 +497,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -530,78 +508,78 @@ "ChannelId": { "target": "com.amazonaws.chatbot#TeamsChannelId", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Teams channel.", + "smithy.api#documentation": "

The ID of the Microsoft Teams channel.

", "smithy.api#required": {} } }, "ChannelName": { "target": "com.amazonaws.chatbot#TeamsChannelName", "traits": { - "smithy.api#documentation": "The name of the Microsoft Teams channel." + "smithy.api#documentation": "

The name of the Microsoft Teams channel.

" } }, "TeamId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.", + "smithy.api#documentation": "

The ID of the Microsoft Teams authorized with AWS Chatbot.

\n

To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "TeamName": { "target": "com.amazonaws.chatbot#TeamName", "traits": { - "smithy.api#documentation": "The name of the Microsoft Teams Team." + "smithy.api#documentation": "

The name of the Microsoft Teams Team.

" } }, "TenantId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Teams tenant.", + "smithy.api#documentation": "

The ID of the Microsoft Teams tenant.

", "smithy.api#required": {} } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { - "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot." + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

" } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "ConfigurationName": { "target": "com.amazonaws.chatbot#ConfigurationName", "traits": { - "smithy.api#documentation": "The name of the configuration.", + "smithy.api#documentation": "

The name of the configuration.

", "smithy.api#required": {} } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { - "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } }, "GuardrailPolicyArns": { "target": "com.amazonaws.chatbot#GuardrailPolicyArnList", "traits": { - "smithy.api#documentation": "The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set." + "smithy.api#documentation": "

The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed AdministratorAccess policy is applied by default if this is not set.\n

" } }, "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + "smithy.api#documentation": "

Enables use of a user role requirement in your chat configuration.

" } }, "Tags": { "target": "com.amazonaws.chatbot#Tags", "traits": { - "smithy.api#documentation": "A list of tags to apply to the configuration." + "smithy.api#documentation": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" } } }, @@ -615,7 +593,7 @@ "ChannelConfiguration": { "target": "com.amazonaws.chatbot#TeamsChannelConfiguration", "traits": { - "smithy.api#documentation": "The configuration for a Microsoft Teams channel configured with AWS Chatbot." + "smithy.api#documentation": "

The configuration for a Microsoft Teams channel configured with AWS Chatbot.

" } } }, @@ -656,7 +634,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a Chime Webhook Configuration", + "smithy.api#documentation": "

Deletes a Amazon Chime webhook configuration for AWS Chatbot.

", "smithy.api#http": { "method": "POST", "uri": "/delete-chime-webhook-configuration", @@ -672,7 +650,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -683,7 +661,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the ChimeWebhookConfiguration to delete.", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration to delete.

", "smithy.api#required": {} } } @@ -722,12 +700,16 @@ } ], "traits": { - "smithy.api#documentation": "Deletes MS Teams Channel Configuration", + "smithy.api#documentation": "

Deletes a Microsoft Teams channel configuration for AWS Chatbot

", "smithy.api#http": { "method": "POST", "uri": "/delete-ms-teams-channel-configuration", "code": 204 - } + }, + "smithy.api#suppress": [ + "OperationInputOutputName.input", + "OperationInputOutputName.output" + ] } }, "com.amazonaws.chatbot#DeleteMicrosoftTeamsConfiguredTeam": { @@ -747,12 +729,16 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team. Note that the Microsoft Teams team must have no channels configured to remove it.", + "smithy.api#documentation": "

Deletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team. Note that the Microsoft Teams team must have no channels configured to remove it.\n

", "smithy.api#http": { "method": "POST", "uri": "/delete-ms-teams-configured-teams", "code": 204 - } + }, + "smithy.api#suppress": [ + "OperationInputOutputName.input", + "OperationInputOutputName.output" + ] } }, "com.amazonaws.chatbot#DeleteMicrosoftTeamsUserIdentity": { @@ -775,7 +761,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a Teams user identity", + "smithy.api#documentation": "

Identifes a user level permission for a channel configuration.

", "smithy.api#http": { "method": "POST", "uri": "/delete-ms-teams-user-identity", @@ -791,7 +777,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -802,14 +788,14 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.", + "smithy.api#documentation": "

The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

", "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "Id from Microsoft Teams for user.", + "smithy.api#documentation": "

The Microsoft Teams user ID.

", "smithy.api#required": {} } } @@ -848,7 +834,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes Slack Channel Configuration", + "smithy.api#documentation": "

Deletes a Slack channel configuration for AWS Chatbot

", "smithy.api#http": { "method": "POST", "uri": "/delete-slack-channel-configuration", @@ -864,7 +850,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -875,7 +861,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the SlackChannelConfiguration to delete.", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SlackChannelConfiguration to delete.

", "smithy.api#required": {} } } @@ -911,7 +897,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a Slack user identity", + "smithy.api#documentation": "

Deletes a user level permission for a Slack channel configuration.

", "smithy.api#http": { "method": "POST", "uri": "/delete-slack-user-identity", @@ -927,7 +913,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -938,21 +924,21 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the SlackChannelConfiguration associated with the user identity to delete.", + "smithy.api#documentation": "

The ARN of the SlackChannelConfiguration associated with the user identity to delete.

", "smithy.api#required": {} } }, "SlackTeamId": { "target": "com.amazonaws.chatbot#SlackTeamId", "traits": { - "smithy.api#documentation": "The ID of the Slack workspace authorized with AWS Chatbot.", + "smithy.api#documentation": "

The ID of the Slack workspace authorized with AWS Chatbot.

", "smithy.api#required": {} } }, "SlackUserId": { "target": "com.amazonaws.chatbot#SlackUserId", "traits": { - "smithy.api#documentation": "The ID of the user in Slack.", + "smithy.api#documentation": "

The ID of the user in Slack

", "smithy.api#required": {} } } @@ -985,7 +971,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the Slack workspace authorization that allows channels to be configured in that workspace. This requires all configured channels in the workspace to be deleted.", + "smithy.api#documentation": "

Deletes the Slack workspace authorization that allows channels to be configured in that workspace. This requires all configured channels in the workspace to be deleted.\n

", "smithy.api#http": { "method": "POST", "uri": "/delete-slack-workspace-authorization", @@ -1001,7 +987,7 @@ } }, "traits": { - "smithy.api#documentation": "There was an issue deleting your Slack workspace.", + "smithy.api#documentation": "

There was an issue deleting your Slack workspace.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1012,7 +998,7 @@ "SlackTeamId": { "target": "com.amazonaws.chatbot#SlackTeamId", "traits": { - "smithy.api#documentation": "The ID of the Slack workspace authorized with AWS Chatbot.", + "smithy.api#documentation": "

The ID of the Slack workspace authorized with AWS Chatbot.

", "smithy.api#required": {} } } @@ -1036,7 +1022,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1047,7 +1033,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration to delete.", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

", "smithy.api#required": {} } } @@ -1071,7 +1057,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1082,7 +1068,7 @@ "TeamId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.", + "smithy.api#documentation": "

The ID of the Microsoft Teams team authorized with AWS Chatbot.

\n

To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } } @@ -1118,7 +1104,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists Chime Webhook Configurations optionally filtered by ChatConfigurationArn", + "smithy.api#documentation": "

Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn

", "smithy.api#http": { "method": "POST", "uri": "/describe-chime-webhook-configurations", @@ -1127,8 +1113,10 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults" - } + "pageSize": "MaxResults", + "items": "WebhookConfigurations" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#DescribeChimeWebhookConfigurationsException": { @@ -1139,7 +1127,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1150,19 +1138,19 @@ "MaxResults": { "target": "com.amazonaws.chatbot#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved." + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.\n

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.\n

" } }, "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "An optional ARN of a ChimeWebhookConfiguration to describe." + "smithy.api#documentation": "

An optional Amazon Resource Number (ARN) of a ChimeWebhookConfiguration to describe.

" } } }, @@ -1176,13 +1164,13 @@ "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.\n

" } }, "WebhookConfigurations": { "target": "com.amazonaws.chatbot#ChimeWebhookConfigurationList", "traits": { - "smithy.api#documentation": "A list of Chime webhooks associated with the account." + "smithy.api#documentation": "

A list of Amazon Chime webhooks associated with the account.

" } } }, @@ -1210,7 +1198,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists Slack Channel Configurations optionally filtered by ChatConfigurationArn", + "smithy.api#documentation": "

Lists Slack channel configurations optionally filtered by ChatConfigurationArn

", "smithy.api#http": { "method": "POST", "uri": "/describe-slack-channel-configurations", @@ -1219,8 +1207,10 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults" - } + "pageSize": "MaxResults", + "items": "SlackChannelConfigurations" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#DescribeSlackChannelConfigurationsException": { @@ -1231,7 +1221,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1242,19 +1232,19 @@ "MaxResults": { "target": "com.amazonaws.chatbot#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved." + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.\n

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.\n

" } }, "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "An optional ARN of a SlackChannelConfiguration to describe." + "smithy.api#documentation": "

An optional Amazon Resource Number (ARN) of a SlackChannelConfiguration to describe.

" } } }, @@ -1268,13 +1258,13 @@ "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.\n

" } }, "SlackChannelConfigurations": { "target": "com.amazonaws.chatbot#SlackChannelConfigurationList", "traits": { - "smithy.api#documentation": "A list of Slack channel configurations." + "smithy.api#documentation": "

A list of Slack channel configurations.

" } } }, @@ -1302,7 +1292,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all Slack user identities with a mapped role.", + "smithy.api#documentation": "

Lists all Slack user identities with a mapped role.

", "smithy.api#http": { "method": "POST", "uri": "/describe-slack-user-identities", @@ -1311,8 +1301,10 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults" - } + "pageSize": "MaxResults", + "items": "SlackUserIdentities" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#DescribeSlackUserIdentitiesException": { @@ -1323,7 +1315,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1334,19 +1326,19 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the SlackChannelConfiguration associated with the user identities to describe." + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the SlackChannelConfiguration associated with the user identities to describe.

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.\n

" } }, "MaxResults": { "target": "com.amazonaws.chatbot#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved." + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.\n

" } } }, @@ -1360,13 +1352,13 @@ "SlackUserIdentities": { "target": "com.amazonaws.chatbot#SlackUserIdentitiesList", "traits": { - "smithy.api#documentation": "A list of Slack User Identities." + "smithy.api#documentation": "

A list of Slack User Identities.

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.\n

" } } }, @@ -1394,7 +1386,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all authorized Slack Workspaces for AWS Account", + "smithy.api#documentation": "

List all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot.

", "smithy.api#http": { "method": "POST", "uri": "/describe-slack-workspaces", @@ -1403,8 +1395,10 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults" - } + "pageSize": "MaxResults", + "items": "SlackWorkspaces" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#DescribeSlackWorkspacesException": { @@ -1415,7 +1409,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1426,13 +1420,13 @@ "MaxResults": { "target": "com.amazonaws.chatbot#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved." + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.\n

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.\n

" } } }, @@ -1446,13 +1440,13 @@ "SlackWorkspaces": { "target": "com.amazonaws.chatbot#SlackWorkspacesList", "traits": { - "smithy.api#documentation": "A list of Slack Workspaces registered with AWS Chatbot." + "smithy.api#documentation": "

A list of Slack workspaces registered with AWS Chatbot.

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.\n

" } } }, @@ -1480,12 +1474,13 @@ } ], "traits": { - "smithy.api#documentation": "Get Chatbot account level preferences", + "smithy.api#documentation": "

Returns AWS Chatbot account preferences.

", "smithy.api#http": { "method": "POST", "uri": "/get-account-preferences", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#GetAccountPreferencesException": { @@ -1496,7 +1491,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1514,7 +1509,7 @@ "AccountPreferences": { "target": "com.amazonaws.chatbot#AccountPreferences", "traits": { - "smithy.api#documentation": "Preferences which apply for AWS Chatbot usage in the calling AWS account." + "smithy.api#documentation": "

The preferences related to AWS Chatbot usage in the calling AWS account.

" } } }, @@ -1542,12 +1537,17 @@ } ], "traits": { - "smithy.api#documentation": "Get a single MS Teams Channel Configurations", + "smithy.api#documentation": "

Returns a Microsoft Teams channel configuration in an AWS account.

", "smithy.api#http": { "method": "POST", "uri": "/get-ms-teams-channel-configuration", "code": 200 - } + }, + "smithy.api#readonly": {}, + "smithy.api#suppress": [ + "OperationInputOutputName.input", + "OperationInputOutputName.output" + ] } }, "com.amazonaws.chatbot#GetTeamsChannelConfigurationException": { @@ -1558,7 +1558,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1569,7 +1569,7 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration to retrieve.", + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the MicrosoftTeamsChannelConfiguration to retrieve.

", "smithy.api#required": {} } } @@ -1584,7 +1584,7 @@ "ChannelConfiguration": { "target": "com.amazonaws.chatbot#TeamsChannelConfiguration", "traits": { - "smithy.api#documentation": "The configuration for a Microsoft Teams channel configured with AWS Chatbot." + "smithy.api#documentation": "

The configuration for a Microsoft Teams channel configured with AWS Chatbot.

" } } }, @@ -1616,7 +1616,7 @@ } }, "traits": { - "smithy.api#documentation": "Customer/consumer-facing internal service exception.\n https://w.amazon.com/index.php/AWS/API_Standards/Exceptions#InternalServiceError", + "smithy.api#documentation": "

Unexpected error during processing of request.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1629,7 +1629,7 @@ } }, "traits": { - "smithy.api#documentation": "Your request input doesn't meet the constraints that AWS Chatbot requires.", + "smithy.api#documentation": "

Your request input doesn't meet the constraints required by AWS Chatbot.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1642,7 +1642,7 @@ } }, "traits": { - "smithy.api#documentation": "Your request input doesn't meet the constraints that AWS Chatbot requires.", + "smithy.api#documentation": "

Your request input doesn't meet the constraints required by AWS Chatbot.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1655,7 +1655,7 @@ } }, "traits": { - "smithy.api#documentation": "You have exceeded a service limit for AWS Chatbot.", + "smithy.api#documentation": "

You have exceeded a service limit for AWS Chatbot.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -1680,7 +1680,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists MS Teams Channel Configurations optionally filtered by TeamId", + "smithy.api#documentation": "

Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS account.

", "smithy.api#http": { "method": "POST", "uri": "/list-ms-teams-channel-configurations", @@ -1689,8 +1689,14 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults" - } + "pageSize": "MaxResults", + "items": "TeamChannelConfigurations" + }, + "smithy.api#readonly": {}, + "smithy.api#suppress": [ + "OperationInputOutputName.input", + "OperationInputOutputName.output" + ] } }, "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeams": { @@ -1713,7 +1719,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all authorized MS teams for AWS Account", + "smithy.api#documentation": "

Lists all authorized Microsoft Teams for an AWS Account

", "smithy.api#http": { "method": "POST", "uri": "/list-ms-teams-configured-teams", @@ -1722,8 +1728,10 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults" - } + "pageSize": "MaxResults", + "items": "ConfiguredTeams" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeamsException": { @@ -1734,7 +1742,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1745,13 +1753,13 @@ "MaxResults": { "target": "com.amazonaws.chatbot#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved." + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

" } } }, @@ -1765,13 +1773,13 @@ "ConfiguredTeams": { "target": "com.amazonaws.chatbot#ConfiguredTeamsList", "traits": { - "smithy.api#documentation": "A list of teams in Microsoft Teams that have been configured with AWS Chatbot." + "smithy.api#documentation": "

A list of teams in Microsoft Teams that are configured with AWS Chatbot.

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

" } } }, @@ -1799,7 +1807,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all Microsoft Teams user identities with a mapped role.", + "smithy.api#documentation": "

A list all Microsoft Teams user identities with a mapped role.

", "smithy.api#http": { "method": "POST", "uri": "/list-ms-teams-user-identities", @@ -1808,8 +1816,10 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults" - } + "pageSize": "MaxResults", + "items": "TeamsUserIdentities" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#ListMicrosoftTeamsUserIdentitiesException": { @@ -1820,7 +1830,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1831,19 +1841,19 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identities to list." + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.\n

" } }, "MaxResults": { "target": "com.amazonaws.chatbot#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved." + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.\n

" } } }, @@ -1857,13 +1867,13 @@ "TeamsUserIdentities": { "target": "com.amazonaws.chatbot#TeamsUserIdentitiesList", "traits": { - "smithy.api#documentation": "User level permissions associated to a channel configuration." + "smithy.api#documentation": "

User level permissions associated to a channel configuration.

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.\n

" } } }, @@ -1891,12 +1901,13 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the list of tags applied to a configuration.", + "smithy.api#documentation": "

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.

", "smithy.api#http": { "method": "POST", "uri": "/list-tags-for-resource", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#ListTagsForResourceRequest": { @@ -1905,7 +1916,7 @@ "ResourceARN": { "target": "com.amazonaws.chatbot#AmazonResourceName", "traits": { - "smithy.api#documentation": "The ARN of the configuration.", + "smithy.api#documentation": "

The ARN you specified to list the tags of.

", "smithy.api#required": {} } } @@ -1920,7 +1931,7 @@ "Tags": { "target": "com.amazonaws.chatbot#TagList", "traits": { - "smithy.api#documentation": "A list of tags applied to the configuration." + "smithy.api#documentation": "

Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define.

" } } }, @@ -1936,7 +1947,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1947,19 +1958,19 @@ "MaxResults": { "target": "com.amazonaws.chatbot#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved." + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" } }, "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

" } }, "TeamId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide." + "smithy.api#documentation": "

The ID of the Microsoft Teams authorized with AWS Chatbot.

\n

To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide.\n

" } } }, @@ -1973,13 +1984,13 @@ "NextToken": { "target": "com.amazonaws.chatbot#PaginationToken", "traits": { - "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + "smithy.api#documentation": "

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

" } }, "TeamChannelConfigurations": { "target": "com.amazonaws.chatbot#TeamChannelConfigurationsList", "traits": { - "smithy.api#documentation": "A list of AWS Chatbot channel configurations for Microsoft Teams." + "smithy.api#documentation": "

A list of AWS Chatbot channel configurations for Microsoft Teams.

" } } }, @@ -2014,7 +2025,7 @@ } }, "traits": { - "smithy.api#documentation": "We were not able to find the resource for your request.", + "smithy.api#documentation": "

We were unable to find the resource for your request

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -2027,7 +2038,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -2038,85 +2049,85 @@ "SlackTeamName": { "target": "com.amazonaws.chatbot#SlackTeamName", "traits": { - "smithy.api#documentation": "Name of the Slack Workspace.", + "smithy.api#documentation": "

Name of the Slack workspace.

", "smithy.api#required": {} } }, "SlackTeamId": { "target": "com.amazonaws.chatbot#SlackTeamId", "traits": { - "smithy.api#documentation": "The ID of the Slack workspace authorized with AWS Chatbot.", + "smithy.api#documentation": "

The ID of the Slack workspace authorized with Amazon Chime.

", "smithy.api#required": {} } }, "SlackChannelId": { "target": "com.amazonaws.chatbot#SlackChannelId", "traits": { - "smithy.api#documentation": "The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.", + "smithy.api#documentation": "

The ID of the Slack channel.

\n

To get this ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.\n

", "smithy.api#required": {} } }, "SlackChannelName": { "target": "com.amazonaws.chatbot#SlackChannelDisplayName", "traits": { - "smithy.api#documentation": "The name of the Slack Channel.", + "smithy.api#documentation": "

The name of the Slack channel.

", "smithy.api#required": {} } }, "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the SlackChannelConfiguration.", + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the SlackChannelConfiguration.

", "smithy.api#required": {} } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { - "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot.", + "smithy.api#documentation": "

The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

", "smithy.api#required": {} } }, "ConfigurationName": { "target": "com.amazonaws.chatbot#ConfigurationName", "traits": { - "smithy.api#documentation": "The name of the configuration." + "smithy.api#documentation": "

The name of the configuration.

" } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { - "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } }, "GuardrailPolicyArns": { "target": "com.amazonaws.chatbot#GuardrailPolicyArnList", "traits": { - "smithy.api#documentation": "The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set." + "smithy.api#documentation": "

The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed AdministratorAccess policy is applied by default if this is not set.\n

" } }, "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + "smithy.api#documentation": "

Enables use of a user role requirement in your chat configuration.

" } }, "Tags": { "target": "com.amazonaws.chatbot#Tags", "traits": { - "smithy.api#documentation": "A list of tags applied to the configuration." + "smithy.api#documentation": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" } } }, "traits": { - "smithy.api#documentation": "An AWS Chatbot configuration for Slack." + "smithy.api#documentation": "

An AWS Chatbot configuration for Slack.

" } }, "com.amazonaws.chatbot#SlackChannelConfigurationList": { @@ -2131,7 +2142,8 @@ "smithy.api#length": { "min": 1, "max": 255 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.chatbot#SlackChannelId": { @@ -2185,40 +2197,40 @@ "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the SlackChannelConfiguration associated with the user identity.", + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the SlackChannelConfiguration associated with the user identity to delete.

", "smithy.api#required": {} } }, "SlackTeamId": { "target": "com.amazonaws.chatbot#SlackTeamId", "traits": { - "smithy.api#documentation": "The ID of the Slack workspace authorized with AWS Chatbot.", + "smithy.api#documentation": "

The ID of the Slack workspace authorized with AWS Chatbot.

", "smithy.api#required": {} } }, "SlackUserId": { "target": "com.amazonaws.chatbot#SlackUserId", "traits": { - "smithy.api#documentation": "The ID of the user in Slack.", + "smithy.api#documentation": "

The ID of the user in Slack

", "smithy.api#required": {} } }, "AwsUserIdentity": { "target": "com.amazonaws.chatbot#AwsUserIdentity", "traits": { - "smithy.api#documentation": "The AWS user identity ARN used to associate a Slack User Identity with an IAM Role." + "smithy.api#documentation": "

The AWS user identity ARN used to associate a Slack user ID with an IAM Role.

" } } }, "traits": { - "smithy.api#documentation": "Identifes a User level permission for a channel configuration." + "smithy.api#documentation": "

Identifes a user level permission for a channel configuration.

" } }, "com.amazonaws.chatbot#SlackWorkspace": { @@ -2227,20 +2239,20 @@ "SlackTeamId": { "target": "com.amazonaws.chatbot#SlackTeamId", "traits": { - "smithy.api#documentation": "The ID of the Slack workspace authorized with AWS Chatbot.", + "smithy.api#documentation": "

The ID of the Slack workspace authorized with AWS Chatbot.

", "smithy.api#required": {} } }, "SlackTeamName": { "target": "com.amazonaws.chatbot#SlackTeamName", "traits": { - "smithy.api#documentation": "Name of the Slack Workspace.", + "smithy.api#documentation": "

The name of the Slack workspace.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A Slack Workspace." + "smithy.api#documentation": "

A Slack workspace.

" } }, "com.amazonaws.chatbot#SlackWorkspacesList": { @@ -2255,29 +2267,26 @@ "target": "com.amazonaws.chatbot#Arn" } }, - "com.amazonaws.chatbot#String": { - "type": "string" - }, "com.amazonaws.chatbot#Tag": { "type": "structure", "members": { "TagKey": { "target": "com.amazonaws.chatbot#TagKey", "traits": { - "smithy.api#documentation": "The tag key.", + "smithy.api#documentation": "

The key of the tag.

", "smithy.api#required": {} } }, "TagValue": { "target": "com.amazonaws.chatbot#TagValue", "traits": { - "smithy.api#documentation": "The tag value.", + "smithy.api#documentation": "

The value of the tag.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A tag applied to the configuration." + "smithy.api#documentation": "

A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

\n \n

Do not include confidential or sensitive information in this field.

\n
\n

For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.

" } }, "com.amazonaws.chatbot#TagKey": { @@ -2336,7 +2345,7 @@ } ], "traits": { - "smithy.api#documentation": "Applies the supplied tags to a configuration.", + "smithy.api#documentation": "

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

", "smithy.api#http": { "method": "POST", "uri": "/tag-resource", @@ -2350,14 +2359,14 @@ "ResourceARN": { "target": "com.amazonaws.chatbot#AmazonResourceName", "traits": { - "smithy.api#documentation": "The ARN of the configuration.", + "smithy.api#documentation": "

The ARN of the configuration.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.chatbot#TagList", "traits": { - "smithy.api#documentation": "A list of tags to apply to the configuration.", + "smithy.api#documentation": "

A list of tags to apply to the configuration.

", "smithy.api#required": {} } } @@ -2377,7 +2386,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 256 } } @@ -2401,7 +2410,8 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "^(.*)$" + "smithy.api#pattern": "^(.*)$", + "smithy.api#sensitive": {} } }, "com.amazonaws.chatbot#TeamsChannelConfiguration": { @@ -2410,90 +2420,90 @@ "ChannelId": { "target": "com.amazonaws.chatbot#TeamsChannelId", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Teams channel.", + "smithy.api#documentation": "

The ID of the Microsoft Teams channel.

", "smithy.api#required": {} } }, "ChannelName": { "target": "com.amazonaws.chatbot#TeamsChannelName", "traits": { - "smithy.api#documentation": "The name of the Microsoft Teams channel." + "smithy.api#documentation": "

The name of the Microsoft Teams channel.

" } }, "TeamId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.", + "smithy.api#documentation": "

The ID of the Microsoft Teams authorized with AWS Chatbot.

\n

To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "TeamName": { - "target": "com.amazonaws.chatbot#String", + "target": "com.amazonaws.chatbot#TeamName", "traits": { - "smithy.api#documentation": "The name of the Microsoft Teams Team." + "smithy.api#documentation": "

The name of the Microsoft Teams Team.

" } }, "TenantId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Teams tenant.", + "smithy.api#documentation": "

The ID of the Microsoft Teams tenant.

", "smithy.api#required": {} } }, "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration.", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

", "smithy.api#required": {} } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { - "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot.", + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

", "smithy.api#required": {} } }, "ConfigurationName": { "target": "com.amazonaws.chatbot#ConfigurationName", "traits": { - "smithy.api#documentation": "The name of the configuration." + "smithy.api#documentation": "

The name of the configuration.

" } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { - "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } }, "GuardrailPolicyArns": { "target": "com.amazonaws.chatbot#GuardrailPolicyArnList", "traits": { - "smithy.api#documentation": "The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set." + "smithy.api#documentation": "

The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed AdministratorAccess policy is applied by default if this is not set.\n

" } }, "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + "smithy.api#documentation": "

Enables use of a user role requirement in your chat configuration.

" } }, "Tags": { "target": "com.amazonaws.chatbot#Tags", "traits": { - "smithy.api#documentation": "A list of tags applied to the configuration." + "smithy.api#documentation": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" } } }, "traits": { - "smithy.api#documentation": "An AWS Chatbot configuration for Microsoft Teams." + "smithy.api#documentation": "

An AWS Chatbot configuration for Microsoft Teams.

" } }, "com.amazonaws.chatbot#TeamsChannelId": { @@ -2513,7 +2523,8 @@ "min": 1, "max": 1000 }, - "smithy.api#pattern": "^(.*)$" + "smithy.api#pattern": "^(.*)$", + "smithy.api#sensitive": {} } }, "com.amazonaws.chatbot#TeamsUserIdentitiesList": { @@ -2528,51 +2539,51 @@ "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity.", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

", "smithy.api#required": {} } }, "TeamId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.", + "smithy.api#documentation": "

The ID of the Microsoft Teams authorized with AWS Chatbot.

\n

To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide.\n

", "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "Id from Microsoft Teams for user." + "smithy.api#documentation": "

The Microsoft Teams user ID.

" } }, "AwsUserIdentity": { "target": "com.amazonaws.chatbot#AwsUserIdentity", "traits": { - "smithy.api#documentation": "The AWS user identity ARN used to associate a Microsoft Teams User Identity with an IAM Role." + "smithy.api#documentation": "

The AWS user identity ARN used to associate a Microsoft Teams user Identity with an IAM Role.

" } }, "TeamsChannelId": { "target": "com.amazonaws.chatbot#TeamsChannelId", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Teams channel." + "smithy.api#documentation": "

The ID of the Microsoft Teams channel.

" } }, "TeamsTenantId": { "target": "com.amazonaws.chatbot#UUID", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Teams tenant." + "smithy.api#documentation": "

The ID of the Microsoft Teams tenant.

" } } }, "traits": { - "smithy.api#documentation": "Identifes a user level permission for a channel configuration." + "smithy.api#documentation": "

Identifes a user level permission for a channel configuration.

" } }, "com.amazonaws.chatbot#TooManyTagsException": { @@ -2583,7 +2594,7 @@ } }, "traits": { - "smithy.api#documentation": "The supplied list of tags contains too many tags.", + "smithy.api#documentation": "

The supplied list of tags contains too many tags.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2618,7 +2629,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the supplied tags from a configuration", + "smithy.api#documentation": "

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

", "smithy.api#http": { "method": "POST", "uri": "/untag-resource", @@ -2632,14 +2643,14 @@ "ResourceARN": { "target": "com.amazonaws.chatbot#AmazonResourceName", "traits": { - "smithy.api#documentation": "The ARN of the configuration.", + "smithy.api#documentation": "

The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role.

", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.chatbot#TagKeyList", "traits": { - "smithy.api#documentation": "A list of tag keys to remove from the configuration.", + "smithy.api#documentation": "

TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose.

", "smithy.api#required": {} } } @@ -2675,7 +2686,7 @@ } ], "traits": { - "smithy.api#documentation": "Update Chatbot account level preferences", + "smithy.api#documentation": "

Updates AWS Chatbot account preferences.

", "smithy.api#http": { "method": "POST", "uri": "/update-account-preferences", @@ -2691,7 +2702,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -2702,13 +2713,13 @@ "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + "smithy.api#documentation": "

Enables use of a user role requirement in your chat configuration.

" } }, "TrainingDataCollectionEnabled": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "Turns on training data collection. This helps improve the AWS Chatbot experience by allowing AWS Chatbot to store and use your customer information, such as AWS Chatbot configurations, notifications, user inputs, AWS Chatbot generated responses, and interaction data. This data helps us to continuously improve and develop Artificial Intelligence (AI) technologies. Your data is not shared with any third parties and is protected using sophisticated controls to prevent unauthorized access and misuse. AWS Chatbot does not store or use interactions in chat channels with Amazon Q for training AWS Chatbot’s AI technologies." + "smithy.api#documentation": "

Turns on training data collection.

\n

This helps improve the AWS Chatbot experience by allowing AWS Chatbot to store and use your customer information, such as AWS Chatbot configurations, notifications, user inputs, AWS Chatbot generated responses, and interaction data. This data helps us to continuously improve and develop Artificial Intelligence (AI) technologies. Your data is not shared with any third parties and is protected using sophisticated controls to prevent unauthorized access and misuse. AWS Chatbot does not store or use interactions in chat channels with Amazon Q for training AI technologies for AWS Chatbot.\n

" } } }, @@ -2722,7 +2733,7 @@ "AccountPreferences": { "target": "com.amazonaws.chatbot#AccountPreferences", "traits": { - "smithy.api#documentation": "Preferences which apply for AWS Chatbot usage in the calling AWS account." + "smithy.api#documentation": "

Preferences related to AWS Chatbot usage in the calling AWS account.

" } } }, @@ -2753,7 +2764,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a Chime Webhook Configuration", + "smithy.api#documentation": "

Updates a Amazon Chime webhook configuration.

", "smithy.api#http": { "method": "POST", "uri": "/update-chime-webhook-configuration", @@ -2769,7 +2780,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -2780,38 +2791,38 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the ChimeWebhookConfiguration to update.", + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration to update.

", "smithy.api#required": {} } }, "WebhookDescription": { "target": "com.amazonaws.chatbot#ChimeWebhookDescription", "traits": { - "smithy.api#documentation": "Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html." + "smithy.api#documentation": "

A description of the webhook. We recommend using the convention RoomName/WebhookName.

\n

For more information, see Tutorial: Get started with Amazon Chime in the AWS Chatbot Administrator Guide.\n

" } }, "WebhookUrl": { "target": "com.amazonaws.chatbot#ChimeWebhookUrl", "traits": { - "smithy.api#documentation": "URL for the Chime webhook." + "smithy.api#documentation": "

The URL for the Amazon Chime webhook.

" } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { - "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot." + "smithy.api#documentation": "

The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

" } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot." + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

" } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { - "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } } }, @@ -2825,7 +2836,7 @@ "WebhookConfiguration": { "target": "com.amazonaws.chatbot#ChimeWebhookConfiguration", "traits": { - "smithy.api#documentation": "Chime webhook configuration." + "smithy.api#documentation": "

A Amazon Chime webhook configuration.

" } } }, @@ -2856,12 +2867,16 @@ } ], "traits": { - "smithy.api#documentation": "Updates MS Teams Channel Configuration", + "smithy.api#documentation": "

Updates an Microsoft Teams channel configuration.

", "smithy.api#http": { "method": "POST", "uri": "/update-ms-teams-channel-configuration", "code": 200 - } + }, + "smithy.api#suppress": [ + "OperationInputOutputName.input", + "OperationInputOutputName.output" + ] } }, "com.amazonaws.chatbot#UpdateSlackChannelConfiguration": { @@ -2887,7 +2902,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates Slack Channel Configuration", + "smithy.api#documentation": "

Updates a Slack channel configuration.

", "smithy.api#http": { "method": "POST", "uri": "/update-slack-channel-configuration", @@ -2903,7 +2918,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -2914,51 +2929,51 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the SlackChannelConfiguration to update.", + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the SlackChannelConfiguration to update.

", "smithy.api#required": {} } }, "SlackChannelId": { "target": "com.amazonaws.chatbot#SlackChannelId", "traits": { - "smithy.api#documentation": "The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.", + "smithy.api#documentation": "

The ID of the Slack channel.

\n

To get this ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.\n

", "smithy.api#required": {} } }, "SlackChannelName": { "target": "com.amazonaws.chatbot#SlackChannelDisplayName", "traits": { - "smithy.api#documentation": "The name of the Slack Channel." + "smithy.api#documentation": "

The name of the Slack channel.

" } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { - "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot." + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

" } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot." + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

" } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { - "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } }, "GuardrailPolicyArns": { "target": "com.amazonaws.chatbot#GuardrailPolicyArnList", "traits": { - "smithy.api#documentation": "The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set." + "smithy.api#documentation": "

The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed AdministratorAccess policy is applied by default if this is not set.\n

" } }, "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + "smithy.api#documentation": "

Enables use of a user role requirement in your chat configuration.

" } } }, @@ -2972,7 +2987,7 @@ "ChannelConfiguration": { "target": "com.amazonaws.chatbot#SlackChannelConfiguration", "traits": { - "smithy.api#documentation": "The configuration for a Slack channel configured with AWS Chatbot." + "smithy.api#documentation": "

The configuration for a Slack channel configured with AWS Chatbot.

" } } }, @@ -2988,7 +3003,7 @@ } }, "traits": { - "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#documentation": "

We can’t process your request right now because of a server issue. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -2999,51 +3014,51 @@ "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration to update.", + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the TeamsChannelConfiguration to update.

", "smithy.api#required": {} } }, "ChannelId": { "target": "com.amazonaws.chatbot#TeamsChannelId", "traits": { - "smithy.api#documentation": "The ID of the Microsoft Teams channel.", + "smithy.api#documentation": "

The ID of the Microsoft Teams channel.

", "smithy.api#required": {} } }, "ChannelName": { "target": "com.amazonaws.chatbot#TeamsChannelName", "traits": { - "smithy.api#documentation": "The name of the Microsoft Teams channel." + "smithy.api#documentation": "

The name of the Microsoft Teams channel.

" } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { - "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot." + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

" } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot." + "smithy.api#documentation": "

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

\n

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.\n

" } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { - "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } }, "GuardrailPolicyArns": { "target": "com.amazonaws.chatbot#GuardrailPolicyArnList", "traits": { - "smithy.api#documentation": "The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set." + "smithy.api#documentation": "

The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed AdministratorAccess policy is applied by default if this is not set.\n

" } }, "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { - "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + "smithy.api#documentation": "

Enables use of a user role requirement in your chat configuration.

" } } }, @@ -3057,7 +3072,7 @@ "ChannelConfiguration": { "target": "com.amazonaws.chatbot#TeamsChannelConfiguration", "traits": { - "smithy.api#documentation": "The configuration for a Microsoft Teams channel configured with AWS Chatbot." + "smithy.api#documentation": "

The configuration for a Microsoft Teams channel configured with AWS Chatbot.

" } } }, @@ -3160,7 +3175,26 @@ "name": "chatbot" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "AWS Chatbot API", + "smithy.api#auth": [ + "aws.auth#sigv4" + ], + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-trace-id" + ], + "maxAge": 86400 + }, + "smithy.api#documentation": "

The AWS Chatbot API Reference provides descriptions, API request parameters, and the XML response for each of the AWS Chatbot API actions.

\n

AWS Chatbot APIs are currently available in the following Regions:

\n \n

The AWS Chatbot console can only be used in US East (Ohio). Your configuration data however, is stored in each of the relevant available Regions.

\n \n

Your AWS CloudTrail events are logged in whatever Region you call from, not US East (N. Virginia) by default.

\n
", "smithy.api#title": "AWS Chatbot", "smithy.api#xmlNamespace": { "uri": "http://wheatley.amazonaws.com/orchestration/2017-10-11/" @@ -3832,4 +3866,4 @@ } } } -} +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/omics.json b/codegen/sdk-codegen/aws-models/omics.json index f3db885ee59..d28c1aef313 100644 --- a/codegen/sdk-codegen/aws-models/omics.json +++ b/codegen/sdk-codegen/aws-models/omics.json @@ -1906,7 +1906,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a run group.

", + "smithy.api#documentation": "

You can optionally create a run group to limit the compute resources for the runs that you add to the group.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -1929,7 +1929,7 @@ "maxCpus": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of CPUs to use in the group.

", + "smithy.api#documentation": "

The maximum number of CPUs that can run\n concurrently across all active runs in the run group.

", "smithy.api#range": { "min": 1, "max": 100000 @@ -1939,7 +1939,7 @@ "maxRuns": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of concurrent runs for the group.

", + "smithy.api#documentation": "

The maximum number of runs that can be running at the same time.

", "smithy.api#range": { "min": 1, "max": 100000 @@ -1949,7 +1949,7 @@ "maxDuration": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

A maximum run time for the group in minutes.

", + "smithy.api#documentation": "

The maximum time for each run (in minutes). If a run exceeds\n the maximum run time, the run fails automatically.

", "smithy.api#range": { "min": 1, "max": 100000 @@ -1973,7 +1973,7 @@ "maxGpus": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum GPUs that can be used by a run group.

", + "smithy.api#documentation": "

The maximum number of GPUs that can run concurrently across all active\n runs in the run group.

", "smithy.api#range": { "min": 1, "max": 100000 @@ -2198,7 +2198,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a cross-account shared resource. The resource owner makes an offer to share the resource \n with the principal subscriber (an AWS user with a different account than the resource owner).

\n

The following resources support cross-account sharing:

\n ", + "smithy.api#documentation": "

Creates a cross-account shared resource. The resource owner makes an offer to share the resource \n with the principal subscriber (an AWS user with a different account than the resource owner).

\n

The following resources support cross-account sharing:

\n ", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -2485,7 +2485,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The storage capacity for the workflow in gibibytes.

", + "smithy.api#documentation": "

The default storage capacity for the workflow runs, in gibibytes.

", "smithy.api#range": { "min": 0, "max": 100000 @@ -2549,6 +2549,16 @@ "smithy.api#output": {} } }, + "com.amazonaws.omics#CreationJobId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, "com.amazonaws.omics#CreationTime": { "type": "timestamp", "traits": { @@ -5291,6 +5301,12 @@ "traits": { "smithy.api#documentation": "

The entity tag (ETag) is a hash of the object meant to represent its semantic content.

" } + }, + "creationJobId": { + "target": "com.amazonaws.omics#CreationJobId", + "traits": { + "smithy.api#documentation": "

The read set's creation job ID.

" + } } }, "traits": { @@ -5745,6 +5761,18 @@ "traits": { "smithy.api#documentation": "

The reference's files.

" } + }, + "creationType": { + "target": "com.amazonaws.omics#ReferenceCreationType", + "traits": { + "smithy.api#documentation": "

The reference's creation type.

" + } + }, + "creationJobId": { + "target": "com.amazonaws.omics#CreationJobId", + "traits": { + "smithy.api#documentation": "

The reference's creation job ID.

" + } } }, "traits": { @@ -7588,7 +7616,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The workflow's storage capacity in gibibytes.

", + "smithy.api#documentation": "

The workflow's default run storage capacity in gibibytes.

", "smithy.api#range": { "min": 0, "max": 100000 @@ -7811,6 +7839,12 @@ "traits": { "smithy.api#documentation": "

The source's tags.

" } + }, + "readSetId": { + "target": "com.amazonaws.omics#ReadSetId", + "traits": { + "smithy.api#documentation": "

The source's read set ID.

" + } } }, "traits": { @@ -7947,6 +7981,12 @@ "traits": { "smithy.api#documentation": "

The source's tags.

" } + }, + "referenceId": { + "target": "com.amazonaws.omics#ReferenceId", + "traits": { + "smithy.api#documentation": "

The source's reference ID.

" + } } }, "traits": { @@ -12069,6 +12109,17 @@ "smithy.api#pattern": "^$|^arn:.+$" } }, + "com.amazonaws.omics#ReferenceCreationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IMPORT", + "name": "IMPORT" + } + ] + } + }, "com.amazonaws.omics#ReferenceDescription": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/polly.json b/codegen/sdk-codegen/aws-models/polly.json index 5b9a83199e0..c5ade3bce3f 100644 --- a/codegen/sdk-codegen/aws-models/polly.json +++ b/codegen/sdk-codegen/aws-models/polly.json @@ -764,6 +764,18 @@ "traits": { "smithy.api#enumValue": "fr-BE" } + }, + "cs_CZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cs-CZ" + } + }, + "de_CH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "de-CH" + } } } }, @@ -3523,6 +3535,18 @@ "traits": { "smithy.api#enumValue": "Burcu" } + }, + "Jitka": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Jitka" + } + }, + "Sabrina": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Sabrina" + } } } },