AssociateToConfiguration

$result = $client->associateToConfiguration([/* ... */]);
$promise = $client->associateToConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->associateToConfiguration([
    'ChatConfiguration' => '<string>', // REQUIRED
    'Resource' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

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

InternalServiceError:

Unexpected error during processing of request.

UnauthorizedException:

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

Examples

Example 1: Associate a custom action to a configuration

Associate a custom action to a channel configuration, allowing it to be used in that channel

$result = $client->associateToConfiguration([
    'ChatConfiguration' => 'arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-channel',
    'Resource' => 'arn:aws:chatbot::1234567890:custom-action/my-custom-action',
]);

Result syntax:

[
]

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

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

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.

CreateCustomAction

$result = $client->createCustomAction([/* ... */]);
$promise = $client->createCustomActionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createCustomAction([
    'ActionName' => '<string>', // REQUIRED
    'AliasName' => '<string>',
    'Attachments' => [
        [
            'ButtonText' => '<string>',
            'Criteria' => [
                [
                    'Operator' => 'HAS_VALUE|EQUALS', // REQUIRED
                    'Value' => '<string>',
                    'VariableName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'NotificationType' => '<string>',
            'Variables' => ['<string>', ...],
        ],
        // ...
    ],
    'ClientToken' => '<string>',
    'Definition' => [ // REQUIRED
        'CommandText' => '<string>', // REQUIRED
    ],
    'Tags' => [
        [
            'TagKey' => '<string>', // REQUIRED
            'TagValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'CustomActionArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

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

LimitExceededException:

You have exceeded a service limit for AWS Chatbot.

ConflictException:

There was an issue processing your request.

InternalServiceError:

Unexpected error during processing of request.

UnauthorizedException:

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

Examples

Example 1: Create an alias that invokes a Lambda function

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.

$result = $client->createCustomAction([
    'ActionName' => 'my-custom-action',
    'AliasName' => 'invoke',
    'Definition' => [
        'CommandText' => 'lambda invoke $functionName',
    ],
]);

Result syntax:

[
    'CustomActionArn' => 'arn:aws:chatbot::1234567890:custom-action/my-custom-action',
]

Example 2: Create a custom action to list alarms

Creates a button on all Cloudwatch notifications that lists alarms in the ‘ALARM’ state.

$result = $client->createCustomAction([
    'ActionName' => 'describe-alarms',
    'Attachments' => [
        [
            'ButtonText' => 'List alarms',
            'NotificationType' => 'CloudWatch',
        ],
    ],
    'Definition' => [
        'CommandText' => 'cloudwatch describe-alarms --state-value ALARM',
    ],
]);

Result syntax:

[
    'CustomActionArn' => 'arn:aws:chatbot::1234567890:custom-action/describe-alarms',
]

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

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

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

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

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

Result Syntax

[]

Result Details

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.

DeleteCustomAction

$result = $client->deleteCustomAction([/* ... */]);
$promise = $client->deleteCustomActionAsync([/* ... */]);

Deletes a custom action.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

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

ResourceNotFoundException:

We were unable to find the resource for your request

InternalServiceError:

Unexpected error during processing of request.

UnauthorizedException:

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

Examples

Example 1: Delete a custom action

$result = $client->deleteCustomAction([
    'CustomActionArn' => 'arn:aws:chatbot::1234567890:custom-action/my-custom-action',
]);

Result syntax:

[
]

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

DisassociateFromConfiguration

$result = $client->disassociateFromConfiguration([/* ... */]);
$promise = $client->disassociateFromConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disassociateFromConfiguration([
    'ChatConfiguration' => '<string>', // REQUIRED
    'Resource' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

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

InternalServiceError:

Unexpected error during processing of request.

UnauthorizedException:

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

Examples

Example 1: Disassociate a custom action from a configuration

$result = $client->disassociateFromConfiguration([
    'ChatConfiguration' => 'arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-channel',
    'Resource' => 'arn:aws:chatbot::1234567890:custom-action/my-custom-action',
]);

Result syntax:

[
]

GetAccountPreferences

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

Returns AWS Chatbot account preferences.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

GetCustomAction

$result = $client->getCustomAction([/* ... */]);
$promise = $client->getCustomActionAsync([/* ... */]);

Returns a custom action.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CustomAction' => [
        'ActionName' => '<string>',
        'AliasName' => '<string>',
        'Attachments' => [
            [
                'ButtonText' => '<string>',
                'Criteria' => [
                    [
                        'Operator' => 'HAS_VALUE|EQUALS',
                        'Value' => '<string>',
                        'VariableName' => '<string>',
                    ],
                    // ...
                ],
                'NotificationType' => '<string>',
                'Variables' => ['<string>', ...],
            ],
            // ...
        ],
        'CustomActionArn' => '<string>',
        'Definition' => [
            'CommandText' => '<string>',
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

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

ResourceNotFoundException:

We were unable to find the resource for your request

InternalServiceError:

Unexpected error during processing of request.

UnauthorizedException:

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

Examples

Example 1: Get a custom action

$result = $client->getCustomAction([
    'CustomActionArn' => 'arn:aws:chatbot::1234567890:custom-action/my-custom-action',
]);

Result syntax:

[
    'CustomAction' => [
        'ActionName' => 'my-custom-action',
        'CustomActionArn' => 'arn:aws:chatbot::1234567890:custom-action/my-custom-action',
        'Definition' => [
            'CommandText' => 'lambda invoke $functionName',
        ],
    ],
]

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

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

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.

ListAssociations

$result = $client->listAssociations([/* ... */]);
$promise = $client->listAssociationsAsync([/* ... */]);

Lists resources associated with a channel configuration.

Parameter Syntax

$result = $client->listAssociations([
    'ChatConfiguration' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Associations' => [
        [
            'Resource' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

Examples

Example 1: List custom actions associated with a configuration

$result = $client->listAssociations([
    'ChatConfiguration' => 'arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-channel',
]);

Result syntax:

[
    'Associations' => [
        [
            'Resource' => 'arn:aws:chatbot::1234567890:custom-action/my-custom-action',
        ],
    ],
]

ListCustomActions

$result = $client->listCustomActions([/* ... */]);
$promise = $client->listCustomActionsAsync([/* ... */]);

Lists custom actions defined in this account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CustomActions' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

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

InternalServiceError:

Unexpected error during processing of request.

UnauthorizedException:

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

Examples

Example 1: List custom actions

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

Result syntax:

[
    'CustomActions' => [
        'arn:aws:chatbot::1234567890:custom-action/my-custom-action',
    ],
]

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

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

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

UpdateCustomAction

$result = $client->updateCustomAction([/* ... */]);
$promise = $client->updateCustomActionAsync([/* ... */]);

Updates a custom action.

Parameter Syntax

$result = $client->updateCustomAction([
    'AliasName' => '<string>',
    'Attachments' => [
        [
            'ButtonText' => '<string>',
            'Criteria' => [
                [
                    'Operator' => 'HAS_VALUE|EQUALS', // REQUIRED
                    'Value' => '<string>',
                    'VariableName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'NotificationType' => '<string>',
            'Variables' => ['<string>', ...],
        ],
        // ...
    ],
    'CustomActionArn' => '<string>', // REQUIRED
    'Definition' => [ // REQUIRED
        'CommandText' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'CustomActionArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

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

ResourceNotFoundException:

We were unable to find the resource for your request

InternalServiceError:

Unexpected error during processing of request.

UnauthorizedException:

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

Examples

Example 1: Update the command definition of an existing action

Updates the command text of a custom action without altering the existing alias name or attachment criteria

$result = $client->updateCustomAction([
    'CustomActionArn' => 'arn:aws:chatbot::1234567890:custom-action/my-custom-action',
    'Definition' => [
        'CommandText' => 'lambda invoke MyNewFunction',
    ],
]);

Result syntax:

[
    'CustomActionArn' => 'arn:aws:chatbot::1234567890:custom-action/my-custom-action',
]

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

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

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

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

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.