describe_key_registration ¶

describe_key_registration(
    aws_account_id: AwsAccountId,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    default_key_only: Optional[Boolean] = None,
) -> DescribeKeyRegistrationResponse

Describes all customer managed key registrations in a Quick Sight account.

Parameters:

aws_account_id (AwsAccountId) –

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.
default_key_only (Optional[Boolean], default: None ) –

Determines whether the request returns the default key only.

Raises:

AccessDeniedException –

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
InternalFailureException –

An internal failure occurred.
InvalidParameterValueException –

One or more parameters has a value that isn't valid.
ThrottlingException –

Access is throttled.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_quicksight/_services/quick_sight.py

def describe_key_registration(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    default_key_only: Optional["capo_quicksight.types.boolean.Boolean"] = None,
) -> "capo_quicksight.types.describe_key_registration_response.DescribeKeyRegistrationResponse":
    """<p>Describes all customer managed key registrations in a Quick Sight account.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.</p>
        default_key_only: <p>Determines whether the request returns the default key only.</p>

    Raises:
        capo_quicksight.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more parameters has a value that isn't valid.</p>
        capo_quicksight.errors.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.describe_key_registration_request.DescribeKeyRegistrationRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.describe_key_registration_response.DescribeKeyRegistrationResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_key_registration

        output, http_response = (
            capo_quicksight._operations.quick_sight_20180401.describe_key_registration.describe_key_registration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeKeyRegistration")
    )
    input_: capo_quicksight.types.describe_key_registration_request.DescribeKeyRegistrationRequest = {
        "aws_account_id": aws_account_id
    }
    if default_key_only is not None:
        input_["default_key_only"] = default_key_only

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output