Skip to content

RestoreRequest

Source code in docs_src/capo_s3/types/restore_request.py
class RestoreRequest(TypedDict, closed=True):
    days: NotRequired["capo_s3.types.days.Days"]
    """<p>Lifetime of the active copy in days. Do not use with restores that specify <code>OutputLocation</code>.</p> <p>The Days element is required for regular restores, and must not be provided for select requests.</p>"""
    glacier_job_parameters: NotRequired[
        "capo_s3.types.glacier_job_parameters.GlacierJobParameters"
    ]
    """<p>S3 Glacier related parameters pertaining to this job. Do not use with restores that specify <code>OutputLocation</code>.</p>"""
    type: NotRequired["capo_s3.types.restore_request_type.RestoreRequestType"]
    """<important> <p>Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">Learn more</a> </p> </important> <p>Type of restore request.</p>"""
    tier: NotRequired["capo_s3.types.tier.Tier"]
    """<p>Retrieval tier at which the restore will be processed.</p>"""
    description: NotRequired["capo_s3.types.description.Description"]
    """<p>The optional description for the job.</p>"""
    select_parameters: NotRequired["capo_s3.types.select_parameters.SelectParameters"]
    """<important> <p>Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">Learn more</a> </p> </important> <p>Describes the parameters for Select job types.</p>"""
    output_location: NotRequired["capo_s3.types.output_location.OutputLocation"]
    """<p>Describes the location where the restore job's output is stored.</p>"""

days instance-attribute

days: NotRequired[Days]

Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

The Days element is required for regular restores, and must not be provided for select requests.

description instance-attribute

description: NotRequired[Description]

The optional description for the job.

glacier_job_parameters instance-attribute

glacier_job_parameters: NotRequired[GlacierJobParameters]

S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

output_location instance-attribute

output_location: NotRequired[OutputLocation]

Describes the location where the restore job's output is stored.

select_parameters instance-attribute

select_parameters: NotRequired[SelectParameters]

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more

Describes the parameters for Select job types.

tier instance-attribute

tier: NotRequired[Tier]

Retrieval tier at which the restore will be processed.

type instance-attribute

type: NotRequired[RestoreRequestType]

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more

Type of restore request.