Kafka / Client / list_scram_secrets

list_scram_secrets#

Kafka.Client.list_scram_secrets(**kwargs)#

Returns a list of the Scram Secrets associated with an Amazon MSK cluster.

See also: AWS API Documentation

Request Syntax

response = client.list_scram_secrets(
    ClusterArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:
  • ClusterArn (string) –

    [REQUIRED]

    The arn of the cluster.

  • MaxResults (integer) – The maxResults of the query.

  • NextToken (string) – The nextToken of the query.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'SecretArnList': [
        'string',
    ]
}

Response Structure

  • (dict) –

    200 response

    • NextToken (string) –

      Paginated results marker.

    • SecretArnList (list) –

      The list of scram secrets associated with the cluster.

      • (string) –

Exceptions

  • Kafka.Client.exceptions.BadRequestException

  • Kafka.Client.exceptions.UnauthorizedException

  • Kafka.Client.exceptions.InternalServerErrorException

  • Kafka.Client.exceptions.ForbiddenException

  • Kafka.Client.exceptions.NotFoundException

  • Kafka.Client.exceptions.ServiceUnavailableException

  • Kafka.Client.exceptions.TooManyRequestsException