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

Class: Aws::StorageGateway::Types::DescribeTapesInput

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

Overview

Note:

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

{
  gateway_arn: "GatewayARN", # required
  tape_arns: ["TapeARN"],
  marker: "Marker",
  limit: 1,
}

DescribeTapesInput

Instance Attribute Summary collapse

Instance Attribute Details

#gateway_arnString

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Returns:

  • (String)


1958
1959
1960
1961
1962
1963
1964
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1958

class DescribeTapesInput < Struct.new(
  :gateway_arn,
  :tape_arns,
  :marker,
  :limit)
  include Aws::Structure
end

#limitInteger

Specifies that the number of virtual tapes described be limited to the specified number.

Amazon Web Services may impose its own limit, if this field is not set.

Returns:

  • (Integer)


1958
1959
1960
1961
1962
1963
1964
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1958

class DescribeTapesInput < Struct.new(
  :gateway_arn,
  :tape_arns,
  :marker,
  :limit)
  include Aws::Structure
end

#markerString

A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

Returns:

  • (String)


1958
1959
1960
1961
1962
1963
1964
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1958

class DescribeTapesInput < Struct.new(
  :gateway_arn,
  :tape_arns,
  :marker,
  :limit)
  include Aws::Structure
end

#tape_arnsArray<String>

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

Returns:

  • (Array<String>)


1958
1959
1960
1961
1962
1963
1964
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1958

class DescribeTapesInput < Struct.new(
  :gateway_arn,
  :tape_arns,
  :marker,
  :limit)
  include Aws::Structure
end