Class: AWS.S3Control
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.S3Control
- Identifier:
- s3control
- API Version:
- 2018-08-20
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
AWS S3 Control provides access to Amazon S3 control plane operations.
Sending a Request Using S3Control
var s3control = new AWS.S3Control();
s3control.createAccessPoint(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the S3Control object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var s3control = new AWS.S3Control({apiVersion: '2018-08-20'});
You can also set the API version globally in AWS.config.apiVersions
using
the s3control service identifier:
AWS.config.apiVersions = {
s3control: '2018-08-20',
// other service API versions
};
var s3control = new AWS.S3Control();
Constructor Summary collapse
-
new AWS.S3Control(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
addOutpostIdHeader(req) ⇒ void
Adds outpostId header.
-
createAccessPoint(params = {}, callback) ⇒ AWS.Request
Creates an access point and associates it with the specified bucket.
-
createBucket(params = {}, callback) ⇒ AWS.Request
Note: This API operation creates an Amazon S3 on Outposts bucket.
-
createJob(params = {}, callback) ⇒ AWS.Request
S3 Batch Operations performs large-scale Batch Operations on Amazon S3 objects.
-
deleteAccessPoint(params = {}, callback) ⇒ AWS.Request
Deletes the specified access point.
-
deleteAccessPointPolicy(params = {}, callback) ⇒ AWS.Request
Deletes the access point policy for the specified access point.
-
deleteBucket(params = {}, callback) ⇒ AWS.Request
Note: This API operation deletes an Amazon S3 on Outposts bucket.
-
deleteBucketLifecycleConfiguration(params = {}, callback) ⇒ AWS.Request
Note: This API action deletes an Amazon S3 on Outposts bucket's lifecycle configuration.
-
deleteBucketPolicy(params = {}, callback) ⇒ AWS.Request
Note: This API operation deletes an Amazon S3 on Outposts bucket policy.
-
deleteBucketTagging(params = {}, callback) ⇒ AWS.Request
Note: This operation deletes an Amazon S3 on Outposts bucket's tags.
-
deleteJobTagging(params = {}, callback) ⇒ AWS.Request
Removes the entire tag set from the specified S3 Batch Operations job.
-
deletePublicAccessBlock(params = {}, callback) ⇒ AWS.Request
Removes the PublicAccessBlock configuration for an AWS account.
-
deleteStorageLensConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes the Amazon S3 Storage Lens configuration.
-
deleteStorageLensConfigurationTagging(params = {}, callback) ⇒ AWS.Request
Deletes the Amazon S3 Storage Lens configuration tags.
-
describeJob(params = {}, callback) ⇒ AWS.Request
Retrieves the configuration parameters and status for a Batch Operations job.
-
getAccessPoint(params = {}, callback) ⇒ AWS.Request
Returns configuration information about the specified access point.
-
getAccessPointPolicy(params = {}, callback) ⇒ AWS.Request
Returns the access point policy associated with the specified access point.
-
getAccessPointPolicyStatus(params = {}, callback) ⇒ AWS.Request
Indicates whether the specified access point currently has a policy that allows public access.
-
getBucket(params = {}, callback) ⇒ AWS.Request
Gets an Amazon S3 on Outposts bucket.
-
getBucketLifecycleConfiguration(params = {}, callback) ⇒ AWS.Request
Note: This operation gets an Amazon S3 on Outposts bucket's lifecycle configuration.
-
getBucketPolicy(params = {}, callback) ⇒ AWS.Request
Note: This action gets a bucket policy for an Amazon S3 on Outposts bucket.
-
getBucketTagging(params = {}, callback) ⇒ AWS.Request
Note: This operation gets an Amazon S3 on Outposts bucket's tags.
-
getJobTagging(params = {}, callback) ⇒ AWS.Request
Returns the tags on an S3 Batch Operations job.
-
getPublicAccessBlock(params = {}, callback) ⇒ AWS.Request
Retrieves the PublicAccessBlock configuration for an AWS account.
-
getStorageLensConfiguration(params = {}, callback) ⇒ AWS.Request
Gets the Amazon S3 Storage Lens configuration.
-
getStorageLensConfigurationTagging(params = {}, callback) ⇒ AWS.Request
Gets the tags of Amazon S3 Storage Lens configuration.
-
listAccessPoints(params = {}, callback) ⇒ AWS.Request
Returns a list of the access points currently associated with the specified bucket.
-
listJobs(params = {}, callback) ⇒ AWS.Request
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request.
-
listRegionalBuckets(params = {}, callback) ⇒ AWS.Request
Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request.
-
listStorageLensConfigurations(params = {}, callback) ⇒ AWS.Request
Gets a list of Amazon S3 Storage Lens configurations.
-
populateUriFromArn(req) ⇒ void
Populate URI according to the ARN.
-
putAccessPointPolicy(params = {}, callback) ⇒ AWS.Request
Associates an access policy with the specified access point.
-
putBucketLifecycleConfiguration(params = {}, callback) ⇒ AWS.Request
Note: This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket.
-
putBucketPolicy(params = {}, callback) ⇒ AWS.Request
Note: This action puts a bucket policy to an Amazon S3 on Outposts bucket.
-
putBucketTagging(params = {}, callback) ⇒ AWS.Request
Note: This action puts tags on an Amazon S3 on Outposts bucket.
-
putJobTagging(params = {}, callback) ⇒ AWS.Request
Sets the supplied tag-set on an S3 Batch Operations job.
-
putPublicAccessBlock(params = {}, callback) ⇒ AWS.Request
Creates or modifies the PublicAccessBlock configuration for an AWS account.
-
putStorageLensConfiguration(params = {}, callback) ⇒ AWS.Request
Puts an Amazon S3 Storage Lens configuration.
-
putStorageLensConfigurationTagging(params = {}, callback) ⇒ AWS.Request
Put or replace tags on an existing Amazon S3 Storage Lens configuration.
-
updateJobPriority(params = {}, callback) ⇒ AWS.Request
Updates an existing S3 Batch Operations job's priority.
-
updateJobStatus(params = {}, callback) ⇒ AWS.Request
Updates the status for the specified job.
-
validateOutpostsBucketArn(req) ⇒ void
Validate Outposts ARN supplied in Bucket parameter is a valid bucket name.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, defineService
Constructor Details
new AWS.S3Control(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
addOutpostIdHeader(req) ⇒ void
Adds outpostId header
createAccessPoint(params = {}, callback) ⇒ AWS.Request
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
:
createBucket(params = {}, callback) ⇒ AWS.Request
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:
createJob(params = {}, callback) ⇒ AWS.Request
S3 Batch Operations performs large-scale Batch Operations on Amazon S3 objects. Batch Operations can run a single operation or action 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 an S3 Batch Operations job.
Related actions include:
deleteAccessPoint(params = {}, callback) ⇒ AWS.Request
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
:
deleteAccessPointPolicy(params = {}, callback) ⇒ AWS.Request
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
:
deleteBucket(params = {}, callback) ⇒ AWS.Request
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
deleteBucketLifecycleConfiguration(params = {}, callback) ⇒ AWS.Request
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:
deleteBucketPolicy(params = {}, callback) ⇒ AWS.Request
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
:
deleteBucketTagging(params = {}, callback) ⇒ AWS.Request
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
:
deleteJobTagging(params = {}, callback) ⇒ AWS.Request
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:
deletePublicAccessBlock(params = {}, callback) ⇒ AWS.Request
Removes the PublicAccessBlock
configuration for an AWS account. For more information, see Using Amazon S3 block public access.
Related actions include:
deleteStorageLensConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
s3:DeleteStorageLensConfiguration
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide. deleteStorageLensConfigurationTagging(params = {}, callback) ⇒ AWS.Request
Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
s3:DeleteStorageLensConfigurationTagging
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide. describeJob(params = {}, callback) ⇒ AWS.Request
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:
getAccessPoint(params = {}, callback) ⇒ AWS.Request
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
:
getAccessPointPolicy(params = {}, callback) ⇒ AWS.Request
Returns the access point policy associated with the specified access point.
The following actions are related to GetAccessPointPolicy
:
getAccessPointPolicyStatus(params = {}, callback) ⇒ AWS.Request
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.
getBucket(params = {}, callback) ⇒ AWS.Request
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.
getBucketLifecycleConfiguration(params = {}, callback) ⇒ AWS.Request
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
:
getBucketPolicy(params = {}, callback) ⇒ AWS.Request
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
:
getBucketTagging(params = {}, callback) ⇒ AWS.Request
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
:
getJobTagging(params = {}, callback) ⇒ AWS.Request
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:
getPublicAccessBlock(params = {}, callback) ⇒ AWS.Request
Retrieves the PublicAccessBlock
configuration for an AWS account. For more information, see Using Amazon S3 block public access.
Related actions include:
getStorageLensConfiguration(params = {}, callback) ⇒ AWS.Request
Gets the Amazon S3 Storage Lens configuration. For more information, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
s3:GetStorageLensConfiguration
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide. getStorageLensConfigurationTagging(params = {}, callback) ⇒ AWS.Request
Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
s3:GetStorageLensConfigurationTagging
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide. listAccessPoints(params = {}, callback) ⇒ AWS.Request
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
:
listJobs(params = {}, callback) ⇒ AWS.Request
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:
listRegionalBuckets(params = {}, callback) ⇒ AWS.Request
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.
listStorageLensConfigurations(params = {}, callback) ⇒ AWS.Request
Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
s3:ListStorageLensConfigurations
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide. populateUriFromArn(req) ⇒ void
Populate URI according to the ARN
putAccessPointPolicy(params = {}, callback) ⇒ AWS.Request
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
:
putBucketLifecycleConfiguration(params = {}, callback) ⇒ AWS.Request
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
:
putBucketPolicy(params = {}, callback) ⇒ AWS.Request
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
:
putBucketTagging(params = {}, callback) ⇒ AWS.Request
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.
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
:
putJobTagging(params = {}, callback) ⇒ AWS.Request
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:
putPublicAccessBlock(params = {}, callback) ⇒ AWS.Request
Creates or modifies the PublicAccessBlock
configuration for an AWS account. For more information, see Using Amazon S3 block public access.
Related actions include:
putStorageLensConfiguration(params = {}, callback) ⇒ AWS.Request
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.
s3:PutStorageLensConfiguration
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide. putStorageLensConfigurationTagging(params = {}, callback) ⇒ AWS.Request
Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide.
s3:PutStorageLensConfigurationTagging
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple Storage Service Developer Guide. updateJobPriority(params = {}, callback) ⇒ AWS.Request
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:
updateJobStatus(params = {}, callback) ⇒ AWS.Request
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:
validateOutpostsBucketArn(req) ⇒ void
Validate Outposts ARN supplied in Bucket parameter is a valid bucket name