| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Lightsail.GetBuckets
Description
Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets.
For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.
Synopsis
- data GetBuckets = GetBuckets' {}
- newGetBuckets :: GetBuckets
- getBuckets_bucketName :: Lens' GetBuckets (Maybe Text)
- getBuckets_includeConnectedResources :: Lens' GetBuckets (Maybe Bool)
- getBuckets_pageToken :: Lens' GetBuckets (Maybe Text)
- data GetBucketsResponse = GetBucketsResponse' {}
- newGetBucketsResponse :: Int -> GetBucketsResponse
- getBucketsResponse_accountLevelBpaSync :: Lens' GetBucketsResponse (Maybe AccountLevelBpaSync)
- getBucketsResponse_buckets :: Lens' GetBucketsResponse (Maybe [Bucket])
- getBucketsResponse_nextPageToken :: Lens' GetBucketsResponse (Maybe Text)
- getBucketsResponse_httpStatus :: Lens' GetBucketsResponse Int
Creating a Request
data GetBuckets Source #
See: newGetBuckets smart constructor.
Constructors
| GetBuckets' | |
Fields
| |
Instances
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 Amazon Web Services 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 Amazon Web Services 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
| |
Instances
newGetBucketsResponse Source #
Arguments
| :: Int | |
| -> GetBucketsResponse |
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:accountLevelBpaSync:GetBucketsResponse', getBucketsResponse_accountLevelBpaSync - An object that describes the synchronization status of the Amazon S3
account-level block public access feature for your Lightsail buckets.
For more information about this feature and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail.
$sel:buckets:GetBucketsResponse', getBucketsResponse_buckets - An array of objects that describe buckets.
$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:httpStatus:GetBucketsResponse', getBucketsResponse_httpStatus - The response's http status code.
Response Lenses
getBucketsResponse_accountLevelBpaSync :: Lens' GetBucketsResponse (Maybe AccountLevelBpaSync) Source #
An object that describes the synchronization status of the Amazon S3 account-level block public access feature for your Lightsail buckets.
For more information about this feature and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail.
getBucketsResponse_buckets :: Lens' GetBucketsResponse (Maybe [Bucket]) Source #
An array of objects that describe buckets.
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_httpStatus :: Lens' GetBucketsResponse Int Source #
The response's http status code.