{ "smithy": "2.0", "shapes": { "com.amazonaws.chatbot#AccountPreferences": { "type": "structure", "members": { "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { "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.

\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 related to AWS Chatbot usage in the calling AWS account.

" } }, "com.amazonaws.chatbot#AmazonResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1011 }, "smithy.api#pattern": "^arn:aws:(wheatley|chatbot):[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$" } }, "com.amazonaws.chatbot#Arn": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 1224 }, "smithy.api#pattern": "^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$" } }, "com.amazonaws.chatbot#AssociateToConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#AssociateToConfigurationRequest" }, "output": { "target": "com.amazonaws.chatbot#AssociateToConfigurationResult" }, "errors": [ { "target": "com.amazonaws.chatbot#InternalServiceError" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#UnauthorizedException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to associate a resource with a configuration", "resources": { "required": { "ChatbotConfiguration": {}, "custom-action": {} } } }, "smithy.api#documentation": "

Links a resource (for example, a custom action) to a channel configuration.

", "smithy.api#examples": [ { "title": "Associate a custom action to a configuration", "documentation": "Associate a custom action to a channel configuration, allowing it to be used in that channel", "input": { "Resource": "arn:aws:chatbot::1234567890:custom-action/my-custom-action", "ChatConfiguration": "arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-channel" }, "output": {} } ], "smithy.api#http": { "code": 201, "method": "POST", "uri": "/associate-to-configuration" }, "smithy.api#idempotent": {} } }, "com.amazonaws.chatbot#AssociateToConfigurationRequest": { "type": "structure", "members": { "Resource": { "target": "com.amazonaws.chatbot#ResourceIdentifier", "traits": { "smithy.api#documentation": "

The resource Amazon Resource Name (ARN) to link.

", "smithy.api#required": {} } }, "ChatConfiguration": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { "smithy.api#documentation": "

The channel configuration to associate with the resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#AssociateToConfigurationResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#AssociationList": { "type": "list", "member": { "target": "com.amazonaws.chatbot#AssociationListing" } }, "com.amazonaws.chatbot#AssociationListing": { "type": "structure", "members": { "Resource": { "target": "com.amazonaws.chatbot#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource (for example, a custom action).

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

A listing of an association with a channel configuration.

" } }, "com.amazonaws.chatbot#AwsUserIdentity": { "type": "string", "traits": { "smithy.api#length": { "min": 15, "max": 1101 }, "smithy.api#pattern": "^arn:aws:(iam|sts)::[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$" } }, "com.amazonaws.chatbot#BooleanAccountPreference": { "type": "boolean" }, "com.amazonaws.chatbot#ChatConfigurationArn": { "type": "string", "traits": { "smithy.api#length": { "min": 19, "max": 1169 }, "smithy.api#pattern": "^arn:aws:(wheatley|chatbot):[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$" } }, "com.amazonaws.chatbot#ChimeWebhookConfiguration": { "type": "structure", "members": { "WebhookDescription": { "target": "com.amazonaws.chatbot#ChimeWebhookDescription", "traits": { "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 Amazon Resource Name (ARN) of the ChimeWebhookConfiguration.

", "smithy.api#required": {} } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { "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 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.

" } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

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

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

" } }, "State": { "target": "com.amazonaws.chatbot#ResourceState", "traits": { "smithy.api#documentation": "

Either ENABLED or DISABLED. The resource returns DISABLED if the organization's AWS Chatbot policy has explicitly denied that configuration.\n\t For example, if Amazon Chime is disabled.

" } }, "StateReason": { "target": "com.amazonaws.chatbot#String", "traits": { "smithy.api#documentation": "

Provided if State is DISABLED. Provides context as to why the resource is disabled.

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

An AWS Chatbot configuration for Amazon Chime.

" } }, "com.amazonaws.chatbot#ChimeWebhookConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.chatbot#ChimeWebhookConfiguration" } }, "com.amazonaws.chatbot#ChimeWebhookDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#sensitive": {} } }, "com.amazonaws.chatbot#ChimeWebhookUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^https://hooks\\.chime\\.aws/incomingwebhooks/[A-Za-z0-9\\-]+?\\?token=[A-Za-z0-9\\-]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.chatbot#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 33, "max": 126 }, "smithy.api#pattern": "^[\\x21-\\x7F]+$" } }, "com.amazonaws.chatbot#ConfigurationName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[A-Za-z0-9-_]+$" } }, "com.amazonaws.chatbot#ConfiguredTeam": { "type": "structure", "members": { "TenantId": { "target": "com.amazonaws.chatbot#UUID", "traits": { "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 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.

" } }, "State": { "target": "com.amazonaws.chatbot#ResourceState", "traits": { "smithy.api#documentation": "

Either ENABLED or DISABLED. The resource returns DISABLED if the organization's AWS Chatbot policy has explicitly denied that configuration.\n\t For example, if Amazon Chime is disabled.

" } }, "StateReason": { "target": "com.amazonaws.chatbot#String", "traits": { "smithy.api#documentation": "

Provided if State is DISABLED. Provides context as to why the resource is disabled.

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

A Microsoft Teams team that is authorized with AWS Chatbot.

" } }, "com.amazonaws.chatbot#ConfiguredTeamsList": { "type": "list", "member": { "target": "com.amazonaws.chatbot#ConfiguredTeam" } }, "com.amazonaws.chatbot#ConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

There was an issue processing your request.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.chatbot#CreateChimeWebhookConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#CreateChimeWebhookConfigurationRequest" }, "output": { "target": "com.amazonaws.chatbot#CreateChimeWebhookConfigurationResult" }, "errors": [ { "target": "com.amazonaws.chatbot#ConflictException" }, { "target": "com.amazonaws.chatbot#CreateChimeWebhookConfigurationException" }, { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#LimitExceededException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create an AWS Chatbot Chime Webhook Configuration", "createsResources": [ "ChatbotConfiguration" ] }, "smithy.api#documentation": "

Creates an AWS Chatbot configuration for Amazon Chime.

", "smithy.api#http": { "method": "POST", "uri": "/create-chime-webhook-configuration", "code": 201 } } }, "com.amazonaws.chatbot#CreateChimeWebhookConfigurationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#CreateChimeWebhookConfigurationRequest": { "type": "structure", "members": { "WebhookDescription": { "target": "com.amazonaws.chatbot#ChimeWebhookDescription", "traits": { "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": "

The URL for the Amazon Chime webhook.

", "smithy.api#required": {} } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { "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": "

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#required": {} } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { "smithy.api#documentation": "

Logging levels include ERROR, INFO, or NONE.

" } }, "Tags": { "target": "com.amazonaws.chatbot#Tags", "traits": { "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#input": {} } }, "com.amazonaws.chatbot#CreateChimeWebhookConfigurationResult": { "type": "structure", "members": { "WebhookConfiguration": { "target": "com.amazonaws.chatbot#ChimeWebhookConfiguration", "traits": { "smithy.api#documentation": "

An Amazon Chime webhook configuration.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#CreateCustomAction": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#CreateCustomActionRequest" }, "output": { "target": "com.amazonaws.chatbot#CreateCustomActionResult" }, "errors": [ { "target": "com.amazonaws.chatbot#ConflictException" }, { "target": "com.amazonaws.chatbot#InternalServiceError" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#LimitExceededException" }, { "target": "com.amazonaws.chatbot#UnauthorizedException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create a custom action" }, "smithy.api#documentation": "

Creates a custom action that can be invoked as an alias or as a button on a notification.

", "smithy.api#examples": [ { "title": "Create an alias that invokes a Lambda function", "documentation": "Creates an alias that invokes a Lambda function from chat channels. You can use this alias by entering 'run invoke', after which you're prompted for the function name.", "input": { "ActionName": "my-custom-action", "Definition": { "CommandText": "lambda invoke $functionName" }, "AliasName": "invoke" }, "output": { "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/my-custom-action" } }, { "title": "Create a custom action to list alarms", "documentation": "Creates a button on all Cloudwatch notifications that lists alarms in the \u2018ALARM\u2019 state.", "input": { "ActionName": "describe-alarms", "Definition": { "CommandText": "cloudwatch describe-alarms --state-value ALARM" }, "Attachments": [ { "NotificationType": "CloudWatch", "ButtonText": "List alarms" } ] }, "output": { "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/describe-alarms" } } ], "smithy.api#http": { "code": 201, "method": "POST", "uri": "/create-custom-action" }, "smithy.api#idempotent": {} } }, "com.amazonaws.chatbot#CreateCustomActionRequest": { "type": "structure", "members": { "Definition": { "target": "com.amazonaws.chatbot#CustomActionDefinition", "traits": { "smithy.api#documentation": "

The definition of the command to run when invoked as an alias or as an action button.

", "smithy.api#required": {} } }, "AliasName": { "target": "com.amazonaws.chatbot#CustomActionAliasName", "traits": { "smithy.api#documentation": "

The name used to invoke this action in a chat channel. For example, @aws run my-alias.

" } }, "Attachments": { "target": "com.amazonaws.chatbot#CustomActionAttachmentList", "traits": { "smithy.api#documentation": "

Defines when this custom action button should be attached to a notification.

" } }, "Tags": { "target": "com.amazonaws.chatbot#TagList", "traits": { "smithy.api#documentation": "

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

" } }, "ClientToken": { "target": "com.amazonaws.chatbot#ClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

\n

If you do not specify a client token, one is automatically generated by the SDK.

", "smithy.api#idempotencyToken": {} } }, "ActionName": { "target": "com.amazonaws.chatbot#CustomActionName", "traits": { "smithy.api#documentation": "

The name of the custom action. This name is included in the Amazon Resource Name (ARN).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#CreateCustomActionResult": { "type": "structure", "members": { "CustomActionArn": { "target": "com.amazonaws.chatbot#CustomActionArn", "traits": { "smithy.api#documentation": "

The fully defined ARN of the custom action.

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CustomActionArn" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#CreateMicrosoftTeamsChannelConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#CreateTeamsChannelConfigurationRequest" }, "output": { "target": "com.amazonaws.chatbot#CreateTeamsChannelConfigurationResult" }, "errors": [ { "target": "com.amazonaws.chatbot#ConflictException" }, { "target": "com.amazonaws.chatbot#CreateTeamsChannelConfigurationException" }, { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#LimitExceededException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create an AWS Chatbot Microsoft Teams Channel Configuration", "createsResources": [ "ChatbotConfiguration" ] }, "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": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#CreateSlackChannelConfigurationRequest" }, "output": { "target": "com.amazonaws.chatbot#CreateSlackChannelConfigurationResult" }, "errors": [ { "target": "com.amazonaws.chatbot#ConflictException" }, { "target": "com.amazonaws.chatbot#CreateSlackChannelConfigurationException" }, { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#LimitExceededException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create an AWS Chatbot Slack Channel Configuration", "createsResources": [ "ChatbotConfiguration" ] }, "smithy.api#documentation": "

Creates an AWS Chatbot confugration for Slack.

", "smithy.api#http": { "method": "POST", "uri": "/create-slack-channel-configuration", "code": 201 } } }, "com.amazonaws.chatbot#CreateSlackChannelConfigurationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#CreateSlackChannelConfigurationRequest": { "type": "structure", "members": { "SlackTeamId": { "target": "com.amazonaws.chatbot#SlackTeamId", "traits": { "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.

\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.

" } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { "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": "

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#required": {} } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { "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.\n

" } }, "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { "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 map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#CreateSlackChannelConfigurationResult": { "type": "structure", "members": { "ChannelConfiguration": { "target": "com.amazonaws.chatbot#SlackChannelConfiguration", "traits": { "smithy.api#documentation": "

The configuration for a Slack channel configured with AWS Chatbot.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#CreateTeamsChannelConfigurationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#CreateTeamsChannelConfigurationRequest": { "type": "structure", "members": { "ChannelId": { "target": "com.amazonaws.chatbot#TeamsChannelId", "traits": { "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.

" } }, "TeamId": { "target": "com.amazonaws.chatbot#UUID", "traits": { "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.

" } }, "TenantId": { "target": "com.amazonaws.chatbot#UUID", "traits": { "smithy.api#documentation": "

The ID of the Microsoft Teams tenant.

", "smithy.api#required": {} } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { "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": "

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#required": {} } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { "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.\n

" } }, "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { "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 map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#CreateTeamsChannelConfigurationResult": { "type": "structure", "members": { "ChannelConfiguration": { "target": "com.amazonaws.chatbot#TeamsChannelConfiguration", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#CustomAction": { "type": "structure", "members": { "CustomActionArn": { "target": "com.amazonaws.chatbot#CustomActionArn", "traits": { "smithy.api#documentation": "

The fully defined Amazon Resource Name (ARN) of the custom action.

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CustomActionArn" } }, "Definition": { "target": "com.amazonaws.chatbot#CustomActionDefinition", "traits": { "smithy.api#documentation": "

The definition of the command to run when invoked an alias or as an action button.

", "smithy.api#required": {} } }, "AliasName": { "target": "com.amazonaws.chatbot#CustomActionAliasName", "traits": { "smithy.api#documentation": "

The name used to invoke this action in the chat channel. For example, @aws run my-alias.

" } }, "Attachments": { "target": "com.amazonaws.chatbot#CustomActionAttachmentList", "traits": { "smithy.api#documentation": "

Defines when this custom action button should be attached to a notification.

" } }, "ActionName": { "target": "com.amazonaws.chatbot#CustomActionName", "traits": { "smithy.api#documentation": "

The name of the custom action that is included in the ARN.

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

Represents a parameterized command that can be invoked as an alias or as a notification button in the chat client.

" } }, "com.amazonaws.chatbot#CustomActionAliasName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 30 }, "smithy.api#pattern": "^[A-Za-z0-9-_]+$" } }, "com.amazonaws.chatbot#CustomActionArn": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::Chatbot::CustomAction", "service": "com.amazonaws.chatbot#WheatleyOrchestration_20171011", "resource": "com.amazonaws.chatbot#CustomActionResource" }, "smithy.api#length": { "min": 1, "max": 1011 }, "smithy.api#pattern": "^arn:aws:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:custom-action/[a-zA-Z0-9_-]{1,64}$" } }, "com.amazonaws.chatbot#CustomActionArnList": { "type": "list", "member": { "target": "com.amazonaws.chatbot#CustomActionArn" } }, "com.amazonaws.chatbot#CustomActionAttachment": { "type": "structure", "members": { "NotificationType": { "target": "com.amazonaws.chatbot#CustomActionAttachmentNotificationType", "traits": { "smithy.api#documentation": "

The type of notification that the custom action should be attached to.

" } }, "ButtonText": { "target": "com.amazonaws.chatbot#CustomActionButtonText", "traits": { "smithy.api#documentation": "

The text of the button that appears on the notification.

" } }, "Criteria": { "target": "com.amazonaws.chatbot#CustomActionAttachmentCriteriaList", "traits": { "smithy.api#documentation": "

The criteria for when a button should be shown based on values in the notification.

" } }, "Variables": { "target": "com.amazonaws.chatbot#CustomActionAttachmentVariables", "traits": { "smithy.api#documentation": "

The variables to extract from the notification.

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

Defines when a custom action button should be attached to a notification.

" } }, "com.amazonaws.chatbot#CustomActionAttachmentCriteria": { "type": "structure", "members": { "Operator": { "target": "com.amazonaws.chatbot#CustomActionAttachmentCriteriaOperator", "traits": { "smithy.api#documentation": "

The operation to perform on the named variable.

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

The name of the variable to operate on.

", "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[A-Za-z0-9-_]+$", "smithy.api#required": {} } }, "Value": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A value that is compared with the actual value of the variable based on the behavior of the operator.

", "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^[\\S\\s]+$" } } }, "traits": { "smithy.api#documentation": "

A criteria for when a button should be shown based on values in the notification

" } }, "com.amazonaws.chatbot#CustomActionAttachmentCriteriaList": { "type": "list", "member": { "target": "com.amazonaws.chatbot#CustomActionAttachmentCriteria" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.chatbot#CustomActionAttachmentCriteriaOperator": { "type": "enum", "members": { "HAS_VALUE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HAS_VALUE" } }, "EQUALS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EQUALS" } } } }, "com.amazonaws.chatbot#CustomActionAttachmentList": { "type": "list", "member": { "target": "com.amazonaws.chatbot#CustomActionAttachment" } }, "com.amazonaws.chatbot#CustomActionAttachmentNotificationType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[a-zA-Z0-9-]+$" } }, "com.amazonaws.chatbot#CustomActionAttachmentVariables": { "type": "map", "key": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[A-Za-z0-9-_]+$" } }, "value": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^[\\x21-\\x7F]+$" } }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.chatbot#CustomActionButtonText": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 }, "smithy.api#pattern": "^[\\S\\s]+$" } }, "com.amazonaws.chatbot#CustomActionDefinition": { "type": "structure", "members": { "CommandText": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The command string to run which may include variables by prefixing with a dollar sign ($).

", "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[\\S\\s]+$", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The definition of the command to run when invoked as an alias or as an action button.

" } }, "com.amazonaws.chatbot#CustomActionName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,64}$" } }, "com.amazonaws.chatbot#CustomActionResource": { "type": "resource", "identifiers": { "CustomActionArn": { "target": "com.amazonaws.chatbot#CustomActionArn" } }, "properties": { "ActionName": { "target": "com.amazonaws.chatbot#CustomActionName" }, "Definition": { "target": "com.amazonaws.chatbot#CustomActionDefinition" }, "AliasName": { "target": "com.amazonaws.chatbot#CustomActionAliasName" }, "Attachments": { "target": "com.amazonaws.chatbot#CustomActionAttachmentList" }, "Tags": { "target": "com.amazonaws.chatbot#TagList" } }, "create": { "target": "com.amazonaws.chatbot#CreateCustomAction" }, "read": { "target": "com.amazonaws.chatbot#GetCustomAction" }, "update": { "target": "com.amazonaws.chatbot#UpdateCustomAction" }, "delete": { "target": "com.amazonaws.chatbot#DeleteCustomAction" }, "list": { "target": "com.amazonaws.chatbot#ListCustomActions" }, "traits": { "aws.api#arn": { "template": "{CustomActionArn}", "absolute": true }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "custom-action", "relativeDocumentation": "what-is.html" } } }, "com.amazonaws.chatbot#CustomerCwLogLevel": { "type": "string", "traits": { "smithy.api#length": { "min": 4, "max": 5 }, "smithy.api#pattern": "^(ERROR|INFO|NONE)$" } }, "com.amazonaws.chatbot#DeleteChimeWebhookConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#DeleteChimeWebhookConfigurationRequest" }, "output": { "target": "com.amazonaws.chatbot#DeleteChimeWebhookConfigurationResult" }, "errors": [ { "target": "com.amazonaws.chatbot#DeleteChimeWebhookConfigurationException" }, { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#ResourceNotFoundException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete an AWS Chatbot Chime Webhook Configuration", "resources": { "required": { "ChatbotConfiguration": {} } } }, "smithy.api#documentation": "

Deletes a Amazon Chime webhook configuration for AWS Chatbot.

", "smithy.api#http": { "method": "POST", "uri": "/delete-chime-webhook-configuration", "code": 204 } } }, "com.amazonaws.chatbot#DeleteChimeWebhookConfigurationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#DeleteChimeWebhookConfigurationRequest": { "type": "structure", "members": { "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#DeleteChimeWebhookConfigurationResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#DeleteCustomAction": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#DeleteCustomActionRequest" }, "output": { "target": "com.amazonaws.chatbot#DeleteCustomActionResult" }, "errors": [ { "target": "com.amazonaws.chatbot#InternalServiceError" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#ResourceNotFoundException" }, { "target": "com.amazonaws.chatbot#UnauthorizedException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a custom action" }, "smithy.api#documentation": "

Deletes a custom action.

", "smithy.api#examples": [ { "title": "Delete a custom action", "input": { "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/my-custom-action" }, "output": {} } ], "smithy.api#http": { "code": 204, "method": "POST", "uri": "/delete-custom-action" }, "smithy.api#idempotent": {} } }, "com.amazonaws.chatbot#DeleteCustomActionRequest": { "type": "structure", "members": { "CustomActionArn": { "target": "com.amazonaws.chatbot#CustomActionArn", "traits": { "smithy.api#documentation": "

The fully defined ARN of the custom action.

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CustomActionArn" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#DeleteCustomActionResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#DeleteMicrosoftTeamsChannelConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#DeleteTeamsChannelConfigurationRequest" }, "output": { "target": "com.amazonaws.chatbot#DeleteTeamsChannelConfigurationResult" }, "errors": [ { "target": "com.amazonaws.chatbot#DeleteTeamsChannelConfigurationException" }, { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#ResourceNotFoundException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete an AWS Chatbot Microsoft Teams Channel Configuration", "resources": { "required": { "ChatbotConfiguration": {} } } }, "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": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#DeleteTeamsConfiguredTeamRequest" }, "output": { "target": "com.amazonaws.chatbot#DeleteTeamsConfiguredTeamResult" }, "errors": [ { "target": "com.amazonaws.chatbot#DeleteTeamsConfiguredTeamException" }, { "target": "com.amazonaws.chatbot#InvalidParameterException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete the Microsoft Teams configured with AWS Chatbot in an AWS account" }, "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": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#DeleteMicrosoftTeamsUserIdentityRequest" }, "output": { "target": "com.amazonaws.chatbot#DeleteMicrosoftTeamsUserIdentityResult" }, "errors": [ { "target": "com.amazonaws.chatbot#DeleteMicrosoftTeamsUserIdentityException" }, { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#ResourceNotFoundException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete an AWS Chatbot Microsoft 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", "code": 204 } } }, "com.amazonaws.chatbot#DeleteMicrosoftTeamsUserIdentityException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#DeleteMicrosoftTeamsUserIdentityRequest": { "type": "structure", "members": { "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { "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": "

The Microsoft Teams user ID.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#DeleteMicrosoftTeamsUserIdentityResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#DeleteSlackChannelConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#DeleteSlackChannelConfigurationRequest" }, "output": { "target": "com.amazonaws.chatbot#DeleteSlackChannelConfigurationResult" }, "errors": [ { "target": "com.amazonaws.chatbot#DeleteSlackChannelConfigurationException" }, { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#ResourceNotFoundException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete an AWS Chatbot Slack Channel Configuration", "resources": { "required": { "ChatbotConfiguration": {} } } }, "smithy.api#documentation": "

Deletes a Slack channel configuration for AWS Chatbot

", "smithy.api#http": { "method": "POST", "uri": "/delete-slack-channel-configuration", "code": 204 } } }, "com.amazonaws.chatbot#DeleteSlackChannelConfigurationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#DeleteSlackChannelConfigurationRequest": { "type": "structure", "members": { "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#DeleteSlackChannelConfigurationResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#DeleteSlackUserIdentity": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#DeleteSlackUserIdentityRequest" }, "output": { "target": "com.amazonaws.chatbot#DeleteSlackUserIdentityResult" }, "errors": [ { "target": "com.amazonaws.chatbot#DeleteSlackUserIdentityException" }, { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#ResourceNotFoundException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete an AWS Chatbot 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", "code": 204 } } }, "com.amazonaws.chatbot#DeleteSlackUserIdentityException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#DeleteSlackUserIdentityRequest": { "type": "structure", "members": { "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { "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#required": {} } }, "SlackUserId": { "target": "com.amazonaws.chatbot#SlackUserId", "traits": { "smithy.api#documentation": "

The ID of the user in Slack

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#DeleteSlackUserIdentityResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#DeleteSlackWorkspaceAuthorization": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#DeleteSlackWorkspaceAuthorizationRequest" }, "output": { "target": "com.amazonaws.chatbot#DeleteSlackWorkspaceAuthorizationResult" }, "errors": [ { "target": "com.amazonaws.chatbot#DeleteSlackWorkspaceAuthorizationFault" }, { "target": "com.amazonaws.chatbot#InvalidParameterException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete the Slack workspace authorization with AWS Chatbot, associated with an AWS account" }, "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", "code": 204 } } }, "com.amazonaws.chatbot#DeleteSlackWorkspaceAuthorizationFault": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

There was an issue deleting your Slack workspace.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#DeleteSlackWorkspaceAuthorizationRequest": { "type": "structure", "members": { "SlackTeamId": { "target": "com.amazonaws.chatbot#SlackTeamId", "traits": { "smithy.api#documentation": "

The ID of the Slack workspace authorized with AWS Chatbot.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#DeleteSlackWorkspaceAuthorizationResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#DeleteTeamsChannelConfigurationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#DeleteTeamsChannelConfigurationRequest": { "type": "structure", "members": { "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#DeleteTeamsChannelConfigurationResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#DeleteTeamsConfiguredTeamException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#DeleteTeamsConfiguredTeamRequest": { "type": "structure", "members": { "TeamId": { "target": "com.amazonaws.chatbot#UUID", "traits": { "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#DeleteTeamsConfiguredTeamResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#DescribeChimeWebhookConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#DescribeChimeWebhookConfigurationsRequest" }, "output": { "target": "com.amazonaws.chatbot#DescribeChimeWebhookConfigurationsResult" }, "errors": [ { "target": "com.amazonaws.chatbot#DescribeChimeWebhookConfigurationsException" }, { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list all AWS Chatbot Chime Webhook Configurations in an AWS Account" }, "smithy.api#documentation": "

Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn

", "smithy.api#http": { "method": "POST", "uri": "/describe-chime-webhook-configurations", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "WebhookConfigurations" }, "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#DescribeChimeWebhookConfigurationsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#DescribeChimeWebhookConfigurationsRequest": { "type": "structure", "members": { "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.\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.\n

" } }, "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#DescribeChimeWebhookConfigurationsResult": { "type": "structure", "members": { "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.\n

" } }, "WebhookConfigurations": { "target": "com.amazonaws.chatbot#ChimeWebhookConfigurationList", "traits": { "smithy.api#documentation": "

A list of Amazon Chime webhooks associated with the account.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#DescribeSlackChannelConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#DescribeSlackChannelConfigurationsRequest" }, "output": { "target": "com.amazonaws.chatbot#DescribeSlackChannelConfigurationsResult" }, "errors": [ { "target": "com.amazonaws.chatbot#DescribeSlackChannelConfigurationsException" }, { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list all AWS Chatbot Slack Channel Configurations in an AWS account" }, "smithy.api#documentation": "

Lists Slack channel configurations optionally filtered by ChatConfigurationArn

", "smithy.api#http": { "method": "POST", "uri": "/describe-slack-channel-configurations", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "SlackChannelConfigurations" }, "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#DescribeSlackChannelConfigurationsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#DescribeSlackChannelConfigurationsRequest": { "type": "structure", "members": { "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.\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.\n

" } }, "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#DescribeSlackChannelConfigurationsResult": { "type": "structure", "members": { "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.\n

" } }, "SlackChannelConfigurations": { "target": "com.amazonaws.chatbot#SlackChannelConfigurationList", "traits": { "smithy.api#documentation": "

A list of Slack channel configurations.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#DescribeSlackUserIdentities": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#DescribeSlackUserIdentitiesRequest" }, "output": { "target": "com.amazonaws.chatbot#DescribeSlackUserIdentitiesResult" }, "errors": [ { "target": "com.amazonaws.chatbot#DescribeSlackUserIdentitiesException" }, { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to describe AWS Chatbot Slack User Identities" }, "smithy.api#documentation": "

Lists all Slack user identities with a mapped role.

", "smithy.api#http": { "method": "POST", "uri": "/describe-slack-user-identities", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "SlackUserIdentities" }, "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#DescribeSlackUserIdentitiesException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#DescribeSlackUserIdentitiesRequest": { "type": "structure", "members": { "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (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.\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.\n

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#DescribeSlackUserIdentitiesResult": { "type": "structure", "members": { "SlackUserIdentities": { "target": "com.amazonaws.chatbot#SlackUserIdentitiesList", "traits": { "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.\n

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#DescribeSlackWorkspaces": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#DescribeSlackWorkspacesRequest" }, "output": { "target": "com.amazonaws.chatbot#DescribeSlackWorkspacesResult" }, "errors": [ { "target": "com.amazonaws.chatbot#DescribeSlackWorkspacesException" }, { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot service" }, "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", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "SlackWorkspaces" }, "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#DescribeSlackWorkspacesException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#DescribeSlackWorkspacesRequest": { "type": "structure", "members": { "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.\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.\n

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#DescribeSlackWorkspacesResult": { "type": "structure", "members": { "SlackWorkspaces": { "target": "com.amazonaws.chatbot#SlackWorkspacesList", "traits": { "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.\n

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#DisassociateFromConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#DisassociateFromConfigurationRequest" }, "output": { "target": "com.amazonaws.chatbot#DisassociateFromConfigurationResult" }, "errors": [ { "target": "com.amazonaws.chatbot#InternalServiceError" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#UnauthorizedException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to disassociate a resource from a configuration", "resources": { "required": { "ChatbotConfiguration": {}, "custom-action": {} } } }, "smithy.api#documentation": "

Unlink a resource, for example a custom action, from a channel configuration.

", "smithy.api#examples": [ { "title": "Disassociate a custom action from a configuration", "input": { "Resource": "arn:aws:chatbot::1234567890:custom-action/my-custom-action", "ChatConfiguration": "arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-channel" }, "output": {} } ], "smithy.api#http": { "code": 204, "method": "POST", "uri": "/disassociate-from-configuration" }, "smithy.api#idempotent": {} } }, "com.amazonaws.chatbot#DisassociateFromConfigurationRequest": { "type": "structure", "members": { "Resource": { "target": "com.amazonaws.chatbot#ResourceIdentifier", "traits": { "smithy.api#documentation": "

The resource (for example, a custom action) Amazon Resource Name (ARN) to unlink.

", "smithy.api#required": {} } }, "ChatConfiguration": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { "smithy.api#documentation": "

The channel configuration the resource is being disassociated from.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#DisassociateFromConfigurationResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#ErrorMessage": { "type": "string" }, "com.amazonaws.chatbot#GetAccountPreferences": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#GetAccountPreferencesRequest" }, "output": { "target": "com.amazonaws.chatbot#GetAccountPreferencesResult" }, "errors": [ { "target": "com.amazonaws.chatbot#GetAccountPreferencesException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve AWS Chatbot account 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": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#GetAccountPreferencesRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#GetAccountPreferencesResult": { "type": "structure", "members": { "AccountPreferences": { "target": "com.amazonaws.chatbot#AccountPreferences", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#GetCustomAction": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#GetCustomActionRequest" }, "output": { "target": "com.amazonaws.chatbot#GetCustomActionResult" }, "errors": [ { "target": "com.amazonaws.chatbot#InternalServiceError" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#ResourceNotFoundException" }, { "target": "com.amazonaws.chatbot#UnauthorizedException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get a custom action" }, "smithy.api#documentation": "

Returns a custom action.

", "smithy.api#examples": [ { "title": "Get a custom action", "input": { "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/my-custom-action" }, "output": { "CustomAction": { "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/my-custom-action", "ActionName": "my-custom-action", "Definition": { "CommandText": "lambda invoke $functionName" } } } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/get-custom-action" }, "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#GetCustomActionRequest": { "type": "structure", "members": { "CustomActionArn": { "target": "com.amazonaws.chatbot#CustomActionArn", "traits": { "smithy.api#documentation": "

Returns the fully defined Amazon Resource Name (ARN) of the custom action.

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CustomActionArn" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#GetCustomActionResult": { "type": "structure", "members": { "CustomAction": { "target": "com.amazonaws.chatbot#CustomAction", "traits": { "smithy.api#documentation": "

Returns the custom action.

", "smithy.api#nestedProperties": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#GetMicrosoftTeamsChannelConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#GetTeamsChannelConfigurationRequest" }, "output": { "target": "com.amazonaws.chatbot#GetTeamsChannelConfigurationResult" }, "errors": [ { "target": "com.amazonaws.chatbot#GetTeamsChannelConfigurationException" }, { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get a single AWS Chatbot Microsoft Teams Channel Configurations in an AWS account" }, "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": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#GetTeamsChannelConfigurationRequest": { "type": "structure", "members": { "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#GetTeamsChannelConfigurationResult": { "type": "structure", "members": { "ChannelConfiguration": { "target": "com.amazonaws.chatbot#TeamsChannelConfiguration", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#GuardrailPolicyArn": { "type": "string", "traits": { "smithy.api#length": { "min": 11, "max": 1163 }, "smithy.api#pattern": "^(^$|(?!.*\\/aws-service-role\\/.*)arn:aws:iam:[A-Za-z0-9_\\/.-]{0,63}:[A-Za-z0-9_\\/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_\\/+=,@.-]{0,1023})$" } }, "com.amazonaws.chatbot#GuardrailPolicyArnList": { "type": "list", "member": { "target": "com.amazonaws.chatbot#GuardrailPolicyArn" } }, "com.amazonaws.chatbot#InternalServiceError": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

Unexpected error during processing of request.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#InvalidParameterException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.chatbot#InvalidRequestException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.chatbot#LimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

You have exceeded a service limit for AWS Chatbot.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.chatbot#ListAssociations": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#ListAssociationsRequest" }, "output": { "target": "com.amazonaws.chatbot#ListAssociationsResult" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list resources associated with a configuration", "resources": { "required": { "ChatbotConfiguration": {} } } }, "smithy.api#documentation": "

Lists resources associated with a channel configuration.

", "smithy.api#examples": [ { "title": "List custom actions associated with a configuration", "input": { "ChatConfiguration": "arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-channel" }, "output": { "Associations": [ { "Resource": "arn:aws:chatbot::1234567890:custom-action/my-custom-action" } ] } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/list-associations" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "Associations" }, "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#ListAssociationsRequest": { "type": "structure", "members": { "ChatConfiguration": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { "smithy.api#documentation": "

The channel configuration to list associations for.

", "smithy.api#required": {} } }, "MaxResults": { "target": "smithy.api#Integer", "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#range": { "min": 1, "max": 100 } } }, "NextToken": { "target": "com.amazonaws.chatbot#String", "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#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^[\\x20-\\x7F]+$" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#ListAssociationsResult": { "type": "structure", "members": { "Associations": { "target": "com.amazonaws.chatbot#AssociationList", "traits": { "smithy.api#documentation": "

The resources associated with this channel configuration.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.chatbot#String", "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#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^[\\x20-\\x7F]+$" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#ListCustomActions": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#ListCustomActionsRequest" }, "output": { "target": "com.amazonaws.chatbot#ListCustomActionsResult" }, "errors": [ { "target": "com.amazonaws.chatbot#InternalServiceError" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#UnauthorizedException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list custom actions" }, "smithy.api#documentation": "

Lists custom actions defined in this account.

", "smithy.api#examples": [ { "title": "List custom actions", "input": {}, "output": { "CustomActions": [ "arn:aws:chatbot::1234567890:custom-action/my-custom-action" ] } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/list-custom-actions" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "CustomActions" }, "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#ListCustomActionsRequest": { "type": "structure", "members": { "MaxResults": { "target": "smithy.api#Integer", "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#range": { "min": 1, "max": 100 } } }, "NextToken": { "target": "smithy.api#String", "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#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^[\\x20-\\x7F]+$" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#ListCustomActionsResult": { "type": "structure", "members": { "CustomActions": { "target": "com.amazonaws.chatbot#CustomActionArnList", "traits": { "smithy.api#documentation": "

A list of custom actions.

", "smithy.api#required": {} } }, "NextToken": { "target": "smithy.api#String", "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#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^[\\x20-\\x7F]+$" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#ListMicrosoftTeamsChannelConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#ListTeamsChannelConfigurationsRequest" }, "output": { "target": "com.amazonaws.chatbot#ListTeamsChannelConfigurationsResult" }, "errors": [ { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#ListTeamsChannelConfigurationsException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list all AWS Chatbot Microsoft Teams Channel Configurations in an AWS account" }, "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", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "TeamChannelConfigurations" }, "smithy.api#readonly": {}, "smithy.api#suppress": [ "OperationInputOutputName.input", "OperationInputOutputName.output" ] } }, "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeams": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeamsRequest" }, "output": { "target": "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeamsResult" }, "errors": [ { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeamsException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list all Microsoft Teams connected to the AWS Account onboarded with AWS Chatbot service" }, "smithy.api#documentation": "

Lists all authorized Microsoft Teams for an AWS Account

", "smithy.api#http": { "method": "POST", "uri": "/list-ms-teams-configured-teams", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "ConfiguredTeams" }, "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeamsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeamsRequest": { "type": "structure", "members": { "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.

" } }, "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.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeamsResult": { "type": "structure", "members": { "ConfiguredTeams": { "target": "com.amazonaws.chatbot#ConfiguredTeamsList", "traits": { "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.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#ListMicrosoftTeamsUserIdentities": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#ListMicrosoftTeamsUserIdentitiesRequest" }, "output": { "target": "com.amazonaws.chatbot#ListMicrosoftTeamsUserIdentitiesResult" }, "errors": [ { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#ListMicrosoftTeamsUserIdentitiesException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to describe AWS Chatbot Microsoft Teams User Identities" }, "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", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "TeamsUserIdentities" }, "smithy.api#readonly": {} } }, "com.amazonaws.chatbot#ListMicrosoftTeamsUserIdentitiesException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#ListMicrosoftTeamsUserIdentitiesRequest": { "type": "structure", "members": { "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (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.\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.\n

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#ListMicrosoftTeamsUserIdentitiesResult": { "type": "structure", "members": { "TeamsUserIdentities": { "target": "com.amazonaws.chatbot#TeamsUserIdentitiesList", "traits": { "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.\n

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.chatbot#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.chatbot#InternalServiceError" }, { "target": "com.amazonaws.chatbot#ResourceNotFoundException" }, { "target": "com.amazonaws.chatbot#ServiceUnavailableException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to List all tags associated with the AWS Chatbot Channel 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": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.chatbot#AmazonResourceName", "traits": { "smithy.api#documentation": "

The ARN of the resource to list tags for.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.chatbot#TagList", "traits": { "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.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#ListTeamsChannelConfigurationsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#ListTeamsChannelConfigurationsRequest": { "type": "structure", "members": { "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.

" } }, "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.

" } }, "TeamId": { "target": "com.amazonaws.chatbot#UUID", "traits": { "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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#ListTeamsChannelConfigurationsResult": { "type": "structure", "members": { "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.

" } }, "TeamChannelConfigurations": { "target": "com.amazonaws.chatbot#TeamChannelConfigurationsList", "traits": { "smithy.api#documentation": "

A list of AWS Chatbot channel configurations for Microsoft Teams.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.chatbot#PaginationToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1276 }, "smithy.api#pattern": "^[a-zA-Z0-9=\\/+_.\\-,#:\\\\\"{}]{4,1276}$" } }, "com.amazonaws.chatbot#ResourceIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1011 }, "smithy.api#pattern": "^arn:aws:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:custom-action/[a-zA-Z0-9_-]{1,64}$" } }, "com.amazonaws.chatbot#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

We were unable to find the resource for your request

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.chatbot#ResourceState": { "type": "string", "traits": { "smithy.api#pattern": "^(ENABLED|DISABLED)$" } }, "com.amazonaws.chatbot#ServiceUnavailableException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.chatbot#SlackChannelConfiguration": { "type": "structure", "members": { "SlackTeamName": { "target": "com.amazonaws.chatbot#SlackTeamName", "traits": { "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 Amazon Chime.

", "smithy.api#required": {} } }, "SlackChannelId": { "target": "com.amazonaws.chatbot#SlackChannelId", "traits": { "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#required": {} } }, "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SlackChannelConfiguration.

", "smithy.api#required": {} } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { "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#required": {} } }, "ConfigurationName": { "target": "com.amazonaws.chatbot#ConfigurationName", "traits": { "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.

" } }, "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.\n

" } }, "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { "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 map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" } }, "State": { "target": "com.amazonaws.chatbot#ResourceState", "traits": { "smithy.api#documentation": "

Either ENABLED or DISABLED. The resource returns DISABLED if the organization's AWS Chatbot policy has explicitly denied that configuration.\n\t For example, if Amazon Chime is disabled.

" } }, "StateReason": { "target": "com.amazonaws.chatbot#String", "traits": { "smithy.api#documentation": "

Provided if State is DISABLED. Provides context as to why the resource is disabled.

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

An AWS Chatbot configuration for Slack.

" } }, "com.amazonaws.chatbot#SlackChannelConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.chatbot#SlackChannelConfiguration" } }, "com.amazonaws.chatbot#SlackChannelDisplayName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#sensitive": {} } }, "com.amazonaws.chatbot#SlackChannelId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[A-Za-z0-9]+$" } }, "com.amazonaws.chatbot#SlackTeamId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[0-9A-Z]{1,255}$" } }, "com.amazonaws.chatbot#SlackTeamName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.chatbot#SlackUserId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(.*)$" } }, "com.amazonaws.chatbot#SlackUserIdentitiesList": { "type": "list", "member": { "target": "com.amazonaws.chatbot#SlackUserIdentity" } }, "com.amazonaws.chatbot#SlackUserIdentity": { "type": "structure", "members": { "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { "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 Amazon Resource Name (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#required": {} } }, "SlackUserId": { "target": "com.amazonaws.chatbot#SlackUserId", "traits": { "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 ID with an IAM Role.

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

Identifes a user level permission for a channel configuration.

" } }, "com.amazonaws.chatbot#SlackWorkspace": { "type": "structure", "members": { "SlackTeamId": { "target": "com.amazonaws.chatbot#SlackTeamId", "traits": { "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": "

The name of the Slack workspace.

", "smithy.api#required": {} } }, "State": { "target": "com.amazonaws.chatbot#ResourceState", "traits": { "smithy.api#documentation": "

Either ENABLED or DISABLED. The resource returns DISABLED if the organization's AWS Chatbot policy has explicitly denied that configuration.\n\t For example, if Amazon Chime is disabled.

" } }, "StateReason": { "target": "com.amazonaws.chatbot#String", "traits": { "smithy.api#documentation": "

Provided if State is DISABLED. Provides context as to why the resource is disabled.

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

A Slack workspace.

" } }, "com.amazonaws.chatbot#SlackWorkspacesList": { "type": "list", "member": { "target": "com.amazonaws.chatbot#SlackWorkspace" } }, "com.amazonaws.chatbot#SnsTopicArnList": { "type": "list", "member": { "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 key of the tag.

", "smithy.api#required": {} } }, "TagValue": { "target": "com.amazonaws.chatbot#TagValue", "traits": { "smithy.api#documentation": "

The value of the tag.

", "smithy.api#required": {} } } }, "traits": { "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": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.chatbot#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.chatbot#TagKey" }, "traits": { "aws.api#data": "tagging", "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.chatbot#TagList": { "type": "list", "member": { "target": "com.amazonaws.chatbot#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.chatbot#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#TagResourceRequest" }, "output": { "target": "com.amazonaws.chatbot#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.chatbot#InternalServiceError" }, { "target": "com.amazonaws.chatbot#ResourceNotFoundException" }, { "target": "com.amazonaws.chatbot#ServiceUnavailableException" }, { "target": "com.amazonaws.chatbot#TooManyTagsException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create tags on AWS Chatbot Channel 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", "code": 200 } } }, "com.amazonaws.chatbot#TagResourceRequest": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.chatbot#AmazonResourceName", "traits": { "smithy.api#documentation": "

The ARN of the configuration.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.chatbot#TagList", "traits": { "aws.api#data": "tagging", "smithy.api#documentation": "

A list of tags to apply to the configuration.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.chatbot#Tags": { "type": "list", "member": { "target": "com.amazonaws.chatbot#Tag" } }, "com.amazonaws.chatbot#TeamChannelConfigurationsList": { "type": "list", "member": { "target": "com.amazonaws.chatbot#TeamsChannelConfiguration" } }, "com.amazonaws.chatbot#TeamName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(.*)$", "smithy.api#sensitive": {} } }, "com.amazonaws.chatbot#TeamsChannelConfiguration": { "type": "structure", "members": { "ChannelId": { "target": "com.amazonaws.chatbot#TeamsChannelId", "traits": { "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.

" } }, "TeamId": { "target": "com.amazonaws.chatbot#UUID", "traits": { "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.

" } }, "TenantId": { "target": "com.amazonaws.chatbot#UUID", "traits": { "smithy.api#documentation": "

The ID of the Microsoft Teams tenant.

", "smithy.api#required": {} } }, "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { "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": "

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 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.

" } }, "LoggingLevel": { "target": "com.amazonaws.chatbot#CustomerCwLogLevel", "traits": { "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.\n

" } }, "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { "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 map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" } }, "State": { "target": "com.amazonaws.chatbot#ResourceState", "traits": { "smithy.api#documentation": "

Either ENABLED or DISABLED. The resource returns DISABLED if the organization's AWS Chatbot policy has explicitly denied that configuration.\n\t For example, if Amazon Chime is disabled.

" } }, "StateReason": { "target": "com.amazonaws.chatbot#String", "traits": { "smithy.api#documentation": "

Provided if State is DISABLED. Provides context as to why the resource is disabled.

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

An AWS Chatbot configuration for Microsoft Teams.

" } }, "com.amazonaws.chatbot#TeamsChannelId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^([a-zA-Z0-9-_=+\\/.,])*%3[aA]([a-zA-Z0-9-_=+\\/.,])*%40([a-zA-Z0-9-_=+\\/.,])*$" } }, "com.amazonaws.chatbot#TeamsChannelName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 }, "smithy.api#pattern": "^(.*)$", "smithy.api#sensitive": {} } }, "com.amazonaws.chatbot#TeamsUserIdentitiesList": { "type": "list", "member": { "target": "com.amazonaws.chatbot#TeamsUserIdentity" } }, "com.amazonaws.chatbot#TeamsUserIdentity": { "type": "structure", "members": { "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { "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 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 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": "

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.

" } }, "TeamsChannelId": { "target": "com.amazonaws.chatbot#TeamsChannelId", "traits": { "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.

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

Identifes a user level permission for a channel configuration.

" } }, "com.amazonaws.chatbot#TooManyTagsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The supplied list of tags contains too many tags.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.chatbot#UUID": { "type": "string", "traits": { "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$" } }, "com.amazonaws.chatbot#UnauthorizedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The request was rejected because it doesn't have valid credentials for the target resource.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.chatbot#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#UntagResourceRequest" }, "output": { "target": "com.amazonaws.chatbot#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.chatbot#InternalServiceError" }, { "target": "com.amazonaws.chatbot#ResourceNotFoundException" }, { "target": "com.amazonaws.chatbot#ServiceUnavailableException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to remove tags on AWS Chatbot Channel 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", "code": 200 } } }, "com.amazonaws.chatbot#UntagResourceRequest": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.chatbot#AmazonResourceName", "traits": { "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": { "aws.api#data": "tagging", "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#UpdateAccountPreferences": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#UpdateAccountPreferencesRequest" }, "output": { "target": "com.amazonaws.chatbot#UpdateAccountPreferencesResult" }, "errors": [ { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#UpdateAccountPreferencesException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update AWS Chatbot account preferences" }, "smithy.api#documentation": "

Updates AWS Chatbot account preferences.

", "smithy.api#http": { "method": "POST", "uri": "/update-account-preferences", "code": 200 } } }, "com.amazonaws.chatbot#UpdateAccountPreferencesException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#UpdateAccountPreferencesRequest": { "type": "structure", "members": { "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { "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.

\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#input": {} } }, "com.amazonaws.chatbot#UpdateAccountPreferencesResult": { "type": "structure", "members": { "AccountPreferences": { "target": "com.amazonaws.chatbot#AccountPreferences", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#UpdateChimeWebhookConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#UpdateChimeWebhookConfigurationRequest" }, "output": { "target": "com.amazonaws.chatbot#UpdateChimeWebhookConfigurationResult" }, "errors": [ { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#ResourceNotFoundException" }, { "target": "com.amazonaws.chatbot#UpdateChimeWebhookConfigurationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update an AWS Chatbot Chime Webhook Configuration", "resources": { "required": { "ChatbotConfiguration": {} } } }, "smithy.api#documentation": "

Updates a Amazon Chime webhook configuration.

", "smithy.api#http": { "method": "POST", "uri": "/update-chime-webhook-configuration", "code": 200 } } }, "com.amazonaws.chatbot#UpdateChimeWebhookConfigurationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#UpdateChimeWebhookConfigurationRequest": { "type": "structure", "members": { "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "WebhookDescription": { "target": "com.amazonaws.chatbot#ChimeWebhookDescription", "traits": { "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": "

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.

" } }, "IamRoleArn": { "target": "com.amazonaws.chatbot#Arn", "traits": { "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.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#UpdateChimeWebhookConfigurationResult": { "type": "structure", "members": { "WebhookConfiguration": { "target": "com.amazonaws.chatbot#ChimeWebhookConfiguration", "traits": { "smithy.api#documentation": "

A Amazon Chime webhook configuration.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#UpdateCustomAction": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#UpdateCustomActionRequest" }, "output": { "target": "com.amazonaws.chatbot#UpdateCustomActionResult" }, "errors": [ { "target": "com.amazonaws.chatbot#InternalServiceError" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#ResourceNotFoundException" }, { "target": "com.amazonaws.chatbot#UnauthorizedException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update a custom action" }, "smithy.api#documentation": "

Updates a custom action.

", "smithy.api#examples": [ { "title": "Update the command definition of an existing action", "documentation": "Updates the command text of a custom action without altering the existing alias name or attachment criteria", "input": { "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/my-custom-action", "Definition": { "CommandText": "lambda invoke MyNewFunction" } }, "output": { "CustomActionArn": "arn:aws:chatbot::1234567890:custom-action/my-custom-action" } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/update-custom-action" } } }, "com.amazonaws.chatbot#UpdateCustomActionRequest": { "type": "structure", "members": { "CustomActionArn": { "target": "com.amazonaws.chatbot#CustomActionArn", "traits": { "smithy.api#documentation": "

The fully defined Amazon Resource Name (ARN) of the custom action.

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CustomActionArn" } }, "Definition": { "target": "com.amazonaws.chatbot#CustomActionDefinition", "traits": { "smithy.api#documentation": "

The definition of the command to run when invoked as an alias or as an action button.

", "smithy.api#required": {} } }, "AliasName": { "target": "com.amazonaws.chatbot#CustomActionAliasName", "traits": { "smithy.api#documentation": "

The name used to invoke this action in the chat channel. For example, @aws run my-alias.

" } }, "Attachments": { "target": "com.amazonaws.chatbot#CustomActionAttachmentList", "traits": { "smithy.api#documentation": "

Defines when this custom action button should be attached to a notification.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#UpdateCustomActionResult": { "type": "structure", "members": { "CustomActionArn": { "target": "com.amazonaws.chatbot#CustomActionArn", "traits": { "smithy.api#documentation": "

The fully defined ARN of the custom action.

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CustomActionArn" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#UpdateMicrosoftTeamsChannelConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#UpdateTeamsChannelConfigurationRequest" }, "output": { "target": "com.amazonaws.chatbot#UpdateTeamsChannelConfigurationResult" }, "errors": [ { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#ResourceNotFoundException" }, { "target": "com.amazonaws.chatbot#UpdateTeamsChannelConfigurationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update an AWS Chatbot Microsoft Teams Channel Configuration", "resources": { "required": { "ChatbotConfiguration": {} } } }, "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": { "type": "operation", "input": { "target": "com.amazonaws.chatbot#UpdateSlackChannelConfigurationRequest" }, "output": { "target": "com.amazonaws.chatbot#UpdateSlackChannelConfigurationResult" }, "errors": [ { "target": "com.amazonaws.chatbot#InvalidParameterException" }, { "target": "com.amazonaws.chatbot#InvalidRequestException" }, { "target": "com.amazonaws.chatbot#ResourceNotFoundException" }, { "target": "com.amazonaws.chatbot#UpdateSlackChannelConfigurationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update an AWS Chatbot Slack Channel Configuration", "resources": { "required": { "ChatbotConfiguration": {} } } }, "smithy.api#documentation": "

Updates a Slack channel configuration.

", "smithy.api#http": { "method": "POST", "uri": "/update-slack-channel-configuration", "code": 200 } } }, "com.amazonaws.chatbot#UpdateSlackChannelConfigurationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#UpdateSlackChannelConfigurationRequest": { "type": "structure", "members": { "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (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.

\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.

" } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { "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": "

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.

" } }, "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.\n

" } }, "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#UpdateSlackChannelConfigurationResult": { "type": "structure", "members": { "ChannelConfiguration": { "target": "com.amazonaws.chatbot#SlackChannelConfiguration", "traits": { "smithy.api#documentation": "

The configuration for a Slack channel configured with AWS Chatbot.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#UpdateTeamsChannelConfigurationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.chatbot#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.chatbot#UpdateTeamsChannelConfigurationRequest": { "type": "structure", "members": { "ChatConfigurationArn": { "target": "com.amazonaws.chatbot#ChatConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (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#required": {} } }, "ChannelName": { "target": "com.amazonaws.chatbot#TeamsChannelName", "traits": { "smithy.api#documentation": "

The name of the Microsoft Teams channel.

" } }, "SnsTopicArns": { "target": "com.amazonaws.chatbot#SnsTopicArnList", "traits": { "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": "

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.

" } }, "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.\n

" } }, "UserAuthorizationRequired": { "target": "com.amazonaws.chatbot#BooleanAccountPreference", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.chatbot#UpdateTeamsChannelConfigurationResult": { "type": "structure", "members": { "ChannelConfiguration": { "target": "com.amazonaws.chatbot#TeamsChannelConfiguration", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.chatbot#WheatleyOrchestration_20171011": { "type": "service", "version": "2017-10-11", "operations": [ { "target": "com.amazonaws.chatbot#AssociateToConfiguration" }, { "target": "com.amazonaws.chatbot#CreateChimeWebhookConfiguration" }, { "target": "com.amazonaws.chatbot#CreateMicrosoftTeamsChannelConfiguration" }, { "target": "com.amazonaws.chatbot#CreateSlackChannelConfiguration" }, { "target": "com.amazonaws.chatbot#DeleteChimeWebhookConfiguration" }, { "target": "com.amazonaws.chatbot#DeleteMicrosoftTeamsChannelConfiguration" }, { "target": "com.amazonaws.chatbot#DeleteMicrosoftTeamsConfiguredTeam" }, { "target": "com.amazonaws.chatbot#DeleteMicrosoftTeamsUserIdentity" }, { "target": "com.amazonaws.chatbot#DeleteSlackChannelConfiguration" }, { "target": "com.amazonaws.chatbot#DeleteSlackUserIdentity" }, { "target": "com.amazonaws.chatbot#DeleteSlackWorkspaceAuthorization" }, { "target": "com.amazonaws.chatbot#DescribeChimeWebhookConfigurations" }, { "target": "com.amazonaws.chatbot#DescribeSlackChannelConfigurations" }, { "target": "com.amazonaws.chatbot#DescribeSlackUserIdentities" }, { "target": "com.amazonaws.chatbot#DescribeSlackWorkspaces" }, { "target": "com.amazonaws.chatbot#DisassociateFromConfiguration" }, { "target": "com.amazonaws.chatbot#GetAccountPreferences" }, { "target": "com.amazonaws.chatbot#GetMicrosoftTeamsChannelConfiguration" }, { "target": "com.amazonaws.chatbot#ListAssociations" }, { "target": "com.amazonaws.chatbot#ListMicrosoftTeamsChannelConfigurations" }, { "target": "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeams" }, { "target": "com.amazonaws.chatbot#ListMicrosoftTeamsUserIdentities" }, { "target": "com.amazonaws.chatbot#ListTagsForResource" }, { "target": "com.amazonaws.chatbot#TagResource" }, { "target": "com.amazonaws.chatbot#UntagResource" }, { "target": "com.amazonaws.chatbot#UpdateAccountPreferences" }, { "target": "com.amazonaws.chatbot#UpdateChimeWebhookConfiguration" }, { "target": "com.amazonaws.chatbot#UpdateMicrosoftTeamsChannelConfiguration" }, { "target": "com.amazonaws.chatbot#UpdateSlackChannelConfiguration" } ], "resources": [ { "target": "com.amazonaws.chatbot#CustomActionResource" } ], "traits": { "aws.api#service": { "sdkId": "chatbot", "arnNamespace": "chatbot", "cloudFormationName": "Chatbot", "cloudTrailEventSource": "chatbot.amazonaws.com", "endpointPrefix": "chatbot" }, "aws.auth#sigv4": { "name": "chatbot" }, "aws.iam#supportedPrincipalTypes": [ "Root", "IAMUser", "IAMRole", "FederatedUser" ], "aws.protocols#restJson1": {}, "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/" }, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://chatbot-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://chatbot-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://chatbot.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://chatbot.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://chatbot-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://chatbot-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://chatbot.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://chatbot.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://chatbot-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chatbot-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://chatbot.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chatbot.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://chatbot-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chatbot-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://chatbot.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chatbot.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://chatbot-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chatbot-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://chatbot.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chatbot.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chatbot-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chatbot.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chatbot-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://chatbot.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } } } }