Skip to content

S3  >  Operations  >  list_bucket_analytics_configurations

list_bucket_analytics_configurations

Operation

list_bucket_analytics_configurations async

list_bucket_analytics_configurations(request: ListBucketAnalyticsConfigurationsInput | ListBucketAnalyticsConfigurationsInputDict, /, *, plugins: list[Plugin] | None = None) -> ListBucketAnalyticsConfigurationsOutput
list_bucket_analytics_configurations(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListBucketAnalyticsConfigurationsInputDict]) -> ListBucketAnalyticsConfigurationsOutput
Note

This operation is not supported for directory buckets.

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics -- Storage Class Analysis.

The following operations are related to ListBucketAnalyticsConfigurations:

Warning

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
ListBucketAnalyticsConfigurationsOutput

An instance of ListBucketAnalyticsConfigurationsOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

ListBucketAnalyticsConfigurationsInput dataclass

Bases: _SerdeShape

Dataclass for ListBucketAnalyticsConfigurationsInput structure.

Attributes
bucket class-attribute instance-attribute
bucket: str | None = ...

The name of the bucket from which analytics configurations are retrieved.

continuation_token class-attribute instance-attribute
continuation_token: str | None = ...

The ContinuationToken that represents a placeholder from where this request should begin.

expected_bucket_owner class-attribute instance-attribute
expected_bucket_owner: str | None = ...

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Dictionaries

ListBucketAnalyticsConfigurationsInputDict

Bases: TypedDict

Dictionary form of ListBucketAnalyticsConfigurationsInput.

Attributes
bucket instance-attribute
bucket: Required[str]

The name of the bucket from which analytics configurations are retrieved.

continuation_token instance-attribute
continuation_token: str | None

The ContinuationToken that represents a placeholder from where this request should begin.

expected_bucket_owner instance-attribute
expected_bucket_owner: str | None

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Output

ListBucketAnalyticsConfigurationsOutput dataclass

Bases: _SerdeShape

Dataclass for ListBucketAnalyticsConfigurationsOutput structure.

Attributes

analytics_configuration_list class-attribute instance-attribute
analytics_configuration_list: list[AnalyticsConfiguration] | None = ...

The list of analytics configurations for a bucket.

continuation_token class-attribute instance-attribute
continuation_token: str | None = ...

The marker that is used as a starting point for this analytics configuration list response. This value is present if it was sent in the request.

is_truncated class-attribute instance-attribute
is_truncated: bool | None = ...

Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

next_continuation_token class-attribute instance-attribute
next_continuation_token: str | None = ...

NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.