Skip to content

GetBackupPlanOutput

Source code in docs_src/capo_backup/types/get_backup_plan_output.py
class GetBackupPlanOutput(TypedDict, closed=True):
    backup_plan: NotRequired["capo_backup.types.backup_plan.BackupPlan"]
    """<p>Specifies the body of a backup plan. Includes a <code>BackupPlanName</code> and one or more sets of <code>Rules</code>.</p>"""
    backup_plan_id: NotRequired["capo_backup.types.string.string"]
    """<p>Uniquely identifies a backup plan.</p>"""
    backup_plan_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, <code>arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50</code>.</p>"""
    version_id: NotRequired["capo_backup.types.string.string"]
    """<p>Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.</p>"""
    creator_request_id: NotRequired["capo_backup.types.string.string"]
    """<p>A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. </p>"""
    creation_date: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    deletion_date: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of <code>DeletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    last_execution_date: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The last time this backup plan was run. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of <code>LastExecutionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    advanced_backup_settings: NotRequired[
        "capo_backup.types.advanced_backup_settings.AdvancedBackupSettings"
    ]
    """<p>Contains a list of <code>BackupOptions</code> for each resource type. The list is populated only if the advanced option is set for the backup plan.</p>"""
    scheduled_runs_preview: NotRequired[
        "capo_backup.types.scheduled_runs_preview.ScheduledRunsPreview"
    ]
    """<p>List of upcoming scheduled backup runs. Only included when <code>MaxScheduledRunsPreview</code> parameter is greater than 0. Contains up to 10 future backup executions with their scheduled times, execution types, and associated rule IDs.</p>"""

advanced_backup_settings instance-attribute

advanced_backup_settings: NotRequired[AdvancedBackupSettings]

Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.

backup_plan instance-attribute

backup_plan: NotRequired[BackupPlan]

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

backup_plan_arn instance-attribute

backup_plan_arn: NotRequired[ARN]

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

backup_plan_id instance-attribute

backup_plan_id: NotRequired[string]

Uniquely identifies a backup plan.

creation_date instance-attribute

creation_date: NotRequired[timestamp]

The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

creator_request_id instance-attribute

creator_request_id: NotRequired[string]

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

deletion_date instance-attribute

deletion_date: NotRequired[timestamp]

The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

last_execution_date instance-attribute

last_execution_date: NotRequired[timestamp]

The last time this backup plan was run. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

scheduled_runs_preview instance-attribute

scheduled_runs_preview: NotRequired[ScheduledRunsPreview]

List of upcoming scheduled backup runs. Only included when MaxScheduledRunsPreview parameter is greater than 0. Contains up to 10 future backup executions with their scheduled times, execution types, and associated rule IDs.

version_id instance-attribute

version_id: NotRequired[string]

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.