libZSservicesZSamazonka-lightsailZSamazonka-lightsail
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Lightsail.GetBuckets

Description

Returns information about one or more Amazon Lightsail buckets.

For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide..

Synopsis

Creating a Request

data GetBuckets Source #

See: newGetBuckets smart constructor.

Constructors

GetBuckets' 

Fields

  • bucketName :: Maybe Text

    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.

  • includeConnectedResources :: Maybe Bool

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

  • pageToken :: Maybe Text

    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.

Instances

Instances details
Eq GetBuckets Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

Read GetBuckets Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

Show GetBuckets Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

Generic GetBuckets Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

Associated Types

type Rep GetBuckets :: Type -> Type #

NFData GetBuckets Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

Methods

rnf :: GetBuckets -> () #

Hashable GetBuckets Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

ToJSON GetBuckets Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

AWSRequest GetBuckets Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

Associated Types

type AWSResponse GetBuckets #

ToHeaders GetBuckets Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

Methods

toHeaders :: GetBuckets -> [Header] #

ToPath GetBuckets Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

ToQuery GetBuckets Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

type Rep GetBuckets Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

type Rep GetBuckets = D1 ('MetaData "GetBuckets" "Amazonka.Lightsail.GetBuckets" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "GetBuckets'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "includeConnectedResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "pageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse GetBuckets Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

newGetBuckets :: GetBuckets Source #

Create a value of GetBuckets with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:bucketName:GetBuckets', getBuckets_bucketName - 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.

$sel:includeConnectedResources:GetBuckets', getBuckets_includeConnectedResources - A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the SetResourceAccessForBucket action.

$sel:pageToken:GetBuckets', getBuckets_pageToken - 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.

Request Lenses

getBuckets_bucketName :: Lens' GetBuckets (Maybe Text) Source #

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.

getBuckets_includeConnectedResources :: Lens' GetBuckets (Maybe Bool) Source #

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

getBuckets_pageToken :: Lens' GetBuckets (Maybe Text) Source #

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.

Destructuring the Response

data GetBucketsResponse Source #

See: newGetBucketsResponse smart constructor.

Constructors

GetBucketsResponse' 

Fields

  • nextPageToken :: Maybe Text

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

    A next page token is not returned if there are no more results to display.

    To get the next page of results, perform another GetBuckets request and specify the next page token using the pageToken parameter.

  • buckets :: Maybe [Bucket]

    An array of objects that describe buckets.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetBucketsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

Read GetBucketsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

Show GetBucketsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

Generic GetBucketsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

Associated Types

type Rep GetBucketsResponse :: Type -> Type #

NFData GetBucketsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

Methods

rnf :: GetBucketsResponse -> () #

type Rep GetBucketsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetBuckets

type Rep GetBucketsResponse = D1 ('MetaData "GetBucketsResponse" "Amazonka.Lightsail.GetBuckets" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "GetBucketsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "buckets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Bucket])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetBucketsResponse Source #

Create a value of GetBucketsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextPageToken:GetBucketsResponse', getBucketsResponse_nextPageToken - The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetBuckets request and specify the next page token using the pageToken parameter.

$sel:buckets:GetBucketsResponse', getBucketsResponse_buckets - An array of objects that describe buckets.

$sel:httpStatus:GetBucketsResponse', getBucketsResponse_httpStatus - The response's http status code.

Response Lenses

getBucketsResponse_nextPageToken :: Lens' GetBucketsResponse (Maybe Text) Source #

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

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetBuckets request and specify the next page token using the pageToken parameter.

getBucketsResponse_buckets :: Lens' GetBucketsResponse (Maybe [Bucket]) Source #

An array of objects that describe buckets.