get-bucket-analytics-configuration¶
Description¶
This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.
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 in the Amazon S3 User Guide .
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon S3 User Guide .
Related Resources
See also: AWS API Documentation
Synopsis¶
get-bucket-analytics-configuration
--bucket <value>
--id <value>
[--expected-bucket-owner <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--bucket (string)
The name of the bucket from which an analytics configuration is retrieved.
--id (string)
The ID that identifies the analytics configuration.
--expected-bucket-owner (string)
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code
403 Forbidden(access denied).
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
on
off
auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To retrieve the analytics configuration for a bucket with a specific ID
The following get-bucket-analytics-configuration example displays the analytics configuration for the specified bucket and ID.
aws s3api get-bucket-analytics-configuration \
--bucket my-bucket \
--id 1
Output:
{
"AnalyticsConfiguration": {
"StorageClassAnalysis": {},
"Id": "1"
}
}
Output¶
AnalyticsConfiguration -> (structure)
The configuration and any analyses for the analytics filter.
Id -> (string)
The ID that identifies the analytics configuration.
Filter -> (structure)
The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.
Prefix -> (string)
The prefix to use when evaluating an analytics filter.
Tag -> (structure)
The tag to use when evaluating an analytics filter.
Key -> (string)
Name of the object key.
Value -> (string)
Value of the tag.
And -> (structure)
A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.
Prefix -> (string)
The prefix to use when evaluating an AND predicate: The prefix that an object must have to be included in the metrics results.
Tags -> (list)
The list of tags to use when evaluating an AND predicate.
(structure)
A container of a key value name pair.
Key -> (string)
Name of the object key.
Value -> (string)
Value of the tag.
StorageClassAnalysis -> (structure)
Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.
DataExport -> (structure)
Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.
OutputSchemaVersion -> (string)
The version of the output schema to use when exporting data. Must be
V_1.Destination -> (structure)
The place to store the data for an analysis.
S3BucketDestination -> (structure)
A destination signifying output to an S3 bucket.
Format -> (string)
Specifies the file format used when exporting data to Amazon S3.
BucketAccountId -> (string)
The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.
Note
Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.
Bucket -> (string)
The Amazon Resource Name (ARN) of the bucket to which data is exported.
Prefix -> (string)
The prefix to use when exporting data. The prefix is prepended to all results.