AWS SDK for PHP 3.x

Service ID: chatbot

Version: 2017-10-11

This page describes the parameters and results for the operations of the AWS Chatbot (2017-10-11), and shows how to use the Aws\Chatbot\ChatbotClient object to call the described operations. This documentation is specific to the 2017-10-11 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateChimeWebhookConfiguration ( array $params = [] ): Creates an AWS Chatbot configuration for Amazon Chime.
CreateMicrosoftTeamsChannelConfiguration ( array $params = [] ): Creates an AWS Chatbot configuration for Microsoft Teams.
CreateSlackChannelConfiguration ( array $params = [] ): Creates an AWS Chatbot confugration for Slack.
DeleteChimeWebhookConfiguration ( array $params = [] ): Deletes a Amazon Chime webhook configuration for AWS Chatbot.
DeleteMicrosoftTeamsChannelConfiguration ( array $params = [] ): Deletes a Microsoft Teams channel configuration for AWS Chatbot
DeleteMicrosoftTeamsConfiguredTeam ( array $params = [] ): Deletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team.
DeleteMicrosoftTeamsUserIdentity ( array $params = [] ): Identifes a user level permission for a channel configuration.
DeleteSlackChannelConfiguration ( array $params = [] ): Deletes a Slack channel configuration for AWS Chatbot
DeleteSlackUserIdentity ( array $params = [] ): Deletes a user level permission for a Slack channel configuration.
DeleteSlackWorkspaceAuthorization ( array $params = [] ): Deletes the Slack workspace authorization that allows channels to be configured in that workspace.
DescribeChimeWebhookConfigurations ( array $params = [] ): Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn
DescribeSlackChannelConfigurations ( array $params = [] ): Lists Slack channel configurations optionally filtered by ChatConfigurationArn
DescribeSlackUserIdentities ( array $params = [] ): Lists all Slack user identities with a mapped role.
DescribeSlackWorkspaces ( array $params = [] ): List all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot.
GetAccountPreferences ( array $params = [] ): Returns AWS Chatbot account preferences.
GetMicrosoftTeamsChannelConfiguration ( array $params = [] ): Returns a Microsoft Teams channel configuration in an AWS account.
ListMicrosoftTeamsChannelConfigurations ( array $params = [] ): Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS account.
ListMicrosoftTeamsConfiguredTeams ( array $params = [] ): Lists all authorized Microsoft Teams for an AWS Account
ListMicrosoftTeamsUserIdentities ( array $params = [] ): A list all Microsoft Teams user identities with a mapped role.
ListTagsForResource ( array $params = [] ): Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
TagResource ( array $params = [] ): Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
UntagResource ( array $params = [] ): Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
UpdateAccountPreferences ( array $params = [] ): Updates AWS Chatbot account preferences.
UpdateChimeWebhookConfiguration ( array $params = [] ): Updates a Amazon Chime webhook configuration.
UpdateMicrosoftTeamsChannelConfiguration ( array $params = [] ): Updates an Microsoft Teams channel configuration.
UpdateSlackChannelConfiguration ( array $params = [] ): Updates a Slack channel configuration.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeChimeWebhookConfigurations
DescribeSlackChannelConfigurations
DescribeSlackUserIdentities
DescribeSlackWorkspaces
ListMicrosoftTeamsChannelConfigurations
ListMicrosoftTeamsConfiguredTeams
ListMicrosoftTeamsUserIdentities

Operations

CreateChimeWebhookConfiguration

$result = $client->createChimeWebhookConfiguration([/* ... */]);
$promise = $client->createChimeWebhookConfigurationAsync([/* ... */]);

Creates an AWS Chatbot configuration for Amazon Chime.

Parameter Syntax

$result = $client->createChimeWebhookConfiguration([
    'ConfigurationName' => '<string>', // REQUIRED
    'IamRoleArn' => '<string>', // REQUIRED
    'LoggingLevel' => '<string>',
    'SnsTopicArns' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'TagKey' => '<string>', // REQUIRED
            'TagValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'WebhookDescription' => '<string>', // REQUIRED
    'WebhookUrl' => '<string>', // REQUIRED
]);

Parameter Details

Members

ConfigurationName

: Required: Yes
: Type: string

The name of the configuration.

IamRoleArn

: Required: Yes
: Type: string

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

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

LoggingLevel

: Type: string

Logging levels include ERROR, INFO, or NONE.

SnsTopicArns

: Required: Yes
: Type: Array of strings

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

Tags

: Type: Array of Tag structures

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

WebhookDescription

: Required: Yes
: Type: string

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

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

WebhookUrl

: Required: Yes
: Type: string

The URL for the Amazon Chime webhook.

Result Syntax

[
    'WebhookConfiguration' => [
        'ChatConfigurationArn' => '<string>',
        'ConfigurationName' => '<string>',
        'IamRoleArn' => '<string>',
        'LoggingLevel' => '<string>',
        'SnsTopicArns' => ['<string>', ...],
        'State' => '<string>',
        'StateReason' => '<string>',
        'Tags' => [
            [
                'TagKey' => '<string>',
                'TagValue' => '<string>',
            ],
            // ...
        ],
        'WebhookDescription' => '<string>',
    ],
]

Result Details

Members

WebhookConfiguration

: Type: ChimeWebhookConfiguration structure

An Amazon Chime webhook configuration.

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.
ConflictException:: There was an issue processing your request.
LimitExceededException:: You have exceeded a service limit for AWS Chatbot.
CreateChimeWebhookConfigurationException:: We can’t process your request right now because of a server issue. Try again later.

CreateMicrosoftTeamsChannelConfiguration

$result = $client->createMicrosoftTeamsChannelConfiguration([/* ... */]);
$promise = $client->createMicrosoftTeamsChannelConfigurationAsync([/* ... */]);

Creates an AWS Chatbot configuration for Microsoft Teams.

Parameter Syntax

$result = $client->createMicrosoftTeamsChannelConfiguration([
    'ChannelId' => '<string>', // REQUIRED
    'ChannelName' => '<string>',
    'ConfigurationName' => '<string>', // REQUIRED
    'GuardrailPolicyArns' => ['<string>', ...],
    'IamRoleArn' => '<string>', // REQUIRED
    'LoggingLevel' => '<string>',
    'SnsTopicArns' => ['<string>', ...],
    'Tags' => [
        [
            'TagKey' => '<string>', // REQUIRED
            'TagValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TeamId' => '<string>', // REQUIRED
    'TeamName' => '<string>',
    'TenantId' => '<string>', // REQUIRED
    'UserAuthorizationRequired' => true || false,
]);

Parameter Details

Members

ChannelId

: Required: Yes
: Type: string

The ID of the Microsoft Teams channel.

ChannelName

: Type: string

The name of the Microsoft Teams channel.

ConfigurationName

: Required: Yes
: Type: string

The name of the configuration.

GuardrailPolicyArns

: Type: Array of strings

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.

IamRoleArn

: Required: Yes
: Type: string

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

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

LoggingLevel

: Type: string

Logging levels include ERROR, INFO, or NONE.

SnsTopicArns

: Type: Array of strings

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

Tags

: Type: Array of Tag structures

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

TeamId

: Required: Yes
: Type: string

The ID of the Microsoft Teams authorized with AWS Chatbot.

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

TeamName

: Type: string

The name of the Microsoft Teams Team.

TenantId

: Required: Yes
: Type: string

The ID of the Microsoft Teams tenant.

UserAuthorizationRequired

: Type: boolean

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

Result Syntax

[
    'ChannelConfiguration' => [
        'ChannelId' => '<string>',
        'ChannelName' => '<string>',
        'ChatConfigurationArn' => '<string>',
        'ConfigurationName' => '<string>',
        'GuardrailPolicyArns' => ['<string>', ...],
        'IamRoleArn' => '<string>',
        'LoggingLevel' => '<string>',
        'SnsTopicArns' => ['<string>', ...],
        'State' => '<string>',
        'StateReason' => '<string>',
        'Tags' => [
            [
                'TagKey' => '<string>',
                'TagValue' => '<string>',
            ],
            // ...
        ],
        'TeamId' => '<string>',
        'TeamName' => '<string>',
        'TenantId' => '<string>',
        'UserAuthorizationRequired' => true || false,
    ],
]

Result Details

Members

ChannelConfiguration

: Type: TeamsChannelConfiguration structure

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

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.
ConflictException:: There was an issue processing your request.
LimitExceededException:: You have exceeded a service limit for AWS Chatbot.
CreateTeamsChannelConfigurationException:: We can’t process your request right now because of a server issue. Try again later.

CreateSlackChannelConfiguration

$result = $client->createSlackChannelConfiguration([/* ... */]);
$promise = $client->createSlackChannelConfigurationAsync([/* ... */]);

Creates an AWS Chatbot confugration for Slack.

Parameter Syntax

$result = $client->createSlackChannelConfiguration([
    'ConfigurationName' => '<string>', // REQUIRED
    'GuardrailPolicyArns' => ['<string>', ...],
    'IamRoleArn' => '<string>', // REQUIRED
    'LoggingLevel' => '<string>',
    'SlackChannelId' => '<string>', // REQUIRED
    'SlackChannelName' => '<string>',
    'SlackTeamId' => '<string>', // REQUIRED
    'SnsTopicArns' => ['<string>', ...],
    'Tags' => [
        [
            'TagKey' => '<string>', // REQUIRED
            'TagValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'UserAuthorizationRequired' => true || false,
]);

Parameter Details

Members

ConfigurationName

: Required: Yes
: Type: string

The name of the configuration.

GuardrailPolicyArns

: Type: Array of strings

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.

IamRoleArn

: Required: Yes
: Type: string

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

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

LoggingLevel

: Type: string

Logging levels include ERROR, INFO, or NONE.

SlackChannelId

: Required: Yes
: Type: string

The ID of the Slack channel.

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.

SlackChannelName

: Type: string

The name of the Slack channel.

SlackTeamId

: Required: Yes
: Type: string

The ID of the Slack workspace authorized with AWS Chatbot.

SnsTopicArns

: Type: Array of strings

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

Tags

: Type: Array of Tag structures

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

UserAuthorizationRequired

: Type: boolean

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

Result Syntax

[
    'ChannelConfiguration' => [
        'ChatConfigurationArn' => '<string>',
        'ConfigurationName' => '<string>',
        'GuardrailPolicyArns' => ['<string>', ...],
        'IamRoleArn' => '<string>',
        'LoggingLevel' => '<string>',
        'SlackChannelId' => '<string>',
        'SlackChannelName' => '<string>',
        'SlackTeamId' => '<string>',
        'SlackTeamName' => '<string>',
        'SnsTopicArns' => ['<string>', ...],
        'State' => '<string>',
        'StateReason' => '<string>',
        'Tags' => [
            [
                'TagKey' => '<string>',
                'TagValue' => '<string>',
            ],
            // ...
        ],
        'UserAuthorizationRequired' => true || false,
    ],
]

Result Details

Members

ChannelConfiguration

: Type: SlackChannelConfiguration structure

The configuration for a Slack channel configured with AWS Chatbot.

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.
ConflictException:: There was an issue processing your request.
LimitExceededException:: You have exceeded a service limit for AWS Chatbot.
CreateSlackChannelConfigurationException:: We can’t process your request right now because of a server issue. Try again later.

DeleteChimeWebhookConfiguration

$result = $client->deleteChimeWebhookConfiguration([/* ... */]);
$promise = $client->deleteChimeWebhookConfigurationAsync([/* ... */]);

Deletes a Amazon Chime webhook configuration for AWS Chatbot.

Parameter Syntax

$result = $client->deleteChimeWebhookConfiguration([
    'ChatConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ChatConfigurationArn

: Required: Yes
: Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.
ResourceNotFoundException:: We were unable to find the resource for your request
DeleteChimeWebhookConfigurationException:: We can’t process your request right now because of a server issue. Try again later.

DeleteMicrosoftTeamsChannelConfiguration

$result = $client->deleteMicrosoftTeamsChannelConfiguration([/* ... */]);
$promise = $client->deleteMicrosoftTeamsChannelConfigurationAsync([/* ... */]);

Deletes a Microsoft Teams channel configuration for AWS Chatbot

Parameter Syntax

$result = $client->deleteMicrosoftTeamsChannelConfiguration([
    'ChatConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ChatConfigurationArn

: Required: Yes
: Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.
ResourceNotFoundException:: We were unable to find the resource for your request
DeleteTeamsChannelConfigurationException:: We can’t process your request right now because of a server issue. Try again later.

DeleteMicrosoftTeamsConfiguredTeam

$result = $client->deleteMicrosoftTeamsConfiguredTeam([/* ... */]);
$promise = $client->deleteMicrosoftTeamsConfiguredTeamAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteMicrosoftTeamsConfiguredTeam([
    'TeamId' => '<string>', // REQUIRED
]);

Parameter Details

Members

TeamId

: Required: Yes
: Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
DeleteTeamsConfiguredTeamException:: We can’t process your request right now because of a server issue. Try again later.

DeleteMicrosoftTeamsUserIdentity

$result = $client->deleteMicrosoftTeamsUserIdentity([/* ... */]);
$promise = $client->deleteMicrosoftTeamsUserIdentityAsync([/* ... */]);

Identifes a user level permission for a channel configuration.

Parameter Syntax

$result = $client->deleteMicrosoftTeamsUserIdentity([
    'ChatConfigurationArn' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ChatConfigurationArn

: Required: Yes
: Type: string

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

UserId

: Required: Yes
: Type: string

The Microsoft Teams user ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
ResourceNotFoundException:: We were unable to find the resource for your request
DeleteMicrosoftTeamsUserIdentityException:: We can’t process your request right now because of a server issue. Try again later.

DeleteSlackChannelConfiguration

$result = $client->deleteSlackChannelConfiguration([/* ... */]);
$promise = $client->deleteSlackChannelConfigurationAsync([/* ... */]);

Deletes a Slack channel configuration for AWS Chatbot

Parameter Syntax

$result = $client->deleteSlackChannelConfiguration([
    'ChatConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ChatConfigurationArn

: Required: Yes
: Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.
DeleteSlackChannelConfigurationException:: We can’t process your request right now because of a server issue. Try again later.
ResourceNotFoundException:: We were unable to find the resource for your request

DeleteSlackUserIdentity

$result = $client->deleteSlackUserIdentity([/* ... */]);
$promise = $client->deleteSlackUserIdentityAsync([/* ... */]);

Deletes a user level permission for a Slack channel configuration.

Parameter Syntax

$result = $client->deleteSlackUserIdentity([
    'ChatConfigurationArn' => '<string>', // REQUIRED
    'SlackTeamId' => '<string>', // REQUIRED
    'SlackUserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ChatConfigurationArn

: Required: Yes
: Type: string

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

SlackTeamId

: Required: Yes
: Type: string

The ID of the Slack workspace authorized with AWS Chatbot.

SlackUserId

: Required: Yes
: Type: string

The ID of the user in Slack

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
DeleteSlackUserIdentityException:: We can’t process your request right now because of a server issue. Try again later.
ResourceNotFoundException:: We were unable to find the resource for your request

DeleteSlackWorkspaceAuthorization

$result = $client->deleteSlackWorkspaceAuthorization([/* ... */]);
$promise = $client->deleteSlackWorkspaceAuthorizationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteSlackWorkspaceAuthorization([
    'SlackTeamId' => '<string>', // REQUIRED
]);

Parameter Details

Members

SlackTeamId

: Required: Yes
: Type: string

The ID of the Slack workspace authorized with AWS Chatbot.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
DeleteSlackWorkspaceAuthorizationFault:: There was an issue deleting your Slack workspace.

DescribeChimeWebhookConfigurations

$result = $client->describeChimeWebhookConfigurations([/* ... */]);
$promise = $client->describeChimeWebhookConfigurationsAsync([/* ... */]);

Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn

Parameter Syntax

$result = $client->describeChimeWebhookConfigurations([
    'ChatConfigurationArn' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

ChatConfigurationArn

: Type: string

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

MaxResults

: Type: int

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

: Type: string

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.

Result Syntax

[
    'NextToken' => '<string>',
    'WebhookConfigurations' => [
        [
            'ChatConfigurationArn' => '<string>',
            'ConfigurationName' => '<string>',
            'IamRoleArn' => '<string>',
            'LoggingLevel' => '<string>',
            'SnsTopicArns' => ['<string>', ...],
            'State' => '<string>',
            'StateReason' => '<string>',
            'Tags' => [
                [
                    'TagKey' => '<string>',
                    'TagValue' => '<string>',
                ],
                // ...
            ],
            'WebhookDescription' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: string

WebhookConfigurations

: Type: Array of ChimeWebhookConfiguration structures

A list of Amazon Chime webhooks associated with the account.

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.
DescribeChimeWebhookConfigurationsException:: We can’t process your request right now because of a server issue. Try again later.

DescribeSlackChannelConfigurations

$result = $client->describeSlackChannelConfigurations([/* ... */]);
$promise = $client->describeSlackChannelConfigurationsAsync([/* ... */]);

Lists Slack channel configurations optionally filtered by ChatConfigurationArn

Parameter Syntax

$result = $client->describeSlackChannelConfigurations([
    'ChatConfigurationArn' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

ChatConfigurationArn

: Type: string

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

MaxResults

: Type: int

NextToken

: Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'SlackChannelConfigurations' => [
        [
            'ChatConfigurationArn' => '<string>',
            'ConfigurationName' => '<string>',
            'GuardrailPolicyArns' => ['<string>', ...],
            'IamRoleArn' => '<string>',
            'LoggingLevel' => '<string>',
            'SlackChannelId' => '<string>',
            'SlackChannelName' => '<string>',
            'SlackTeamId' => '<string>',
            'SlackTeamName' => '<string>',
            'SnsTopicArns' => ['<string>', ...],
            'State' => '<string>',
            'StateReason' => '<string>',
            'Tags' => [
                [
                    'TagKey' => '<string>',
                    'TagValue' => '<string>',
                ],
                // ...
            ],
            'UserAuthorizationRequired' => true || false,
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: string

SlackChannelConfigurations

: Type: Array of SlackChannelConfiguration structures

A list of Slack channel configurations.

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.
DescribeSlackChannelConfigurationsException:: We can’t process your request right now because of a server issue. Try again later.

DescribeSlackUserIdentities

$result = $client->describeSlackUserIdentities([/* ... */]);
$promise = $client->describeSlackUserIdentitiesAsync([/* ... */]);

Lists all Slack user identities with a mapped role.

Parameter Syntax

$result = $client->describeSlackUserIdentities([
    'ChatConfigurationArn' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

ChatConfigurationArn

: Type: string

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

MaxResults

: Type: int

NextToken

: Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'SlackUserIdentities' => [
        [
            'AwsUserIdentity' => '<string>',
            'ChatConfigurationArn' => '<string>',
            'IamRoleArn' => '<string>',
            'SlackTeamId' => '<string>',
            'SlackUserId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: string

SlackUserIdentities

: Type: Array of SlackUserIdentity structures

A list of Slack User Identities.

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.
DescribeSlackUserIdentitiesException:: We can’t process your request right now because of a server issue. Try again later.

DescribeSlackWorkspaces

$result = $client->describeSlackWorkspaces([/* ... */]);
$promise = $client->describeSlackWorkspacesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeSlackWorkspaces([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

: Type: int

NextToken

: Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'SlackWorkspaces' => [
        [
            'SlackTeamId' => '<string>',
            'SlackTeamName' => '<string>',
            'State' => '<string>',
            'StateReason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: string

SlackWorkspaces

: Type: Array of SlackWorkspace structures

A list of Slack workspaces registered with AWS Chatbot.

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
DescribeSlackWorkspacesException:: We can’t process your request right now because of a server issue. Try again later.
InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.

GetAccountPreferences

$result = $client->getAccountPreferences([/* ... */]);
$promise = $client->getAccountPreferencesAsync([/* ... */]);

Returns AWS Chatbot account preferences.

Parameter Syntax

$result = $client->getAccountPreferences([
]);

Parameter Details

Members

Result Syntax

[
    'AccountPreferences' => [
        'TrainingDataCollectionEnabled' => true || false,
        'UserAuthorizationRequired' => true || false,
    ],
]

Result Details

Members

AccountPreferences

: Type: AccountPreferences structure

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

Errors

InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.
GetAccountPreferencesException:: We can’t process your request right now because of a server issue. Try again later.

GetMicrosoftTeamsChannelConfiguration

$result = $client->getMicrosoftTeamsChannelConfiguration([/* ... */]);
$promise = $client->getMicrosoftTeamsChannelConfigurationAsync([/* ... */]);

Returns a Microsoft Teams channel configuration in an AWS account.

Parameter Syntax

$result = $client->getMicrosoftTeamsChannelConfiguration([
    'ChatConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ChatConfigurationArn

: Required: Yes
: Type: string

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

Result Syntax

[
    'ChannelConfiguration' => [
        'ChannelId' => '<string>',
        'ChannelName' => '<string>',
        'ChatConfigurationArn' => '<string>',
        'ConfigurationName' => '<string>',
        'GuardrailPolicyArns' => ['<string>', ...],
        'IamRoleArn' => '<string>',
        'LoggingLevel' => '<string>',
        'SnsTopicArns' => ['<string>', ...],
        'State' => '<string>',
        'StateReason' => '<string>',
        'Tags' => [
            [
                'TagKey' => '<string>',
                'TagValue' => '<string>',
            ],
            // ...
        ],
        'TeamId' => '<string>',
        'TeamName' => '<string>',
        'TenantId' => '<string>',
        'UserAuthorizationRequired' => true || false,
    ],
]

Result Details

Members

ChannelConfiguration

: Type: TeamsChannelConfiguration structure

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

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.
GetTeamsChannelConfigurationException:: We can’t process your request right now because of a server issue. Try again later.

ListMicrosoftTeamsChannelConfigurations

$result = $client->listMicrosoftTeamsChannelConfigurations([/* ... */]);
$promise = $client->listMicrosoftTeamsChannelConfigurationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listMicrosoftTeamsChannelConfigurations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TeamId' => '<string>',
]);

Parameter Details

Members

MaxResults

: Type: int

NextToken

: Type: string

TeamId

: Type: string

The ID of the Microsoft Teams authorized with AWS Chatbot.

Result Syntax

[
    'NextToken' => '<string>',
    'TeamChannelConfigurations' => [
        [
            'ChannelId' => '<string>',
            'ChannelName' => '<string>',
            'ChatConfigurationArn' => '<string>',
            'ConfigurationName' => '<string>',
            'GuardrailPolicyArns' => ['<string>', ...],
            'IamRoleArn' => '<string>',
            'LoggingLevel' => '<string>',
            'SnsTopicArns' => ['<string>', ...],
            'State' => '<string>',
            'StateReason' => '<string>',
            'Tags' => [
                [
                    'TagKey' => '<string>',
                    'TagValue' => '<string>',
                ],
                // ...
            ],
            'TeamId' => '<string>',
            'TeamName' => '<string>',
            'TenantId' => '<string>',
            'UserAuthorizationRequired' => true || false,
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: string

TeamChannelConfigurations

: Type: Array of TeamsChannelConfiguration structures

A list of AWS Chatbot channel configurations for Microsoft Teams.

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
ListTeamsChannelConfigurationsException:: We can’t process your request right now because of a server issue. Try again later.
InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.

ListMicrosoftTeamsConfiguredTeams

$result = $client->listMicrosoftTeamsConfiguredTeams([/* ... */]);
$promise = $client->listMicrosoftTeamsConfiguredTeamsAsync([/* ... */]);

Lists all authorized Microsoft Teams for an AWS Account

Parameter Syntax

$result = $client->listMicrosoftTeamsConfiguredTeams([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

: Type: int

NextToken

: Type: string

Result Syntax

[
    'ConfiguredTeams' => [
        [
            'State' => '<string>',
            'StateReason' => '<string>',
            'TeamId' => '<string>',
            'TeamName' => '<string>',
            'TenantId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ConfiguredTeams

: Type: Array of ConfiguredTeam structures

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

NextToken

: Type: string

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.
ListMicrosoftTeamsConfiguredTeamsException:: We can’t process your request right now because of a server issue. Try again later.

ListMicrosoftTeamsUserIdentities

$result = $client->listMicrosoftTeamsUserIdentities([/* ... */]);
$promise = $client->listMicrosoftTeamsUserIdentitiesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listMicrosoftTeamsUserIdentities([
    'ChatConfigurationArn' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

ChatConfigurationArn

: Type: string

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

MaxResults

: Type: int

NextToken

: Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'TeamsUserIdentities' => [
        [
            'AwsUserIdentity' => '<string>',
            'ChatConfigurationArn' => '<string>',
            'IamRoleArn' => '<string>',
            'TeamId' => '<string>',
            'TeamsChannelId' => '<string>',
            'TeamsTenantId' => '<string>',
            'UserId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: string

TeamsUserIdentities

: Type: Array of TeamsUserIdentity structures

User level permissions associated to a channel configuration.

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.
ListMicrosoftTeamsUserIdentitiesException:: We can’t process your request right now because of a server issue. Try again later.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceARN

: Required: Yes
: Type: string

The ARN you specified to list the tags of.

Result Syntax

[
    'Tags' => [
        [
            'TagKey' => '<string>',
            'TagValue' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Tags

: Type: Array of Tag structures

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.

Errors

ServiceUnavailableException:: We can’t process your request right now because of a server issue. Try again later.
ResourceNotFoundException:: We were unable to find the resource for your request
InternalServiceError:: Unexpected error during processing of request.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'TagKey' => '<string>', // REQUIRED
            'TagValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceARN

: Required: Yes
: Type: string

The ARN of the configuration.

Tags

: Required: Yes
: Type: Array of Tag structures

A list of tags to apply to the configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:: We can’t process your request right now because of a server issue. Try again later.
ResourceNotFoundException:: We were unable to find the resource for your request
InternalServiceError:: Unexpected error during processing of request.
TooManyTagsException:: The supplied list of tags contains too many tags.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceARN

: Required: Yes
: Type: string

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.

TagKeys

: Required: Yes
: Type: Array of strings

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:: We can’t process your request right now because of a server issue. Try again later.
ResourceNotFoundException:: We were unable to find the resource for your request
InternalServiceError:: Unexpected error during processing of request.

UpdateAccountPreferences

$result = $client->updateAccountPreferences([/* ... */]);
$promise = $client->updateAccountPreferencesAsync([/* ... */]);

Updates AWS Chatbot account preferences.

Parameter Syntax

$result = $client->updateAccountPreferences([
    'TrainingDataCollectionEnabled' => true || false,
    'UserAuthorizationRequired' => true || false,
]);

Parameter Details

Members

TrainingDataCollectionEnabled

: Type: boolean

Turns on training data collection.

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

UserAuthorizationRequired

: Type: boolean

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

Result Syntax

[
    'AccountPreferences' => [
        'TrainingDataCollectionEnabled' => true || false,
        'UserAuthorizationRequired' => true || false,
    ],
]

Result Details

Members

AccountPreferences

: Type: AccountPreferences structure

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

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.
UpdateAccountPreferencesException:: We can’t process your request right now because of a server issue. Try again later.

UpdateChimeWebhookConfiguration

$result = $client->updateChimeWebhookConfiguration([/* ... */]);
$promise = $client->updateChimeWebhookConfigurationAsync([/* ... */]);

Updates a Amazon Chime webhook configuration.

Parameter Syntax

$result = $client->updateChimeWebhookConfiguration([
    'ChatConfigurationArn' => '<string>', // REQUIRED
    'IamRoleArn' => '<string>',
    'LoggingLevel' => '<string>',
    'SnsTopicArns' => ['<string>', ...],
    'WebhookDescription' => '<string>',
    'WebhookUrl' => '<string>',
]);

Parameter Details

Members

ChatConfigurationArn

: Required: Yes
: Type: string

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

IamRoleArn

: Type: string

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

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

LoggingLevel

: Type: string

Logging levels include ERROR, INFO, or NONE.

SnsTopicArns

: Type: Array of strings

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

WebhookDescription

: Type: string

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

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

WebhookUrl

: Type: string

The URL for the Amazon Chime webhook.

Result Syntax

[
    'WebhookConfiguration' => [
        'ChatConfigurationArn' => '<string>',
        'ConfigurationName' => '<string>',
        'IamRoleArn' => '<string>',
        'LoggingLevel' => '<string>',
        'SnsTopicArns' => ['<string>', ...],
        'State' => '<string>',
        'StateReason' => '<string>',
        'Tags' => [
            [
                'TagKey' => '<string>',
                'TagValue' => '<string>',
            ],
            // ...
        ],
        'WebhookDescription' => '<string>',
    ],
]

Result Details

Members

WebhookConfiguration

: Type: ChimeWebhookConfiguration structure

A Amazon Chime webhook configuration.

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.
UpdateChimeWebhookConfigurationException:: We can’t process your request right now because of a server issue. Try again later.
ResourceNotFoundException:: We were unable to find the resource for your request

UpdateMicrosoftTeamsChannelConfiguration

$result = $client->updateMicrosoftTeamsChannelConfiguration([/* ... */]);
$promise = $client->updateMicrosoftTeamsChannelConfigurationAsync([/* ... */]);

Updates an Microsoft Teams channel configuration.

Parameter Syntax

$result = $client->updateMicrosoftTeamsChannelConfiguration([
    'ChannelId' => '<string>', // REQUIRED
    'ChannelName' => '<string>',
    'ChatConfigurationArn' => '<string>', // REQUIRED
    'GuardrailPolicyArns' => ['<string>', ...],
    'IamRoleArn' => '<string>',
    'LoggingLevel' => '<string>',
    'SnsTopicArns' => ['<string>', ...],
    'UserAuthorizationRequired' => true || false,
]);

Parameter Details

Members

ChannelId

: Required: Yes
: Type: string

The ID of the Microsoft Teams channel.

ChannelName

: Type: string

The name of the Microsoft Teams channel.

ChatConfigurationArn

: Required: Yes
: Type: string

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

GuardrailPolicyArns

: Type: Array of strings

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.

IamRoleArn

: Type: string

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

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

LoggingLevel

: Type: string

Logging levels include ERROR, INFO, or NONE.

SnsTopicArns

: Type: Array of strings

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

UserAuthorizationRequired

: Type: boolean

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

Result Syntax

[
    'ChannelConfiguration' => [
        'ChannelId' => '<string>',
        'ChannelName' => '<string>',
        'ChatConfigurationArn' => '<string>',
        'ConfigurationName' => '<string>',
        'GuardrailPolicyArns' => ['<string>', ...],
        'IamRoleArn' => '<string>',
        'LoggingLevel' => '<string>',
        'SnsTopicArns' => ['<string>', ...],
        'State' => '<string>',
        'StateReason' => '<string>',
        'Tags' => [
            [
                'TagKey' => '<string>',
                'TagValue' => '<string>',
            ],
            // ...
        ],
        'TeamId' => '<string>',
        'TeamName' => '<string>',
        'TenantId' => '<string>',
        'UserAuthorizationRequired' => true || false,
    ],
]

Result Details

Members

ChannelConfiguration

: Type: TeamsChannelConfiguration structure

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

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.
ResourceNotFoundException:: We were unable to find the resource for your request
UpdateTeamsChannelConfigurationException:: We can’t process your request right now because of a server issue. Try again later.

UpdateSlackChannelConfiguration

$result = $client->updateSlackChannelConfiguration([/* ... */]);
$promise = $client->updateSlackChannelConfigurationAsync([/* ... */]);

Updates a Slack channel configuration.

Parameter Syntax

$result = $client->updateSlackChannelConfiguration([
    'ChatConfigurationArn' => '<string>', // REQUIRED
    'GuardrailPolicyArns' => ['<string>', ...],
    'IamRoleArn' => '<string>',
    'LoggingLevel' => '<string>',
    'SlackChannelId' => '<string>', // REQUIRED
    'SlackChannelName' => '<string>',
    'SnsTopicArns' => ['<string>', ...],
    'UserAuthorizationRequired' => true || false,
]);

Parameter Details

Members

ChatConfigurationArn

: Required: Yes
: Type: string

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

GuardrailPolicyArns

: Type: Array of strings

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.

IamRoleArn

: Type: string

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

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

LoggingLevel

: Type: string

Logging levels include ERROR, INFO, or NONE.

SlackChannelId

: Required: Yes
: Type: string

The ID of the Slack channel.

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.

SlackChannelName

: Type: string

The name of the Slack channel.

SnsTopicArns

: Type: Array of strings

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

UserAuthorizationRequired

: Type: boolean

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

Result Syntax

[
    'ChannelConfiguration' => [
        'ChatConfigurationArn' => '<string>',
        'ConfigurationName' => '<string>',
        'GuardrailPolicyArns' => ['<string>', ...],
        'IamRoleArn' => '<string>',
        'LoggingLevel' => '<string>',
        'SlackChannelId' => '<string>',
        'SlackChannelName' => '<string>',
        'SlackTeamId' => '<string>',
        'SlackTeamName' => '<string>',
        'SnsTopicArns' => ['<string>', ...],
        'State' => '<string>',
        'StateReason' => '<string>',
        'Tags' => [
            [
                'TagKey' => '<string>',
                'TagValue' => '<string>',
            ],
            // ...
        ],
        'UserAuthorizationRequired' => true || false,
    ],
]

Result Details

Members

ChannelConfiguration

: Type: SlackChannelConfiguration structure

The configuration for a Slack channel configured with AWS Chatbot.

Errors

InvalidParameterException:: Your request input doesn't meet the constraints required by AWS Chatbot.
InvalidRequestException:: Your request input doesn't meet the constraints required by AWS Chatbot.
ResourceNotFoundException:: We were unable to find the resource for your request
UpdateSlackChannelConfigurationException:: We can’t process your request right now because of a server issue. Try again later.

Shapes

AccountPreferences

Description

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

Members

TrainingDataCollectionEnabled

: Type: boolean

Turns on training data collection.

UserAuthorizationRequired

: Type: boolean

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

ChimeWebhookConfiguration

Description

An AWS Chatbot configuration for Amazon Chime.

Members

ChatConfigurationArn

: Required: Yes
: Type: string

The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration.

ConfigurationName

: Type: string

The name of the configuration.

IamRoleArn

: Required: Yes
: Type: string

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

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

LoggingLevel

: Type: string

Logging levels include ERROR, INFO, or NONE.

SnsTopicArns

: Required: Yes
: Type: Array of strings

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

State

: Type: string

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

StateReason

: Type: string

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

Tags

: Type: Array of Tag structures

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

WebhookDescription

: Required: Yes
: Type: string

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

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

ConfiguredTeam

Description

A Microsoft Teams team that is authorized with AWS Chatbot.

Members

State

: Type: string

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

StateReason

: Type: string

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

TeamId

: Required: Yes
: Type: string

The ID of the Microsoft Teams authorized with AWS Chatbot.

TeamName

: Type: string

The name of the Microsoft Teams Team.

TenantId

: Required: Yes
: Type: string

: Required: Yes
: Type: string

The Amazon Resource Number (ARN) of the SlackChannelConfiguration.

ConfigurationName

: Type: string

The name of the configuration.

GuardrailPolicyArns

: Type: Array of strings

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.

IamRoleArn

: Required: Yes
: Type: string

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

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

LoggingLevel

: Type: string

Logging levels include ERROR, INFO, or NONE.

SlackChannelId

: Required: Yes
: Type: string

The ID of the Slack channel.

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.

SlackChannelName

: Required: Yes
: Type: string

The name of the Slack channel.

SlackTeamId

: Required: Yes
: Type: string

The ID of the Slack workspace authorized with Amazon Chime.

SlackTeamName

: Required: Yes
: Type: string

Name of the Slack workspace.

SnsTopicArns

: Required: Yes
: Type: Array of strings

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

State

: Type: string

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

StateReason

: Type: string

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

Tags

: Type: Array of Tag structures

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

UserAuthorizationRequired

: Type: boolean

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

SlackUserIdentity

Description

Identifes a user level permission for a channel configuration.

Members

AwsUserIdentity

: Type: string

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

ChatConfigurationArn

: Required: Yes
: Type: string

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

IamRoleArn

: Required: Yes
: Type: string

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

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

SlackTeamId

: Required: Yes
: Type: string

The ID of the Slack workspace authorized with AWS Chatbot.

SlackUserId

: Required: Yes
: Type: string

The ID of the user in Slack

SlackWorkspace

Description

A Slack workspace.

Members

SlackTeamId

: Required: Yes
: Type: string

The ID of the Slack workspace authorized with AWS Chatbot.

SlackTeamName

: Required: Yes
: Type: string

The name of the Slack workspace.

State

: Type: string

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

StateReason

: Type: string

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

TeamsChannelConfiguration

Description

An AWS Chatbot configuration for Microsoft Teams.

Members

ChannelId

: Required: Yes
: Type: string

The ID of the Microsoft Teams channel.

ChannelName

: Type: string

The name of the Microsoft Teams channel.

ChatConfigurationArn

: Required: Yes
: Type: string

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

ConfigurationName

: Type: string

The name of the configuration.

GuardrailPolicyArns

: Type: Array of strings

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.

IamRoleArn

: Required: Yes
: Type: string

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

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

LoggingLevel

: Type: string

Logging levels include ERROR, INFO, or NONE.

SnsTopicArns

: Required: Yes
: Type: Array of strings

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

State

: Type: string

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

StateReason

: Type: string

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

Tags

: Type: Array of Tag structures

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

TeamId

: Required: Yes
: Type: string

The ID of the Microsoft Teams authorized with AWS Chatbot.

TeamName

: Type: string

The name of the Microsoft Teams Team.

TenantId

: Required: Yes
: Type: string

The ID of the Microsoft Teams tenant.

UserAuthorizationRequired

: Type: boolean

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

TeamsUserIdentity

Description

Identifes a user level permission for a channel configuration.

Members

AwsUserIdentity

: Type: string

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

ChatConfigurationArn

: Required: Yes
: Type: string

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

IamRoleArn

: Required: Yes
: Type: string

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

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

TeamId

: Required: Yes
: Type: string

The ID of the Microsoft Teams authorized with AWS Chatbot.

TeamsChannelId

: Type: string

The ID of the Microsoft Teams channel.

TeamsTenantId

: Type: string

The ID of the Microsoft Teams tenant.

UserId

: Type: string

: Type: string

AWS Chatbot 2017-10-11

Operation Summary

Paginators

Operations

CreateChimeWebhookConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateMicrosoftTeamsChannelConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateSlackChannelConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteChimeWebhookConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteMicrosoftTeamsChannelConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteMicrosoftTeamsConfiguredTeam

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteMicrosoftTeamsUserIdentity

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteSlackChannelConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteSlackUserIdentity

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteSlackWorkspaceAuthorization

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeChimeWebhookConfigurations

Parameter Syntax

Parameter Details