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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_name ⇒ String

The name of the bucket for which to return information.

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

Returns:

  • (String) 


6756
6757
6758
6759
6760
6761
6762
 
# File 'lib/aws-sdk-lightsail/types.rb', line 6756

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

#include_connected_resources ⇒ Boolean

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

SetResourceAccessForBucket][1

action.

[1]: docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html

Returns:

  • (Boolean) 


6756
6757
6758
6759
6760
6761
6762
 
# File 'lib/aws-sdk-lightsail/types.rb', line 6756

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

#page_token ⇒ String

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) 


6756
6757
6758
6759
6760
6761
6762
 
# File 'lib/aws-sdk-lightsail/types.rb', line 6756

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