aws_s3_control
AWS S3 Control provides access to Amazon S3 control plane operations.
Summary
Functions
-
create_access_point(Client, Name, Input)
Creates an access point and associates it with the specified bucket.
- create_access_point(Client, Name, Input0, Options0)
-
create_bucket(Client, Bucket, Input)
This API operation creates an Amazon S3 on Outposts bucket.
- create_bucket(Client, Bucket, Input0, Options0)
-
create_job(Client, Input)
You can use S3 Batch Operations to perform large-scale batch operations on Amazon S3 objects.
- create_job(Client, Input0, Options0)
-
delete_access_point(Client, Name, Input)
Deletes the specified access point.
- delete_access_point(Client, Name, Input0, Options0)
-
delete_access_point_policy(Client, Name, Input)
Deletes the access point policy for the specified access point.
- delete_access_point_policy(Client, Name, Input0, Options0)
-
delete_bucket(Client, Bucket, Input)
This API operation deletes an Amazon S3 on Outposts bucket.
- delete_bucket(Client, Bucket, Input0, Options0)
-
delete_bucket_lifecycle_configuration(Client, Bucket, Input)
This API action deletes an Amazon S3 on Outposts bucket's lifecycle configuration.
- delete_bucket_lifecycle_configuration(Client, Bucket, Input0, Options0)
-
delete_bucket_policy(Client, Bucket, Input)
This API operation deletes an Amazon S3 on Outposts bucket policy.
- delete_bucket_policy(Client, Bucket, Input0, Options0)
-
delete_bucket_tagging(Client, Bucket, Input)
This operation deletes an Amazon S3 on Outposts bucket's tags.
- delete_bucket_tagging(Client, Bucket, Input0, Options0)
-
delete_job_tagging(Client, JobId, Input)
Removes the entire tag set from the specified S3 Batch Operations job.
- delete_job_tagging(Client, JobId, Input0, Options0)
-
delete_public_access_block(Client, Input)
Removes the
PublicAccessBlock
configuration for an AWS account. - delete_public_access_block(Client, Input0, Options0)
-
delete_storage_lens_configuration(Client, ConfigId, Input)
Deletes the Amazon S3 Storage Lens configuration.
- delete_storage_lens_configuration(Client, ConfigId, Input0, Options0)
-
delete_storage_lens_configuration_tagging(Client, ConfigId, Input)
Deletes the Amazon S3 Storage Lens configuration tags.
- delete_storage_lens_configuration_tagging(Client, ConfigId, Input0, Options0)
-
describe_job(Client, JobId, AccountId)
Retrieves the configuration parameters and status for a Batch Operations job.
- describe_job(Client, JobId, AccountId, QueryMap, HeadersMap)
- describe_job(Client, JobId, AccountId, QueryMap, HeadersMap, Options0)
-
get_access_point(Client, Name, AccountId)
Returns configuration information about the specified access point.
- get_access_point(Client, Name, AccountId, QueryMap, HeadersMap)
- get_access_point(Client, Name, AccountId, QueryMap, HeadersMap, Options0)
-
get_access_point_policy(Client, Name, AccountId)
Returns the access point policy associated with the specified access point.
- get_access_point_policy(Client, Name, AccountId, QueryMap, HeadersMap)
- get_access_point_policy(Client, Name, AccountId, QueryMap, HeadersMap, Options0)
-
get_access_point_policy_status(Client, Name, AccountId)
Indicates whether the specified access point currently has a policy that allows public access.
- get_access_point_policy_status(Client, Name, AccountId, QueryMap, HeadersMap)
- get_access_point_policy_status(Client, Name, AccountId, QueryMap, HeadersMap, Options0)
-
get_bucket(Client, Bucket, AccountId)
Gets an Amazon S3 on Outposts bucket.
- get_bucket(Client, Bucket, AccountId, QueryMap, HeadersMap)
- get_bucket(Client, Bucket, AccountId, QueryMap, HeadersMap, Options0)
-
get_bucket_lifecycle_configuration(Client, Bucket, AccountId)
This operation gets an Amazon S3 on Outposts bucket's lifecycle configuration.
- get_bucket_lifecycle_configuration(Client, Bucket, AccountId, QueryMap, HeadersMap)
- get_bucket_lifecycle_configuration(Client, Bucket, AccountId, QueryMap, HeadersMap, Options0)
-
get_bucket_policy(Client, Bucket, AccountId)
This action gets a bucket policy for an Amazon S3 on Outposts bucket.
- get_bucket_policy(Client, Bucket, AccountId, QueryMap, HeadersMap)
- get_bucket_policy(Client, Bucket, AccountId, QueryMap, HeadersMap, Options0)
-
get_bucket_tagging(Client, Bucket, AccountId)
This operation gets an Amazon S3 on Outposts bucket's tags.
- get_bucket_tagging(Client, Bucket, AccountId, QueryMap, HeadersMap)
- get_bucket_tagging(Client, Bucket, AccountId, QueryMap, HeadersMap, Options0)
-
get_job_tagging(Client, JobId, AccountId)
Returns the tags on an S3 Batch Operations job.
- get_job_tagging(Client, JobId, AccountId, QueryMap, HeadersMap)
- get_job_tagging(Client, JobId, AccountId, QueryMap, HeadersMap, Options0)
-
get_public_access_block(Client, AccountId)
Retrieves the
PublicAccessBlock
configuration for an AWS account. - get_public_access_block(Client, AccountId, QueryMap, HeadersMap)
- get_public_access_block(Client, AccountId, QueryMap, HeadersMap, Options0)
-
get_storage_lens_configuration(Client, ConfigId, AccountId)
Gets the Amazon S3 Storage Lens configuration.
- get_storage_lens_configuration(Client, ConfigId, AccountId, QueryMap, HeadersMap)
- get_storage_lens_configuration(Client, ConfigId, AccountId, QueryMap, HeadersMap, Options0)
-
get_storage_lens_configuration_tagging(Client, ConfigId, AccountId)
Gets the tags of Amazon S3 Storage Lens configuration.
- get_storage_lens_configuration_tagging(Client, ConfigId, AccountId, QueryMap, HeadersMap)
- get_storage_lens_configuration_tagging(Client, ConfigId, AccountId, QueryMap, HeadersMap, Options0)
-
list_access_points(Client, AccountId)
Returns a list of the access points currently associated with the specified bucket.
- list_access_points(Client, AccountId, QueryMap, HeadersMap)
- list_access_points(Client, AccountId, QueryMap, HeadersMap, Options0)
-
list_jobs(Client, AccountId)
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request.
- list_jobs(Client, AccountId, QueryMap, HeadersMap)
- list_jobs(Client, AccountId, QueryMap, HeadersMap, Options0)
-
list_regional_buckets(Client, AccountId)
Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request.
- list_regional_buckets(Client, AccountId, QueryMap, HeadersMap)
- list_regional_buckets(Client, AccountId, QueryMap, HeadersMap, Options0)
-
list_storage_lens_configurations(Client, AccountId)
Gets a list of Amazon S3 Storage Lens configurations.
- list_storage_lens_configurations(Client, AccountId, QueryMap, HeadersMap)
- list_storage_lens_configurations(Client, AccountId, QueryMap, HeadersMap, Options0)
-
put_access_point_policy(Client, Name, Input)
Associates an access policy with the specified access point.
- put_access_point_policy(Client, Name, Input0, Options0)
-
put_bucket_lifecycle_configuration(Client, Bucket, Input)
This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket.
- put_bucket_lifecycle_configuration(Client, Bucket, Input0, Options0)
-
put_bucket_policy(Client, Bucket, Input)
This action puts a bucket policy to an Amazon S3 on Outposts bucket.
- put_bucket_policy(Client, Bucket, Input0, Options0)
-
put_bucket_tagging(Client, Bucket, Input)
This action puts tags on an Amazon S3 on Outposts bucket.
- put_bucket_tagging(Client, Bucket, Input0, Options0)
-
put_job_tagging(Client, JobId, Input)
Sets the supplied tag-set on an S3 Batch Operations job.
- put_job_tagging(Client, JobId, Input0, Options0)
-
put_public_access_block(Client, Input)
Creates or modifies the
PublicAccessBlock
configuration for an AWS account. - put_public_access_block(Client, Input0, Options0)
-
put_storage_lens_configuration(Client, ConfigId, Input)
Puts an Amazon S3 Storage Lens configuration.
- put_storage_lens_configuration(Client, ConfigId, Input0, Options0)
-
put_storage_lens_configuration_tagging(Client, ConfigId, Input)
Put or replace tags on an existing Amazon S3 Storage Lens configuration.
- put_storage_lens_configuration_tagging(Client, ConfigId, Input0, Options0)
-
update_job_priority(Client, JobId, Input)
Updates an existing S3 Batch Operations job's priority.
- update_job_priority(Client, JobId, Input0, Options0)
-
update_job_status(Client, JobId, Input)
Updates the status for the specified job.
- update_job_status(Client, JobId, Input0, Options0)
Functions
create_access_point(Client, Name, Input)
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
:
GetAccessPoint
DeleteAccessPoint
ListAccessPoints
create_access_point(Client, Name, Input0, Options0)
create_bucket(Client, Bucket, Input)
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:
PutObject
GetBucket
DeleteBucket
CreateAccessPoint
PutAccessPointPolicy
create_bucket(Client, Bucket, Input0, Options0)
create_job(Client, Input)
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:
DescribeJob
ListJobs
UpdateJobPriority
UpdateJobStatus
JobOperation
create_job(Client, Input0, Options0)
delete_access_point(Client, Name, Input)
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
:
CreateAccessPoint
GetAccessPoint
ListAccessPoints
delete_access_point(Client, Name, Input0, Options0)
delete_access_point_policy(Client, Name, Input)
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
:
PutAccessPointPolicy
GetAccessPointPolicy
delete_access_point_policy(Client, Name, Input0, Options0)
delete_bucket(Client, Bucket, Input)
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
CreateBucket
GetBucket
DeleteObject
delete_bucket(Client, Bucket, Input0, Options0)
delete_bucket_lifecycle_configuration(Client, Bucket, Input)
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:
PutBucketLifecycleConfiguration
GetBucketLifecycleConfiguration
delete_bucket_lifecycle_configuration(Client, Bucket, Input0, Options0)
delete_bucket_policy(Client, Bucket, Input)
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
:
GetBucketPolicy
PutBucketPolicy
delete_bucket_policy(Client, Bucket, Input0, Options0)
delete_bucket_tagging(Client, Bucket, Input)
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
:
GetBucketTagging
PutBucketTagging
delete_bucket_tagging(Client, Bucket, Input0, Options0)
delete_job_tagging(Client, JobId, Input)
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:
CreateJob
GetJobTagging
PutJobTagging
delete_job_tagging(Client, JobId, Input0, Options0)
delete_public_access_block(Client, Input)
Removes the PublicAccessBlock
configuration for an AWS account.
For more information, see Using Amazon S3 block public access.
Related actions include:
GetPublicAccessBlock
PutPublicAccessBlock
delete_public_access_block(Client, Input0, Options0)
delete_storage_lens_configuration(Client, ConfigId, Input)
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 thes3:DeleteStorageLensConfiguration
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple
Storage Service Developer Guide.
delete_storage_lens_configuration(Client, ConfigId, Input0, Options0)
delete_storage_lens_configuration_tagging(Client, ConfigId, Input)
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 thes3:DeleteStorageLensConfigurationTagging
action. For more information,
see Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple
Storage Service Developer Guide.
delete_storage_lens_configuration_tagging(Client, ConfigId, Input0, Options0)
describe_job(Client, JobId, AccountId)
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:
CreateJob
ListJobs
UpdateJobPriority
UpdateJobStatus
describe_job(Client, JobId, AccountId, QueryMap, HeadersMap)
describe_job(Client, JobId, AccountId, QueryMap, HeadersMap, Options0)
get_access_point(Client, Name, AccountId)
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
:
CreateAccessPoint
DeleteAccessPoint
ListAccessPoints
get_access_point(Client, Name, AccountId, QueryMap, HeadersMap)
get_access_point(Client, Name, AccountId, QueryMap, HeadersMap, Options0)
get_access_point_policy(Client, Name, AccountId)
Returns the access point policy associated with the specified access point.
The following actions are related to GetAccessPointPolicy
:
PutAccessPointPolicy
DeleteAccessPointPolicy
get_access_point_policy(Client, Name, AccountId, QueryMap, HeadersMap)
get_access_point_policy(Client, Name, AccountId, QueryMap, HeadersMap, Options0)
get_access_point_policy_status(Client, Name, AccountId)
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.get_access_point_policy_status(Client, Name, AccountId, QueryMap, HeadersMap)
get_access_point_policy_status(Client, Name, AccountId, QueryMap, HeadersMap, Options0)
get_bucket(Client, Bucket, AccountId)
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.
PutObject
CreateBucket
DeleteBucket
get_bucket(Client, Bucket, AccountId, QueryMap, HeadersMap)
get_bucket(Client, Bucket, AccountId, QueryMap, HeadersMap, Options0)
get_bucket_lifecycle_configuration(Client, Bucket, AccountId)
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
:
PutBucketLifecycleConfiguration
DeleteBucketLifecycleConfiguration
get_bucket_lifecycle_configuration(Client, Bucket, AccountId, QueryMap, HeadersMap)
get_bucket_lifecycle_configuration(Client, Bucket, AccountId, QueryMap, HeadersMap, Options0)
get_bucket_policy(Client, Bucket, AccountId)
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
:
GetObject
PutBucketPolicy
DeleteBucketPolicy
get_bucket_policy(Client, Bucket, AccountId, QueryMap, HeadersMap)
get_bucket_policy(Client, Bucket, AccountId, QueryMap, HeadersMap, Options0)
get_bucket_tagging(Client, Bucket, AccountId)
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
:
PutBucketTagging
DeleteBucketTagging
get_bucket_tagging(Client, Bucket, AccountId, QueryMap, HeadersMap)
get_bucket_tagging(Client, Bucket, AccountId, QueryMap, HeadersMap, Options0)
get_job_tagging(Client, JobId, AccountId)
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:
CreateJob
PutJobTagging
DeleteJobTagging
get_job_tagging(Client, JobId, AccountId, QueryMap, HeadersMap)
get_job_tagging(Client, JobId, AccountId, QueryMap, HeadersMap, Options0)
get_public_access_block(Client, AccountId)
Retrieves the PublicAccessBlock
configuration for an AWS account.
For more information, see Using Amazon S3 block public access.
Related actions include:
DeletePublicAccessBlock
PutPublicAccessBlock
get_public_access_block(Client, AccountId, QueryMap, HeadersMap)
get_public_access_block(Client, AccountId, QueryMap, HeadersMap, Options0)
get_storage_lens_configuration(Client, ConfigId, AccountId)
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 thes3:GetStorageLensConfiguration
action. For more information, see Setting
permissions to use Amazon S3 Storage Lens in the Amazon Simple Storage
Service Developer Guide.
get_storage_lens_configuration(Client, ConfigId, AccountId, QueryMap, HeadersMap)
get_storage_lens_configuration(Client, ConfigId, AccountId, QueryMap, HeadersMap, Options0)
get_storage_lens_configuration_tagging(Client, ConfigId, AccountId)
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 thes3:GetStorageLensConfigurationTagging
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple
Storage Service Developer Guide.
get_storage_lens_configuration_tagging(Client, ConfigId, AccountId, QueryMap, HeadersMap)
get_storage_lens_configuration_tagging(Client, ConfigId, AccountId, QueryMap, HeadersMap, Options0)
list_access_points(Client, AccountId)
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
:
CreateAccessPoint
DeleteAccessPoint
GetAccessPoint
list_access_points(Client, AccountId, QueryMap, HeadersMap)
list_access_points(Client, AccountId, QueryMap, HeadersMap, Options0)
list_jobs(Client, AccountId)
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:
CreateJob
DescribeJob
UpdateJobPriority
UpdateJobStatus
list_jobs(Client, AccountId, QueryMap, HeadersMap)
list_jobs(Client, AccountId, QueryMap, HeadersMap, Options0)
list_regional_buckets(Client, AccountId)
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 andx-amz-outpost-id
in your
request, see the Examples section.
list_regional_buckets(Client, AccountId, QueryMap, HeadersMap)
list_regional_buckets(Client, AccountId, QueryMap, HeadersMap, Options0)
list_storage_lens_configurations(Client, AccountId)
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 thes3:ListStorageLensConfigurations
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple
Storage Service Developer Guide.
list_storage_lens_configurations(Client, AccountId, QueryMap, HeadersMap)
list_storage_lens_configurations(Client, AccountId, QueryMap, HeadersMap, Options0)
put_access_point_policy(Client, Name, Input)
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
:
GetAccessPointPolicy
DeleteAccessPointPolicy
put_access_point_policy(Client, Name, Input0, Options0)
put_bucket_lifecycle_configuration(Client, Bucket, Input)
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
:
GetBucketLifecycleConfiguration
DeleteBucketLifecycleConfiguration
put_bucket_lifecycle_configuration(Client, Bucket, Input0, Options0)
put_bucket_policy(Client, Bucket, Input)
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
:
GetBucketPolicy
DeleteBucketPolicy
put_bucket_policy(Client, Bucket, Input0, Options0)
put_bucket_tagging(Client, Bucket, Input)
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
:
GetBucketTagging
DeleteBucketTagging
put_bucket_tagging(Client, Bucket, Input0, Options0)
put_job_tagging(Client, JobId, Input)
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:
CreatJob
GetJobTagging
DeleteJobTagging
put_job_tagging(Client, JobId, Input0, Options0)
put_public_access_block(Client, Input)
Creates or modifies the PublicAccessBlock
configuration for an AWS
account.
For more information, see Using Amazon S3 block public access.
Related actions include:
GetPublicAccessBlock
DeletePublicAccessBlock
put_public_access_block(Client, Input0, Options0)
put_storage_lens_configuration(Client, ConfigId, Input)
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 thes3:PutStorageLensConfiguration
action. For more information, see Setting
permissions to use Amazon S3 Storage Lens in the Amazon Simple Storage
Service Developer Guide.
put_storage_lens_configuration(Client, ConfigId, Input0, Options0)
put_storage_lens_configuration_tagging(Client, ConfigId, Input)
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 thes3:PutStorageLensConfigurationTagging
action. For more information, see
Setting permissions to use Amazon S3 Storage Lens in the Amazon Simple
Storage Service Developer Guide.
put_storage_lens_configuration_tagging(Client, ConfigId, Input0, Options0)
update_job_priority(Client, JobId, Input)
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:
CreateJob
ListJobs
DescribeJob
UpdateJobStatus
update_job_priority(Client, JobId, Input0, Options0)
update_job_status(Client, JobId, Input)
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:
CreateJob
ListJobs
DescribeJob
UpdateJobStatus