Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.
Using this action with Amazon S3 on Outposts
This action:
Requires a virtual private cloud (VPC) configuration as S3 on Outposts only supports VPC style access points.
Does not support ACL on S3 on Outposts buckets.
Does not support Public Access on S3 on Outposts buckets.
Does not support object lock for S3 on Outposts buckets.
For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide .
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to CreateAccessPoint:
This API operation creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon Simple Storage Service API.
Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide.
Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.
S3 on Outposts buckets do not support
ACLs. Instead, configure access point policies to manage access to buckets.
Public access.
Object Lock
Bucket Location constraint
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your API request, see the Examples section.
The following actions are related to CreateBucket for Amazon S3 on Outposts:
You can use S3 Batch Operations to perform large-scale batch operations on Amazon S3 objects. Batch Operations can run a single operation on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
This operation creates a S3 Batch Operations job.
Related actions include:
", "endpoint":{ "hostPrefix":"{AccountId}." } }, "DeleteAccessPoint":{ "name":"DeleteAccessPoint", "http":{ "method":"DELETE", "requestUri":"/v20180820/accesspoint/{name}" }, "input":{"shape":"DeleteAccessPointRequest"}, "documentation":"Deletes the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to DeleteAccessPoint:
Deletes the access point policy for the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to DeleteAccessPointPolicy:
This API operation deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon Simple Storage Service API.
Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
Related Resources
", "endpoint":{ "hostPrefix":"{AccountId}." } }, "DeleteBucketLifecycleConfiguration":{ "name":"DeleteBucketLifecycleConfiguration", "http":{ "method":"DELETE", "requestUri":"/v20180820/bucket/{name}/lifecycleconfiguration" }, "input":{"shape":"DeleteBucketLifecycleConfigurationRequest"}, "documentation":"This API action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon Simple Storage Service API.
Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide.
To use this operation, you must have permission to perform the s3-outposts:DeleteLifecycleConfiguration action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
For more information about object expiration, see Elements to Describe Lifecycle Actions.
Related actions include:
", "endpoint":{ "hostPrefix":"{AccountId}." } }, "DeleteBucketPolicy":{ "name":"DeleteBucketPolicy", "http":{ "method":"DELETE", "requestUri":"/v20180820/bucket/{name}/policy" }, "input":{"shape":"DeleteBucketPolicyRequest"}, "documentation":"This API operation deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon Simple Storage Service API.
This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account to use this operation. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide.
If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to DeleteBucketPolicy:
This operation deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon Simple Storage Service API.
Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon Simple Storage Service Developer Guide.
To use this operation, you must have permission to perform the PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to DeleteBucketTagging:
Removes the entire tag set from the specified S3 Batch Operations job. To use this operation, you must have permission to perform the s3:DeleteJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon Simple Storage Service Developer Guide.
Related actions include:
", "endpoint":{ "hostPrefix":"{AccountId}." } }, "DeletePublicAccessBlock":{ "name":"DeletePublicAccessBlock", "http":{ "method":"DELETE", "requestUri":"/v20180820/configuration/publicAccessBlock" }, "input":{"shape":"DeletePublicAccessBlockRequest"}, "documentation":"Removes the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3 block public access.
Related actions include:
", "endpoint":{ "hostPrefix":"{AccountId}." } }, "DeleteStorageLensConfiguration":{ "name":"DeleteStorageLensConfiguration", "http":{ "method":"DELETE", "requestUri":"/v20180820/storagelens/{storagelensid}" }, "input":{"shape":"DeleteStorageLensConfigurationRequest"}, "documentation":"Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
To use this action, you must have permission to perform the s3:DeleteStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
To use this action, you must have permission to perform the s3:DeleteStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
", "endpoint":{ "hostPrefix":"{AccountId}." } }, "GetAccessPoint":{ "name":"GetAccessPoint", "http":{ "method":"GET", "requestUri":"/v20180820/accesspoint/{name}" }, "input":{"shape":"GetAccessPointRequest"}, "output":{"shape":"GetAccessPointResult"}, "documentation":"Returns configuration information about the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to GetAccessPoint:
Returns the access point policy associated with the specified access point.
The following actions are related to GetAccessPointPolicy:
Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.
", "endpoint":{ "hostPrefix":"{AccountId}." } }, "GetBucket":{ "name":"GetBucket", "http":{ "method":"GET", "requestUri":"/v20180820/bucket/{name}" }, "input":{"shape":"GetBucketRequest"}, "output":{"shape":"GetBucketResult"}, "documentation":"Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the s3-outposts:GetBucket permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket.
If you don't have s3-outposts:GetBucket permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error.
The following actions are related to GetBucket for Amazon S3 on Outposts:
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
This operation gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon Simple Storage Service API.
Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts and for information about lifecycle configuration, see Object Lifecycle Management in Amazon Simple Storage Service Developer Guide.
To use this operation, you must have permission to perform the s3-outposts:GetLifecycleConfiguration action. The Outposts 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.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
GetBucketLifecycleConfiguration has the following special error:
Error code: NoSuchLifecycleConfiguration
Description: The lifecycle configuration does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
The following actions are related to GetBucketLifecycleConfiguration:
This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy in the Amazon Simple Storage Service API.
Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.
Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have s3-outposts:GetBucketPolicy permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to GetBucketPolicy:
This operation gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon Simple Storage Service API.
Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
To use this operation, you must have permission to perform the GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.
GetBucketTagging has the following special error:
Error code: NoSuchTagSetError
Description: There is no tag set associated with the bucket.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to GetBucketTagging:
Returns the tags on an S3 Batch Operations job. To use this operation, you must have permission to perform the s3:GetJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon Simple Storage Service Developer Guide.
Related actions include:
", "endpoint":{ "hostPrefix":"{AccountId}." } }, "GetPublicAccessBlock":{ "name":"GetPublicAccessBlock", "http":{ "method":"GET", "requestUri":"/v20180820/configuration/publicAccessBlock" }, "input":{"shape":"GetPublicAccessBlockRequest"}, "output":{"shape":"GetPublicAccessBlockOutput"}, "errors":[ {"shape":"NoSuchPublicAccessBlockConfiguration"} ], "documentation":"Retrieves the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3 block public access.
Related actions include:
", "endpoint":{ "hostPrefix":"{AccountId}." } }, "GetStorageLensConfiguration":{ "name":"GetStorageLensConfiguration", "http":{ "method":"GET", "requestUri":"/v20180820/storagelens/{storagelensid}" }, "input":{"shape":"GetStorageLensConfigurationRequest"}, "output":{"shape":"GetStorageLensConfigurationResult"}, "documentation":"Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
To use this action, you must have permission to perform the s3:GetStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
To use this action, you must have permission to perform the s3:GetStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to ListAccessPoints:
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
", "endpoint":{ "hostPrefix":"{AccountId}." } }, "ListRegionalBuckets":{ "name":"ListRegionalBuckets", "http":{ "method":"GET", "requestUri":"/v20180820/bucket" }, "input":{"shape":"ListRegionalBucketsRequest"}, "output":{"shape":"ListRegionalBucketsResult"}, "documentation":"Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your request, see the Examples section.
Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
To use this action, you must have permission to perform the s3:ListStorageLensConfigurations action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to PutAccessPointPolicy:
This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon Simple Storage Service API.
Creates a new lifecycle configuration for the Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads. For more information, see Managing Lifecycle Permissions for Amazon S3 on Outposts.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to PutBucketLifecycleConfiguration:
This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy in the Amazon Simple Storage Service API.
Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
If you are using an identity other than the root user of the AWS account that owns the Outposts bucket, the calling identity must have the PutBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this operation.
If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to PutBucketPolicy:
This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon Simple Storage Service API.
Sets the tags for an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging.
Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket Tags.
To use this operation, you must have permissions to perform the s3-outposts:PutBucketTagging action. The Outposts bucket owner has this permission by default and 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.
PutBucketTagging has the following special errors:
Error code: InvalidTagError
Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and AWS-Generated Cost Allocation Tag Restrictions.
Error code: MalformedXMLError
Description: The XML provided does not match the schema.
Error code: OperationAbortedError
Description: A conflicting conditional operation is currently in progress against this resource. Try again.
Error code: InternalError
Description: The service was unable to apply the provided tag to the bucket.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.
The following actions are related to PutBucketTagging:
Sets the supplied tag-set on an S3 Batch Operations job.
A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this action to replace the tag set with the one you modified. For more information, see Controlling access and labeling jobs using tags in the Amazon Simple Storage Service Developer Guide.
If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing.
For deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same result without incurring charges.
A few things to consider about using tags:
Amazon S3 limits the maximum number of tags to 50 tags per job.
You can associate up to 50 tags with a job as long as they have unique tag keys.
A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.
The key and values are case sensitive.
For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
To use this operation, you must have permission to perform the s3:PutJobTagging action.
Related actions include:
", "endpoint":{ "hostPrefix":"{AccountId}." } }, "PutPublicAccessBlock":{ "name":"PutPublicAccessBlock", "http":{ "method":"PUT", "requestUri":"/v20180820/configuration/publicAccessBlock" }, "input":{"shape":"PutPublicAccessBlockRequest"}, "documentation":"Creates or modifies the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3 block public access.
Related actions include:
", "endpoint":{ "hostPrefix":"{AccountId}." } }, "PutStorageLensConfiguration":{ "name":"PutStorageLensConfiguration", "http":{ "method":"PUT", "requestUri":"/v20180820/storagelens/{storagelensid}" }, "input":{ "shape":"PutStorageLensConfigurationRequest", "locationName":"PutStorageLensConfigurationRequest", "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} }, "documentation":"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.
To use this action, you must have permission to perform the s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
To use this action, you must have permission to perform the s3:PutStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
", "endpoint":{ "hostPrefix":"{AccountId}." } }, "UpdateJobStatus":{ "name":"UpdateJobStatus", "http":{ "method":"POST", "requestUri":"/v20180820/jobs/{id}/status" }, "input":{"shape":"UpdateJobStatusRequest"}, "output":{"shape":"UpdateJobStatusResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotFoundException"}, {"shape":"JobStatusException"}, {"shape":"InternalServiceException"} ], "documentation":"Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Related actions include:
", "endpoint":{ "hostPrefix":"{AccountId}." } } }, "shapes":{ "AbortIncompleteMultipartUpload":{ "type":"structure", "members":{ "DaysAfterInitiation":{ "shape":"DaysAfterInitiation", "documentation":"Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload to the Outposts bucket.
" } }, "documentation":"The container for abort incomplete multipart upload
" }, "AccessPoint":{ "type":"structure", "required":[ "Name", "NetworkOrigin", "Bucket" ], "members":{ "Name":{ "shape":"AccessPointName", "documentation":"The name of this access point.
" }, "NetworkOrigin":{ "shape":"NetworkOrigin", "documentation":"Indicates whether this access point allows access from the public internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn't allow access from the public internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public internet, subject to the access point and bucket access policies.
The virtual private cloud (VPC) configuration for this access point, if one exists.
" }, "Bucket":{ "shape":"BucketName", "documentation":"The name of the bucket associated with this access point.
" }, "AccessPointArn":{ "shape":"S3AccessPointArn", "documentation":"The ARN for the access point.
" } }, "documentation":"An access point used to access a bucket.
" }, "AccessPointList":{ "type":"list", "member":{ "shape":"AccessPoint", "locationName":"AccessPoint" } }, "AccessPointName":{ "type":"string", "max":50, "min":3 }, "AccountId":{ "type":"string", "max":64, "pattern":"^\\d{12}$" }, "AccountLevel":{ "type":"structure", "required":["BucketLevel"], "members":{ "ActivityMetrics":{ "shape":"ActivityMetrics", "documentation":"A container for the S3 Storage Lens activity metrics.
" }, "BucketLevel":{ "shape":"BucketLevel", "documentation":"A container for the S3 Storage Lens bucket-level configuration.
" } }, "documentation":"A container for the account level Amazon S3 Storage Lens configuration.
" }, "ActivityMetrics":{ "type":"structure", "members":{ "IsEnabled":{ "shape":"IsEnabled", "documentation":"A container for whether the activity metrics are enabled.
" } }, "documentation":"A container for the activity metrics.
" }, "AwsOrgArn":{ "type":"string", "max":1024, "min":1, "pattern":"arn:[a-z\\-]+:organizations::\\d{12}:organization\\/o-[a-z0-9]{10,32}" }, "BadRequestException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"", "exception":true }, "Boolean":{"type":"boolean"}, "BucketAlreadyExists":{ "type":"structure", "members":{ }, "documentation":"The requested Outposts bucket name is not available. The bucket namespace is shared by all users of the AWS Outposts in this Region. Select a different name and try again.
", "exception":true }, "BucketAlreadyOwnedByYou":{ "type":"structure", "members":{ }, "documentation":"The Outposts bucket you tried to create already exists, and you own it.
", "exception":true }, "BucketCannedACL":{ "type":"string", "enum":[ "private", "public-read", "public-read-write", "authenticated-read" ] }, "BucketLevel":{ "type":"structure", "members":{ "ActivityMetrics":{ "shape":"ActivityMetrics", "documentation":"A container for the bucket-level activity metrics for Amazon S3 Storage Lens
" }, "PrefixLevel":{ "shape":"PrefixLevel", "documentation":"A container for the bucket-level prefix-level metrics for S3 Storage Lens
" } }, "documentation":"A container for the bucket-level configuration.
" }, "BucketLocationConstraint":{ "type":"string", "enum":[ "EU", "eu-west-1", "us-west-1", "us-west-2", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "sa-east-1", "cn-north-1", "eu-central-1" ] }, "BucketName":{ "type":"string", "max":255, "min":3 }, "Buckets":{ "type":"list", "member":{ "shape":"S3BucketArnString", "locationName":"Arn" } }, "ConfigId":{ "type":"string", "max":64, "min":1, "pattern":"[a-zA-Z0-9\\-\\_\\.]+" }, "ConfirmRemoveSelfBucketAccess":{"type":"boolean"}, "ConfirmationRequired":{"type":"boolean"}, "ContinuationToken":{"type":"string"}, "CreateAccessPointRequest":{ "type":"structure", "required":[ "AccountId", "Name", "Bucket" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The AWS account ID for the owner of the bucket for which you want to create an access point.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Name":{ "shape":"AccessPointName", "documentation":"The name you want to assign to this access point.
", "location":"uri", "locationName":"name" }, "Bucket":{ "shape":"BucketName", "documentation":"The name of the bucket that you want to associate this access point with.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).
This is required for creating an access point for Amazon S3 on Outposts buckets.
The ARN of the access point.
This is only supported by Amazon S3 on Outposts.
Specifies the Region where the bucket will be created. If you are creating a bucket on the US East (N. Virginia) Region (us-east-1), you do not need to specify the location.
This is not supported by Amazon S3 on Outposts buckets.
The container for the bucket configuration.
This is not supported by Amazon S3 on Outposts buckets.
The canned ACL to apply to the bucket.
This is not supported by Amazon S3 on Outposts buckets.
The name of the bucket.
", "location":"uri", "locationName":"name" }, "CreateBucketConfiguration":{ "shape":"CreateBucketConfiguration", "documentation":"The configuration information for the bucket.
This is not supported by Amazon S3 on Outposts buckets.
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
This is not supported by Amazon S3 on Outposts buckets.
Allows grantee to list the objects in the bucket.
This is not supported by Amazon S3 on Outposts buckets.
Allows grantee to read the bucket ACL.
This is not supported by Amazon S3 on Outposts buckets.
Allows grantee to create, overwrite, and delete any object in the bucket.
This is not supported by Amazon S3 on Outposts buckets.
Allows grantee to write the ACL for the applicable bucket.
This is not supported by Amazon S3 on Outposts buckets.
Specifies whether you want S3 Object Lock to be enabled for the new bucket.
This is not supported by Amazon S3 on Outposts buckets.
The ID of the Outposts where the bucket is being created.
This is required by Amazon S3 on Outposts buckets.
The location of the bucket.
", "location":"header", "locationName":"Location" }, "BucketArn":{ "shape":"S3RegionalBucketArn", "documentation":"The Amazon Resource Name (ARN) of the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
The AWS account ID that creates the job.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "ConfirmationRequired":{ "shape":"ConfirmationRequired", "documentation":"Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.
", "box":true }, "Operation":{ "shape":"JobOperation", "documentation":"The operation that you want this job to perform on every object listed in the manifest. For more information about the available operations, see Operations in the Amazon Simple Storage Service Developer Guide.
" }, "Report":{ "shape":"JobReport", "documentation":"Configuration parameters for the optional job-completion report.
" }, "ClientRequestToken":{ "shape":"NonEmptyMaxLength64String", "documentation":"An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.
", "idempotencyToken":true }, "Manifest":{ "shape":"JobManifest", "documentation":"Configuration parameters for the manifest.
" }, "Description":{ "shape":"NonEmptyMaxLength256String", "documentation":"A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.
" }, "Priority":{ "shape":"JobPriority", "documentation":"The numerical priority for this job. Higher numbers indicate higher priority.
", "box":true }, "RoleArn":{ "shape":"IAMRoleArn", "documentation":"The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that Batch Operations will use to run this job's operation on every object in the manifest.
" }, "Tags":{ "shape":"S3TagSet", "documentation":"A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.
" } } }, "CreateJobResult":{ "type":"structure", "members":{ "JobId":{ "shape":"JobId", "documentation":"The ID for this job. Amazon S3 generates this ID automatically and returns it after a successful Create Job request.
The account ID for the account that owns the specified access point.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Name":{ "shape":"AccessPointName", "documentation":"The name of the access point whose policy you want to delete.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.
The account ID for the account that owns the specified access point.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Name":{ "shape":"AccessPointName", "documentation":"The name of the access point you want to delete.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.
The account ID of the lifecycle configuration to delete.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Bucket":{ "shape":"BucketName", "documentation":"Specifies the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
The account ID of the Outposts bucket.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Bucket":{ "shape":"BucketName", "documentation":"Specifies the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
The account ID that owns the Outposts bucket.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Bucket":{ "shape":"BucketName", "documentation":"Specifies the bucket being deleted.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
The AWS account ID of the Outposts bucket tag set to be removed.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Bucket":{ "shape":"BucketName", "documentation":"The bucket ARN that has the tag set to be removed.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
The AWS account ID associated with the S3 Batch Operations job.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "JobId":{ "shape":"JobId", "documentation":"The ID for the S3 Batch Operations job whose tags you want to delete.
", "location":"uri", "locationName":"id" } } }, "DeleteJobTaggingResult":{ "type":"structure", "members":{ } }, "DeletePublicAccessBlockRequest":{ "type":"structure", "required":["AccountId"], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The account ID for the AWS account whose PublicAccessBlock configuration you want to remove.
The ID of the S3 Storage Lens configuration.
", "location":"uri", "locationName":"storagelensid" }, "AccountId":{ "shape":"AccountId", "documentation":"The account ID of the requester.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" } } }, "DeleteStorageLensConfigurationTaggingRequest":{ "type":"structure", "required":[ "ConfigId", "AccountId" ], "members":{ "ConfigId":{ "shape":"ConfigId", "documentation":"The ID of the S3 Storage Lens configuration.
", "location":"uri", "locationName":"storagelensid" }, "AccountId":{ "shape":"AccountId", "documentation":"The account ID of the requester.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" } } }, "DeleteStorageLensConfigurationTaggingResult":{ "type":"structure", "members":{ } }, "DescribeJobRequest":{ "type":"structure", "required":[ "AccountId", "JobId" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "JobId":{ "shape":"JobId", "documentation":"The ID for the job whose information you want to retrieve.
", "location":"uri", "locationName":"id" } } }, "DescribeJobResult":{ "type":"structure", "members":{ "Job":{ "shape":"JobDescriptor", "documentation":"Contains the configuration parameters and status for the job specified in the Describe Job request.
A container for the S3 Storage Lens bucket excludes.
" }, "Regions":{ "shape":"Regions", "documentation":"A container for the S3 Storage Lens Region excludes.
" } }, "documentation":"A container for what Amazon S3 Storage Lens will exclude.
" }, "ExpirationStatus":{ "type":"string", "enum":[ "Enabled", "Disabled" ] }, "ExpiredObjectDeleteMarker":{"type":"boolean"}, "Format":{ "type":"string", "enum":[ "CSV", "Parquet" ] }, "FunctionArnString":{ "type":"string", "max":1024, "min":1, "pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?" }, "GetAccessPointPolicyRequest":{ "type":"structure", "required":[ "AccountId", "Name" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The account ID for the account that owns the specified access point.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Name":{ "shape":"AccessPointName", "documentation":"The name of the access point whose policy you want to retrieve.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.
The access point policy associated with the specified access point.
" } } }, "GetAccessPointPolicyStatusRequest":{ "type":"structure", "required":[ "AccountId", "Name" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The account ID for the account that owns the specified access point.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Name":{ "shape":"AccessPointName", "documentation":"The name of the access point whose policy status you want to retrieve.
", "location":"uri", "locationName":"name" } } }, "GetAccessPointPolicyStatusResult":{ "type":"structure", "members":{ "PolicyStatus":{ "shape":"PolicyStatus", "documentation":"Indicates the current policy status of the specified access point.
" } } }, "GetAccessPointRequest":{ "type":"structure", "required":[ "AccountId", "Name" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The account ID for the account that owns the specified access point.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Name":{ "shape":"AccessPointName", "documentation":"The name of the access point whose configuration information you want to retrieve.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.
The name of the specified access point.
" }, "Bucket":{ "shape":"BucketName", "documentation":"The name of the bucket associated with the specified access point.
" }, "NetworkOrigin":{ "shape":"NetworkOrigin", "documentation":"Indicates whether this access point allows access from the public internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn't allow access from the public internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public internet, subject to the access point and bucket access policies.
This will always be true for an Amazon S3 on Outposts access point
" }, "VpcConfiguration":{ "shape":"VpcConfiguration", "documentation":"Contains the virtual private cloud (VPC) configuration for the specified access point.
" }, "PublicAccessBlockConfiguration":{"shape":"PublicAccessBlockConfiguration"}, "CreationDate":{ "shape":"CreationDate", "documentation":"The date and time when the specified access point was created.
" } } }, "GetBucketLifecycleConfigurationRequest":{ "type":"structure", "required":[ "AccountId", "Bucket" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The AWS account ID of the Outposts bucket.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Bucket":{ "shape":"BucketName", "documentation":"The Amazon Resource Name (ARN) of the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
Container for the lifecycle rule of the Outposts bucket.
" } } }, "GetBucketPolicyRequest":{ "type":"structure", "required":[ "AccountId", "Bucket" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The AWS account ID of the Outposts bucket.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Bucket":{ "shape":"BucketName", "documentation":"Specifies the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
The policy of the Outposts bucket.
" } } }, "GetBucketRequest":{ "type":"structure", "required":[ "AccountId", "Bucket" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The AWS account ID of the Outposts bucket.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Bucket":{ "shape":"BucketName", "documentation":"Specifies the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
The Outposts bucket requested.
" }, "PublicAccessBlockEnabled":{ "shape":"PublicAccessBlockEnabled", "documentation":"" }, "CreationDate":{ "shape":"CreationDate", "documentation":"The creation date of the Outposts bucket.
" } } }, "GetBucketTaggingRequest":{ "type":"structure", "required":[ "AccountId", "Bucket" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The AWS account ID of the Outposts bucket.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Bucket":{ "shape":"BucketName", "documentation":"Specifies the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
The tags set of the Outposts bucket.
" } } }, "GetJobTaggingRequest":{ "type":"structure", "required":[ "AccountId", "JobId" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The AWS account ID associated with the S3 Batch Operations job.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "JobId":{ "shape":"JobId", "documentation":"The ID for the S3 Batch Operations job whose tags you want to retrieve.
", "location":"uri", "locationName":"id" } } }, "GetJobTaggingResult":{ "type":"structure", "members":{ "Tags":{ "shape":"S3TagSet", "documentation":"The set of tags associated with the S3 Batch Operations job.
" } } }, "GetPublicAccessBlockOutput":{ "type":"structure", "members":{ "PublicAccessBlockConfiguration":{ "shape":"PublicAccessBlockConfiguration", "documentation":"The PublicAccessBlock configuration currently in effect for this AWS account.
The account ID for the AWS account whose PublicAccessBlock configuration you want to retrieve.
The ID of the Amazon S3 Storage Lens configuration.
", "location":"uri", "locationName":"storagelensid" }, "AccountId":{ "shape":"AccountId", "documentation":"The account ID of the requester.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" } } }, "GetStorageLensConfigurationResult":{ "type":"structure", "members":{ "StorageLensConfiguration":{ "shape":"StorageLensConfiguration", "documentation":"The S3 Storage Lens configuration requested.
" } }, "payload":"StorageLensConfiguration" }, "GetStorageLensConfigurationTaggingRequest":{ "type":"structure", "required":[ "ConfigId", "AccountId" ], "members":{ "ConfigId":{ "shape":"ConfigId", "documentation":"The ID of the Amazon S3 Storage Lens configuration.
", "location":"uri", "locationName":"storagelensid" }, "AccountId":{ "shape":"AccountId", "documentation":"The account ID of the requester.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" } } }, "GetStorageLensConfigurationTaggingResult":{ "type":"structure", "members":{ "Tags":{ "shape":"StorageLensTags", "documentation":"The tags of S3 Storage Lens configuration requested.
" } } }, "GrantFullControl":{"type":"string"}, "GrantRead":{"type":"string"}, "GrantReadACP":{"type":"string"}, "GrantWrite":{"type":"string"}, "GrantWriteACP":{"type":"string"}, "IAMRoleArn":{ "type":"string", "max":2048, "min":1, "pattern":"arn:[^:]+:iam::\\d{12}:role/.*" }, "ID":{"type":"string"}, "IdempotencyException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"", "exception":true }, "Include":{ "type":"structure", "members":{ "Buckets":{ "shape":"Buckets", "documentation":"A container for the S3 Storage Lens bucket includes.
" }, "Regions":{ "shape":"Regions", "documentation":"A container for the S3 Storage Lens Region includes.
" } }, "documentation":"A container for what Amazon S3 Storage Lens configuration includes.
" }, "InternalServiceException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"", "exception":true, "fault":true }, "InvalidNextTokenException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"", "exception":true }, "InvalidRequestException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"", "exception":true }, "IsEnabled":{"type":"boolean"}, "IsPublic":{"type":"boolean"}, "JobArn":{ "type":"string", "max":1024, "min":1, "pattern":"arn:[^:]+:s3:[a-zA-Z0-9\\-]+:\\d{12}:job\\/.*" }, "JobCreationTime":{"type":"timestamp"}, "JobDescriptor":{ "type":"structure", "members":{ "JobId":{ "shape":"JobId", "documentation":"The ID for the specified job.
" }, "ConfirmationRequired":{ "shape":"ConfirmationRequired", "documentation":"Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.
", "box":true }, "Description":{ "shape":"NonEmptyMaxLength256String", "documentation":"The description for this job, if one was provided in this job's Create Job request.
The Amazon Resource Name (ARN) for this job.
", "box":true }, "Status":{ "shape":"JobStatus", "documentation":"The current status of the specified job.
" }, "Manifest":{ "shape":"JobManifest", "documentation":"The configuration information for the specified job's manifest object.
", "box":true }, "Operation":{ "shape":"JobOperation", "documentation":"The operation that the specified job is configured to run on the objects listed in the manifest.
", "box":true }, "Priority":{ "shape":"JobPriority", "documentation":"The priority of the specified job.
" }, "ProgressSummary":{ "shape":"JobProgressSummary", "documentation":"Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.
", "box":true }, "StatusUpdateReason":{ "shape":"JobStatusUpdateReason", "documentation":"The reason for updating the job.
", "box":true }, "FailureReasons":{ "shape":"JobFailureList", "documentation":"If the specified job failed, this field contains information describing the failure.
", "box":true }, "Report":{ "shape":"JobReport", "documentation":"Contains the configuration information for the job-completion report if you requested one in the Create Job request.
A timestamp indicating when this job was created.
" }, "TerminationDate":{ "shape":"JobTerminationDate", "documentation":"A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.
", "box":true }, "RoleArn":{ "shape":"IAMRoleArn", "documentation":"The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to run the tasks for this job.
", "box":true }, "SuspendedDate":{ "shape":"SuspendedDate", "documentation":"The timestamp when this job was suspended, if it has been suspended.
", "box":true }, "SuspendedCause":{ "shape":"SuspendedCause", "documentation":"The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.
A container element for the job configuration and status information returned by a Describe Job request.
The failure code, if any, for the specified job.
" }, "FailureReason":{ "shape":"JobFailureReason", "documentation":"The failure reason, if any, for the specified job.
" } }, "documentation":"If this job failed, this element indicates why the job failed.
" }, "JobFailureCode":{ "type":"string", "max":64, "min":1 }, "JobFailureList":{ "type":"list", "member":{"shape":"JobFailure"} }, "JobFailureReason":{ "type":"string", "max":256, "min":1 }, "JobId":{ "type":"string", "max":36, "min":5, "pattern":"[a-zA-Z0-9\\-\\_]+" }, "JobListDescriptor":{ "type":"structure", "members":{ "JobId":{ "shape":"JobId", "documentation":"The ID for the specified job.
" }, "Description":{ "shape":"NonEmptyMaxLength256String", "documentation":"The user-specified description that was included in the specified job's Create Job request.
The operation that the specified job is configured to run on every object listed in the manifest.
" }, "Priority":{ "shape":"JobPriority", "documentation":"The current priority for the specified job.
" }, "Status":{ "shape":"JobStatus", "documentation":"The specified job's current status.
" }, "CreationTime":{ "shape":"JobCreationTime", "documentation":"A timestamp indicating when the specified job was created.
" }, "TerminationDate":{ "shape":"JobTerminationDate", "documentation":"A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.
" }, "ProgressSummary":{ "shape":"JobProgressSummary", "documentation":"Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.
" } }, "documentation":"Contains the configuration and status information for a single job retrieved as part of a job list.
" }, "JobListDescriptorList":{ "type":"list", "member":{"shape":"JobListDescriptor"} }, "JobManifest":{ "type":"structure", "required":[ "Spec", "Location" ], "members":{ "Spec":{ "shape":"JobManifestSpec", "documentation":"Describes the format of the specified job's manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.
" }, "Location":{ "shape":"JobManifestLocation", "documentation":"Contains the information required to locate the specified job's manifest.
" } }, "documentation":"Contains the configuration information for a job's manifest.
" }, "JobManifestFieldList":{ "type":"list", "member":{"shape":"JobManifestFieldName"} }, "JobManifestFieldName":{ "type":"string", "enum":[ "Ignore", "Bucket", "Key", "VersionId" ] }, "JobManifestFormat":{ "type":"string", "enum":[ "S3BatchOperations_CSV_20180820", "S3InventoryReport_CSV_20161130" ] }, "JobManifestLocation":{ "type":"structure", "required":[ "ObjectArn", "ETag" ], "members":{ "ObjectArn":{ "shape":"S3KeyArnString", "documentation":"The Amazon Resource Name (ARN) for a manifest object.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
The optional version ID to identify a specific version of the manifest object.
", "box":true }, "ETag":{ "shape":"NonEmptyMaxLength1024String", "documentation":"The ETag for the specified manifest object.
" } }, "documentation":"Contains the information required to locate a manifest object.
" }, "JobManifestSpec":{ "type":"structure", "required":["Format"], "members":{ "Format":{ "shape":"JobManifestFormat", "documentation":"Indicates which of the available formats the specified manifest uses.
" }, "Fields":{ "shape":"JobManifestFieldList", "documentation":"If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.
Describes the format of a manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.
" }, "JobNumberOfTasksFailed":{ "type":"long", "min":0 }, "JobNumberOfTasksSucceeded":{ "type":"long", "min":0 }, "JobOperation":{ "type":"structure", "members":{ "LambdaInvoke":{ "shape":"LambdaInvokeOperation", "documentation":"Directs the specified job to invoke an AWS Lambda function on every object in the manifest.
", "box":true }, "S3PutObjectCopy":{ "shape":"S3CopyObjectOperation", "documentation":"Directs the specified job to run a PUT Copy object call on every object in the manifest.
", "box":true }, "S3PutObjectAcl":{ "shape":"S3SetObjectAclOperation", "documentation":"Directs the specified job to run a PUT Object acl call on every object in the manifest.
", "box":true }, "S3PutObjectTagging":{ "shape":"S3SetObjectTaggingOperation", "documentation":"Directs the specified job to run a PUT Object tagging call on every object in the manifest.
", "box":true }, "S3DeleteObjectTagging":{ "shape":"S3DeleteObjectTaggingOperation", "documentation":"Directs the specified job to execute a DELETE Object tagging call on every object in the manifest.
", "box":true }, "S3InitiateRestoreObject":{ "shape":"S3InitiateRestoreObjectOperation", "documentation":"Directs the specified job to initiate restore requests for every archived object in the manifest.
", "box":true }, "S3PutObjectLegalHold":{ "shape":"S3SetObjectLegalHoldOperation", "box":true }, "S3PutObjectRetention":{ "shape":"S3SetObjectRetentionOperation", "box":true } }, "documentation":"The operation that you want this job to perform on every object listed in the manifest. For more information about the available operations, see Operations in the Amazon Simple Storage Service Developer Guide.
" }, "JobPriority":{ "type":"integer", "max":2147483647, "min":0 }, "JobProgressSummary":{ "type":"structure", "members":{ "TotalNumberOfTasks":{ "shape":"JobTotalNumberOfTasks", "documentation":"", "box":true }, "NumberOfTasksSucceeded":{ "shape":"JobNumberOfTasksSucceeded", "documentation":"", "box":true }, "NumberOfTasksFailed":{ "shape":"JobNumberOfTasksFailed", "documentation":"", "box":true } }, "documentation":"Describes the total number of tasks that the specified job has started, the number of tasks that succeeded, and the number of tasks that failed.
" }, "JobReport":{ "type":"structure", "required":["Enabled"], "members":{ "Bucket":{ "shape":"S3BucketArnString", "documentation":"The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.
", "box":true }, "Format":{ "shape":"JobReportFormat", "documentation":"The format of the specified job-completion report.
", "box":true }, "Enabled":{ "shape":"Boolean", "documentation":"Indicates whether the specified job will generate a job-completion report.
" }, "Prefix":{ "shape":"ReportPrefixString", "documentation":"An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.
Indicates whether the job-completion report will include details of all tasks or only failed tasks.
", "box":true } }, "documentation":"Contains the configuration parameters for a job-completion report.
" }, "JobReportFormat":{ "type":"string", "enum":["Report_CSV_20180820"] }, "JobReportScope":{ "type":"string", "enum":[ "AllTasks", "FailedTasksOnly" ] }, "JobStatus":{ "type":"string", "enum":[ "Active", "Cancelled", "Cancelling", "Complete", "Completing", "Failed", "Failing", "New", "Paused", "Pausing", "Preparing", "Ready", "Suspended" ] }, "JobStatusException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"", "exception":true }, "JobStatusList":{ "type":"list", "member":{"shape":"JobStatus"} }, "JobStatusUpdateReason":{ "type":"string", "max":256, "min":1 }, "JobTerminationDate":{"type":"timestamp"}, "JobTotalNumberOfTasks":{ "type":"long", "min":0 }, "KmsKeyArnString":{ "type":"string", "max":2000, "min":1 }, "LambdaInvokeOperation":{ "type":"structure", "members":{ "FunctionArn":{ "shape":"FunctionArnString", "documentation":"The Amazon Resource Name (ARN) for the AWS Lambda function that the specified job will invoke on every object in the manifest.
" } }, "documentation":"Contains the configuration parameters for a Lambda Invoke operation.
A lifecycle rule for individual objects in an Outposts bucket.
" } }, "documentation":"The container for the Outposts bucket lifecycle configuration.
" }, "LifecycleExpiration":{ "type":"structure", "members":{ "Date":{ "shape":"Date", "documentation":"Indicates at what date the object is to be deleted. Should be in GMT ISO 8601 format.
" }, "Days":{ "shape":"Days", "documentation":"Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
" }, "ExpiredObjectDeleteMarker":{ "shape":"ExpiredObjectDeleteMarker", "documentation":"Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired. If set to false, the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.
" } }, "documentation":"The container of the Outposts bucket lifecycle expiration.
" }, "LifecycleRule":{ "type":"structure", "required":["Status"], "members":{ "Expiration":{ "shape":"LifecycleExpiration", "documentation":"Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.
" }, "ID":{ "shape":"ID", "documentation":"Unique identifier for the rule. The value cannot be longer than 255 characters.
" }, "Filter":{ "shape":"LifecycleRuleFilter", "documentation":"The container for the filter of lifecycle rule.
" }, "Status":{ "shape":"ExpirationStatus", "documentation":"If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
" }, "Transitions":{ "shape":"TransitionList", "documentation":"Specifies when an Amazon S3 object transitions to a specified storage class.
This is not supported by Amazon S3 on Outposts buckets.
Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.
This is not supported by Amazon S3 on Outposts buckets.
The noncurrent version expiration of the lifecycle rule.
This is not supported by Amazon S3 on Outposts buckets.
Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 waits before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon Simple Storage Service Developer Guide.
" } }, "documentation":"The container for the Outposts bucket lifecycle rule.
" }, "LifecycleRuleAndOperator":{ "type":"structure", "members":{ "Prefix":{ "shape":"Prefix", "documentation":"Prefix identifying one or more objects to which the rule applies.
" }, "Tags":{ "shape":"S3TagSet", "documentation":"All of these tags must exist in the object's tag set in order for the rule to apply.
" } }, "documentation":"The container for the Outposts bucket lifecycle rule and operator.
" }, "LifecycleRuleFilter":{ "type":"structure", "members":{ "Prefix":{ "shape":"Prefix", "documentation":"Prefix identifying one or more objects to which the rule applies.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
The container for the AND condition for the lifecycle rule.
The container for the filter of the lifecycle rule.
" }, "LifecycleRules":{ "type":"list", "member":{ "shape":"LifecycleRule", "locationName":"Rule" } }, "ListAccessPointsRequest":{ "type":"structure", "required":["AccountId"], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The AWS account ID for owner of the bucket whose access points you want to list.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Bucket":{ "shape":"BucketName", "documentation":"The name of the bucket whose associated access points you want to list.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.
The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.
Contains identification and configuration information for one or more access points associated with the specified bucket.
" }, "NextToken":{ "shape":"NonEmptyMaxLength1024String", "documentation":"If the specified bucket has more access points than can be returned in one call to this API, this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.
" } } }, "ListJobsRequest":{ "type":"structure", "required":["AccountId"], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "JobStatuses":{ "shape":"JobStatusList", "documentation":"The List Jobs request returns jobs that match the statuses listed in this element.
A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.
The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.
If the List Jobs request produced more than the maximum number of results, you can pass this value into a subsequent List Jobs request in order to retrieve the next page of results.
The list of current jobs and jobs that have ended within the last 30 days.
" } } }, "ListRegionalBucketsRequest":{ "type":"structure", "required":["AccountId"], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The AWS account ID of the Outposts bucket.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "NextToken":{ "shape":"NonEmptyMaxLength1024String", "documentation":"", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResults", "documentation":"", "location":"querystring", "locationName":"maxResults" }, "OutpostId":{ "shape":"NonEmptyMaxLength64String", "documentation":"The ID of the AWS Outposts.
This is required by Amazon S3 on Outposts buckets.
NextToken is sent when isTruncated is true, which means there are more buckets that can be listed. The next list requests to Amazon S3 can be continued with this NextToken. NextToken is obfuscated and is not a real key.
A container for the S3 Storage Lens configuration ID.
" }, "StorageLensArn":{ "shape":"StorageLensArn", "documentation":"The ARN of the S3 Storage Lens configuration. This property is read-only.
" }, "HomeRegion":{ "shape":"S3AWSRegion", "documentation":"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":{ "shape":"IsEnabled", "documentation":"A container for whether the S3 Storage Lens configuration is enabled. This property is required.
" } }, "documentation":"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.
The account ID of the requester.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "NextToken":{ "shape":"ContinuationToken", "documentation":"A pagination token to request the next page of results.
", "location":"querystring", "locationName":"nextToken" } } }, "ListStorageLensConfigurationsResult":{ "type":"structure", "members":{ "NextToken":{ "shape":"ContinuationToken", "documentation":"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":{ "shape":"StorageLensConfigurationList", "documentation":"A list of S3 Storage Lens configurations.
" } } }, "Location":{"type":"string"}, "MaxLength1024String":{ "type":"string", "max":1024 }, "MaxResults":{ "type":"integer", "max":1000, "min":0 }, "MinStorageBytesPercentage":{ "type":"double", "max":100, "min":0.1 }, "NetworkOrigin":{ "type":"string", "enum":[ "Internet", "VPC" ] }, "NoSuchPublicAccessBlockConfiguration":{ "type":"structure", "members":{ "Message":{"shape":"NoSuchPublicAccessBlockConfigurationMessage"} }, "documentation":"Amazon S3 throws this exception if you make a GetPublicAccessBlock request against an account that doesn't have a PublicAccessBlockConfiguration set.
Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.
" } }, "documentation":"The container of the noncurrent version expiration.
" }, "NoncurrentVersionTransition":{ "type":"structure", "members":{ "NoncurrentDays":{ "shape":"Days", "documentation":"Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon Simple Storage Service Developer Guide.
" }, "StorageClass":{ "shape":"TransitionStorageClass", "documentation":"The class of storage used to store the object.
" } }, "documentation":"The container for the noncurrent version transition.
" }, "NoncurrentVersionTransitionList":{ "type":"list", "member":{ "shape":"NoncurrentVersionTransition", "locationName":"NoncurrentVersionTransition" } }, "NotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"", "exception":true }, "ObjectLockEnabledForBucket":{"type":"boolean"}, "OperationName":{ "type":"string", "enum":[ "LambdaInvoke", "S3PutObjectCopy", "S3PutObjectAcl", "S3PutObjectTagging", "S3DeleteObjectTagging", "S3InitiateRestoreObject", "S3PutObjectLegalHold", "S3PutObjectRetention" ] }, "OutputSchemaVersion":{ "type":"string", "enum":["V_1"] }, "Policy":{"type":"string"}, "PolicyStatus":{ "type":"structure", "members":{ "IsPublic":{ "shape":"IsPublic", "documentation":"", "locationName":"IsPublic" } }, "documentation":"Indicates whether this access point policy is public. For more information about how Amazon S3 evaluates policies to determine whether they are public, see The Meaning of \"Public\" in the Amazon Simple Storage Service Developer Guide.
" }, "Prefix":{"type":"string"}, "PrefixLevel":{ "type":"structure", "required":["StorageMetrics"], "members":{ "StorageMetrics":{ "shape":"PrefixLevelStorageMetrics", "documentation":"A container for the prefix-level storage metrics for S3 Storage Lens.
" } }, "documentation":"A container for the prefix-level configuration.
" }, "PrefixLevelStorageMetrics":{ "type":"structure", "members":{ "IsEnabled":{ "shape":"IsEnabled", "documentation":"A container for whether prefix-level storage metrics are enabled.
" }, "SelectionCriteria":{"shape":"SelectionCriteria"} }, "documentation":"A container for the prefix-level storage metrics for S3 Storage Lens.
" }, "PublicAccessBlockConfiguration":{ "type":"structure", "members":{ "BlockPublicAcls":{ "shape":"Setting", "documentation":"Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:
PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
PUT Object calls fail if the request includes a public ACL.
PUT Bucket calls fail if the request includes a public ACL.
Enabling this setting doesn't affect existing policies or ACLs.
This is not supported for Amazon S3 on Outposts.
", "locationName":"BlockPublicAcls" }, "IgnorePublicAcls":{ "shape":"Setting", "documentation":"Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.
Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.
This is not supported for Amazon S3 on Outposts.
", "locationName":"IgnorePublicAcls" }, "BlockPublicPolicy":{ "shape":"Setting", "documentation":"Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.
Enabling this setting doesn't affect existing bucket policies.
This is not supported for Amazon S3 on Outposts.
", "locationName":"BlockPublicPolicy" }, "RestrictPublicBuckets":{ "shape":"Setting", "documentation":"Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only AWS service principals and authorized users within this account.
Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.
This is not supported for Amazon S3 on Outposts.
", "locationName":"RestrictPublicBuckets" } }, "documentation":"The PublicAccessBlock configuration that you want to apply to this Amazon S3 account. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of \"Public\" in the Amazon Simple Storage Service Developer Guide.
This is not supported for Amazon S3 on Outposts.
" }, "PublicAccessBlockEnabled":{"type":"boolean"}, "PutAccessPointPolicyRequest":{ "type":"structure", "required":[ "AccountId", "Name", "Policy" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The AWS account ID for owner of the bucket associated with the specified access point.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Name":{ "shape":"AccessPointName", "documentation":"The name of the access point that you want to associate with the specified policy.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.
The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.
" } } }, "PutBucketLifecycleConfigurationRequest":{ "type":"structure", "required":[ "AccountId", "Bucket" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The AWS account ID of the Outposts bucket.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Bucket":{ "shape":"BucketName", "documentation":"The name of the bucket for which to set the configuration.
", "location":"uri", "locationName":"name" }, "LifecycleConfiguration":{ "shape":"LifecycleConfiguration", "documentation":"Container for lifecycle rules. You can add as many as 1,000 rules.
", "locationName":"LifecycleConfiguration", "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} } }, "payload":"LifecycleConfiguration" }, "PutBucketPolicyRequest":{ "type":"structure", "required":[ "AccountId", "Bucket", "Policy" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The AWS account ID of the Outposts bucket.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Bucket":{ "shape":"BucketName", "documentation":"Specifies the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.
This is not supported by Amazon S3 on Outposts buckets.
The bucket policy as a JSON document.
" } } }, "PutBucketTaggingRequest":{ "type":"structure", "required":[ "AccountId", "Bucket", "Tagging" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The AWS account ID of the Outposts bucket.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Bucket":{ "shape":"BucketName", "documentation":"The Amazon Resource Name (ARN) of the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
The AWS account ID associated with the S3 Batch Operations job.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "JobId":{ "shape":"JobId", "documentation":"The ID for the S3 Batch Operations job whose tags you want to replace.
", "location":"uri", "locationName":"id" }, "Tags":{ "shape":"S3TagSet", "documentation":"The set of tags to associate with the S3 Batch Operations job.
" } } }, "PutJobTaggingResult":{ "type":"structure", "members":{ } }, "PutPublicAccessBlockRequest":{ "type":"structure", "required":[ "PublicAccessBlockConfiguration", "AccountId" ], "members":{ "PublicAccessBlockConfiguration":{ "shape":"PublicAccessBlockConfiguration", "documentation":"The PublicAccessBlock configuration that you want to apply to the specified AWS account.
The account ID for the AWS account whose PublicAccessBlock configuration you want to set.
The ID of the S3 Storage Lens configuration.
", "location":"uri", "locationName":"storagelensid" }, "AccountId":{ "shape":"AccountId", "documentation":"The account ID of the requester.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "StorageLensConfiguration":{ "shape":"StorageLensConfiguration", "documentation":"The S3 Storage Lens configuration.
" }, "Tags":{ "shape":"StorageLensTags", "documentation":"The tag set of the S3 Storage Lens configuration.
You can set up to a maximum of 50 tags.
The ID of the S3 Storage Lens configuration.
", "location":"uri", "locationName":"storagelensid" }, "AccountId":{ "shape":"AccountId", "documentation":"The account ID of the requester.
", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "Tags":{ "shape":"StorageLensTags", "documentation":"The tag set of the S3 Storage Lens configuration.
You can set up to a maximum of 50 tags.
The Amazon Resource Name (ARN) for the regional bucket.
" }, "PublicAccessBlockEnabled":{ "shape":"PublicAccessBlockEnabled", "documentation":"" }, "CreationDate":{ "shape":"CreationDate", "documentation":"The creation date of the regional bucket
" }, "OutpostId":{ "shape":"NonEmptyMaxLength64String", "documentation":"The AWS Outposts ID of the regional bucket.
" } }, "documentation":"The container for the regional bucket.
" }, "RegionalBucketList":{ "type":"list", "member":{ "shape":"RegionalBucket", "locationName":"RegionalBucket" } }, "Regions":{ "type":"list", "member":{ "shape":"S3AWSRegion", "locationName":"Region" } }, "ReportPrefixString":{ "type":"string", "max":512, "min":1 }, "RequestedJobStatus":{ "type":"string", "enum":[ "Cancelled", "Ready" ] }, "S3AWSRegion":{ "type":"string", "max":30, "min":5, "pattern":"[a-z0-9\\-]+" }, "S3AccessControlList":{ "type":"structure", "required":["Owner"], "members":{ "Owner":{ "shape":"S3ObjectOwner", "documentation":"" }, "Grants":{ "shape":"S3GrantList", "documentation":"" } }, "documentation":"" }, "S3AccessControlPolicy":{ "type":"structure", "members":{ "AccessControlList":{ "shape":"S3AccessControlList", "documentation":"", "box":true }, "CannedAccessControlList":{ "shape":"S3CannedAccessControlList", "documentation":"", "box":true } }, "documentation":"" }, "S3AccessPointArn":{ "type":"string", "max":128, "min":4 }, "S3BucketArnString":{ "type":"string", "max":128, "min":1, "pattern":"arn:[^:]+:s3:.*" }, "S3BucketDestination":{ "type":"structure", "required":[ "Format", "OutputSchemaVersion", "AccountId", "Arn" ], "members":{ "Format":{ "shape":"Format", "documentation":"" }, "OutputSchemaVersion":{ "shape":"OutputSchemaVersion", "documentation":"The schema version of the export file.
" }, "AccountId":{ "shape":"AccountId", "documentation":"The account ID of the owner of the S3 Storage Lens metrics export bucket.
" }, "Arn":{ "shape":"S3BucketArnString", "documentation":"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
The prefix of the destination bucket where the metrics export will be delivered.
" }, "Encryption":{ "shape":"StorageLensDataExportEncryption", "documentation":"The container for the type encryption of the metrics exports in this bucket.
" } }, "documentation":"A container for the bucket where the Amazon S3 Storage Lens metrics export files are located.
" }, "S3CannedAccessControlList":{ "type":"string", "enum":[ "private", "public-read", "public-read-write", "aws-exec-read", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control" ] }, "S3ContentLength":{ "type":"long", "min":0 }, "S3CopyObjectOperation":{ "type":"structure", "members":{ "TargetResource":{ "shape":"S3BucketArnString", "documentation":"Specifies the destination bucket ARN for the batch copy operation. For example, to copy objects to a bucket named \"destinationBucket\", set the TargetResource to \"arn:aws:s3:::destinationBucket\".
" }, "CannedAccessControlList":{ "shape":"S3CannedAccessControlList", "documentation":"", "box":true }, "AccessControlGrants":{ "shape":"S3GrantList", "documentation":"", "box":true }, "MetadataDirective":{ "shape":"S3MetadataDirective", "documentation":"" }, "ModifiedSinceConstraint":{ "shape":"TimeStamp", "documentation":"" }, "NewObjectMetadata":{ "shape":"S3ObjectMetadata", "documentation":"" }, "NewObjectTagging":{ "shape":"S3TagSet", "documentation":"" }, "RedirectLocation":{ "shape":"NonEmptyMaxLength2048String", "documentation":"Specifies an optional metadata property for website redirects, x-amz-website-redirect-location. Allows webpage redirects if the object is accessed through a website endpoint.
Specifies the folder prefix into which you would like the objects to be copied. For example, to copy objects into a folder named \"Folder1\" in the destination bucket, set the TargetKeyPrefix to \"Folder1/\".
" }, "ObjectLockLegalHoldStatus":{ "shape":"S3ObjectLockLegalHoldStatus", "documentation":"The legal hold status to be applied to all objects in the Batch Operations job.
" }, "ObjectLockMode":{ "shape":"S3ObjectLockMode", "documentation":"The retention mode to be applied to all objects in the Batch Operations job.
" }, "ObjectLockRetainUntilDate":{ "shape":"TimeStamp", "documentation":"The date when the applied object retention configuration expires on all objects in the Batch Operations job.
" } }, "documentation":"Contains the configuration parameters for a PUT Copy object operation. S3 Batch Operations passes every object to the underlying PUT Copy object API. For more information about the parameters for this operation, see PUT Object - Copy.
" }, "S3DeleteObjectTaggingOperation":{ "type":"structure", "members":{ }, "documentation":"Contains no configuration parameters because the DELETE Object tagging API only accepts the bucket name and key name as parameters, which are defined in the job's manifest.
" }, "S3ExpirationInDays":{ "type":"integer", "min":0 }, "S3GlacierJobTier":{ "type":"string", "enum":[ "BULK", "STANDARD" ] }, "S3Grant":{ "type":"structure", "members":{ "Grantee":{ "shape":"S3Grantee", "documentation":"" }, "Permission":{ "shape":"S3Permission", "documentation":"" } }, "documentation":"" }, "S3GrantList":{ "type":"list", "member":{"shape":"S3Grant"} }, "S3Grantee":{ "type":"structure", "members":{ "TypeIdentifier":{ "shape":"S3GranteeTypeIdentifier", "documentation":"" }, "Identifier":{ "shape":"NonEmptyMaxLength1024String", "documentation":"", "box":true }, "DisplayName":{ "shape":"NonEmptyMaxLength1024String", "documentation":"" } }, "documentation":"" }, "S3GranteeTypeIdentifier":{ "type":"string", "enum":[ "id", "emailAddress", "uri" ] }, "S3InitiateRestoreObjectOperation":{ "type":"structure", "members":{ "ExpirationInDays":{ "shape":"S3ExpirationInDays", "documentation":"This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects require ExpirationInDays set to 1 or greater.
Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying ExpirationInDays results in restore request failure.
S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the same job. If you need to restore objects of both types you must create separate Batch Operations jobs.
", "box":true }, "GlacierJobTier":{ "shape":"S3GlacierJobTier", "documentation":"S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the EXPEDITED retrieval tier.
Contains the configuration parameters for an S3 Initiate Restore Object job. S3 Batch Operations passes every object to the underlying POST Object restore API. For more information about the parameters for this operation, see RestoreObject.
" }, "S3KeyArnString":{ "type":"string", "max":2000, "min":1, "pattern":"arn:[^:]+:s3:.*" }, "S3MetadataDirective":{ "type":"string", "enum":[ "COPY", "REPLACE" ] }, "S3ObjectLockLegalHold":{ "type":"structure", "required":["Status"], "members":{ "Status":{ "shape":"S3ObjectLockLegalHoldStatus", "documentation":"The Object Lock legal hold status to be applied to all objects in the Batch Operations job.
" } }, "documentation":"Whether S3 Object Lock legal hold will be applied to objects in an S3 Batch Operations job.
" }, "S3ObjectLockLegalHoldStatus":{ "type":"string", "enum":[ "OFF", "ON" ] }, "S3ObjectLockMode":{ "type":"string", "enum":[ "COMPLIANCE", "GOVERNANCE" ] }, "S3ObjectLockRetentionMode":{ "type":"string", "enum":[ "COMPLIANCE", "GOVERNANCE" ] }, "S3ObjectMetadata":{ "type":"structure", "members":{ "CacheControl":{ "shape":"NonEmptyMaxLength1024String", "documentation":"" }, "ContentDisposition":{ "shape":"NonEmptyMaxLength1024String", "documentation":"" }, "ContentEncoding":{ "shape":"NonEmptyMaxLength1024String", "documentation":"" }, "ContentLanguage":{ "shape":"NonEmptyMaxLength1024String", "documentation":"" }, "UserMetadata":{ "shape":"S3UserMetadata", "documentation":"" }, "ContentLength":{ "shape":"S3ContentLength", "documentation":"", "box":true }, "ContentMD5":{ "shape":"NonEmptyMaxLength1024String", "documentation":"" }, "ContentType":{ "shape":"NonEmptyMaxLength1024String", "documentation":"" }, "HttpExpiresDate":{ "shape":"TimeStamp", "documentation":"" }, "RequesterCharged":{ "shape":"Boolean", "documentation":"" }, "SSEAlgorithm":{ "shape":"S3SSEAlgorithm", "documentation":"" } }, "documentation":"" }, "S3ObjectOwner":{ "type":"structure", "members":{ "ID":{ "shape":"NonEmptyMaxLength1024String", "documentation":"" }, "DisplayName":{ "shape":"NonEmptyMaxLength1024String", "documentation":"" } }, "documentation":"" }, "S3ObjectVersionId":{ "type":"string", "max":2000, "min":1 }, "S3Permission":{ "type":"string", "enum":[ "FULL_CONTROL", "READ", "WRITE", "READ_ACP", "WRITE_ACP" ] }, "S3RegionalBucketArn":{ "type":"string", "max":128, "min":4 }, "S3Retention":{ "type":"structure", "members":{ "RetainUntilDate":{ "shape":"TimeStamp", "documentation":"The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.
" }, "Mode":{ "shape":"S3ObjectLockRetentionMode", "documentation":"The Object Lock retention mode to be applied to all objects in the Batch Operations job.
" } }, "documentation":"Contains the S3 Object Lock retention mode to be applied to all objects in the S3 Batch Operations job. If you don't provide Mode and RetainUntilDate data types in your operation, you will remove the retention from your objects. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Contains the configuration parameters for a Set Object ACL operation. S3 Batch Operations passes every object to the underlying PUT Object acl API. For more information about the parameters for this operation, see PUT Object acl.
" }, "S3SetObjectLegalHoldOperation":{ "type":"structure", "required":["LegalHold"], "members":{ "LegalHold":{ "shape":"S3ObjectLockLegalHold", "documentation":"Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.
" } }, "documentation":"Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes every object to the underlying PutObjectLegalHold API. For more information, see Using S3 Object Lock legal hold with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.
Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
" } }, "documentation":"Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes every object to the underlying PutObjectRetention API. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.
Contains the configuration parameters for a Set Object Tagging operation. S3 Batch Operations passes every object to the underlying PUT Object tagging API. For more information about the parameters for this operation, see PUT Object tagging.
" }, "S3StorageClass":{ "type":"string", "enum":[ "STANDARD", "STANDARD_IA", "ONEZONE_IA", "GLACIER", "INTELLIGENT_TIERING", "DEEP_ARCHIVE" ] }, "S3Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKeyString", "documentation":"" }, "Value":{ "shape":"TagValueString", "documentation":"" } }, "documentation":"" }, "S3TagSet":{ "type":"list", "member":{"shape":"S3Tag"} }, "S3UserMetadata":{ "type":"map", "key":{"shape":"NonEmptyMaxLength1024String"}, "value":{"shape":"MaxLength1024String"}, "max":8192 }, "SSEKMS":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"SSEKMSKeyId", "documentation":"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
A container for the delimiter of the selection criteria being used.
" }, "MaxDepth":{ "shape":"StorageLensPrefixLevelMaxDepth", "documentation":"The max depth of the selection criteria
" }, "MinStorageBytesPercentage":{ "shape":"MinStorageBytesPercentage", "documentation":"The minimum number of storage bytes percentage whose metrics will be selected.
You must choose a value greater than or equal to 1.0.
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
The AWS organization for your S3 Storage Lens.
" }, "StorageLensConfiguration":{ "type":"structure", "required":[ "Id", "AccountLevel", "IsEnabled" ], "members":{ "Id":{ "shape":"ConfigId", "documentation":"A container for the Amazon S3 Storage Lens configuration ID.
" }, "AccountLevel":{ "shape":"AccountLevel", "documentation":"A container for all the account-level configurations of your S3 Storage Lens configuration.
" }, "Include":{ "shape":"Include", "documentation":"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.
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.
A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.
" }, "IsEnabled":{ "shape":"IsEnabled", "documentation":"A container for whether the S3 Storage Lens configuration is enabled.
" }, "AwsOrg":{ "shape":"StorageLensAwsOrg", "documentation":"A container for the AWS organization for this S3 Storage Lens configuration.
" }, "StorageLensArn":{ "shape":"StorageLensArn", "documentation":"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
A container for the Amazon S3 Storage Lens configuration.
" }, "StorageLensConfigurationList":{ "type":"list", "member":{ "shape":"ListStorageLensConfigurationEntry", "locationName":"StorageLensConfiguration" }, "flattened":true }, "StorageLensDataExport":{ "type":"structure", "required":["S3BucketDestination"], "members":{ "S3BucketDestination":{ "shape":"S3BucketDestination", "documentation":"A container for the bucket where the S3 Storage Lens metrics export will be located.
This bucket must be located in the same Region as the storage lens configuration.
A container to specify the properties of your S3 Storage Lens metrics export, including the destination, schema, and format.
" }, "StorageLensDataExportEncryption":{ "type":"structure", "members":{ "SSES3":{ "shape":"SSES3", "documentation":"", "locationName":"SSE-S3" }, "SSEKMS":{ "shape":"SSEKMS", "documentation":"", "locationName":"SSE-KMS" } }, "documentation":"A container for the encryption of the S3 Storage Lens metrics exports.
" }, "StorageLensPrefixLevelDelimiter":{ "type":"string", "max":1 }, "StorageLensPrefixLevelMaxDepth":{ "type":"integer", "max":10, "min":1 }, "StorageLensTag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKeyString", "documentation":"" }, "Value":{ "shape":"TagValueString", "documentation":"" } }, "documentation":"" }, "StorageLensTags":{ "type":"list", "member":{ "shape":"StorageLensTag", "locationName":"Tag" } }, "StringForNextToken":{ "type":"string", "max":1024, "min":1, "pattern":"^[A-Za-z0-9\\+\\:\\/\\=\\?\\#-_]+$" }, "SuspendedCause":{ "type":"string", "max":1024, "min":1 }, "SuspendedDate":{"type":"timestamp"}, "TagKeyString":{ "type":"string", "max":1024, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:=+\\-@%]*)$" }, "TagValueString":{ "type":"string", "max":1024, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:=+\\-@%]*)$" }, "Tagging":{ "type":"structure", "required":["TagSet"], "members":{ "TagSet":{ "shape":"S3TagSet", "documentation":"A collection for a set of tags.
" } }, "documentation":"" }, "TimeStamp":{"type":"timestamp"}, "TooManyRequestsException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"", "exception":true }, "TooManyTagsException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"Amazon S3 throws this exception if you have too many tags in your tag set.
", "exception":true }, "Transition":{ "type":"structure", "members":{ "Date":{ "shape":"Date", "documentation":"Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.
" }, "Days":{ "shape":"Days", "documentation":"Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.
" }, "StorageClass":{ "shape":"TransitionStorageClass", "documentation":"The storage class to which you want the object to transition.
" } }, "documentation":"Specifies when an object transitions to a specified storage class. For more information about Amazon S3 Lifecycle configuration rules, see Transitioning objects using Amazon S3 Lifecycle in the Amazon Simple Storage Service Developer Guide.
" }, "TransitionList":{ "type":"list", "member":{ "shape":"Transition", "locationName":"Transition" } }, "TransitionStorageClass":{ "type":"string", "enum":[ "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE" ] }, "UpdateJobPriorityRequest":{ "type":"structure", "required":[ "AccountId", "JobId", "Priority" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "JobId":{ "shape":"JobId", "documentation":"The ID for the job whose priority you want to update.
", "location":"uri", "locationName":"id" }, "Priority":{ "shape":"JobPriority", "documentation":"The priority you want to assign to this job.
", "location":"querystring", "locationName":"priority" } } }, "UpdateJobPriorityResult":{ "type":"structure", "required":[ "JobId", "Priority" ], "members":{ "JobId":{ "shape":"JobId", "documentation":"The ID for the job whose priority Amazon S3 updated.
" }, "Priority":{ "shape":"JobPriority", "documentation":"The new priority assigned to the specified job.
" } } }, "UpdateJobStatusRequest":{ "type":"structure", "required":[ "AccountId", "JobId", "RequestedJobStatus" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"", "hostLabel":true, "location":"header", "locationName":"x-amz-account-id" }, "JobId":{ "shape":"JobId", "documentation":"The ID of the job whose status you want to update.
", "location":"uri", "locationName":"id" }, "RequestedJobStatus":{ "shape":"RequestedJobStatus", "documentation":"The status that you want to move the specified job to.
", "location":"querystring", "locationName":"requestedJobStatus" }, "StatusUpdateReason":{ "shape":"JobStatusUpdateReason", "documentation":"A description of the reason why you want to change the specified job's status. This field can be any string up to the maximum length.
", "location":"querystring", "locationName":"statusUpdateReason" } } }, "UpdateJobStatusResult":{ "type":"structure", "members":{ "JobId":{ "shape":"JobId", "documentation":"The ID for the job whose status was updated.
" }, "Status":{ "shape":"JobStatus", "documentation":"The current status for the specified job.
" }, "StatusUpdateReason":{ "shape":"JobStatusUpdateReason", "documentation":"The reason that the specified job's status was updated.
" } } }, "VpcConfiguration":{ "type":"structure", "required":["VpcId"], "members":{ "VpcId":{ "shape":"VpcId", "documentation":"If this field is specified, this access point will only allow connections from the specified VPC ID.
" } }, "documentation":"The virtual private cloud (VPC) configuration for an access point.
" }, "VpcId":{ "type":"string", "max":1024, "min":1 } }, "documentation":"AWS S3 Control provides access to Amazon S3 control plane operations.
" }