Class: Aws::FSx::Types::DescribeBackupsRequest

Inherits:

Struct

• Object
• Struct
• Aws::FSx::Types::DescribeBackupsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-fsx/types.rb

Overview

Note:

When making an API call, you may pass DescribeBackupsRequest data as a hash:

{
  backup_ids: ["BackupId"],
  filters: [
    {
      name: "file-system-id", # accepts file-system-id, backup-type
      values: ["FilterValue"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
}

The request object for ‘DescribeBackups` operation.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #backup_ids ⇒ Array<String>

  (Optional) IDs of the backups you want to retrieve (String).

• #filters ⇒ Array<Types::Filter>

  (Optional) Filters structure.

• #max_results ⇒ Integer

  (Optional) Maximum number of backups to return in the response (integer).

• #next_token ⇒ String

  (Optional) Opaque pagination token returned from a previous ‘DescribeBackups` operation (String).

Instance Attribute Details

#backup_ids ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-fsx/types.rb', line 747

class DescribeBackupsRequest < Struct.new(
  :backup_ids,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

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

Returns:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-fsx/types.rb', line 747

class DescribeBackupsRequest < Struct.new(
  :backup_ids,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_results ⇒ Integer

(Optional) 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.

Returns:

• (Integer)

# File 'lib/aws-sdk-fsx/types.rb', line 747

class DescribeBackupsRequest < Struct.new(
  :backup_ids,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_token ⇒ String

(Optional) 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.

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 747

class DescribeBackupsRequest < Struct.new(
  :backup_ids,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end