Chatbot / Client / describe_slack_workspaces

describe_slack_workspaces#

Chatbot.Client.describe_slack_workspaces(**kwargs)#

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

Request Syntax

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

Parameters:

MaxResults (integer) – The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
NextToken (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.

Return type:

dict

Returns:

Response Syntax

{
    'SlackWorkspaces': [
        {
            'SlackTeamId': 'string',
            'SlackTeamName': '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.
- 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.

Exceptions

Chatbot.Client.exceptions.InvalidParameterException
Chatbot.Client.exceptions.DescribeSlackWorkspacesException
Chatbot.Client.exceptions.InvalidRequestException