Skip to content

get_lifecycle_policy async

get_lifecycle_policy(
    lifecycle_policy_arn: LifecyclePolicyArn,
    *,
    config_overrides: Optional[AsyncimagebuilderClientConfig] = None,
) -> GetLifecyclePolicyResponse

Retrieves details for the specified image lifecycle policy.

Parameters:

  • lifecycle_policy_arn (LifecyclePolicyArn) –

    Specifies the Amazon Resource Name (ARN) of the image lifecycle policy resource to get.

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 lifecycle policy The following example retrieves the full definition of the specified lifecycle policy.

>>> await client.get_lifecycle_policy(lifecycle_policy_arn='arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-lifecycle-policy')
Source code in docs_src/capo_imagebuilder/_services/async_imagebuilder.py
async def get_lifecycle_policy(
    self,
    lifecycle_policy_arn: "capo_imagebuilder.types.lifecycle_policy_arn.LifecyclePolicyArn",
    *,
    config_overrides: Optional[AsyncimagebuilderClientConfig] = None,
) -> "capo_imagebuilder.types.get_lifecycle_policy_response.GetLifecyclePolicyResponse":
    """<p>Retrieves details for the specified image lifecycle policy.</p>

    Args:
        lifecycle_policy_arn: <p>Specifies the Amazon Resource Name (ARN) of the image lifecycle policy resource to get.</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 lifecycle policy
        The following example retrieves the full definition of the specified lifecycle policy.

        >>> await client.get_lifecycle_policy(lifecycle_policy_arn='arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-lifecycle-policy')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_imagebuilder.types.get_lifecycle_policy_request.GetLifecyclePolicyRequest]",
    ) -> AsyncOperationResponse[
        "capo_imagebuilder.types.get_lifecycle_policy_response.GetLifecyclePolicyResponse"
    ]:
        import capo_imagebuilder._operations.imagebuilder.get_lifecycle_policy

        (
            output,
            http_response,
        ) = await capo_imagebuilder._operations.imagebuilder.get_lifecycle_policy.async_get_lifecycle_policy(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetLifecyclePolicy")
    )
    input_: capo_imagebuilder.types.get_lifecycle_policy_request.GetLifecyclePolicyRequest = {
        "lifecycle_policy_arn": lifecycle_policy_arn
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output