Chatbot / Paginator / DescribeSlackWorkspaces

DescribeSlackWorkspaces#

class Chatbot.Paginator.DescribeSlackWorkspaces#

paginator = client.get_paginator('describe_slack_workspaces')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from Chatbot.Client.describe_slack_workspaces().

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

MaxItems (integer) –

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
PageSize (integer) –

The size of each page.
StartingToken (string) –

A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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