2020/11/18 - AWS S3 Control - 7 new api methods
Changes Update s3control client to latest version
Gets the Amazon S3 Storage Lens configuration. For more information, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
See also: AWS API Documentation
Request Syntax
client.get_storage_lens_configuration(
ConfigId='string',
AccountId='string'
)
string
[REQUIRED]
The ID of the Amazon S3 Storage Lens configuration.
string
[REQUIRED]
The account ID of the requester.
dict
Response Syntax
{
'StorageLensConfiguration': {
'Id': 'string',
'AccountLevel': {
'ActivityMetrics': {
'IsEnabled': True|False
},
'BucketLevel': {
'ActivityMetrics': {
'IsEnabled': True|False
},
'PrefixLevel': {
'StorageMetrics': {
'IsEnabled': True|False,
'SelectionCriteria': {
'Delimiter': 'string',
'MaxDepth': 123,
'MinStorageBytesPercentage': 123.0
}
}
}
}
},
'Include': {
'Buckets': [
'string',
],
'Regions': [
'string',
]
},
'Exclude': {
'Buckets': [
'string',
],
'Regions': [
'string',
]
},
'DataExport': {
'S3BucketDestination': {
'Format': 'CSV'|'Parquet',
'OutputSchemaVersion': 'V_1',
'AccountId': 'string',
'Arn': 'string',
'Prefix': 'string',
'Encryption': {
'SSES3': {},
'SSEKMS': {
'KeyId': 'string'
}
}
}
},
'IsEnabled': True|False,
'AwsOrg': {
'Arn': 'string'
},
'StorageLensArn': 'string'
}
}
Response Structure
(dict) --
StorageLensConfiguration (dict) --
The S3 Storage Lens configuration requested.
Id (string) --
A container for the Amazon S3 Storage Lens configuration ID.
AccountLevel (dict) --
A container for all the account-level configurations of your S3 Storage Lens configuration.
ActivityMetrics (dict) --
A container for the S3 Storage Lens activity metrics.
IsEnabled (boolean) --
A container for whether the activity metrics are enabled.
BucketLevel (dict) --
A container for the S3 Storage Lens bucket-level configuration.
ActivityMetrics (dict) --
A container for the bucket-level activity metrics for Amazon S3 Storage Lens
IsEnabled (boolean) --
A container for whether the activity metrics are enabled.
PrefixLevel (dict) --
A container for the bucket-level prefix-level metrics for S3 Storage Lens
StorageMetrics (dict) --
A container for the prefix-level storage metrics for S3 Storage Lens.
IsEnabled (boolean) --
A container for whether prefix-level storage metrics are enabled.
SelectionCriteria (dict) --
Delimiter (string) --
A container for the delimiter of the selection criteria being used.
MaxDepth (integer) --
The max depth of the selection criteria
MinStorageBytesPercentage (float) --
The minimum number of storage bytes percentage whose metrics will be selected.
Include (dict) --
A container for what is included in this configuration. This container can only be valid if there is no Exclude container submitted, and it's not empty.
Buckets (list) --
A container for the S3 Storage Lens bucket includes.
(string) --
Regions (list) --
A container for the S3 Storage Lens Region includes.
(string) --
Exclude (dict) --
A container for what is excluded in this configuration. This container can only be valid if there is no Include container submitted, and it's not empty.
Buckets (list) --
A container for the S3 Storage Lens bucket excludes.
(string) --
Regions (list) --
A container for the S3 Storage Lens Region excludes.
(string) --
DataExport (dict) --
A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.
S3BucketDestination (dict) --
A container for the bucket where the S3 Storage Lens metrics export will be located.
Format (string) --
OutputSchemaVersion (string) --
The schema version of the export file.
AccountId (string) --
The account ID of the owner of the S3 Storage Lens metrics export bucket.
Arn (string) --
The Amazon Resource Name (ARN) of the bucket. This property is read-only and follows the following format: arn:aws:s3:us-east-1:example-account-id:bucket/your-destination-bucket-name
Prefix (string) --
The prefix of the destination bucket where the metrics export will be delivered.
Encryption (dict) --
The container for the type encryption of the metrics exports in this bucket.
SSES3 (dict) --
SSEKMS (dict) --
KeyId (string) --
A container for the ARN of the SSE-KMS encryption. This property is read-only and follows the following format: arn:aws:kms:us-east-1:example-account-id:key/example-9a73-4afc-8d29-8f5900cef44e
IsEnabled (boolean) --
A container for whether the S3 Storage Lens configuration is enabled.
AwsOrg (dict) --
A container for the AWS organization for this S3 Storage Lens configuration.
Arn (string) --
A container for the Amazon Resource Name (ARN) of the AWS organization. This property is read-only and follows the following format: arn:aws:organizations:us-east-1:example-account-id:organization/o-ex2l495dck
StorageLensArn (string) --
The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only and follows the following format: arn:aws:s3:us-east-1:example-account-id:storage-lens/your-dashboard-name
Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
See also: AWS API Documentation
Request Syntax
client.put_storage_lens_configuration(
ConfigId='string',
AccountId='string',
StorageLensConfiguration={
'Id': 'string',
'AccountLevel': {
'ActivityMetrics': {
'IsEnabled': True|False
},
'BucketLevel': {
'ActivityMetrics': {
'IsEnabled': True|False
},
'PrefixLevel': {
'StorageMetrics': {
'IsEnabled': True|False,
'SelectionCriteria': {
'Delimiter': 'string',
'MaxDepth': 123,
'MinStorageBytesPercentage': 123.0
}
}
}
}
},
'Include': {
'Buckets': [
'string',
],
'Regions': [
'string',
]
},
'Exclude': {
'Buckets': [
'string',
],
'Regions': [
'string',
]
},
'DataExport': {
'S3BucketDestination': {
'Format': 'CSV'|'Parquet',
'OutputSchemaVersion': 'V_1',
'AccountId': 'string',
'Arn': 'string',
'Prefix': 'string',
'Encryption': {
'SSES3': {}
,
'SSEKMS': {
'KeyId': 'string'
}
}
}
},
'IsEnabled': True|False,
'AwsOrg': {
'Arn': 'string'
},
'StorageLensArn': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the S3 Storage Lens configuration.
string
[REQUIRED]
The account ID of the requester.
dict
[REQUIRED]
The S3 Storage Lens configuration.
Id (string) -- [REQUIRED]
A container for the Amazon S3 Storage Lens configuration ID.
AccountLevel (dict) -- [REQUIRED]
A container for all the account-level configurations of your S3 Storage Lens configuration.
ActivityMetrics (dict) --
A container for the S3 Storage Lens activity metrics.
IsEnabled (boolean) --
A container for whether the activity metrics are enabled.
BucketLevel (dict) -- [REQUIRED]
A container for the S3 Storage Lens bucket-level configuration.
ActivityMetrics (dict) --
A container for the bucket-level activity metrics for Amazon S3 Storage Lens
IsEnabled (boolean) --
A container for whether the activity metrics are enabled.
PrefixLevel (dict) --
A container for the bucket-level prefix-level metrics for S3 Storage Lens
StorageMetrics (dict) -- [REQUIRED]
A container for the prefix-level storage metrics for S3 Storage Lens.
IsEnabled (boolean) --
A container for whether prefix-level storage metrics are enabled.
SelectionCriteria (dict) --
Delimiter (string) --
A container for the delimiter of the selection criteria being used.
MaxDepth (integer) --
The max depth of the selection criteria
MinStorageBytesPercentage (float) --
The minimum number of storage bytes percentage whose metrics will be selected.
Include (dict) --
A container for what is included in this configuration. This container can only be valid if there is no Exclude container submitted, and it's not empty.
Buckets (list) --
A container for the S3 Storage Lens bucket includes.
(string) --
Regions (list) --
A container for the S3 Storage Lens Region includes.
(string) --
Exclude (dict) --
A container for what is excluded in this configuration. This container can only be valid if there is no Include container submitted, and it's not empty.
Buckets (list) --
A container for the S3 Storage Lens bucket excludes.
(string) --
Regions (list) --
A container for the S3 Storage Lens Region excludes.
(string) --
DataExport (dict) --
A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.
S3BucketDestination (dict) -- [REQUIRED]
A container for the bucket where the S3 Storage Lens metrics export will be located.
Format (string) -- [REQUIRED]
OutputSchemaVersion (string) -- [REQUIRED]
The schema version of the export file.
AccountId (string) -- [REQUIRED]
The account ID of the owner of the S3 Storage Lens metrics export bucket.
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the bucket. This property is read-only and follows the following format: arn:aws:s3:us-east-1:example-account-id:bucket/your-destination-bucket-name
Prefix (string) --
The prefix of the destination bucket where the metrics export will be delivered.
Encryption (dict) --
The container for the type encryption of the metrics exports in this bucket.
SSES3 (dict) --
SSEKMS (dict) --
KeyId (string) -- [REQUIRED]
A container for the ARN of the SSE-KMS encryption. This property is read-only and follows the following format: arn:aws:kms:us-east-1:example-account-id:key/example-9a73-4afc-8d29-8f5900cef44e
IsEnabled (boolean) -- [REQUIRED]
A container for whether the S3 Storage Lens configuration is enabled.
AwsOrg (dict) --
A container for the AWS organization for this S3 Storage Lens configuration.
Arn (string) -- [REQUIRED]
A container for the Amazon Resource Name (ARN) of the AWS organization. This property is read-only and follows the following format: arn:aws:organizations:us-east-1:example-account-id:organization/o-ex2l495dck
StorageLensArn (string) --
The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only and follows the following format: arn:aws:s3:us-east-1:example-account-id:storage-lens/your-dashboard-name
list
The tag set of the S3 Storage Lens configuration.
(dict) --
Key (string) -- [REQUIRED]
Value (string) -- [REQUIRED]
None
Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
See also: AWS API Documentation
Request Syntax
client.list_storage_lens_configurations(
AccountId='string',
NextToken='string'
)
string
[REQUIRED]
The account ID of the requester.
string
A pagination token to request the next page of results.
dict
Response Syntax
{
'NextToken': 'string',
'StorageLensConfigurationList': [
{
'Id': 'string',
'StorageLensArn': 'string',
'HomeRegion': 'string',
'IsEnabled': True|False
},
]
}
Response Structure
(dict) --
NextToken (string) --
If the request produced more than the maximum number of S3 Storage Lens configuration results, you can pass this value into a subsequent request to retrieve the next page of results.
StorageLensConfigurationList (list) --
A list of S3 Storage Lens configurations.
(dict) --
Part of ListStorageLensConfigurationResult. Each entry includes the description of the S3 Storage Lens configuration, its home Region, whether it is enabled, its Amazon Resource Name (ARN), and config ID.
Id (string) --
A container for the S3 Storage Lens configuration ID.
StorageLensArn (string) --
The ARN of the S3 Storage Lens configuration. This property is read-only.
HomeRegion (string) --
A container for the S3 Storage Lens home Region. Your metrics data is stored and retained in your designated S3 Storage Lens home Region.
IsEnabled (boolean) --
A container for whether the S3 Storage Lens configuration is enabled. This property is required.
Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
See also: AWS API Documentation
Request Syntax
client.delete_storage_lens_configuration(
ConfigId='string',
AccountId='string'
)
string
[REQUIRED]
The ID of the S3 Storage Lens configuration.
string
[REQUIRED]
The account ID of the requester.
None
Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
See also: AWS API Documentation
Request Syntax
client.delete_storage_lens_configuration_tagging(
ConfigId='string',
AccountId='string'
)
string
[REQUIRED]
The ID of the S3 Storage Lens configuration.
string
[REQUIRED]
The account ID of the requester.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
See also: AWS API Documentation
Request Syntax
client.get_storage_lens_configuration_tagging(
ConfigId='string',
AccountId='string'
)
string
[REQUIRED]
The ID of the Amazon S3 Storage Lens configuration.
string
[REQUIRED]
The account ID of the requester.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Tags (list) --
The tags of S3 Storage Lens configuration requested.
(dict) --
Key (string) --
Value (string) --
Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
See also: AWS API Documentation
Request Syntax
client.put_storage_lens_configuration_tagging(
ConfigId='string',
AccountId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the S3 Storage Lens configuration.
string
[REQUIRED]
The account ID of the requester.
list
[REQUIRED]
The tag set of the S3 Storage Lens configuration.
(dict) --
Key (string) -- [REQUIRED]
Value (string) -- [REQUIRED]
dict
Response Syntax
{}
Response Structure
(dict) --