The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::FSX::DescribeBackups - Arguments for method DescribeBackups on Paws::FSX

DESCRIPTION

This class represents the parameters used for calling the method DescribeBackups on the Amazon FSx service. Use the attributes of this class as arguments to method DescribeBackups.

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

SYNOPSIS

my $fsx = Paws->service('FSX');
my $DescribeBackupsResponse = $fsx->DescribeBackups(
  BackupIds => [
    'MyBackupId', ...    # min: 12, max: 128
  ],    # OPTIONAL
  Filters => [
    {
      Name => 'file-system-id'
      ,    # values: file-system-id, backup-type, file-system-type; OPTIONAL
      Values => [
        'MyFilterValue', ...    # min: 1, max: 128
      ],    # max: 20; OPTIONAL
    },
    ...
  ],    # OPTIONAL
  MaxResults => 1,                # OPTIONAL
  NextToken  => 'MyNextToken',    # OPTIONAL
);

# Results:
my $Backups   = $DescribeBackupsResponse->Backups;
my $NextToken = $DescribeBackupsResponse->NextToken;

# Returns a L<Paws::FSX::DescribeBackupsResponse> 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/fsx/DescribeBackups

ATTRIBUTES

BackupIds => ArrayRef[Str|Undef]

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Filters => ArrayRef[Paws::FSX::Filter]

Filters structure. Supported names are file-system-id and backup-type.

MaxResults => Int

Maximum number of backups to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

NextToken => Str

Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeBackups in Paws::FSX

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