chatbot / Client / describe_slack_user_identities

describe_slack_user_identities#

chatbot.Client.describe_slack_user_identities(**kwargs)#

Lists all Slack user identities with a mapped role.

See also: AWS API Documentation

Request Syntax

response = client.describe_slack_user_identities(
    ChatConfigurationArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • ChatConfigurationArn (string) – The ARN of the SlackChannelConfiguration associated with the user identities to describe.

  • 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.

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'SlackUserIdentities': [
        {
            'IamRoleArn': 'string',
            'ChatConfigurationArn': 'string',
            'SlackTeamId': 'string',
            'SlackUserId': 'string',
            'AwsUserIdentity': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • SlackUserIdentities (list) – A list of Slack User Identities.

      • (dict) – Identifes a User level permission for a channel configuration.

        • IamRoleArn (string) – The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.

        • ChatConfigurationArn (string) – The ARN of the SlackChannelConfiguration associated with the user identity.

        • SlackTeamId (string) – The ID of the Slack workspace authorized with AWS Chatbot.

        • SlackUserId (string) – The ID of the user in Slack.

        • AwsUserIdentity (string) – The AWS user identity ARN used to associate a Slack User Identity with an IAM Role.

    • 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.InvalidRequestException

  • chatbot.Client.exceptions.DescribeSlackUserIdentitiesException