Skip to content

get_lifecycle_policies async

get_lifecycle_policies(
    *,
    config_overrides: Optional[AsyncDLMClientConfig] = None,
    policy_ids: Optional[PolicyIdList] = None,
    state: Optional[GettablePolicyStateValues] = None,
    resource_types: Optional[ResourceTypeValuesList] = None,
    target_tags: Optional[TargetTagsFilterList] = None,
    tags_to_add: Optional[TagsToAddFilterList] = None,
    default_policy_type: Optional[DefaultPoliciesTypeValues] = None,
) -> GetLifecyclePoliciesResponse

Gets summary information about all or the specified data lifecycle policies.

To get complete information about a policy, use GetLifecyclePolicy.

Parameters:

  • policy_ids (Optional[PolicyIdList], default: None ) –

    The identifiers of the data lifecycle policies.

  • state (Optional[GettablePolicyStateValues], default: None ) –

    The activation state.

  • resource_types (Optional[ResourceTypeValuesList], default: None ) –

    The resource type.

  • target_tags (Optional[TargetTagsFilterList], default: None ) –

    The target tag for a policy.

    Tags are strings in the format key=value.

  • tags_to_add (Optional[TagsToAddFilterList], default: None ) –

    The tags to add to objects created by the policy.

    Tags are strings in the format key=value.

    These user-defined tags are added in addition to the Amazon Web Services-added lifecycle tags.

  • default_policy_type (Optional[DefaultPoliciesTypeValues], default: None ) –

    [Default policies only] Specifies the type of default policy to get. Specify one of the following:

    • VOLUME - To get only the default policy for EBS snapshots

    • INSTANCE - To get only the default policy for EBS-backed AMIs

    • ALL - To get all default policies

Raises:

Source code in docs_src/capo_dlm/_services/async_dlm.py
async def get_lifecycle_policies(
    self,
    *,
    config_overrides: Optional[AsyncDLMClientConfig] = None,
    policy_ids: Optional["capo_dlm.types.policy_id_list.PolicyIdList"] = None,
    state: Optional[
        "capo_dlm.types.gettable_policy_state_values.GettablePolicyStateValues"
    ] = None,
    resource_types: Optional[
        "capo_dlm.types.resource_type_values_list.ResourceTypeValuesList"
    ] = None,
    target_tags: Optional[
        "capo_dlm.types.target_tags_filter_list.TargetTagsFilterList"
    ] = None,
    tags_to_add: Optional[
        "capo_dlm.types.tags_to_add_filter_list.TagsToAddFilterList"
    ] = None,
    default_policy_type: Optional[
        "capo_dlm.types.default_policies_type_values.DefaultPoliciesTypeValues"
    ] = None,
) -> "capo_dlm.types.get_lifecycle_policies_response.GetLifecyclePoliciesResponse":
    """<p>Gets summary information about all or the specified data lifecycle policies.</p> <p>To get complete information about a policy, use <a href="https://docs.aws.amazon.com/dlm/latest/APIReference/API_GetLifecyclePolicy.html">GetLifecyclePolicy</a>.</p>

    Args:
        policy_ids: <p>The identifiers of the data lifecycle policies.</p>
        state: <p>The activation state.</p>
        resource_types: <p>The resource type.</p>
        target_tags: <p>The target tag for a policy.</p> <p>Tags are strings in the format <code>key=value</code>.</p>
        tags_to_add: <p>The tags to add to objects created by the policy.</p> <p>Tags are strings in the format <code>key=value</code>.</p> <p>These user-defined tags are added in addition to the Amazon Web Services-added lifecycle tags.</p>
        default_policy_type: <p> <b>[Default policies only]</b> Specifies the type of default policy to get. Specify one of the following:</p> <ul> <li> <p> <code>VOLUME</code> - To get only the default policy for EBS snapshots</p> </li> <li> <p> <code>INSTANCE</code> - To get only the default policy for EBS-backed AMIs</p> </li> <li> <p> <code>ALL</code> - To get all default policies</p> </li> </ul>

    Raises:
        capo_dlm.errors.internal_server_exception.InternalServerException: <p>The service failed in an unexpected way.</p>
        capo_dlm.errors.invalid_request_exception.InvalidRequestException: <p>Bad request. The request is missing required parameters or has invalid parameters.</p>
        capo_dlm.errors.limit_exceeded_exception.LimitExceededException: <p>The request failed because a limit was exceeded.</p>
        capo_dlm.errors.resource_not_found_exception.ResourceNotFoundException: <p>A requested resource was not found.</p>
        capo_dlm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_dlm.types.get_lifecycle_policies_request.GetLifecyclePoliciesRequest]",
    ) -> AsyncOperationResponse[
        "capo_dlm.types.get_lifecycle_policies_response.GetLifecyclePoliciesResponse"
    ]:
        import capo_dlm._operations.dlm_20180112.get_lifecycle_policies

        (
            output,
            http_response,
        ) = await capo_dlm._operations.dlm_20180112.get_lifecycle_policies.async_get_lifecycle_policies(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetLifecyclePolicies")
    )
    input_: capo_dlm.types.get_lifecycle_policies_request.GetLifecyclePoliciesRequest = {}
    if policy_ids is not None:
        input_["policy_ids"] = policy_ids
    if state is not None:
        input_["state"] = state
    if resource_types is not None:
        input_["resource_types"] = resource_types
    if target_tags is not None:
        input_["target_tags"] = target_tags
    if tags_to_add is not None:
        input_["tags_to_add"] = tags_to_add
    if default_policy_type is not None:
        input_["default_policy_type"] = default_policy_type

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