Skip to content

describe_snapshot_tier_status async

describe_snapshot_tier_status(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    filters: Optional[FilterList] = None,
    dry_run: Optional[Boolean] = None,
    next_token: Optional[String] = None,
    max_results: Optional[DescribeSnapshotTierStatusMaxResults] = None,
) -> DescribeSnapshotTierStatusResult

Describes the storage tier status of one or more Amazon EBS snapshots.

Parameters:

  • filters (Optional[FilterList], default: None ) –

    The filters.

    • snapshot-id - The snapshot ID.

    • volume-id - The ID of the volume the snapshot is for.

    • last-tiering-operation - The state of the last archive or restore action. (archival-in-progress | archival-completed | archival-failed | permanent-restore-in-progress | permanent-restore-completed | permanent-restore-failed | temporary-restore-in-progress | temporary-restore-completed | temporary-restore-failed)

  • dry_run (Optional[Boolean], default: None ) –

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • next_token (Optional[String], default: None ) –

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • max_results (Optional[DescribeSnapshotTierStatusMaxResults], default: None ) –

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def describe_snapshot_tier_status(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    max_results: Optional[
        "capo_ec2.types.describe_snapshot_tier_status_max_results.DescribeSnapshotTierStatusMaxResults"
    ] = None,
) -> "capo_ec2.types.describe_snapshot_tier_status_result.DescribeSnapshotTierStatusResult":
    """<p>Describes the storage tier status of one or more Amazon EBS snapshots.</p>

    Args:
        filters: <p>The filters.</p> <ul> <li> <p> <code>snapshot-id</code> - The snapshot ID.</p> </li> <li> <p> <code>volume-id</code> - The ID of the volume the snapshot is for.</p> </li> <li> <p> <code>last-tiering-operation</code> - The state of the last archive or restore action. (<code>archival-in-progress</code> | <code>archival-completed</code> | <code>archival-failed</code> | <code>permanent-restore-in-progress</code> | <code>permanent-restore-completed</code> | <code>permanent-restore-failed</code> | <code>temporary-restore-in-progress</code> | <code>temporary-restore-completed</code> | <code>temporary-restore-failed</code>)</p> </li> </ul>
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        next_token: <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
        max_results: <p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.describe_snapshot_tier_status_request.DescribeSnapshotTierStatusRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_snapshot_tier_status_result.DescribeSnapshotTierStatusResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_snapshot_tier_status

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.describe_snapshot_tier_status.async_describe_snapshot_tier_status(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeSnapshotTierStatus")
    )
    input_: capo_ec2.types.describe_snapshot_tier_status_request.DescribeSnapshotTierStatusRequest = {}
    if filters is not None:
        input_["filters"] = filters
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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