Class: Aws::Lightsail::Types::GetBucketsRequest

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

Overview

Note:

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

{
  bucket_name: "BucketName",
  page_token: "string",
  include_connected_resources: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_nameString

The name of the bucket for which to return information.

When omitted, the response includes all of your buckets in the AWS Region where the request is made.

Returns:

  • (String)


7224
7225
7226
7227
7228
7229
7230
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7224

class GetBucketsRequest < Struct.new(
  :bucket_name,
  :page_token,
  :include_connected_resources)
  SENSITIVE = []
  include Aws::Structure
end

#include_connected_resourcesBoolean

A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the SetResourceAccessForBucket action.

Returns:

  • (Boolean)


7224
7225
7226
7227
7228
7229
7230
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7224

class GetBucketsRequest < Struct.new(
  :bucket_name,
  :page_token,
  :include_connected_resources)
  SENSITIVE = []
  include Aws::Structure
end

#page_tokenString

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBuckets request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Returns:

  • (String)


7224
7225
7226
7227
7228
7229
7230
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7224

class GetBucketsRequest < Struct.new(
  :bucket_name,
  :page_token,
  :include_connected_resources)
  SENSITIVE = []
  include Aws::Structure
end