get_distribution_configuration ¶

get_distribution_configuration(
    distribution_configuration_arn: DistributionConfigurationArn,
    *,
    config_overrides: Optional[imagebuilderClientConfig] = None,
) -> GetDistributionConfigurationResponse

Retrieves a distribution configuration.

Parameters:

distribution_configuration_arn (DistributionConfigurationArn) –

The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.

Raises:

CallRateLimitExceededException –

You have exceeded the permitted request rate for the Amazon EC2 APIs that Image Builder calls on your behalf. Retry with an increasing or variable delay between requests.
ClientException –

A generic client error. This error usually indicates that the request failed a validation check, such as when a downstream service rejects a configured value.
ForbiddenException –

You are not authorized to perform the requested operation.
InvalidRequestException –

The request is malformed or otherwise invalid. Verify the request and try again.
ServiceException –

An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
ServiceUnavailableException –

The service is unable to process your request at this time.
UnknownServiceError –

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

Examples:

Get the details of a distribution configuration The following example retrieves a distribution configuration that distributes the output AMI to two Regions.

>>> client.get_distribution_configuration(distribution_configuration_arn='arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution')

Source code in docs_src/capo_imagebuilder/_services/imagebuilder.py

def get_distribution_configuration(
    self,
    distribution_configuration_arn: "capo_imagebuilder.types.distribution_configuration_arn.DistributionConfigurationArn",
    *,
    config_overrides: Optional[imagebuilderClientConfig] = None,
) -> "capo_imagebuilder.types.get_distribution_configuration_response.GetDistributionConfigurationResponse":
    """<p>Retrieves a distribution configuration.</p>

    Args:
        distribution_configuration_arn: <p>The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.</p>

    Raises:
        capo_imagebuilder.errors.call_rate_limit_exceeded_exception.CallRateLimitExceededException: <p>You have exceeded the permitted request rate for the Amazon EC2 APIs that Image Builder calls on your behalf. Retry with an increasing or variable delay between requests.</p>
        capo_imagebuilder.errors.client_exception.ClientException: <p>A generic client error. This error usually indicates that the request failed a validation check, such as when a downstream service rejects a configured value.</p>
        capo_imagebuilder.errors.forbidden_exception.ForbiddenException: <p>You are not authorized to perform the requested operation.</p>
        capo_imagebuilder.errors.invalid_request_exception.InvalidRequestException: <p>The request is malformed or otherwise invalid. Verify the request and try again.</p>
        capo_imagebuilder.errors.service_exception.ServiceException: <p>An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.</p>
        capo_imagebuilder.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is unable to process your request at this time.</p>
        capo_imagebuilder.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Get the details of a distribution configuration
        The following example retrieves a distribution configuration that distributes the output AMI to two Regions.

        >>> client.get_distribution_configuration(distribution_configuration_arn='arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution')
    """

    def _handler(
        req: "OperationRequest[capo_imagebuilder.types.get_distribution_configuration_request.GetDistributionConfigurationRequest]",
    ) -> OperationResponse[
        "capo_imagebuilder.types.get_distribution_configuration_response.GetDistributionConfigurationResponse"
    ]:
        import capo_imagebuilder._operations.imagebuilder.get_distribution_configuration

        output, http_response = (
            capo_imagebuilder._operations.imagebuilder.get_distribution_configuration.get_distribution_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDistributionConfiguration")
    )
    input_: capo_imagebuilder.types.get_distribution_configuration_request.GetDistributionConfigurationRequest = {
        "distribution_configuration_arn": distribution_configuration_arn
    }

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