AWS Backup

2023/11/14 - AWS Backup - 3 new 4 updated api methods

Changes  AWS Backup - Features: Provide Job Summary for your backup activity.

ListBackupJobSummaries (new) Link ¶

This is a request for a summary of backup jobs created or running within the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.

This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

See also: AWS API Documentation

Request Syntax

client.list_backup_job_summaries(
    AccountId='string',
    State='CREATED'|'PENDING'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETED'|'FAILED'|'EXPIRED'|'PARTIAL'|'AGGREGATE_ALL'|'ANY',
    ResourceType='string',
    MessageCategory='string',
    AggregationPeriod='ONE_DAY'|'SEVEN_DAYS'|'FOURTEEN_DAYS',
    MaxResults=123,
    NextToken='string'
)
type AccountId

string

param AccountId

Returns the job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

type State

string

param State

This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

type ResourceType

string

param ResourceType

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

type MessageCategory

string

param MessageCategory

This parameter returns the job count for the specified message category.

Example accepted strings include AccessDenied , Success , and InvalidParameters . See Monitoring for a list of accepted MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

type AggregationPeriod

string

param AggregationPeriod

This is the period that sets the boundaries for returned results.

Acceptable values include

  • ONE_DAY for daily job count for the prior 14 days.

  • SEVEN_DAYS for the aggregated job count for the prior 7 days.

  • FOURTEEN_DAYS for aggregated job count for prior 14 days.

type MaxResults

integer

param MaxResults

This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

type NextToken

string

param NextToken

The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

rtype

dict

returns

Response Syntax

{
    'BackupJobSummaries': [
        {
            'Region': 'string',
            'AccountId': 'string',
            'State': 'CREATED'|'PENDING'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETED'|'FAILED'|'EXPIRED'|'PARTIAL'|'AGGREGATE_ALL'|'ANY',
            'ResourceType': 'string',
            'MessageCategory': 'string',
            'Count': 123,
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
    ],
    'AggregationPeriod': 'string',
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • BackupJobSummaries (list) --

      This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

      • (dict) --

        This is a summary of jobs created or running within the most recent 30 days.

        The returned summary may contain the following: Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

        • Region (string) --

          The Amazon Web Services Regions within the job summary.

        • AccountId (string) --

          The account ID that owns the jobs within the summary.

        • State (string) --

          This value is job count for jobs with the specified state.

        • ResourceType (string) --

          This value is the job count for the specified resource type. The request GetSupportedResourceTypes returns strings for supported resource types.

        • MessageCategory (string) --

          This parameter is the job count for the specified message category.

          Example strings include AccessDenied , Success , and InvalidParameters . See Monitoring for a list of MessageCategory strings.

          The the value ANY returns count of all message categories.

          AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

        • Count (integer) --

          The value as a number of jobs in a job summary.

        • StartTime (datetime) --

          The value of time in number format of a job start time.

          This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • EndTime (datetime) --

          The value of time in number format of a job end time.

          This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • AggregationPeriod (string) --

      This is the period that sets the boundaries for returned results.

      • ONE_DAY for daily job count for the prior 14 days.

      • SEVEN_DAYS for the aggregated job count for the prior 7 days.

      • FOURTEEN_DAYS for aggregated job count for prior 14 days.

    • NextToken (string) --

      The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

ListCopyJobSummaries (new) Link ¶

This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.

This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

See also: AWS API Documentation

Request Syntax

client.list_copy_job_summaries(
    AccountId='string',
    State='CREATED'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED'|'PARTIAL'|'AGGREGATE_ALL'|'ANY',
    ResourceType='string',
    MessageCategory='string',
    AggregationPeriod='ONE_DAY'|'SEVEN_DAYS'|'FOURTEEN_DAYS',
    MaxResults=123,
    NextToken='string'
)
type AccountId

string

param AccountId

Returns the job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

type State

string

param State

This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

type ResourceType

string

param ResourceType

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

type MessageCategory

string

param MessageCategory

This parameter returns the job count for the specified message category.

Example accepted strings include AccessDenied , Success , and InvalidParameters . See Monitoring for a list of accepted MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

type AggregationPeriod

string

param AggregationPeriod

This is the period that sets the boundaries for returned results.

  • ONE_DAY for daily job count for the prior 14 days.

  • SEVEN_DAYS for the aggregated job count for the prior 7 days.

  • FOURTEEN_DAYS for aggregated job count for prior 14 days.

type MaxResults

integer

param MaxResults

This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

type NextToken

string

param NextToken

The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

rtype

dict

returns

Response Syntax

{
    'CopyJobSummaries': [
        {
            'Region': 'string',
            'AccountId': 'string',
            'State': 'CREATED'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED'|'PARTIAL'|'AGGREGATE_ALL'|'ANY',
            'ResourceType': 'string',
            'MessageCategory': 'string',
            'Count': 123,
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
    ],
    'AggregationPeriod': 'string',
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • CopyJobSummaries (list) --

      This return shows a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

      • (dict) --

        This is a summary of copy jobs created or running within the most recent 30 days.

        The returned summary may contain the following: Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

        • Region (string) --

          This is the Amazon Web Services Regions within the job summary.

        • AccountId (string) --

          The account ID that owns the jobs within the summary.

        • State (string) --

          This value is job count for jobs with the specified state.

        • ResourceType (string) --

          This value is the job count for the specified resource type. The request GetSupportedResourceTypes returns strings for supported resource types

        • MessageCategory (string) --

          This parameter is the job count for the specified message category.

          Example strings include AccessDenied , Success , and InvalidParameters . See Monitoring for a list of MessageCategory strings.

          The the value ANY returns count of all message categories.

          AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

        • Count (integer) --

          The value as a number of jobs in a job summary.

        • StartTime (datetime) --

          The value of time in number format of a job start time.

          This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • EndTime (datetime) --

          The value of time in number format of a job end time.

          This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • AggregationPeriod (string) --

      This is the period that sets the boundaries for returned results.

      • ONE_DAY for daily job count for the prior 14 days.

      • SEVEN_DAYS for the aggregated job count for the prior 7 days.

      • FOURTEEN_DAYS for aggregated job count for prior 14 days.

    • NextToken (string) --

      The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

ListRestoreJobSummaries (new) Link ¶

This request obtains a summary of restore jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results.

This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

See also: AWS API Documentation

Request Syntax

client.list_restore_job_summaries(
    AccountId='string',
    State='CREATED'|'PENDING'|'RUNNING'|'ABORTED'|'COMPLETED'|'FAILED'|'AGGREGATE_ALL'|'ANY',
    ResourceType='string',
    AggregationPeriod='ONE_DAY'|'SEVEN_DAYS'|'FOURTEEN_DAYS',
    MaxResults=123,
    NextToken='string'
)
type AccountId

string

param AccountId

Returns the job count for the specified account.

If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

type State

string

param State

This parameter returns the job count for jobs with the specified state.

The the value ANY returns count of all states.

AGGREGATE_ALL aggregates job counts for all states and returns the sum.

type ResourceType

string

param ResourceType

Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

The the value ANY returns count of all resource types.

AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

type AggregationPeriod

string

param AggregationPeriod

This is the period that sets the boundaries for returned results.

Acceptable values include

  • ONE_DAY for daily job count for the prior 14 days.

  • SEVEN_DAYS for the aggregated job count for the prior 7 days.

  • FOURTEEN_DAYS for aggregated job count for prior 14 days.

type MaxResults

integer

param MaxResults

This parameter sets the maximum number of items to be returned.

The value is an integer. Range of accepted values is from 1 to 500.

type NextToken

string

param NextToken

The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

rtype

dict

returns

Response Syntax

{
    'RestoreJobSummaries': [
        {
            'Region': 'string',
            'AccountId': 'string',
            'State': 'CREATED'|'PENDING'|'RUNNING'|'ABORTED'|'COMPLETED'|'FAILED'|'AGGREGATE_ALL'|'ANY',
            'ResourceType': 'string',
            'Count': 123,
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
    ],
    'AggregationPeriod': 'string',
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • RestoreJobSummaries (list) --

      This return contains a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

      • (dict) --

        This is a summary of restore jobs created or running within the most recent 30 days.

        The returned summary may contain the following: Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.

        • Region (string) --

          The Amazon Web Services Regions within the job summary.

        • AccountId (string) --

          The account ID that owns the jobs within the summary.

        • State (string) --

          This value is job count for jobs with the specified state.

        • ResourceType (string) --

          This value is the job count for the specified resource type. The request GetSupportedResourceTypes returns strings for supported resource types.

        • Count (integer) --

          The value as a number of jobs in a job summary.

        • StartTime (datetime) --

          The value of time in number format of a job start time.

          This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • EndTime (datetime) --

          The value of time in number format of a job end time.

          This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • AggregationPeriod (string) --

      This is the period that sets the boundaries for returned results.

      • ONE_DAY for daily job count for the prior 14 days.

      • SEVEN_DAYS for the aggregated job count for the prior 7 days.

      • FOURTEEN_DAYS for aggregated job count for prior 14 days.

    • NextToken (string) --

      The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

DescribeBackupJob (updated) Link ¶
Changes (response)
{'MessageCategory': 'string'}

Returns backup job details for the specified BackupJobId .

See also: AWS API Documentation

Request Syntax

client.describe_backup_job(
    BackupJobId='string'
)
type BackupJobId

string

param BackupJobId

[REQUIRED]

Uniquely identifies a request to Backup to back up a resource.

rtype

dict

returns

Response Syntax

{
    'AccountId': 'string',
    'BackupJobId': 'string',
    'BackupVaultName': 'string',
    'BackupVaultArn': 'string',
    'RecoveryPointArn': 'string',
    'ResourceArn': 'string',
    'CreationDate': datetime(2015, 1, 1),
    'CompletionDate': datetime(2015, 1, 1),
    'State': 'CREATED'|'PENDING'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETED'|'FAILED'|'EXPIRED'|'PARTIAL',
    'StatusMessage': 'string',
    'PercentDone': 'string',
    'BackupSizeInBytes': 123,
    'IamRoleArn': 'string',
    'CreatedBy': {
        'BackupPlanId': 'string',
        'BackupPlanArn': 'string',
        'BackupPlanVersion': 'string',
        'BackupRuleId': 'string'
    },
    'ResourceType': 'string',
    'BytesTransferred': 123,
    'ExpectedCompletionDate': datetime(2015, 1, 1),
    'StartBy': datetime(2015, 1, 1),
    'BackupOptions': {
        'string': 'string'
    },
    'BackupType': 'string',
    'ParentJobId': 'string',
    'IsParent': True|False,
    'NumberOfChildJobs': 123,
    'ChildJobsInState': {
        'string': 123
    },
    'ResourceName': 'string',
    'MessageCategory': 'string'
}

Response Structure

  • (dict) --

    • AccountId (string) --

      Returns the account ID that owns the backup job.

    • BackupJobId (string) --

      Uniquely identifies a request to Backup to back up a resource.

    • BackupVaultName (string) --

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • BackupVaultArn (string) --

      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .

    • RecoveryPointArn (string) --

      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .

    • ResourceArn (string) --

      An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

    • CreationDate (datetime) --

      The date and time that a backup job 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.

    • CompletionDate (datetime) --

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

    • State (string) --

      The current state of a backup job.

    • StatusMessage (string) --

      A detailed message explaining the status of the job to back up a resource.

    • PercentDone (string) --

      Contains an estimated percentage that is complete of a job at the time the job status was queried.

    • BackupSizeInBytes (integer) --

      The size, in bytes, of a backup.

    • IamRoleArn (string) --

      Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access .

    • CreatedBy (dict) --

      Contains identifying information about the creation of a backup job, including the BackupPlanArn , BackupPlanId , BackupPlanVersion , and BackupRuleId of the backup plan that is used to create it.

      • BackupPlanId (string) --

        Uniquely identifies a backup plan.

      • BackupPlanArn (string) --

        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 .

      • BackupPlanVersion (string) --

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

      • BackupRuleId (string) --

        Uniquely identifies a rule used to schedule the backup of a selection of resources.

    • ResourceType (string) --

      The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

    • BytesTransferred (integer) --

      The size in bytes transferred to a backup vault at the time that the job status was queried.

    • ExpectedCompletionDate (datetime) --

      The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • StartBy (datetime) --

      Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • BackupOptions (dict) --

      Represents the options specified as part of backup plan or on-demand backup job.

      • (string) --

        • (string) --

    • BackupType (string) --

      Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS" . If BackupType is empty, then the backup type was a regular backup.

    • ParentJobId (string) --

      This returns the parent (composite) resource backup job ID.

    • IsParent (boolean) --

      This returns the boolean value that a backup job is a parent (composite) job.

    • NumberOfChildJobs (integer) --

      This returns the number of child (nested) backup jobs.

    • ChildJobsInState (dict) --

      This returns the statistics of the included child (nested) backup jobs.

      • (string) --

        • (integer) --

    • ResourceName (string) --

      This is the non-unique name of the resource that belongs to the specified backup.

    • MessageCategory (string) --

      This is the job count for the specified message category.

      Example strings may include AccessDenied , Success , and InvalidParameters . See Monitoring for a list of MessageCategory strings.

DescribeCopyJob (updated) Link ¶
Changes (response)
{'CopyJob': {'MessageCategory': 'string'}}

Returns metadata associated with creating a copy of a resource.

See also: AWS API Documentation

Request Syntax

client.describe_copy_job(
    CopyJobId='string'
)
type CopyJobId

string

param CopyJobId

[REQUIRED]

Uniquely identifies a copy job.

rtype

dict

returns

Response Syntax

{
    'CopyJob': {
        'AccountId': 'string',
        'CopyJobId': 'string',
        'SourceBackupVaultArn': 'string',
        'SourceRecoveryPointArn': 'string',
        'DestinationBackupVaultArn': 'string',
        'DestinationRecoveryPointArn': 'string',
        'ResourceArn': 'string',
        'CreationDate': datetime(2015, 1, 1),
        'CompletionDate': datetime(2015, 1, 1),
        'State': 'CREATED'|'RUNNING'|'COMPLETED'|'FAILED'|'PARTIAL',
        'StatusMessage': 'string',
        'BackupSizeInBytes': 123,
        'IamRoleArn': 'string',
        'CreatedBy': {
            'BackupPlanId': 'string',
            'BackupPlanArn': 'string',
            'BackupPlanVersion': 'string',
            'BackupRuleId': 'string'
        },
        'ResourceType': 'string',
        'ParentJobId': 'string',
        'IsParent': True|False,
        'CompositeMemberIdentifier': 'string',
        'NumberOfChildJobs': 123,
        'ChildJobsInState': {
            'string': 123
        },
        'ResourceName': 'string',
        'MessageCategory': 'string'
    }
}

Response Structure

  • (dict) --

    • CopyJob (dict) --

      Contains detailed information about a copy job.

      • AccountId (string) --

        The account ID that owns the copy job.

      • CopyJobId (string) --

        Uniquely identifies a copy job.

      • SourceBackupVaultArn (string) --

        An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .

      • SourceRecoveryPointArn (string) --

        An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .

      • DestinationBackupVaultArn (string) --

        An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .

      • DestinationRecoveryPointArn (string) --

        An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .

      • ResourceArn (string) --

        The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

      • CreationDate (datetime) --

        The date and time a copy job 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.

      • CompletionDate (datetime) --

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

      • State (string) --

        The current state of a copy job.

      • StatusMessage (string) --

        A detailed message explaining the status of the job to copy a resource.

      • BackupSizeInBytes (integer) --

        The size, in bytes, of a copy job.

      • IamRoleArn (string) --

        Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access .

      • CreatedBy (dict) --

        Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.

        • BackupPlanId (string) --

          Uniquely identifies a backup plan.

        • BackupPlanArn (string) --

          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 .

        • BackupPlanVersion (string) --

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

        • BackupRuleId (string) --

          Uniquely identifies a rule used to schedule the backup of a selection of resources.

      • ResourceType (string) --

        The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

      • ParentJobId (string) --

        This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.

      • IsParent (boolean) --

        This is a boolean value indicating this is a parent (composite) copy job.

      • CompositeMemberIdentifier (string) --

        This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

      • NumberOfChildJobs (integer) --

        This is the number of child (nested) copy jobs.

      • ChildJobsInState (dict) --

        This returns the statistics of the included child (nested) copy jobs.

        • (string) --

          • (integer) --

      • ResourceName (string) --

        This is the non-unique name of the resource that belongs to the specified backup.

      • MessageCategory (string) --

        This parameter is the job count for the specified message category.

        Example strings include AccessDenied , Success , and InvalidParameters . See Monitoring for a list of MessageCategory strings.

        The the value ANY returns count of all message categories.

        AGGREGATE_ALL aggregates job counts for all message categories and returns the sum

ListBackupJobs (updated) Link ¶
Changes (request, response)
Request
{'ByMessageCategory': 'string'}
Response
{'BackupJobs': {'MessageCategory': 'string'}}

Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools .

See also: AWS API Documentation

Request Syntax

client.list_backup_jobs(
    NextToken='string',
    MaxResults=123,
    ByResourceArn='string',
    ByState='CREATED'|'PENDING'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETED'|'FAILED'|'EXPIRED'|'PARTIAL',
    ByBackupVaultName='string',
    ByCreatedBefore=datetime(2015, 1, 1),
    ByCreatedAfter=datetime(2015, 1, 1),
    ByResourceType='string',
    ByAccountId='string',
    ByCompleteAfter=datetime(2015, 1, 1),
    ByCompleteBefore=datetime(2015, 1, 1),
    ByParentJobId='string',
    ByMessageCategory='string'
)
type NextToken

string

param NextToken

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

type MaxResults

integer

param MaxResults

The maximum number of items to be returned.

type ByResourceArn

string

param ByResourceArn

Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).

type ByState

string

param ByState

Returns only backup jobs that are in the specified state.

type ByBackupVaultName

string

param ByBackupVaultName

Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

type ByCreatedBefore

datetime

param ByCreatedBefore

Returns only backup jobs that were created before the specified date.

type ByCreatedAfter

datetime

param ByCreatedAfter

Returns only backup jobs that were created after the specified date.

type ByResourceType

string

param ByResourceType

Returns only backup jobs for the specified resources:

  • Aurora for Amazon Aurora

  • DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

  • DynamoDB for Amazon DynamoDB

  • EBS for Amazon Elastic Block Store

  • EC2 for Amazon Elastic Compute Cloud

  • EFS for Amazon Elastic File System

  • FSx for Amazon FSx

  • Neptune for Amazon Neptune

  • RDS for Amazon Relational Database Service

  • Storage Gateway for Storage Gateway

  • S3 for Amazon S3

  • VirtualMachine for virtual machines

type ByAccountId

string

param ByAccountId

The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.

If used from an Organizations management account, passing * returns all jobs across the organization.

type ByCompleteAfter

datetime

param ByCompleteAfter

Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

type ByCompleteBefore

datetime

param ByCompleteBefore

Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

type ByParentJobId

string

param ByParentJobId

This is a filter to list child (nested) jobs based on parent job ID.

type ByMessageCategory

string

param ByMessageCategory

This returns a list of backup jobs for the specified message category.

Example strings may include AccessDenied , Success , and InvalidParameters . See Monitoring for a list of MessageCategory strings.

rtype

dict

returns

Response Syntax

{
    'BackupJobs': [
        {
            'AccountId': 'string',
            'BackupJobId': 'string',
            'BackupVaultName': 'string',
            'BackupVaultArn': 'string',
            'RecoveryPointArn': 'string',
            'ResourceArn': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'CompletionDate': datetime(2015, 1, 1),
            'State': 'CREATED'|'PENDING'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETED'|'FAILED'|'EXPIRED'|'PARTIAL',
            'StatusMessage': 'string',
            'PercentDone': 'string',
            'BackupSizeInBytes': 123,
            'IamRoleArn': 'string',
            'CreatedBy': {
                'BackupPlanId': 'string',
                'BackupPlanArn': 'string',
                'BackupPlanVersion': 'string',
                'BackupRuleId': 'string'
            },
            'ExpectedCompletionDate': datetime(2015, 1, 1),
            'StartBy': datetime(2015, 1, 1),
            'ResourceType': 'string',
            'BytesTransferred': 123,
            'BackupOptions': {
                'string': 'string'
            },
            'BackupType': 'string',
            'ParentJobId': 'string',
            'IsParent': True|False,
            'ResourceName': 'string',
            'MessageCategory': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • BackupJobs (list) --

      An array of structures containing metadata about your backup jobs returned in JSON format.

      • (dict) --

        Contains detailed information about a backup job.

        • AccountId (string) --

          The account ID that owns the backup job.

        • BackupJobId (string) --

          Uniquely identifies a request to Backup to back up a resource.

        • BackupVaultName (string) --

          The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

        • BackupVaultArn (string) --

          An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .

        • RecoveryPointArn (string) --

          An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .

        • ResourceArn (string) --

          An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

        • CreationDate (datetime) --

          The date and time a backup job 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.

        • CompletionDate (datetime) --

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

        • State (string) --

          The current state of a backup job.

        • StatusMessage (string) --

          A detailed message explaining the status of the job to back up a resource.

        • PercentDone (string) --

          Contains an estimated percentage complete of a job at the time the job status was queried.

        • BackupSizeInBytes (integer) --

          The size, in bytes, of a backup.

        • IamRoleArn (string) --

          Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess . Role names without those strings lack permissions to perform backup jobs.

        • CreatedBy (dict) --

          Contains identifying information about the creation of a backup job, including the BackupPlanArn , BackupPlanId , BackupPlanVersion , and BackupRuleId of the backup plan used to create it.

          • BackupPlanId (string) --

            Uniquely identifies a backup plan.

          • BackupPlanArn (string) --

            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 .

          • BackupPlanVersion (string) --

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

          • BackupRuleId (string) --

            Uniquely identifies a rule used to schedule the backup of a selection of resources.

        • ExpectedCompletionDate (datetime) --

          The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • StartBy (datetime) --

          Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • ResourceType (string) --

          The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

        • BytesTransferred (integer) --

          The size in bytes transferred to a backup vault at the time that the job status was queried.

        • BackupOptions (dict) --

          Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

          Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

          • (string) --

            • (string) --

        • BackupType (string) --

          Represents the type of backup for a backup job.

        • ParentJobId (string) --

          This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.

        • IsParent (boolean) --

          This is a boolean value indicating this is a parent (composite) backup job.

        • ResourceName (string) --

          This is the non-unique name of the resource that belongs to the specified backup.

        • MessageCategory (string) --

          This parameter is the job count for the specified message category.

          Example strings include AccessDenied , Success , and InvalidParameters . See Monitoring for a list of MessageCategory strings.

          The the value ANY returns count of all message categories.

          AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

    • NextToken (string) --

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

ListCopyJobs (updated) Link ¶
Changes (request, response)
Request
{'ByMessageCategory': 'string'}
Response
{'CopyJobs': {'MessageCategory': 'string'}}

Returns metadata about your copy jobs.

See also: AWS API Documentation

Request Syntax

client.list_copy_jobs(
    NextToken='string',
    MaxResults=123,
    ByResourceArn='string',
    ByState='CREATED'|'RUNNING'|'COMPLETED'|'FAILED'|'PARTIAL',
    ByCreatedBefore=datetime(2015, 1, 1),
    ByCreatedAfter=datetime(2015, 1, 1),
    ByResourceType='string',
    ByDestinationVaultArn='string',
    ByAccountId='string',
    ByCompleteBefore=datetime(2015, 1, 1),
    ByCompleteAfter=datetime(2015, 1, 1),
    ByParentJobId='string',
    ByMessageCategory='string'
)
type NextToken

string

param NextToken

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

type MaxResults

integer

param MaxResults

The maximum number of items to be returned.

type ByResourceArn

string

param ByResourceArn

Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).

type ByState

string

param ByState

Returns only copy jobs that are in the specified state.

type ByCreatedBefore

datetime

param ByCreatedBefore

Returns only copy jobs that were created before the specified date.

type ByCreatedAfter

datetime

param ByCreatedAfter

Returns only copy jobs that were created after the specified date.

type ByResourceType

string

param ByResourceType

Returns only backup jobs for the specified resources:

  • Aurora for Amazon Aurora

  • DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

  • DynamoDB for Amazon DynamoDB

  • EBS for Amazon Elastic Block Store

  • EC2 for Amazon Elastic Compute Cloud

  • EFS for Amazon Elastic File System

  • FSx for Amazon FSx

  • Neptune for Amazon Neptune

  • RDS for Amazon Relational Database Service

  • Storage Gateway for Storage Gateway

  • S3 for Amazon S3

  • VirtualMachine for virtual machines

type ByDestinationVaultArn

string

param ByDestinationVaultArn

An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .

type ByAccountId

string

param ByAccountId

The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.

type ByCompleteBefore

datetime

param ByCompleteBefore

Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

type ByCompleteAfter

datetime

param ByCompleteAfter

Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

type ByParentJobId

string

param ByParentJobId

This is a filter to list child (nested) jobs based on parent job ID.

type ByMessageCategory

string

param ByMessageCategory

This parameter returns the job count for the specified message category.

Example accepted strings include AccessDenied , Success , and InvalidParameters . See Monitoring for a list of accepted MessageCategory strings.

The the value ANY returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

rtype

dict

returns

Response Syntax

{
    'CopyJobs': [
        {
            'AccountId': 'string',
            'CopyJobId': 'string',
            'SourceBackupVaultArn': 'string',
            'SourceRecoveryPointArn': 'string',
            'DestinationBackupVaultArn': 'string',
            'DestinationRecoveryPointArn': 'string',
            'ResourceArn': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'CompletionDate': datetime(2015, 1, 1),
            'State': 'CREATED'|'RUNNING'|'COMPLETED'|'FAILED'|'PARTIAL',
            'StatusMessage': 'string',
            'BackupSizeInBytes': 123,
            'IamRoleArn': 'string',
            'CreatedBy': {
                'BackupPlanId': 'string',
                'BackupPlanArn': 'string',
                'BackupPlanVersion': 'string',
                'BackupRuleId': 'string'
            },
            'ResourceType': 'string',
            'ParentJobId': 'string',
            'IsParent': True|False,
            'CompositeMemberIdentifier': 'string',
            'NumberOfChildJobs': 123,
            'ChildJobsInState': {
                'string': 123
            },
            'ResourceName': 'string',
            'MessageCategory': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • CopyJobs (list) --

      An array of structures containing metadata about your copy jobs returned in JSON format.

      • (dict) --

        Contains detailed information about a copy job.

        • AccountId (string) --

          The account ID that owns the copy job.

        • CopyJobId (string) --

          Uniquely identifies a copy job.

        • SourceBackupVaultArn (string) --

          An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .

        • SourceRecoveryPointArn (string) --

          An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .

        • DestinationBackupVaultArn (string) --

          An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .

        • DestinationRecoveryPointArn (string) --

          An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .

        • ResourceArn (string) --

          The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

        • CreationDate (datetime) --

          The date and time a copy job 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.

        • CompletionDate (datetime) --

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

        • State (string) --

          The current state of a copy job.

        • StatusMessage (string) --

          A detailed message explaining the status of the job to copy a resource.

        • BackupSizeInBytes (integer) --

          The size, in bytes, of a copy job.

        • IamRoleArn (string) --

          Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access .

        • CreatedBy (dict) --

          Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.

          • BackupPlanId (string) --

            Uniquely identifies a backup plan.

          • BackupPlanArn (string) --

            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 .

          • BackupPlanVersion (string) --

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

          • BackupRuleId (string) --

            Uniquely identifies a rule used to schedule the backup of a selection of resources.

        • ResourceType (string) --

          The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

        • ParentJobId (string) --

          This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.

        • IsParent (boolean) --

          This is a boolean value indicating this is a parent (composite) copy job.

        • CompositeMemberIdentifier (string) --

          This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

        • NumberOfChildJobs (integer) --

          This is the number of child (nested) copy jobs.

        • ChildJobsInState (dict) --

          This returns the statistics of the included child (nested) copy jobs.

          • (string) --

            • (integer) --

        • ResourceName (string) --

          This is the non-unique name of the resource that belongs to the specified backup.

        • MessageCategory (string) --

          This parameter is the job count for the specified message category.

          Example strings include AccessDenied , Success , and InvalidParameters . See Monitoring for a list of MessageCategory strings.

          The the value ANY returns count of all message categories.

          AGGREGATE_ALL aggregates job counts for all message categories and returns the sum

    • NextToken (string) --

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.