You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::OpsWorksCM::Types::DescribeBackupsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb

Overview

Note:

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

{
  backup_id: "BackupId",
  server_name: "ServerName",
  next_token: "NextToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#backup_idString

Describes a single backup.

Returns:

  • (String)


602
603
604
605
606
607
608
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 602

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

#max_resultsInteger

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Returns:

  • (Integer)


602
603
604
605
606
607
608
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 602

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

#next_tokenString

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeBackups again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

Returns:

  • (String)


602
603
604
605
606
607
608
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 602

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

#server_nameString

Returns backups for the server with the specified ServerName.

Returns:

  • (String)


602
603
604
605
606
607
608
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 602

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