AWS API Changes

2024/09/26 - AWS Chatbot - 12 updated api methods

Changes Return State and StateReason fields for Chatbot Channel Configurations.

CreateChimeWebhookConfiguration (updated)

Link ¶
Changes (response)

{'WebhookConfiguration': {'State': 'string', 'StateReason': 'string'}}

Creates an AWS Chatbot configuration for Amazon Chime.

See also: AWS API Documentation

Request Syntax

client.create_chime_webhook_configuration(
    WebhookDescription='string',
    WebhookUrl='string',
    SnsTopicArns=[
        'string',
    ],
    IamRoleArn='string',
    ConfigurationName='string',
    LoggingLevel='string',
    Tags=[
        {
            'TagKey': 'string',
            'TagValue': 'string'
        },
    ]
)

type WebhookDescription

string

param WebhookDescription

[REQUIRED]

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 .

type WebhookUrl

string

param WebhookUrl

[REQUIRED]

The URL for the Amazon Chime webhook.

type SnsTopicArns

list

param SnsTopicArns

[REQUIRED]

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

(string) --

type IamRoleArn

string

param IamRoleArn

[REQUIRED]

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 .

type ConfigurationName

string

param ConfigurationName

[REQUIRED]

The name of the configuration.

type LoggingLevel

string

param LoggingLevel

Logging levels include ERROR , INFO , or NONE .

type Tags

list

param Tags

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

(dict) --

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

Warning

Do not include confidential or sensitive information in this field.

For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide .
- TagKey (string) -- [REQUIRED]
  
  The key of the tag.
- TagValue (string) -- [REQUIRED]
  
  The value of the tag.

rtype

dict

returns

Response Syntax

{
    'WebhookConfiguration': {
        'WebhookDescription': 'string',
        'ChatConfigurationArn': 'string',
        'IamRoleArn': 'string',
        'SnsTopicArns': [
            'string',
        ],
        'ConfigurationName': 'string',
        'LoggingLevel': 'string',
        'Tags': [
            {
                'TagKey': 'string',
                'TagValue': 'string'
            },
        ],
        'State': 'string',
        'StateReason': 'string'
    }
}

Response Structure

(dict) --
- WebhookConfiguration (dict) --
  
  An Amazon Chime webhook configuration.
  - WebhookDescription (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 .
  - ChatConfigurationArn (string) --
    
    The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration.
  - IamRoleArn (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 .
  - SnsTopicArns (list) --
    
    The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
    - (string) --
  - ConfigurationName (string) --
    
    The name of the configuration.
  - LoggingLevel (string) --
    
    Logging levels include ERROR , INFO , or NONE .
  - Tags (list) --
    
    A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
    - (dict) --
      
      A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
      
      Warning
      
      Do not include confidential or sensitive information in this field.
      
      For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide .
      - TagKey (string) --
        
        The key of the tag.
      - TagValue (string) --
        
        The value of the tag.
  - State (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 (string) --
    
    Provided if State is DISABLED . Provides context as to why the resource is disabled.

CreateMicrosoftTeamsChannelConfiguration (updated)

Link ¶
Changes (response)

{'ChannelConfiguration': {'State': 'string', 'StateReason': 'string'}}

Creates an AWS Chatbot configuration for Microsoft Teams.

See also: AWS API Documentation

Request Syntax

client.create_microsoft_teams_channel_configuration(
    ChannelId='string',
    ChannelName='string',
    TeamId='string',
    TeamName='string',
    TenantId='string',
    SnsTopicArns=[
        'string',
    ],
    IamRoleArn='string',
    ConfigurationName='string',
    LoggingLevel='string',
    GuardrailPolicyArns=[
        'string',
    ],
    UserAuthorizationRequired=True|False,
    Tags=[
        {
            'TagKey': 'string',
            'TagValue': 'string'
        },
    ]
)

type ChannelId

string

param ChannelId

[REQUIRED]

The ID of the Microsoft Teams channel.

type ChannelName

string

param ChannelName

The name of the Microsoft Teams channel.

type TeamId

string

param TeamId

[REQUIRED]

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 .

type TeamName

string

param TeamName

The name of the Microsoft Teams Team.

type TenantId

string

param TenantId

[REQUIRED]

The ID of the Microsoft Teams tenant.

type SnsTopicArns

list

param SnsTopicArns

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

(string) --

type IamRoleArn

string

param IamRoleArn

[REQUIRED]

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 .

type ConfigurationName

string

param ConfigurationName

[REQUIRED]

The name of the configuration.

type LoggingLevel

string

param LoggingLevel

Logging levels include ERROR , INFO , or NONE .

type GuardrailPolicyArns

list

param GuardrailPolicyArns

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.

(string) --

type UserAuthorizationRequired

boolean

param UserAuthorizationRequired

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

type Tags

list

param Tags

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

(dict) --

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

Warning

Do not include confidential or sensitive information in this field.

For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide .
- TagKey (string) -- [REQUIRED]
  
  The key of the tag.
- TagValue (string) -- [REQUIRED]
  
  The value of the tag.

rtype

dict

returns

Response Syntax

{
    'ChannelConfiguration': {
        'ChannelId': 'string',
        'ChannelName': 'string',
        'TeamId': 'string',
        'TeamName': 'string',
        'TenantId': 'string',
        'ChatConfigurationArn': 'string',
        'IamRoleArn': 'string',
        'SnsTopicArns': [
            'string',
        ],
        'ConfigurationName': 'string',
        'LoggingLevel': 'string',
        'GuardrailPolicyArns': [
            'string',
        ],
        'UserAuthorizationRequired': True|False,
        'Tags': [
            {
                'TagKey': 'string',
                'TagValue': 'string'
            },
        ],
        'State': 'string',
        'StateReason': 'string'
    }
}

Response Structure

(dict) --
- ChannelConfiguration (dict) --
  
  The configuration for a Microsoft Teams channel configured with AWS Chatbot.
  - ChannelId (string) --
    
    The ID of the Microsoft Teams channel.
  - ChannelName (string) --
    
    The name of the Microsoft Teams channel.
  - TeamId (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 (string) --
    
    The name of the Microsoft Teams Team.
  - TenantId (string) --
    
    The ID of the Microsoft Teams tenant.
  - ChatConfigurationArn (string) --
    
    The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.
  - IamRoleArn (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 .
  - SnsTopicArns (list) --
    
    The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
    - (string) --
  - ConfigurationName (string) --
    
    The name of the configuration.
  - LoggingLevel (string) --
    
    Logging levels include ERROR , INFO , or NONE .
  - GuardrailPolicyArns (list) --
    
    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.
    - (string) --
  - UserAuthorizationRequired (boolean) --
    
    Enables use of a user role requirement in your chat configuration.
  - Tags (list) --
    
    A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
    - (dict) --
      
      A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
      
      Warning
      
      Do not include confidential or sensitive information in this field.
      
      For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide .
      - TagKey (string) --
        
        The key of the tag.
      - TagValue (string) --
        
        The value of the tag.
  - State (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 (string) --
    
    Provided if State is DISABLED . Provides context as to why the resource is disabled.

CreateSlackChannelConfiguration (updated)

Link ¶
Changes (response)

{'ChannelConfiguration': {'State': 'string', 'StateReason': 'string'}}

Creates an AWS Chatbot confugration for Slack.

See also: AWS API Documentation

Request Syntax

client.create_slack_channel_configuration(
    SlackTeamId='string',
    SlackChannelId='string',
    SlackChannelName='string',
    SnsTopicArns=[
        'string',
    ],
    IamRoleArn='string',
    ConfigurationName='string',
    LoggingLevel='string',
    GuardrailPolicyArns=[
        'string',
    ],
    UserAuthorizationRequired=True|False,
    Tags=[
        {
            'TagKey': 'string',
            'TagValue': 'string'
        },
    ]
)

type SlackTeamId

string

param SlackTeamId

[REQUIRED]

The ID of the Slack workspace authorized with AWS Chatbot.

type SlackChannelId

string

param SlackChannelId

[REQUIRED]

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.

type SlackChannelName

string

param SlackChannelName

The name of the Slack channel.

type SnsTopicArns

list

param SnsTopicArns

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

(string) --

type IamRoleArn

string

param IamRoleArn

[REQUIRED]

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 .

type ConfigurationName

string

param ConfigurationName

[REQUIRED]

The name of the configuration.

type LoggingLevel

string

param LoggingLevel

Logging levels include ERROR , INFO , or NONE .

type GuardrailPolicyArns

list

param GuardrailPolicyArns

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.

(string) --

type UserAuthorizationRequired

boolean

param UserAuthorizationRequired

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

type Tags

list

param Tags

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

(dict) --

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

Warning

Do not include confidential or sensitive information in this field.

For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide .
- TagKey (string) -- [REQUIRED]
  
  The key of the tag.
- TagValue (string) -- [REQUIRED]
  
  The value of the tag.

rtype

dict

returns

Response Syntax

{
    'ChannelConfiguration': {
        'SlackTeamName': 'string',
        'SlackTeamId': 'string',
        'SlackChannelId': 'string',
        'SlackChannelName': 'string',
        'ChatConfigurationArn': 'string',
        'IamRoleArn': 'string',
        'SnsTopicArns': [
            'string',
        ],
        'ConfigurationName': 'string',
        'LoggingLevel': 'string',
        'GuardrailPolicyArns': [
            'string',
        ],
        'UserAuthorizationRequired': True|False,
        'Tags': [
            {
                'TagKey': 'string',
                'TagValue': 'string'
            },
        ],
        'State': 'string',
        'StateReason': 'string'
    }
}

Response Structure

(dict) --
- ChannelConfiguration (dict) --
  
  The configuration for a Slack channel configured with AWS Chatbot.
  - SlackTeamName (string) --
    
    Name of the Slack workspace.
  - SlackTeamId (string) --
    
    The ID of the Slack workspace authorized with Amazon Chime.
  - SlackChannelId (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 (string) --
    
    The name of the Slack channel.
  - ChatConfigurationArn (string) --
    
    The Amazon Resource Number (ARN) of the SlackChannelConfiguration.
  - IamRoleArn (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 .
  - SnsTopicArns (list) --
    
    The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
    - (string) --
  - ConfigurationName (string) --
    
    The name of the configuration.
  - LoggingLevel (string) --
    
    Logging levels include ERROR , INFO , or NONE .
  - GuardrailPolicyArns (list) --
    
    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.
    - (string) --
  - UserAuthorizationRequired (boolean) --
    
    Enables use of a user role requirement in your chat configuration.
  - Tags (list) --
    
    A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
    - (dict) --
      
      A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
      
      Warning
      
      Do not include confidential or sensitive information in this field.
      
      For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide .
      - TagKey (string) --
        
        The key of the tag.
      - TagValue (string) --
        
        The value of the tag.
  - State (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 (string) --
    
    Provided if State is DISABLED . Provides context as to why the resource is disabled.

DescribeChimeWebhookConfigurations (updated)

Link ¶
Changes (response)

{'WebhookConfigurations': {'State': 'string', 'StateReason': 'string'}}

Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn

See also: AWS API Documentation

Request Syntax

client.describe_chime_webhook_configurations(
    MaxResults=123,
    NextToken='string',
    ChatConfigurationArn='string'
)

type MaxResults

integer

param MaxResults

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.

type NextToken

string

param NextToken

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.

type ChatConfigurationArn

string

param ChatConfigurationArn

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

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'WebhookConfigurations': [
        {
            'WebhookDescription': 'string',
            'ChatConfigurationArn': 'string',
            'IamRoleArn': 'string',
            'SnsTopicArns': [
                'string',
            ],
            'ConfigurationName': 'string',
            'LoggingLevel': 'string',
            'Tags': [
                {
                    'TagKey': 'string',
                    'TagValue': 'string'
                },
            ],
            'State': 'string',
            'StateReason': 'string'
        },
    ]
}

Response Structure

(dict) --
- NextToken (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.
- WebhookConfigurations (list) --
  
  A list of Amazon Chime webhooks associated with the account.
  - (dict) --
    
    An AWS Chatbot configuration for Amazon Chime.
    - WebhookDescription (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 .
    - ChatConfigurationArn (string) --
      
      The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration.
    - IamRoleArn (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 .
    - SnsTopicArns (list) --
      
      The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
      - (string) --
    - ConfigurationName (string) --
      
      The name of the configuration.
    - LoggingLevel (string) --
      
      Logging levels include ERROR , INFO , or NONE .
    - Tags (list) --
      
      A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
      - (dict) --
        
        A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
        
        Warning
        
        Do not include confidential or sensitive information in this field.
        
        For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide .
        
        TagKey (string) --
        
        The key of the tag.
        
        TagValue (string) --
        
        The value of the tag.
    - State (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 (string) --
      
      Provided if State is DISABLED . Provides context as to why the resource is disabled.

DescribeSlackChannelConfigurations (updated)

Link ¶
Changes (response)

{'SlackChannelConfigurations': {'State': 'string', 'StateReason': 'string'}}

Lists Slack channel configurations optionally filtered by ChatConfigurationArn

See also: AWS API Documentation

Request Syntax

client.describe_slack_channel_configurations(
    MaxResults=123,
    NextToken='string',
    ChatConfigurationArn='string'
)

type MaxResults

integer

param MaxResults

type NextToken

string

param NextToken

type ChatConfigurationArn

string

param ChatConfigurationArn

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

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'SlackChannelConfigurations': [
        {
            'SlackTeamName': 'string',
            'SlackTeamId': 'string',
            'SlackChannelId': 'string',
            'SlackChannelName': 'string',
            'ChatConfigurationArn': 'string',
            'IamRoleArn': 'string',
            'SnsTopicArns': [
                'string',
            ],
            'ConfigurationName': 'string',
            'LoggingLevel': 'string',
            'GuardrailPolicyArns': [
                'string',
            ],
            'UserAuthorizationRequired': True|False,
            'Tags': [
                {
                    'TagKey': 'string',
                    'TagValue': 'string'
                },
            ],
            'State': 'string',
            'StateReason': 'string'
        },
    ]
}

Response Structure

(dict) --
- NextToken (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.
- SlackChannelConfigurations (list) --
  
  A list of Slack channel configurations.
  - (dict) --
    
    An AWS Chatbot configuration for Slack.
    - SlackTeamName (string) --
      
      Name of the Slack workspace.
    - SlackTeamId (string) --
      
      The ID of the Slack workspace authorized with Amazon Chime.
    - SlackChannelId (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 (string) --
      
      The name of the Slack channel.
    - ChatConfigurationArn (string) --
      
      The Amazon Resource Number (ARN) of the SlackChannelConfiguration.
    - IamRoleArn (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 .
    - SnsTopicArns (list) --
      
      The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
      - (string) --
    - ConfigurationName (string) --
      
      The name of the configuration.
    - LoggingLevel (string) --
      
      Logging levels include ERROR , INFO , or NONE .
    - GuardrailPolicyArns (list) --
      
      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.
      - (string) --
    - UserAuthorizationRequired (boolean) --
      
      Enables use of a user role requirement in your chat configuration.
    - Tags (list) --
      
      A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
      - (dict) --
        
        A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
        
        Warning
        
        Do not include confidential or sensitive information in this field.
        
        For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide .
        
        TagKey (string) --
        
        The key of the tag.
        
        TagValue (string) --
        
        The value of the tag.
    - State (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 (string) --
      
      Provided if State is DISABLED . Provides context as to why the resource is disabled.

DescribeSlackWorkspaces (updated)

Link ¶
Changes (response)

{'SlackWorkspaces': {'State': 'string', 'StateReason': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.describe_slack_workspaces(
    MaxResults=123,
    NextToken='string'
)

type MaxResults

integer

param MaxResults

type NextToken

string

param NextToken

rtype

dict

returns

Response Syntax

{
    'SlackWorkspaces': [
        {
            'SlackTeamId': 'string',
            'SlackTeamName': 'string',
            'State': 'string',
            'StateReason': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- SlackWorkspaces (list) --
  
  A list of Slack workspaces registered with AWS Chatbot.
  - (dict) --
    
    A Slack workspace.
    - SlackTeamId (string) --
      
      The ID of the Slack workspace authorized with AWS Chatbot.
    - SlackTeamName (string) --
      
      The name of the Slack workspace.
    - State (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 (string) --
      
      Provided if State is DISABLED . Provides context as to why the resource is disabled.
- NextToken (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.

GetMicrosoftTeamsChannelConfiguration (updated)

Link ¶
Changes (response)

{'ChannelConfiguration': {'State': 'string', 'StateReason': 'string'}}

Returns a Microsoft Teams channel configuration in an AWS account.

See also: AWS API Documentation

Request Syntax

client.get_microsoft_teams_channel_configuration(
    ChatConfigurationArn='string'
)

type ChatConfigurationArn

string

param ChatConfigurationArn

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'ChannelConfiguration': {
        'ChannelId': 'string',
        'ChannelName': 'string',
        'TeamId': 'string',
        'TeamName': 'string',
        'TenantId': 'string',
        'ChatConfigurationArn': 'string',
        'IamRoleArn': 'string',
        'SnsTopicArns': [
            'string',
        ],
        'ConfigurationName': 'string',
        'LoggingLevel': 'string',
        'GuardrailPolicyArns': [
            'string',
        ],
        'UserAuthorizationRequired': True|False,
        'Tags': [
            {
                'TagKey': 'string',
                'TagValue': 'string'
            },
        ],
        'State': 'string',
        'StateReason': 'string'
    }
}

Response Structure

(dict) --
- ChannelConfiguration (dict) --
  
  The configuration for a Microsoft Teams channel configured with AWS Chatbot.
  - ChannelId (string) --
    
    The ID of the Microsoft Teams channel.
  - ChannelName (string) --
    
    The name of the Microsoft Teams channel.
  - TeamId (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 (string) --
    
    The name of the Microsoft Teams Team.
  - TenantId (string) --
    
    The ID of the Microsoft Teams tenant.
  - ChatConfigurationArn (string) --
    
    The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.
  - IamRoleArn (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 .
  - SnsTopicArns (list) --
    
    The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
    - (string) --
  - ConfigurationName (string) --
    
    The name of the configuration.
  - LoggingLevel (string) --
    
    Logging levels include ERROR , INFO , or NONE .
  - GuardrailPolicyArns (list) --
    
    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.
    - (string) --
  - UserAuthorizationRequired (boolean) --
    
    Enables use of a user role requirement in your chat configuration.
  - Tags (list) --
    
    A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
    - (dict) --
      
      A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
      
      Warning
      
      Do not include confidential or sensitive information in this field.
      
      For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide .
      - TagKey (string) --
        
        The key of the tag.
      - TagValue (string) --
        
        The value of the tag.
  - State (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 (string) --
    
    Provided if State is DISABLED . Provides context as to why the resource is disabled.

ListMicrosoftTeamsChannelConfigurations (updated)

Link ¶
Changes (response)

{'TeamChannelConfigurations': {'State': 'string', 'StateReason': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.list_microsoft_teams_channel_configurations(
    MaxResults=123,
    NextToken='string',
    TeamId='string'
)

type MaxResults

integer

param MaxResults

type NextToken

string

param NextToken

type TeamId

string

param TeamId

The ID of the Microsoft Teams authorized with AWS Chatbot.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'TeamChannelConfigurations': [
        {
            'ChannelId': 'string',
            'ChannelName': 'string',
            'TeamId': 'string',
            'TeamName': 'string',
            'TenantId': 'string',
            'ChatConfigurationArn': 'string',
            'IamRoleArn': 'string',
            'SnsTopicArns': [
                'string',
            ],
            'ConfigurationName': 'string',
            'LoggingLevel': 'string',
            'GuardrailPolicyArns': [
                'string',
            ],
            'UserAuthorizationRequired': True|False,
            'Tags': [
                {
                    'TagKey': 'string',
                    'TagValue': 'string'
                },
            ],
            'State': 'string',
            'StateReason': 'string'
        },
    ]
}

Response Structure

(dict) --
- NextToken (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.
- TeamChannelConfigurations (list) --
  
  A list of AWS Chatbot channel configurations for Microsoft Teams.
  - (dict) --
    
    An AWS Chatbot configuration for Microsoft Teams.
    - ChannelId (string) --
      
      The ID of the Microsoft Teams channel.
    - ChannelName (string) --
      
      The name of the Microsoft Teams channel.
    - TeamId (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 (string) --
      
      The name of the Microsoft Teams Team.
    - TenantId (string) --
      
      The ID of the Microsoft Teams tenant.
    - ChatConfigurationArn (string) --
      
      The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.
    - IamRoleArn (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 .
    - SnsTopicArns (list) --
      
      The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
      - (string) --
    - ConfigurationName (string) --
      
      The name of the configuration.
    - LoggingLevel (string) --
      
      Logging levels include ERROR , INFO , or NONE .
    - GuardrailPolicyArns (list) --
      
      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.
      - (string) --
    - UserAuthorizationRequired (boolean) --
      
      Enables use of a user role requirement in your chat configuration.
    - Tags (list) --
      
      A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
      - (dict) --
        
        A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
        
        Warning
        
        Do not include confidential or sensitive information in this field.
        
        For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide .
        
        TagKey (string) --
        
        The key of the tag.
        
        TagValue (string) --
        
        The value of the tag.
    - State (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 (string) --
      
      Provided if State is DISABLED . Provides context as to why the resource is disabled.

ListMicrosoftTeamsConfiguredTeams (updated)

Link ¶
Changes (response)

{'ConfiguredTeams': {'State': 'string', 'StateReason': 'string'}}

Lists all authorized Microsoft Teams for an AWS Account

See also: AWS API Documentation

Request Syntax

client.list_microsoft_teams_configured_teams(
    MaxResults=123,
    NextToken='string'
)

type MaxResults

integer

param MaxResults

type NextToken

string

param NextToken

rtype

dict

returns

Response Syntax

{
    'ConfiguredTeams': [
        {
            'TenantId': 'string',
            'TeamId': 'string',
            'TeamName': 'string',
            'State': 'string',
            'StateReason': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ConfiguredTeams (list) --
  
  A list of teams in Microsoft Teams that are configured with AWS Chatbot.
  - (dict) --
    
    A Microsoft Teams team that is authorized with AWS Chatbot.
    - TenantId (string) --
      
      The ID of the Microsoft Teams tenant.
    - TeamId (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 (string) --
      
      The name of the Microsoft Teams Team.
    - State (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 (string) --
      
      Provided if State is DISABLED . Provides context as to why the resource is disabled.
- NextToken (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.

UpdateChimeWebhookConfiguration (updated)

Link ¶
Changes (response)

{'WebhookConfiguration': {'State': 'string', 'StateReason': 'string'}}

Updates a Amazon Chime webhook configuration.

See also: AWS API Documentation

Request Syntax

client.update_chime_webhook_configuration(
    ChatConfigurationArn='string',
    WebhookDescription='string',
    WebhookUrl='string',
    SnsTopicArns=[
        'string',
    ],
    IamRoleArn='string',
    LoggingLevel='string'
)

type ChatConfigurationArn

string

param ChatConfigurationArn

[REQUIRED]

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

type WebhookDescription

string

param WebhookDescription

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 .

type WebhookUrl

string

param WebhookUrl

The URL for the Amazon Chime webhook.

type SnsTopicArns

list

param SnsTopicArns

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

(string) --

type IamRoleArn

string

param IamRoleArn

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 .

type LoggingLevel

string

param LoggingLevel

Logging levels include ERROR , INFO , or NONE .

rtype

dict

returns

Response Syntax

{
    'WebhookConfiguration': {
        'WebhookDescription': 'string',
        'ChatConfigurationArn': 'string',
        'IamRoleArn': 'string',
        'SnsTopicArns': [
            'string',
        ],
        'ConfigurationName': 'string',
        'LoggingLevel': 'string',
        'Tags': [
            {
                'TagKey': 'string',
                'TagValue': 'string'
            },
        ],
        'State': 'string',
        'StateReason': 'string'
    }
}

Response Structure

(dict) --
- WebhookConfiguration (dict) --
  
  A Amazon Chime webhook configuration.
  - WebhookDescription (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 .
  - ChatConfigurationArn (string) --
    
    The Amazon Resource Number (ARN) of the ChimeWebhookConfiguration.
  - IamRoleArn (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 .
  - SnsTopicArns (list) --
    
    The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
    - (string) --
  - ConfigurationName (string) --
    
    The name of the configuration.
  - LoggingLevel (string) --
    
    Logging levels include ERROR , INFO , or NONE .
  - Tags (list) --
    
    A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
    - (dict) --
      
      A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
      
      Warning
      
      Do not include confidential or sensitive information in this field.
      
      For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide .
      - TagKey (string) --
        
        The key of the tag.
      - TagValue (string) --
        
        The value of the tag.
  - State (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 (string) --
    
    Provided if State is DISABLED . Provides context as to why the resource is disabled.

UpdateMicrosoftTeamsChannelConfiguration (updated)

Link ¶
Changes (response)

{'ChannelConfiguration': {'State': 'string', 'StateReason': 'string'}}

Updates an Microsoft Teams channel configuration.

See also: AWS API Documentation

Request Syntax

client.update_microsoft_teams_channel_configuration(
    ChatConfigurationArn='string',
    ChannelId='string',
    ChannelName='string',
    SnsTopicArns=[
        'string',
    ],
    IamRoleArn='string',
    LoggingLevel='string',
    GuardrailPolicyArns=[
        'string',
    ],
    UserAuthorizationRequired=True|False
)

type ChatConfigurationArn

string

param ChatConfigurationArn

[REQUIRED]

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

type ChannelId

string

param ChannelId

[REQUIRED]

The ID of the Microsoft Teams channel.

type ChannelName

string

param ChannelName

The name of the Microsoft Teams channel.

type SnsTopicArns

list

param SnsTopicArns

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

(string) --

type IamRoleArn

string

param IamRoleArn

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 .

type LoggingLevel

string

param LoggingLevel

Logging levels include ERROR , INFO , or NONE .

type GuardrailPolicyArns

list

param GuardrailPolicyArns

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.

(string) --

type UserAuthorizationRequired

boolean

param UserAuthorizationRequired

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

rtype

dict

returns

Response Syntax

{
    'ChannelConfiguration': {
        'ChannelId': 'string',
        'ChannelName': 'string',
        'TeamId': 'string',
        'TeamName': 'string',
        'TenantId': 'string',
        'ChatConfigurationArn': 'string',
        'IamRoleArn': 'string',
        'SnsTopicArns': [
            'string',
        ],
        'ConfigurationName': 'string',
        'LoggingLevel': 'string',
        'GuardrailPolicyArns': [
            'string',
        ],
        'UserAuthorizationRequired': True|False,
        'Tags': [
            {
                'TagKey': 'string',
                'TagValue': 'string'
            },
        ],
        'State': 'string',
        'StateReason': 'string'
    }
}

Response Structure

(dict) --
- ChannelConfiguration (dict) --
  
  The configuration for a Microsoft Teams channel configured with AWS Chatbot.
  - ChannelId (string) --
    
    The ID of the Microsoft Teams channel.
  - ChannelName (string) --
    
    The name of the Microsoft Teams channel.
  - TeamId (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 (string) --
    
    The name of the Microsoft Teams Team.
  - TenantId (string) --
    
    The ID of the Microsoft Teams tenant.
  - ChatConfigurationArn (string) --
    
    The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.
  - IamRoleArn (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 .
  - SnsTopicArns (list) --
    
    The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
    - (string) --
  - ConfigurationName (string) --
    
    The name of the configuration.
  - LoggingLevel (string) --
    
    Logging levels include ERROR , INFO , or NONE .
  - GuardrailPolicyArns (list) --
    
    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.
    - (string) --
  - UserAuthorizationRequired (boolean) --
    
    Enables use of a user role requirement in your chat configuration.
  - Tags (list) --
    
    A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
    - (dict) --
      
      A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
      
      Warning
      
      Do not include confidential or sensitive information in this field.
      
      For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide .
      - TagKey (string) --
        
        The key of the tag.
      - TagValue (string) --
        
        The value of the tag.
  - State (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 (string) --
    
    Provided if State is DISABLED . Provides context as to why the resource is disabled.

UpdateSlackChannelConfiguration (updated)

Link ¶
Changes (response)

{'ChannelConfiguration': {'State': 'string', 'StateReason': 'string'}}

Updates a Slack channel configuration.

See also: AWS API Documentation

Request Syntax

client.update_slack_channel_configuration(
    ChatConfigurationArn='string',
    SlackChannelId='string',
    SlackChannelName='string',
    SnsTopicArns=[
        'string',
    ],
    IamRoleArn='string',
    LoggingLevel='string',
    GuardrailPolicyArns=[
        'string',
    ],
    UserAuthorizationRequired=True|False
)

type ChatConfigurationArn

string

param ChatConfigurationArn

[REQUIRED]

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

type SlackChannelId

string

param SlackChannelId

[REQUIRED]

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.

type SlackChannelName

string

param SlackChannelName

The name of the Slack channel.

type SnsTopicArns

list

param SnsTopicArns

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

(string) --

type IamRoleArn

string

param IamRoleArn

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 .

type LoggingLevel

string

param LoggingLevel

Logging levels include ERROR , INFO , or NONE .

type GuardrailPolicyArns

list

param GuardrailPolicyArns

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.

(string) --

type UserAuthorizationRequired

boolean

param UserAuthorizationRequired

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

rtype

dict

returns

Response Syntax

{
    'ChannelConfiguration': {
        'SlackTeamName': 'string',
        'SlackTeamId': 'string',
        'SlackChannelId': 'string',
        'SlackChannelName': 'string',
        'ChatConfigurationArn': 'string',
        'IamRoleArn': 'string',
        'SnsTopicArns': [
            'string',
        ],
        'ConfigurationName': 'string',
        'LoggingLevel': 'string',
        'GuardrailPolicyArns': [
            'string',
        ],
        'UserAuthorizationRequired': True|False,
        'Tags': [
            {
                'TagKey': 'string',
                'TagValue': 'string'
            },
        ],
        'State': 'string',
        'StateReason': 'string'
    }
}

Response Structure

(dict) --
- ChannelConfiguration (dict) --
  
  The configuration for a Slack channel configured with AWS Chatbot.
  - SlackTeamName (string) --
    
    Name of the Slack workspace.
  - SlackTeamId (string) --
    
    The ID of the Slack workspace authorized with Amazon Chime.
  - SlackChannelId (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 (string) --
    
    The name of the Slack channel.
  - ChatConfigurationArn (string) --
    
    The Amazon Resource Number (ARN) of the SlackChannelConfiguration.
  - IamRoleArn (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 .
  - SnsTopicArns (list) --
    
    The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
    - (string) --
  - ConfigurationName (string) --
    
    The name of the configuration.
  - LoggingLevel (string) --
    
    Logging levels include ERROR , INFO , or NONE .
  - GuardrailPolicyArns (list) --
    
    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.
    - (string) --
  - UserAuthorizationRequired (boolean) --
    
    Enables use of a user role requirement in your chat configuration.
  - Tags (list) --
    
    A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
    - (dict) --
      
      A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
      
      Warning
      
      Do not include confidential or sensitive information in this field.
      
      For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide .
      - TagKey (string) --
        
        The key of the tag.
      - TagValue (string) --
        
        The value of the tag.
  - State (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 (string) --
    
    Provided if State is DISABLED . Provides context as to why the resource is disabled.