/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Backup::ListBackupJobs

NAME

Paws::Backup::ListBackupJobs - Arguments for method ListBackupJobs on Paws::Backup

DESCRIPTION

This class represents the parameters used for calling the method ListBackupJobs on the AWS Backup service. Use the attributes of this class as arguments to method ListBackupJobs.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListBackupJobs.

SYNOPSIS

my $backup = Paws->service('Backup');
my $ListBackupJobsOutput = $backup->ListBackupJobs(
  ByAccountId       => 'MyAccountId',            # OPTIONAL
  ByBackupVaultName => 'MyBackupVaultName',      # OPTIONAL
  ByCreatedAfter    => '1970-01-01T01:00:00',    # OPTIONAL
  ByCreatedBefore   => '1970-01-01T01:00:00',    # OPTIONAL
  ByResourceArn     => 'MyARN',                  # OPTIONAL
  ByResourceType    => 'MyResourceType',         # OPTIONAL
  ByState           => 'CREATED',                # OPTIONAL
  MaxResults        => 1,                        # OPTIONAL
  NextToken         => 'Mystring',               # OPTIONAL
);

# Results:
my $BackupJobs = $ListBackupJobsOutput->BackupJobs;
my $NextToken  = $ListBackupJobsOutput->NextToken;

# Returns a L<Paws::Backup::ListBackupJobsOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/backup/ListBackupJobs

ATTRIBUTES

ByAccountId => Str

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

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

ByBackupVaultName => Str

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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

ByCreatedAfter => Str

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

ByCreatedBefore => Str

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

ByResourceArn => Str

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

ByResourceType => Str

Returns only backup jobs for the specified resources:

  • DynamoDB for Amazon DynamoDB

  • EBS for Amazon Elastic Block Store

  • EC2 for Amazon Elastic Compute Cloud

  • EFS for Amazon Elastic File System

  • RDS for Amazon Relational Database Service

  • Aurora for Amazon Aurora

  • Storage Gateway for AWS Storage Gateway

ByState => Str

Returns only backup jobs that are in the specified state.

Valid values are: "CREATED", "PENDING", "RUNNING", "ABORTING", "ABORTED", "COMPLETED", "FAILED", "EXPIRED"

MaxResults => Int

The maximum number of items to be returned.

NextToken => Str

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method ListBackupJobs in Paws::Backup

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues