Kafka / Client / batch_disassociate_scram_secret

batch_disassociate_scram_secret#

Kafka.Client.batch_disassociate_scram_secret(**kwargs)#

Disassociates one or more Scram Secrets from an Amazon MSK cluster.

See also: AWS API Documentation

Request Syntax

response = client.batch_disassociate_scram_secret(
    ClusterArn='string',
    SecretArnList=[
        'string',
    ]
)
Parameters:
  • ClusterArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the cluster to be updated.

  • SecretArnList (list) –

    [REQUIRED]

    List of AWS Secrets Manager secret ARNs.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ClusterArn': 'string',
    'UnprocessedScramSecrets': [
        {
            'ErrorCode': 'string',
            'ErrorMessage': 'string',
            'SecretArn': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    200 response

    • ClusterArn (string) –

      The Amazon Resource Name (ARN) of the cluster.

    • UnprocessedScramSecrets (list) –

      List of errors when disassociating secrets to cluster.

      • (dict) –

        Error info for scram secret associate/disassociate failure.

        • ErrorCode (string) –

          Error code for associate/disassociate failure.

        • ErrorMessage (string) –

          Error message for associate/disassociate failure.

        • SecretArn (string) –

          AWS Secrets Manager secret ARN.

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