QuickSight / Client / describe_key_registration

describe_key_registration#

QuickSight.Client.describe_key_registration(**kwargs)#

Describes all customer managed key registrations in a Amazon QuickSight account.

See also: AWS API Documentation

Request Syntax

response = client.describe_key_registration(
    AwsAccountId='string',
    DefaultKeyOnly=True|False
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.

  • DefaultKeyOnly (boolean) – Determines whether the request returns the default key only.

Return type:

dict

Returns:

Response Syntax

{
    'AwsAccountId': 'string',
    'KeyRegistration': [
        {
            'KeyArn': 'string',
            'DefaultKey': True|False
        },
    ],
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) –

    • AwsAccountId (string) –

      The ID of the Amazon Web Services account that contains the customer managed key registration specified in the request.

    • KeyRegistration (list) –

      A list of RegisteredCustomerManagedKey objects in a Amazon QuickSight account.

      • (dict) –

        A customer managed key structure that contains the information listed below:

        • KeyArn - The ARN of a KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.

        • DefaultKey - Indicates whether the current key is set as the default key for encryption and decryption use.

        • KeyArn (string) –

          The ARN of the KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.

        • DefaultKey (boolean) –

          Indicates whether a RegisteredCustomerManagedKey is set as the default key for encryption and decryption use.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.InternalFailureException