AWS S3 Control 2018-08-20
- Client: Aws\S3Control\S3ControlClient
- Service ID: s3control
- Version: 2018-08-20
This page describes the parameters and results for the operations of the AWS S3 Control (2018-08-20), and shows how to use the Aws\S3Control\S3ControlClient object to call the described operations. This documentation is specific to the 2018-08-20 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- CreateAccessPoint ( array $params = [] )
Creates an access point and associates it with the specified bucket.
- CreateBucket ( array $params = [] )
This API operation creates an Amazon S3 on Outposts bucket.
- CreateJob ( array $params = [] )
S3 Batch Operations performs large-scale Batch Operations on Amazon S3 objects.
- DeleteAccessPoint ( array $params = [] )
Deletes the specified access point.
- DeleteAccessPointPolicy ( array $params = [] )
Deletes the access point policy for the specified access point.
- DeleteBucket ( array $params = [] )
This API operation deletes an Amazon S3 on Outposts bucket.
- DeleteBucketLifecycleConfiguration ( array $params = [] )
This API action deletes an Amazon S3 on Outposts bucket's lifecycle configuration.
- DeleteBucketPolicy ( array $params = [] )
This API operation deletes an Amazon S3 on Outposts bucket policy.
- DeleteBucketTagging ( array $params = [] )
This operation deletes an Amazon S3 on Outposts bucket's tags.
- DeleteJobTagging ( array $params = [] )
Removes the entire tag set from the specified S3 Batch Operations job.
- DeletePublicAccessBlock ( array $params = [] )
Removes the PublicAccessBlock configuration for an AWS account.
- DeleteStorageLensConfiguration ( array $params = [] )
Deletes the Amazon S3 Storage Lens configuration.
- DeleteStorageLensConfigurationTagging ( array $params = [] )
Deletes the Amazon S3 Storage Lens configuration tags.
- DescribeJob ( array $params = [] )
Retrieves the configuration parameters and status for a Batch Operations job.
- GetAccessPoint ( array $params = [] )
Returns configuration information about the specified access point.
- GetAccessPointPolicy ( array $params = [] )
Returns the access point policy associated with the specified access point.
- GetAccessPointPolicyStatus ( array $params = [] )
Indicates whether the specified access point currently has a policy that allows public access.
- GetBucket ( array $params = [] )
Gets an Amazon S3 on Outposts bucket.
- GetBucketLifecycleConfiguration ( array $params = [] )
This operation gets an Amazon S3 on Outposts bucket's lifecycle configuration.
- GetBucketPolicy ( array $params = [] )
This action gets a bucket policy for an Amazon S3 on Outposts bucket.
- GetBucketTagging ( array $params = [] )
This operation gets an Amazon S3 on Outposts bucket's tags.
- GetJobTagging ( array $params = [] )
Returns the tags on an S3 Batch Operations job.
- GetPublicAccessBlock ( array $params = [] )
Retrieves the PublicAccessBlock configuration for an AWS account.
- GetStorageLensConfiguration ( array $params = [] )
Gets the Amazon S3 Storage Lens configuration.
- GetStorageLensConfigurationTagging ( array $params = [] )
Gets the tags of Amazon S3 Storage Lens configuration.
- ListAccessPoints ( array $params = [] )
Returns a list of the access points currently associated with the specified bucket.
- ListJobs ( array $params = [] )
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request.
- ListRegionalBuckets ( array $params = [] )
Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request.
- ListStorageLensConfigurations ( array $params = [] )
Gets a list of Amazon S3 Storage Lens configurations.
- PutAccessPointPolicy ( array $params = [] )
Associates an access policy with the specified access point.
- PutBucketLifecycleConfiguration ( array $params = [] )
This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket.
- PutBucketPolicy ( array $params = [] )
This action puts a bucket policy to an Amazon S3 on Outposts bucket.
- PutBucketTagging ( array $params = [] )
This action puts tags on an Amazon S3 on Outposts bucket.
- PutJobTagging ( array $params = [] )
Sets the supplied tag-set on an S3 Batch Operations job.
- PutPublicAccessBlock ( array $params = [] )
Creates or modifies the PublicAccessBlock configuration for an AWS account.
- PutStorageLensConfiguration ( array $params = [] )
Puts an Amazon S3 Storage Lens configuration.
- PutStorageLensConfigurationTagging ( array $params = [] )
Put or replace tags on an existing Amazon S3 Storage Lens configuration.
- UpdateJobPriority ( array $params = [] )
Updates an existing S3 Batch Operations job's priority.
- UpdateJobStatus ( array $params = [] )
Updates the status for the specified job.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateAccessPoint
$result = $client->createAccessPoint
([/* ... */]); $promise = $client->createAccessPointAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->createAccessPoint([ 'AccountId' => '<string>', // REQUIRED 'Bucket' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'PublicAccessBlockConfiguration' => [ 'BlockPublicAcls' => true || false, 'BlockPublicPolicy' => true || false, 'IgnorePublicAcls' => true || false, 'RestrictPublicBuckets' => true || false, ], 'VpcConfiguration' => [ 'VpcId' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The AWS account ID for the owner of the bucket for which you want to create an access point.
- Bucket
-
- Required: Yes
- Type: string
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 bucketreports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports
. The value must be URL encoded. - Name
-
- Required: Yes
- Type: string
The name you want to assign to this access point.
- PublicAccessBlockConfiguration
-
- Type: PublicAccessBlockConfiguration structure
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.
- VpcConfiguration
-
- Type: VpcConfiguration structure
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.
Result Syntax
[ 'AccessPointArn' => '<string>', ]
Result Details
Members
Errors
There are no errors described for this operation.
CreateBucket
$result = $client->createBucket
([/* ... */]); $promise = $client->createBucketAsync
([/* ... */]);
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:
Parameter Syntax
$result = $client->createBucket([ 'ACL' => 'private|public-read|public-read-write|authenticated-read', 'Bucket' => '<string>', // REQUIRED 'CreateBucketConfiguration' => [ 'LocationConstraint' => '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', ], 'GrantFullControl' => '<string>', 'GrantRead' => '<string>', 'GrantReadACP' => '<string>', 'GrantWrite' => '<string>', 'GrantWriteACP' => '<string>', 'ObjectLockEnabledForBucket' => true || false, 'OutpostId' => '<string>', ]);
Parameter Details
Members
- ACL
-
- Type: string
The canned ACL to apply to the bucket.
This is not supported by Amazon S3 on Outposts buckets.
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket.
- CreateBucketConfiguration
-
- Type: CreateBucketConfiguration structure
The configuration information for the bucket.
This is not supported by Amazon S3 on Outposts buckets.
- GrantFullControl
-
- Type: string
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
This is not supported by Amazon S3 on Outposts buckets.
- GrantRead
-
- Type: string
Allows grantee to list the objects in the bucket.
This is not supported by Amazon S3 on Outposts buckets.
- GrantReadACP
-
- Type: string
Allows grantee to read the bucket ACL.
This is not supported by Amazon S3 on Outposts buckets.
- GrantWrite
-
- Type: string
Allows grantee to create, overwrite, and delete any object in the bucket.
This is not supported by Amazon S3 on Outposts buckets.
- GrantWriteACP
-
- Type: string
Allows grantee to write the ACL for the applicable bucket.
This is not supported by Amazon S3 on Outposts buckets.
- ObjectLockEnabledForBucket
-
- Type: boolean
Specifies whether you want S3 Object Lock to be enabled for the new bucket.
This is not supported by Amazon S3 on Outposts buckets.
- OutpostId
-
- Type: string
The ID of the Outposts where the bucket is being created.
This is required by Amazon S3 on Outposts buckets.
Result Syntax
[ 'BucketArn' => '<string>', 'Location' => '<string>', ]
Result Details
Members
- BucketArn
-
- Type: string
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 bucketreports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports
. The value must be URL encoded. - Location
-
- Type: string
The location of the bucket.
Errors
-
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.
-
The Outposts bucket you tried to create already exists, and you own it.
CreateJob
$result = $client->createJob
([/* ... */]); $promise = $client->createJobAsync
([/* ... */]);
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:
Parameter Syntax
$result = $client->createJob([ 'AccountId' => '<string>', // REQUIRED 'ClientRequestToken' => '<string>', // REQUIRED 'ConfirmationRequired' => true || false, 'Description' => '<string>', 'Manifest' => [ // REQUIRED 'Location' => [ // REQUIRED 'ETag' => '<string>', // REQUIRED 'ObjectArn' => '<string>', // REQUIRED 'ObjectVersionId' => '<string>', ], 'Spec' => [ // REQUIRED 'Fields' => ['<string>', ...], 'Format' => 'S3BatchOperations_CSV_20180820|S3InventoryReport_CSV_20161130', // REQUIRED ], ], 'Operation' => [ // REQUIRED 'LambdaInvoke' => [ 'FunctionArn' => '<string>', ], 'S3InitiateRestoreObject' => [ 'ExpirationInDays' => <integer>, 'GlacierJobTier' => 'BULK|STANDARD', ], 'S3PutObjectAcl' => [ 'AccessControlPolicy' => [ 'AccessControlList' => [ 'Grants' => [ [ 'Grantee' => [ 'DisplayName' => '<string>', 'Identifier' => '<string>', 'TypeIdentifier' => 'id|emailAddress|uri', ], 'Permission' => 'FULL_CONTROL|READ|WRITE|READ_ACP|WRITE_ACP', ], // ... ], 'Owner' => [ // REQUIRED 'DisplayName' => '<string>', 'ID' => '<string>', ], ], 'CannedAccessControlList' => 'private|public-read|public-read-write|aws-exec-read|authenticated-read|bucket-owner-read|bucket-owner-full-control', ], ], 'S3PutObjectCopy' => [ 'AccessControlGrants' => [ [ 'Grantee' => [ 'DisplayName' => '<string>', 'Identifier' => '<string>', 'TypeIdentifier' => 'id|emailAddress|uri', ], 'Permission' => 'FULL_CONTROL|READ|WRITE|READ_ACP|WRITE_ACP', ], // ... ], 'CannedAccessControlList' => 'private|public-read|public-read-write|aws-exec-read|authenticated-read|bucket-owner-read|bucket-owner-full-control', 'MetadataDirective' => 'COPY|REPLACE', 'ModifiedSinceConstraint' => <integer || string || DateTime>, 'NewObjectMetadata' => [ 'CacheControl' => '<string>', 'ContentDisposition' => '<string>', 'ContentEncoding' => '<string>', 'ContentLanguage' => '<string>', 'ContentLength' => <integer>, 'ContentMD5' => '<string>', 'ContentType' => '<string>', 'HttpExpiresDate' => <integer || string || DateTime>, 'RequesterCharged' => true || false, 'SSEAlgorithm' => 'AES256|KMS', 'UserMetadata' => ['<string>', ...], ], 'NewObjectTagging' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'ObjectLockLegalHoldStatus' => 'OFF|ON', 'ObjectLockMode' => 'COMPLIANCE|GOVERNANCE', 'ObjectLockRetainUntilDate' => <integer || string || DateTime>, 'RedirectLocation' => '<string>', 'RequesterPays' => true || false, 'SSEAwsKmsKeyId' => '<string>', 'StorageClass' => 'STANDARD|STANDARD_IA|ONEZONE_IA|GLACIER|INTELLIGENT_TIERING|DEEP_ARCHIVE', 'TargetKeyPrefix' => '<string>', 'TargetResource' => '<string>', 'UnModifiedSinceConstraint' => <integer || string || DateTime>, ], 'S3PutObjectLegalHold' => [ 'LegalHold' => [ // REQUIRED 'Status' => 'OFF|ON', // REQUIRED ], ], 'S3PutObjectRetention' => [ 'BypassGovernanceRetention' => true || false, 'Retention' => [ // REQUIRED 'Mode' => 'COMPLIANCE|GOVERNANCE', 'RetainUntilDate' => <integer || string || DateTime>, ], ], 'S3PutObjectTagging' => [ 'TagSet' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Priority' => <integer>, // REQUIRED 'Report' => [ // REQUIRED 'Bucket' => '<string>', 'Enabled' => true || false, // REQUIRED 'Format' => 'Report_CSV_20180820', 'Prefix' => '<string>', 'ReportScope' => 'AllTasks|FailedTasksOnly', ], 'RoleArn' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The AWS account ID that creates the job.
- ClientRequestToken
-
- Required: Yes
- Type: string
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.
- ConfirmationRequired
-
- Type: boolean
Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.
- Description
-
- Type: string
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.
- Manifest
-
- Required: Yes
- Type: JobManifest structure
Configuration parameters for the manifest.
- Operation
-
- Required: Yes
- Type: JobOperation structure
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.
- Priority
-
- Required: Yes
- Type: int
The numerical priority for this job. Higher numbers indicate higher priority.
- Report
-
- Required: Yes
- Type: JobReport structure
Configuration parameters for the optional job-completion report.
- RoleArn
-
- Required: Yes
- Type: string
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
-
- Type: Array of S3Tag structures
A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.
Result Syntax
[ 'JobId' => '<string>', ]
Result Details
Members
Errors
DeleteAccessPoint
$result = $client->deleteAccessPoint
([/* ... */]); $promise = $client->deleteAccessPointAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->deleteAccessPoint([ 'AccountId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The account ID for the account that owns the specified access point.
- Name
-
- Required: Yes
- Type: string
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 pointreports-ap
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap
. The value must be URL encoded.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteAccessPointPolicy
$result = $client->deleteAccessPointPolicy
([/* ... */]); $promise = $client->deleteAccessPointPolicyAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->deleteAccessPointPolicy([ 'AccountId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The account ID for the account that owns the specified access point.
- Name
-
- Required: Yes
- Type: string
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 pointreports-ap
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap
. The value must be URL encoded.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteBucket
$result = $client->deleteBucket
([/* ... */]); $promise = $client->deleteBucketAsync
([/* ... */]);
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
Parameter Syntax
$result = $client->deleteBucket([ 'AccountId' => '<string>', // REQUIRED 'Bucket' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The account ID that owns the Outposts bucket.
- Bucket
-
- Required: Yes
- Type: string
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 bucketreports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports
. The value must be URL encoded.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteBucketLifecycleConfiguration
$result = $client->deleteBucketLifecycleConfiguration
([/* ... */]); $promise = $client->deleteBucketLifecycleConfigurationAsync
([/* ... */]);
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:
Parameter Syntax
$result = $client->deleteBucketLifecycleConfiguration([ 'AccountId' => '<string>', // REQUIRED 'Bucket' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The account ID of the lifecycle configuration to delete.
- Bucket
-
- Required: Yes
- Type: string
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 bucketreports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports
. The value must be URL encoded.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteBucketPolicy
$result = $client->deleteBucketPolicy
([/* ... */]); $promise = $client->deleteBucketPolicyAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->deleteBucketPolicy([ 'AccountId' => '<string>', // REQUIRED 'Bucket' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The account ID of the Outposts bucket.
- Bucket
-
- Required: Yes
- Type: string
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 bucketreports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports
. The value must be URL encoded.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteBucketTagging
$result = $client->deleteBucketTagging
([/* ... */]); $promise = $client->deleteBucketTaggingAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->deleteBucketTagging([ 'AccountId' => '<string>', // REQUIRED 'Bucket' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The AWS account ID of the Outposts bucket tag set to be removed.
- Bucket
-
- Required: Yes
- Type: string
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 bucketreports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports
. The value must be URL encoded.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteJobTagging
$result = $client->deleteJobTagging
([/* ... */]); $promise = $client->deleteJobTaggingAsync
([/* ... */]);
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:
Parameter Syntax
$result = $client->deleteJobTagging([ 'AccountId' => '<string>', // REQUIRED 'JobId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
DeletePublicAccessBlock
$result = $client->deletePublicAccessBlock
([/* ... */]); $promise = $client->deletePublicAccessBlockAsync
([/* ... */]);
Removes the PublicAccessBlock
configuration for an AWS account. For more information, see Using Amazon S3 block public access.
Related actions include:
Parameter Syntax
$result = $client->deletePublicAccessBlock([ 'AccountId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteStorageLensConfiguration
$result = $client->deleteStorageLensConfiguration
([/* ... */]); $promise = $client->deleteStorageLensConfigurationAsync
([/* ... */]);
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.
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.
Parameter Syntax
$result = $client->deleteStorageLensConfiguration([ 'AccountId' => '<string>', // REQUIRED 'ConfigId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteStorageLensConfigurationTagging
$result = $client->deleteStorageLensConfigurationTagging
([/* ... */]); $promise = $client->deleteStorageLensConfigurationTaggingAsync
([/* ... */]);
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.
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.
Parameter Syntax
$result = $client->deleteStorageLensConfigurationTagging([ 'AccountId' => '<string>', // REQUIRED 'ConfigId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DescribeJob
$result = $client->describeJob
([/* ... */]); $promise = $client->describeJobAsync
([/* ... */]);
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:
Parameter Syntax
$result = $client->describeJob([ 'AccountId' => '<string>', // REQUIRED 'JobId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'Job' => [ 'ConfirmationRequired' => true || false, 'CreationTime' => <DateTime>, 'Description' => '<string>', 'FailureReasons' => [ [ 'FailureCode' => '<string>', 'FailureReason' => '<string>', ], // ... ], 'JobArn' => '<string>', 'JobId' => '<string>', 'Manifest' => [ 'Location' => [ 'ETag' => '<string>', 'ObjectArn' => '<string>', 'ObjectVersionId' => '<string>', ], 'Spec' => [ 'Fields' => ['<string>', ...], 'Format' => 'S3BatchOperations_CSV_20180820|S3InventoryReport_CSV_20161130', ], ], 'Operation' => [ 'LambdaInvoke' => [ 'FunctionArn' => '<string>', ], 'S3InitiateRestoreObject' => [ 'ExpirationInDays' => <integer>, 'GlacierJobTier' => 'BULK|STANDARD', ], 'S3PutObjectAcl' => [ 'AccessControlPolicy' => [ 'AccessControlList' => [ 'Grants' => [ [ 'Grantee' => [ 'DisplayName' => '<string>', 'Identifier' => '<string>', 'TypeIdentifier' => 'id|emailAddress|uri', ], 'Permission' => 'FULL_CONTROL|READ|WRITE|READ_ACP|WRITE_ACP', ], // ... ], 'Owner' => [ 'DisplayName' => '<string>', 'ID' => '<string>', ], ], 'CannedAccessControlList' => 'private|public-read|public-read-write|aws-exec-read|authenticated-read|bucket-owner-read|bucket-owner-full-control', ], ], 'S3PutObjectCopy' => [ 'AccessControlGrants' => [ [ 'Grantee' => [ 'DisplayName' => '<string>', 'Identifier' => '<string>', 'TypeIdentifier' => 'id|emailAddress|uri', ], 'Permission' => 'FULL_CONTROL|READ|WRITE|READ_ACP|WRITE_ACP', ], // ... ], 'CannedAccessControlList' => 'private|public-read|public-read-write|aws-exec-read|authenticated-read|bucket-owner-read|bucket-owner-full-control', 'MetadataDirective' => 'COPY|REPLACE', 'ModifiedSinceConstraint' => <DateTime>, 'NewObjectMetadata' => [ 'CacheControl' => '<string>', 'ContentDisposition' => '<string>', 'ContentEncoding' => '<string>', 'ContentLanguage' => '<string>', 'ContentLength' => <integer>, 'ContentMD5' => '<string>', 'ContentType' => '<string>', 'HttpExpiresDate' => <DateTime>, 'RequesterCharged' => true || false, 'SSEAlgorithm' => 'AES256|KMS', 'UserMetadata' => ['<string>', ...], ], 'NewObjectTagging' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'ObjectLockLegalHoldStatus' => 'OFF|ON', 'ObjectLockMode' => 'COMPLIANCE|GOVERNANCE', 'ObjectLockRetainUntilDate' => <DateTime>, 'RedirectLocation' => '<string>', 'RequesterPays' => true || false, 'SSEAwsKmsKeyId' => '<string>', 'StorageClass' => 'STANDARD|STANDARD_IA|ONEZONE_IA|GLACIER|INTELLIGENT_TIERING|DEEP_ARCHIVE', 'TargetKeyPrefix' => '<string>', 'TargetResource' => '<string>', 'UnModifiedSinceConstraint' => <DateTime>, ], 'S3PutObjectLegalHold' => [ 'LegalHold' => [ 'Status' => 'OFF|ON', ], ], 'S3PutObjectRetention' => [ 'BypassGovernanceRetention' => true || false, 'Retention' => [ 'Mode' => 'COMPLIANCE|GOVERNANCE', 'RetainUntilDate' => <DateTime>, ], ], 'S3PutObjectTagging' => [ 'TagSet' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Priority' => <integer>, 'ProgressSummary' => [ 'NumberOfTasksFailed' => <integer>, 'NumberOfTasksSucceeded' => <integer>, 'TotalNumberOfTasks' => <integer>, ], 'Report' => [ 'Bucket' => '<string>', 'Enabled' => true || false, 'Format' => 'Report_CSV_20180820', 'Prefix' => '<string>', 'ReportScope' => 'AllTasks|FailedTasksOnly', ], 'RoleArn' => '<string>', 'Status' => 'Active|Cancelled|Cancelling|Complete|Completing|Failed|Failing|New|Paused|Pausing|Preparing|Ready|Suspended', 'StatusUpdateReason' => '<string>', 'SuspendedCause' => '<string>', 'SuspendedDate' => <DateTime>, 'TerminationDate' => <DateTime>, ], ]
Result Details
Members
- Job
-
- Type: JobDescriptor structure
Contains the configuration parameters and status for the job specified in the
Describe Job
request.
Errors
GetAccessPoint
$result = $client->getAccessPoint
([/* ... */]); $promise = $client->getAccessPointAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getAccessPoint([ 'AccountId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The account ID for the account that owns the specified access point.
- Name
-
- Required: Yes
- Type: string
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 pointreports-ap
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap
. The value must be URL encoded.
Result Syntax
[ 'Bucket' => '<string>', 'CreationDate' => <DateTime>, 'Name' => '<string>', 'NetworkOrigin' => 'Internet|VPC', 'PublicAccessBlockConfiguration' => [ 'BlockPublicAcls' => true || false, 'BlockPublicPolicy' => true || false, 'IgnorePublicAcls' => true || false, 'RestrictPublicBuckets' => true || false, ], 'VpcConfiguration' => [ 'VpcId' => '<string>', ], ]
Result Details
Members
- Bucket
-
- Type: string
The name of the bucket associated with the specified access point.
- CreationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the specified access point was created.
- Name
-
- Type: string
The name of the specified access point.
- NetworkOrigin
-
- Type: string
Indicates whether this access point allows access from the public internet. If
VpcConfiguration
is specified for this access point, thenNetworkOrigin
isVPC
, and the access point doesn't allow access from the public internet. Otherwise,NetworkOrigin
isInternet
, 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
- PublicAccessBlockConfiguration
-
- Type: PublicAccessBlockConfiguration structure
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.
- VpcConfiguration
-
- Type: VpcConfiguration structure
Contains the virtual private cloud (VPC) configuration for the specified access point.
Errors
There are no errors described for this operation.
GetAccessPointPolicy
$result = $client->getAccessPointPolicy
([/* ... */]); $promise = $client->getAccessPointPolicyAsync
([/* ... */]);
Returns the access point policy associated with the specified access point.
The following actions are related to GetAccessPointPolicy
:
Parameter Syntax
$result = $client->getAccessPointPolicy([ 'AccountId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The account ID for the account that owns the specified access point.
- Name
-
- Required: Yes
- Type: string
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 pointreports-ap
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap
. The value must be URL encoded.
Result Syntax
[ 'Policy' => '<string>', ]
Result Details
Errors
There are no errors described for this operation.
GetAccessPointPolicyStatus
$result = $client->getAccessPointPolicyStatus
([/* ... */]); $promise = $client->getAccessPointPolicyStatusAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->getAccessPointPolicyStatus([ 'AccountId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'PolicyStatus' => [ 'IsPublic' => true || false, ], ]
Result Details
Members
- PolicyStatus
-
- Type: PolicyStatus structure
Indicates the current policy status of the specified access point.
Errors
There are no errors described for this operation.
GetBucket
$result = $client->getBucket
([/* ... */]); $promise = $client->getBucketAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->getBucket([ 'AccountId' => '<string>', // REQUIRED 'Bucket' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The AWS account ID of the Outposts bucket.
- Bucket
-
- Required: Yes
- Type: string
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 bucketreports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports
. The value must be URL encoded.
Result Syntax
[ 'Bucket' => '<string>', 'CreationDate' => <DateTime>, 'PublicAccessBlockEnabled' => true || false, ]
Result Details
Members
Errors
There are no errors described for this operation.
GetBucketLifecycleConfiguration
$result = $client->getBucketLifecycleConfiguration
([/* ... */]); $promise = $client->getBucketLifecycleConfigurationAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getBucketLifecycleConfiguration([ 'AccountId' => '<string>', // REQUIRED 'Bucket' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The AWS account ID of the Outposts bucket.
- Bucket
-
- Required: Yes
- Type: string
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 bucketreports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports
. The value must be URL encoded.
Result Syntax
[ 'Rules' => [ [ 'AbortIncompleteMultipartUpload' => [ 'DaysAfterInitiation' => <integer>, ], 'Expiration' => [ 'Date' => <DateTime>, 'Days' => <integer>, 'ExpiredObjectDeleteMarker' => true || false, ], 'Filter' => [ 'And' => [ 'Prefix' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], 'Prefix' => '<string>', 'Tag' => [ 'Key' => '<string>', 'Value' => '<string>', ], ], 'ID' => '<string>', 'NoncurrentVersionExpiration' => [ 'NoncurrentDays' => <integer>, ], 'NoncurrentVersionTransitions' => [ [ 'NoncurrentDays' => <integer>, 'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE', ], // ... ], 'Status' => 'Enabled|Disabled', 'Transitions' => [ [ 'Date' => <DateTime>, 'Days' => <integer>, 'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE', ], // ... ], ], // ... ], ]
Result Details
Members
- Rules
-
- Type: Array of LifecycleRule structures
Container for the lifecycle rule of the Outposts bucket.
Errors
There are no errors described for this operation.
GetBucketPolicy
$result = $client->getBucketPolicy
([/* ... */]); $promise = $client->getBucketPolicyAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getBucketPolicy([ 'AccountId' => '<string>', // REQUIRED 'Bucket' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The AWS account ID of the Outposts bucket.
- Bucket
-
- Required: Yes
- Type: string
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 bucketreports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports
. The value must be URL encoded.
Result Syntax
[ 'Policy' => '<string>', ]
Result Details
Errors
There are no errors described for this operation.
GetBucketTagging
$result = $client->getBucketTagging
([/* ... */]); $promise = $client->getBucketTaggingAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getBucketTagging([ 'AccountId' => '<string>', // REQUIRED 'Bucket' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The AWS account ID of the Outposts bucket.
- Bucket
-
- Required: Yes
- Type: string
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 bucketreports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports
. The value must be URL encoded.
Result Syntax
[ 'TagSet' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- TagSet
-
- Required: Yes
- Type: Array of S3Tag structures
The tags set of the Outposts bucket.
Errors
There are no errors described for this operation.
GetJobTagging
$result = $client->getJobTagging
([/* ... */]); $promise = $client->getJobTaggingAsync
([/* ... */]);
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:
Parameter Syntax
$result = $client->getJobTagging([ 'AccountId' => '<string>', // REQUIRED 'JobId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- Tags
-
- Type: Array of S3Tag structures
The set of tags associated with the S3 Batch Operations job.
Errors
GetPublicAccessBlock
$result = $client->getPublicAccessBlock
([/* ... */]); $promise = $client->getPublicAccessBlockAsync
([/* ... */]);
Retrieves the PublicAccessBlock
configuration for an AWS account. For more information, see Using Amazon S3 block public access.
Related actions include:
Parameter Syntax
$result = $client->getPublicAccessBlock([ 'AccountId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'PublicAccessBlockConfiguration' => [ 'BlockPublicAcls' => true || false, 'BlockPublicPolicy' => true || false, 'IgnorePublicAcls' => true || false, 'RestrictPublicBuckets' => true || false, ], ]
Result Details
Members
- PublicAccessBlockConfiguration
-
- Type: PublicAccessBlockConfiguration structure
The
PublicAccessBlock
configuration currently in effect for this AWS account.
Errors
-
NoSuchPublicAccessBlockConfiguration:
Amazon S3 throws this exception if you make a
GetPublicAccessBlock
request against an account that doesn't have aPublicAccessBlockConfiguration
set.
GetStorageLensConfiguration
$result = $client->getStorageLensConfiguration
([/* ... */]); $promise = $client->getStorageLensConfigurationAsync
([/* ... */]);
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.
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.
Parameter Syntax
$result = $client->getStorageLensConfiguration([ 'AccountId' => '<string>', // REQUIRED 'ConfigId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'StorageLensConfiguration' => [ 'AccountLevel' => [ 'ActivityMetrics' => [ 'IsEnabled' => true || false, ], 'BucketLevel' => [ 'ActivityMetrics' => [ 'IsEnabled' => true || false, ], 'PrefixLevel' => [ 'StorageMetrics' => [ 'IsEnabled' => true || false, 'SelectionCriteria' => [ 'Delimiter' => '<string>', 'MaxDepth' => <integer>, 'MinStorageBytesPercentage' => <float>, ], ], ], ], ], 'AwsOrg' => [ 'Arn' => '<string>', ], 'DataExport' => [ 'S3BucketDestination' => [ 'AccountId' => '<string>', 'Arn' => '<string>', 'Encryption' => [ 'SSEKMS' => [ 'KeyId' => '<string>', ], 'SSES3' => [ ], ], 'Format' => 'CSV|Parquet', 'OutputSchemaVersion' => 'V_1', 'Prefix' => '<string>', ], ], 'Exclude' => [ 'Buckets' => ['<string>', ...], 'Regions' => ['<string>', ...], ], 'Id' => '<string>', 'Include' => [ 'Buckets' => ['<string>', ...], 'Regions' => ['<string>', ...], ], 'IsEnabled' => true || false, 'StorageLensArn' => '<string>', ], ]
Result Details
Members
- StorageLensConfiguration
-
- Type: StorageLensConfiguration structure
The S3 Storage Lens configuration requested.
Errors
There are no errors described for this operation.
GetStorageLensConfigurationTagging
$result = $client->getStorageLensConfigurationTagging
([/* ... */]); $promise = $client->getStorageLensConfigurationTaggingAsync
([/* ... */]);
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.
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.
Parameter Syntax
$result = $client->getStorageLensConfigurationTagging([ 'AccountId' => '<string>', // REQUIRED 'ConfigId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- Tags
-
- Type: Array of StorageLensTag structures
The tags of S3 Storage Lens configuration requested.
Errors
There are no errors described for this operation.
ListAccessPoints
$result = $client->listAccessPoints
([/* ... */]); $promise = $client->listAccessPointsAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->listAccessPoints([ 'AccountId' => '<string>', // REQUIRED 'Bucket' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The AWS account ID for owner of the bucket whose access points you want to list.
- Bucket
-
- Type: string
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 bucketreports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports
. The value must be URL encoded. - MaxResults
-
- Type: int
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. - NextToken
-
- Type: string
A continuation token. If a previous call to
ListAccessPoints
returned a continuation token in theNextToken
field, then providing that value here causes Amazon S3 to retrieve the next page of results.
Result Syntax
[ 'AccessPointList' => [ [ 'AccessPointArn' => '<string>', 'Bucket' => '<string>', 'Name' => '<string>', 'NetworkOrigin' => 'Internet|VPC', 'VpcConfiguration' => [ 'VpcId' => '<string>', ], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- AccessPointList
-
- Type: Array of AccessPoint structures
Contains identification and configuration information for one or more access points associated with the specified bucket.
- NextToken
-
- Type: string
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.
Errors
There are no errors described for this operation.
ListJobs
$result = $client->listJobs
([/* ... */]); $promise = $client->listJobsAsync
([/* ... */]);
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:
Parameter Syntax
$result = $client->listJobs([ 'AccountId' => '<string>', // REQUIRED 'JobStatuses' => ['<string>', ...], 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
- JobStatuses
-
- Type: Array of strings
The
List Jobs
request returns jobs that match the statuses listed in this element. - MaxResults
-
- Type: int
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 theNextToken
field to enable you to retrieve the next page of results. - NextToken
-
- Type: string
A pagination token to request the next page of results. Use the token that Amazon S3 returned in the
NextToken
element of theListJobsResult
from the previousList Jobs
request.
Result Syntax
[ 'Jobs' => [ [ 'CreationTime' => <DateTime>, 'Description' => '<string>', 'JobId' => '<string>', 'Operation' => 'LambdaInvoke|S3PutObjectCopy|S3PutObjectAcl|S3PutObjectTagging|S3InitiateRestoreObject|S3PutObjectLegalHold|S3PutObjectRetention', 'Priority' => <integer>, 'ProgressSummary' => [ 'NumberOfTasksFailed' => <integer>, 'NumberOfTasksSucceeded' => <integer>, 'TotalNumberOfTasks' => <integer>, ], 'Status' => 'Active|Cancelled|Cancelling|Complete|Completing|Failed|Failing|New|Paused|Pausing|Preparing|Ready|Suspended', 'TerminationDate' => <DateTime>, ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- Jobs
-
- Type: Array of JobListDescriptor structures
The list of current jobs and jobs that have ended within the last 30 days.
- NextToken
-
- Type: string
If the
List Jobs
request produced more than the maximum number of results, you can pass this value into a subsequentList Jobs
request in order to retrieve the next page of results.
Errors
ListRegionalBuckets
$result = $client->listRegionalBuckets
([/* ... */]); $promise = $client->listRegionalBucketsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listRegionalBuckets([ 'AccountId' => '<string>', // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', 'OutpostId' => '<string>', ]);
Parameter Details
Members
Result Syntax
[ 'NextToken' => '<string>', 'RegionalBucketList' => [ [ 'Bucket' => '<string>', 'BucketArn' => '<string>', 'CreationDate' => <DateTime>, 'OutpostId' => '<string>', 'PublicAccessBlockEnabled' => true || false, ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
NextToken
is sent whenisTruncated
is true, which means there are more buckets that can be listed. The next list requests to Amazon S3 can be continued with thisNextToken
.NextToken
is obfuscated and is not a real key. - RegionalBucketList
-
- Type: Array of RegionalBucket structures
Errors
There are no errors described for this operation.
ListStorageLensConfigurations
$result = $client->listStorageLensConfigurations
([/* ... */]); $promise = $client->listStorageLensConfigurationsAsync
([/* ... */]);
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.
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.
Parameter Syntax
$result = $client->listStorageLensConfigurations([ 'AccountId' => '<string>', // REQUIRED 'NextToken' => '<string>', ]);
Parameter Details
Members
Result Syntax
[ 'NextToken' => '<string>', 'StorageLensConfigurationList' => [ [ 'HomeRegion' => '<string>', 'Id' => '<string>', 'IsEnabled' => true || false, 'StorageLensArn' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
If the request produced more than the maximum number of S3 Storage Lens configuration results, you can pass this value into a subsequent request to retrieve the next page of results.
- StorageLensConfigurationList
-
- Type: Array of ListStorageLensConfigurationEntry structures
A list of S3 Storage Lens configurations.
Errors
There are no errors described for this operation.
PutAccessPointPolicy
$result = $client->putAccessPointPolicy
([/* ... */]); $promise = $client->putAccessPointPolicyAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->putAccessPointPolicy([ 'AccountId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Policy' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The AWS account ID for owner of the bucket associated with the specified access point.
- Name
-
- Required: Yes
- Type: string
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 pointreports-ap
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap
. The value must be URL encoded. - Policy
-
- Required: Yes
- Type: string
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.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
PutBucketLifecycleConfiguration
$result = $client->putBucketLifecycleConfiguration
([/* ... */]); $promise = $client->putBucketLifecycleConfigurationAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->putBucketLifecycleConfiguration([ 'AccountId' => '<string>', // REQUIRED 'Bucket' => '<string>', // REQUIRED 'LifecycleConfiguration' => [ 'Rules' => [ [ 'AbortIncompleteMultipartUpload' => [ 'DaysAfterInitiation' => <integer>, ], 'Expiration' => [ 'Date' => <integer || string || DateTime>, 'Days' => <integer>, 'ExpiredObjectDeleteMarker' => true || false, ], 'Filter' => [ 'And' => [ 'Prefix' => '<string>', 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], 'Prefix' => '<string>', 'Tag' => [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], ], 'ID' => '<string>', 'NoncurrentVersionExpiration' => [ 'NoncurrentDays' => <integer>, ], 'NoncurrentVersionTransitions' => [ [ 'NoncurrentDays' => <integer>, 'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE', ], // ... ], 'Status' => 'Enabled|Disabled', // REQUIRED 'Transitions' => [ [ 'Date' => <integer || string || DateTime>, 'Days' => <integer>, 'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE', ], // ... ], ], // ... ], ], ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The AWS account ID of the Outposts bucket.
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket for which to set the configuration.
- LifecycleConfiguration
-
- Type: LifecycleConfiguration structure
Container for lifecycle rules. You can add as many as 1,000 rules.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
PutBucketPolicy
$result = $client->putBucketPolicy
([/* ... */]); $promise = $client->putBucketPolicyAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->putBucketPolicy([ 'AccountId' => '<string>', // REQUIRED 'Bucket' => '<string>', // REQUIRED 'ConfirmRemoveSelfBucketAccess' => true || false, 'Policy' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The AWS account ID of the Outposts bucket.
- Bucket
-
- Required: Yes
- Type: string
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 bucketreports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports
. The value must be URL encoded. - ConfirmRemoveSelfBucketAccess
-
- Type: boolean
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.
- Policy
-
- Required: Yes
- Type: string
The bucket policy as a JSON document.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
PutBucketTagging
$result = $client->putBucketTagging
([/* ... */]); $promise = $client->putBucketTaggingAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->putBucketTagging([ 'AccountId' => '<string>', // REQUIRED 'Bucket' => '<string>', // REQUIRED 'Tagging' => [ // REQUIRED 'TagSet' => [ // REQUIRED [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The AWS account ID of the Outposts bucket.
- Bucket
-
- Required: Yes
- Type: string
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 bucketreports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports
. The value must be URL encoded. - Tagging
-
- Required: Yes
- Type: Tagging structure
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
PutJobTagging
$result = $client->putJobTagging
([/* ... */]); $promise = $client->putJobTaggingAsync
([/* ... */]);
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:
Parameter Syntax
$result = $client->putJobTagging([ 'AccountId' => '<string>', // REQUIRED 'JobId' => '<string>', // REQUIRED 'Tags' => [ // REQUIRED [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The AWS account ID associated with the S3 Batch Operations job.
- JobId
-
- Required: Yes
- Type: string
The ID for the S3 Batch Operations job whose tags you want to replace.
- Tags
-
- Required: Yes
- Type: Array of S3Tag structures
The set of tags to associate with the S3 Batch Operations job.
Result Syntax
[]
Result Details
Errors
-
Amazon S3 throws this exception if you have too many tags in your tag set.
PutPublicAccessBlock
$result = $client->putPublicAccessBlock
([/* ... */]); $promise = $client->putPublicAccessBlockAsync
([/* ... */]);
Creates or modifies the PublicAccessBlock
configuration for an AWS account. For more information, see Using Amazon S3 block public access.
Related actions include:
Parameter Syntax
$result = $client->putPublicAccessBlock([ 'AccountId' => '<string>', // REQUIRED 'PublicAccessBlockConfiguration' => [ // REQUIRED 'BlockPublicAcls' => true || false, 'BlockPublicPolicy' => true || false, 'IgnorePublicAcls' => true || false, 'RestrictPublicBuckets' => true || false, ], ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The account ID for the AWS account whose
PublicAccessBlock
configuration you want to set. - PublicAccessBlockConfiguration
-
- Required: Yes
- Type: PublicAccessBlockConfiguration structure
The
PublicAccessBlock
configuration that you want to apply to the specified AWS account.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
PutStorageLensConfiguration
$result = $client->putStorageLensConfiguration
([/* ... */]); $promise = $client->putStorageLensConfigurationAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->putStorageLensConfiguration([ 'AccountId' => '<string>', // REQUIRED 'ConfigId' => '<string>', // REQUIRED 'StorageLensConfiguration' => [ // REQUIRED 'AccountLevel' => [ // REQUIRED 'ActivityMetrics' => [ 'IsEnabled' => true || false, ], 'BucketLevel' => [ // REQUIRED 'ActivityMetrics' => [ 'IsEnabled' => true || false, ], 'PrefixLevel' => [ 'StorageMetrics' => [ // REQUIRED 'IsEnabled' => true || false, 'SelectionCriteria' => [ 'Delimiter' => '<string>', 'MaxDepth' => <integer>, 'MinStorageBytesPercentage' => <float>, ], ], ], ], ], 'AwsOrg' => [ 'Arn' => '<string>', // REQUIRED ], 'DataExport' => [ 'S3BucketDestination' => [ // REQUIRED 'AccountId' => '<string>', // REQUIRED 'Arn' => '<string>', // REQUIRED 'Encryption' => [ 'SSEKMS' => [ 'KeyId' => '<string>', // REQUIRED ], 'SSES3' => [ ], ], 'Format' => 'CSV|Parquet', // REQUIRED 'OutputSchemaVersion' => 'V_1', // REQUIRED 'Prefix' => '<string>', ], ], 'Exclude' => [ 'Buckets' => ['<string>', ...], 'Regions' => ['<string>', ...], ], 'Id' => '<string>', // REQUIRED 'Include' => [ 'Buckets' => ['<string>', ...], 'Regions' => ['<string>', ...], ], 'IsEnabled' => true || false, // REQUIRED 'StorageLensArn' => '<string>', ], 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The account ID of the requester.
- ConfigId
-
- Required: Yes
- Type: string
The ID of the S3 Storage Lens configuration.
- StorageLensConfiguration
-
- Required: Yes
- Type: StorageLensConfiguration structure
The S3 Storage Lens configuration.
- Tags
-
- Type: Array of StorageLensTag structures
The tag set of the S3 Storage Lens configuration.
You can set up to a maximum of 50 tags.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
PutStorageLensConfigurationTagging
$result = $client->putStorageLensConfigurationTagging
([/* ... */]); $promise = $client->putStorageLensConfigurationTaggingAsync
([/* ... */]);
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.
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.
Parameter Syntax
$result = $client->putStorageLensConfigurationTagging([ 'AccountId' => '<string>', // REQUIRED 'ConfigId' => '<string>', // REQUIRED 'Tags' => [ // REQUIRED [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The account ID of the requester.
- ConfigId
-
- Required: Yes
- Type: string
The ID of the S3 Storage Lens configuration.
- Tags
-
- Required: Yes
- Type: Array of StorageLensTag structures
The tag set of the S3 Storage Lens configuration.
You can set up to a maximum of 50 tags.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
UpdateJobPriority
$result = $client->updateJobPriority
([/* ... */]); $promise = $client->updateJobPriorityAsync
([/* ... */]);
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:
Parameter Syntax
$result = $client->updateJobPriority([ 'AccountId' => '<string>', // REQUIRED 'JobId' => '<string>', // REQUIRED 'Priority' => <integer>, // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'JobId' => '<string>', 'Priority' => <integer>, ]
Result Details
Members
Errors
UpdateJobStatus
$result = $client->updateJobStatus
([/* ... */]); $promise = $client->updateJobStatusAsync
([/* ... */]);
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:
Parameter Syntax
$result = $client->updateJobStatus([ 'AccountId' => '<string>', // REQUIRED 'JobId' => '<string>', // REQUIRED 'RequestedJobStatus' => 'Cancelled|Ready', // REQUIRED 'StatusUpdateReason' => '<string>', ]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
- JobId
-
- Required: Yes
- Type: string
The ID of the job whose status you want to update.
- RequestedJobStatus
-
- Required: Yes
- Type: string
The status that you want to move the specified job to.
- StatusUpdateReason
-
- Type: string
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.
Result Syntax
[ 'JobId' => '<string>', 'Status' => 'Active|Cancelled|Cancelling|Complete|Completing|Failed|Failing|New|Paused|Pausing|Preparing|Ready|Suspended', 'StatusUpdateReason' => '<string>', ]
Result Details
Members
Errors
Shapes
AbortIncompleteMultipartUpload
Description
The container for abort incomplete multipart upload
Members
AccessPoint
Description
An access point used to access a bucket.
Members
- AccessPointArn
-
- Type: string
The ARN for the access point.
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket associated with this access point.
- Name
-
- Required: Yes
- Type: string
The name of this access point.
- NetworkOrigin
-
- Required: Yes
- Type: string
Indicates whether this access point allows access from the public internet. If
VpcConfiguration
is specified for this access point, thenNetworkOrigin
isVPC
, and the access point doesn't allow access from the public internet. Otherwise,NetworkOrigin
isInternet
, and the access point allows access from the public internet, subject to the access point and bucket access policies. - VpcConfiguration
-
- Type: VpcConfiguration structure
The virtual private cloud (VPC) configuration for this access point, if one exists.
AccountLevel
Description
A container for the account level Amazon S3 Storage Lens configuration.
Members
- ActivityMetrics
-
- Type: ActivityMetrics structure
A container for the S3 Storage Lens activity metrics.
- BucketLevel
-
- Required: Yes
- Type: BucketLevel structure
A container for the S3 Storage Lens bucket-level configuration.
ActivityMetrics
Description
A container for the activity metrics.
Members
BadRequestException
BucketAlreadyExists
Description
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.
Members
BucketAlreadyOwnedByYou
Description
The Outposts bucket you tried to create already exists, and you own it.
Members
BucketLevel
Description
A container for the bucket-level configuration.
Members
- ActivityMetrics
-
- Type: ActivityMetrics structure
A container for the bucket-level activity metrics for Amazon S3 Storage Lens
- PrefixLevel
-
- Type: PrefixLevel structure
A container for the bucket-level prefix-level metrics for S3 Storage Lens
CreateAccessPointRequest
Members
- AccountId
-
- Required: Yes
- Type: string
The AWS account ID for the owner of the bucket for which you want to create an access point.
- Bucket
-
- Required: Yes
- Type: string
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 bucketreports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports
. The value must be URL encoded. - Name
-
- Required: Yes
- Type: string
The name you want to assign to this access point.
- PublicAccessBlockConfiguration
-
- Type: PublicAccessBlockConfiguration structure
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.
- VpcConfiguration
-
- Type: VpcConfiguration structure
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.
CreateBucketConfiguration
Description
The container for the bucket configuration.
This is not supported by Amazon S3 on Outposts buckets.
Members
CreateJobRequest
Members
- AccountId
-
- Required: Yes
- Type: string
The AWS account ID that creates the job.
- ClientRequestToken
-
- Required: Yes
- Type: string
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.
- ConfirmationRequired
-
- Type: boolean
Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.
- Description
-
- Type: string
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.
- Manifest
-
- Required: Yes
- Type: JobManifest structure
Configuration parameters for the manifest.
- Operation
-
- Required: Yes
- Type: JobOperation structure
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.
- Priority
-
- Required: Yes
- Type: int
The numerical priority for this job. Higher numbers indicate higher priority.
- Report
-
- Required: Yes
- Type: JobReport structure
Configuration parameters for the optional job-completion report.
- RoleArn
-
- Required: Yes
- Type: string
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
-
- Type: Array of S3Tag structures
A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.
Exclude
Description
A container for what Amazon S3 Storage Lens will exclude.
Members
IdempotencyException
Include
Description
A container for what Amazon S3 Storage Lens configuration includes.
Members
InternalServiceException
InvalidNextTokenException
InvalidRequestException
JobDescriptor
Description
A container element for the job configuration and status information returned by a Describe Job
request.
Members
- ConfirmationRequired
-
- Type: boolean
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.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp indicating when this job was created.
- Description
-
- Type: string
The description for this job, if one was provided in this job's
Create Job
request. - FailureReasons
-
- Type: Array of JobFailure structures
If the specified job failed, this field contains information describing the failure.
- JobArn
-
- Type: string
The Amazon Resource Name (ARN) for this job.
- JobId
-
- Type: string
The ID for the specified job.
- Manifest
-
- Type: JobManifest structure
The configuration information for the specified job's manifest object.
- Operation
-
- Type: JobOperation structure
The operation that the specified job is configured to run on the objects listed in the manifest.
- Priority
-
- Type: int
The priority of the specified job.
- ProgressSummary
-
- Type: JobProgressSummary structure
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.
- Report
-
- Type: JobReport structure
Contains the configuration information for the job-completion report if you requested one in the
Create Job
request. - RoleArn
-
- Type: string
The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to run the tasks for this job.
- Status
-
- Type: string
The current status of the specified job.
- StatusUpdateReason
-
- Type: string
The reason for updating the job.
- SuspendedCause
-
- Type: string
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 theSuspended
state. - SuspendedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when this job was suspended, if it has been suspended.
- TerminationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.
JobFailure
Description
If this job failed, this element indicates why the job failed.
Members
JobListDescriptor
Description
Contains the configuration and status information for a single job retrieved as part of a job list.
Members
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp indicating when the specified job was created.
- Description
-
- Type: string
The user-specified description that was included in the specified job's
Create Job
request. - JobId
-
- Type: string
The ID for the specified job.
- Operation
-
- Type: string
The operation that the specified job is configured to run on every object listed in the manifest.
- Priority
-
- Type: int
The current priority for the specified job.
- ProgressSummary
-
- Type: JobProgressSummary structure
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.
- Status
-
- Type: string
The specified job's current status.
- TerminationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
JobManifest
Description
Contains the configuration information for a job's manifest.
Members
- Location
-
- Required: Yes
- Type: JobManifestLocation structure
Contains the information required to locate the specified job's manifest.
- Spec
-
- Required: Yes
- Type: JobManifestSpec structure
Describes the format of the specified job's manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.
JobManifestLocation
Description
Contains the information required to locate a manifest object.
Members
JobManifestSpec
Description
Describes the format of a manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.
Members
JobOperation
Description
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.
Members
- LambdaInvoke
-
- Type: LambdaInvokeOperation structure
Directs the specified job to invoke an AWS Lambda function on every object in the manifest.
- S3InitiateRestoreObject
-
- Type: S3InitiateRestoreObjectOperation structure
Directs the specified job to initiate restore requests for every archived object in the manifest.
- S3PutObjectAcl
-
- Type: S3SetObjectAclOperation structure
Directs the specified job to run a PUT Object acl call on every object in the manifest.
- S3PutObjectCopy
-
- Type: S3CopyObjectOperation structure
Directs the specified job to run a PUT Copy object call on every object in the manifest.
- S3PutObjectLegalHold
-
- Type: S3SetObjectLegalHoldOperation structure
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. - S3PutObjectRetention
-
- Type: S3SetObjectRetentionOperation structure
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. - S3PutObjectTagging
-
- Type: S3SetObjectTaggingOperation structure
Directs the specified job to run a PUT Object tagging call on every object in the manifest.
JobProgressSummary
Description
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.
Members
JobReport
Description
Contains the configuration parameters for a job-completion report.
Members
- Bucket
-
- Type: string
The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.
- Enabled
-
- Required: Yes
- Type: boolean
Indicates whether the specified job will generate a job-completion report.
- Format
-
- Type: string
The format of the specified job-completion report.
- Prefix
-
- Type: string
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
. - ReportScope
-
- Type: string
Indicates whether the job-completion report will include details of all tasks or only failed tasks.
JobStatusException
LambdaInvokeOperation
Description
Contains the configuration parameters for a Lambda Invoke
operation.
Members
LifecycleConfiguration
Description
The container for the Outposts bucket lifecycle configuration.
Members
- Rules
-
- Type: Array of LifecycleRule structures
A lifecycle rule for individual objects in an Outposts bucket.
LifecycleExpiration
Description
The container of the Outposts bucket lifecycle expiration.
Members
- Date
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Indicates at what date the object is to be deleted. Should be in GMT ISO 8601 format.
- Days
-
- Type: int
Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
- ExpiredObjectDeleteMarker
-
- Type: boolean
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.
LifecycleRule
Description
The container for the Outposts bucket lifecycle rule.
Members
- AbortIncompleteMultipartUpload
-
- Type: AbortIncompleteMultipartUpload structure
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.
- Expiration
-
- Type: LifecycleExpiration structure
Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.
- Filter
-
- Type: LifecycleRuleFilter structure
The container for the filter of lifecycle rule.
- ID
-
- Type: string
Unique identifier for the rule. The value cannot be longer than 255 characters.
- NoncurrentVersionExpiration
-
- Type: NoncurrentVersionExpiration structure
The noncurrent version expiration of the lifecycle rule.
This is not supported by Amazon S3 on Outposts buckets.
- NoncurrentVersionTransitions
-
- Type: Array of NoncurrentVersionTransition structures
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.
- Status
-
- Required: Yes
- Type: string
If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
- Transitions
-
- Type: Array of Transition structures
Specifies when an Amazon S3 object transitions to a specified storage class.
This is not supported by Amazon S3 on Outposts buckets.
LifecycleRuleAndOperator
Description
The container for the Outposts bucket lifecycle rule and operator.
Members
- Prefix
-
- Type: string
Prefix identifying one or more objects to which the rule applies.
- Tags
-
- Type: Array of S3Tag structures
All of these tags must exist in the object's tag set in order for the rule to apply.
LifecycleRuleFilter
Description
The container for the filter of the lifecycle rule.
Members
- And
-
- Type: LifecycleRuleAndOperator structure
The container for the
AND
condition for the lifecycle rule. - Prefix
-
- Type: string
Prefix identifying one or more objects to which the rule applies.
- Tag
-
- Type: S3Tag structure
ListStorageLensConfigurationEntry
Description
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.
Members
- HomeRegion
-
- Required: Yes
- Type: string
A container for the S3 Storage Lens home Region. Your metrics data is stored and retained in your designated S3 Storage Lens home Region.
- Id
-
- Required: Yes
- Type: string
A container for the S3 Storage Lens configuration ID.
- IsEnabled
-
- Type: boolean
A container for whether the S3 Storage Lens configuration is enabled. This property is required.
- StorageLensArn
-
- Required: Yes
- Type: string
The ARN of the S3 Storage Lens configuration. This property is read-only.
NoSuchPublicAccessBlockConfiguration
Description
Amazon S3 throws this exception if you make a GetPublicAccessBlock
request against an account that doesn't have a PublicAccessBlockConfiguration
set.
Members
NoncurrentVersionExpiration
Description
The container of the noncurrent version expiration.
Members
- NoncurrentDays
-
- Type: int
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.
NoncurrentVersionTransition
Description
The container for the noncurrent version transition.
Members
- NoncurrentDays
-
- Type: int
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
-
- Type: string
The class of storage used to store the object.
NotFoundException
PolicyStatus
Description
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.
Members
PrefixLevel
Description
A container for the prefix-level configuration.
Members
- StorageMetrics
-
- Required: Yes
- Type: PrefixLevelStorageMetrics structure
A container for the prefix-level storage metrics for S3 Storage Lens.
PrefixLevelStorageMetrics
Description
A container for the prefix-level storage metrics for S3 Storage Lens.
Members
- IsEnabled
-
- Type: boolean
A container for whether prefix-level storage metrics are enabled.
- SelectionCriteria
-
- Type: SelectionCriteria structure
PublicAccessBlockConfiguration
Description
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.
Members
- BlockPublicAcls
-
- Type: boolean
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.
- BlockPublicPolicy
-
- Type: boolean
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.
- IgnorePublicAcls
-
- Type: boolean
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.
- RestrictPublicBuckets
-
- Type: boolean
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.
PutAccessPointPolicyRequest
Members
- AccountId
-
- Required: Yes
- Type: string
The AWS account ID for owner of the bucket associated with the specified access point.
- Name
-
- Required: Yes
- Type: string
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 pointreports-ap
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap
. The value must be URL encoded. - Policy
-
- Required: Yes
- Type: string
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.
PutBucketPolicyRequest
Members
- AccountId
-
- Required: Yes
- Type: string
The AWS account ID of the Outposts bucket.
- Bucket
-
- Required: Yes
- Type: string
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 bucketreports
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports
. The value must be URL encoded. - ConfirmRemoveSelfBucketAccess
-
- Type: boolean
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.
- Policy
-
- Required: Yes
- Type: string
The bucket policy as a JSON document.
PutJobTaggingRequest
Members
- AccountId
-
- Required: Yes
- Type: string
The AWS account ID associated with the S3 Batch Operations job.
- JobId
-
- Required: Yes
- Type: string
The ID for the S3 Batch Operations job whose tags you want to replace.
- Tags
-
- Required: Yes
- Type: Array of S3Tag structures
The set of tags to associate with the S3 Batch Operations job.
PutStorageLensConfigurationRequest
Members
- AccountId
-
- Required: Yes
- Type: string
The account ID of the requester.
- ConfigId
-
- Required: Yes
- Type: string
The ID of the S3 Storage Lens configuration.
- StorageLensConfiguration
-
- Required: Yes
- Type: StorageLensConfiguration structure
The S3 Storage Lens configuration.
- Tags
-
- Type: Array of StorageLensTag structures
The tag set of the S3 Storage Lens configuration.
You can set up to a maximum of 50 tags.
PutStorageLensConfigurationTaggingRequest
Members
- AccountId
-
- Required: Yes
- Type: string
The account ID of the requester.
- ConfigId
-
- Required: Yes
- Type: string
The ID of the S3 Storage Lens configuration.
- Tags
-
- Required: Yes
- Type: Array of StorageLensTag structures
The tag set of the S3 Storage Lens configuration.
You can set up to a maximum of 50 tags.
RegionalBucket
Description
The container for the regional bucket.
Members
- Bucket
-
- Required: Yes
- Type: string
- BucketArn
-
- Type: string
The Amazon Resource Name (ARN) for the regional bucket.
- CreationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date of the regional bucket
- OutpostId
-
- Type: string
The AWS Outposts ID of the regional bucket.
- PublicAccessBlockEnabled
-
- Required: Yes
- Type: boolean
S3AccessControlList
Description
Members
- Grants
-
- Type: Array of S3Grant structures
- Owner
-
- Required: Yes
- Type: S3ObjectOwner structure
S3AccessControlPolicy
Description
Members
- AccessControlList
-
- Type: S3AccessControlList structure
- CannedAccessControlList
-
- Type: string
S3BucketDestination
Description
A container for the bucket where the Amazon S3 Storage Lens metrics export files are located.
Members
- AccountId
-
- Required: Yes
- Type: string
The account ID of the owner of the S3 Storage Lens metrics export bucket.
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the bucket. This property is read-only and follows the following format:
arn:aws:s3:us-east-1:example-account-id:bucket/your-destination-bucket-name
- Encryption
-
- Type: StorageLensDataExportEncryption structure
The container for the type encryption of the metrics exports in this bucket.
- Format
-
- Required: Yes
- Type: string
- OutputSchemaVersion
-
- Required: Yes
- Type: string
The schema version of the export file.
- Prefix
-
- Type: string
The prefix of the destination bucket where the metrics export will be delivered.
S3CopyObjectOperation
Description
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.
Members
- AccessControlGrants
-
- Type: Array of S3Grant structures
- CannedAccessControlList
-
- Type: string
- MetadataDirective
-
- Type: string
- ModifiedSinceConstraint
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- NewObjectMetadata
-
- Type: S3ObjectMetadata structure
- NewObjectTagging
-
- Type: Array of S3Tag structures
- ObjectLockLegalHoldStatus
-
- Type: string
The legal hold status to be applied to all objects in the Batch Operations job.
- ObjectLockMode
-
- Type: string
The retention mode to be applied to all objects in the Batch Operations job.
- ObjectLockRetainUntilDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date when the applied object retention configuration expires on all objects in the Batch Operations job.
- RedirectLocation
-
- Type: string
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. - RequesterPays
-
- Type: boolean
- SSEAwsKmsKeyId
-
- Type: string
- StorageClass
-
- Type: string
- TargetKeyPrefix
-
- Type: string
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/".
- TargetResource
-
- Type: string
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".
- UnModifiedSinceConstraint
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
S3Grant
S3Grantee
S3InitiateRestoreObjectOperation
Description
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.
Members
- ExpirationInDays
-
- Type: int
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 specifyingExpirationInDays
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.
- GlacierJobTier
-
- Type: string
S3 Batch Operations supports
STANDARD
andBULK
retrieval tiers, but not theEXPEDITED
retrieval tier.
S3ObjectLockLegalHold
Description
Whether S3 Object Lock legal hold will be applied to objects in an S3 Batch Operations job.
Members
S3ObjectMetadata
Description
Members
- CacheControl
-
- Type: string
- ContentDisposition
-
- Type: string
- ContentEncoding
-
- Type: string
- ContentLanguage
-
- Type: string
- ContentLength
-
- Type: long (int|float)
- ContentMD5
-
- Type: string
- ContentType
-
- Type: string
- HttpExpiresDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- RequesterCharged
-
- Type: boolean
- SSEAlgorithm
-
- Type: string
- UserMetadata
-
- Type: Associative array of custom strings keys (NonEmptyMaxLength1024String) to strings
S3ObjectOwner
S3Retention
Description
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.
Members
S3SetObjectAclOperation
Description
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.
Members
- AccessControlPolicy
-
- Type: S3AccessControlPolicy structure
S3SetObjectLegalHoldOperation
Description
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.
Members
- LegalHold
-
- Required: Yes
- Type: S3ObjectLockLegalHold structure
Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.
S3SetObjectRetentionOperation
Description
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.
Members
- BypassGovernanceRetention
-
- Type: boolean
Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock
GOVERNANCE
type in place. - Retention
-
- Required: Yes
- Type: S3Retention structure
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.
S3SetObjectTaggingOperation
Description
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.
Members
- TagSet
-
- Type: Array of S3Tag structures
S3Tag
SSEKMS
Description
Members
SSES3
Description
Members
SelectionCriteria
Description
Members
- Delimiter
-
- Type: string
A container for the delimiter of the selection criteria being used.
- MaxDepth
-
- Type: int
The max depth of the selection criteria
- MinStorageBytesPercentage
-
- Type: double
The minimum number of storage bytes percentage whose metrics will be selected.
You must choose a value greater than or equal to
1.0
.
StorageLensAwsOrg
Description
The AWS organization for your S3 Storage Lens.
Members
StorageLensConfiguration
Description
A container for the Amazon S3 Storage Lens configuration.
Members
- AccountLevel
-
- Required: Yes
- Type: AccountLevel structure
A container for all the account-level configurations of your S3 Storage Lens configuration.
- AwsOrg
-
- Type: StorageLensAwsOrg structure
A container for the AWS organization for this S3 Storage Lens configuration.
- DataExport
-
- Type: StorageLensDataExport structure
A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.
- Exclude
-
- Type: Exclude structure
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. - Id
-
- Required: Yes
- Type: string
A container for the Amazon S3 Storage Lens configuration ID.
- Include
-
- Type: Include structure
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. - IsEnabled
-
- Required: Yes
- Type: boolean
A container for whether the S3 Storage Lens configuration is enabled.
- StorageLensArn
-
- Type: string
The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only and follows the following format:
arn:aws:s3:us-east-1:example-account-id:storage-lens/your-dashboard-name
StorageLensDataExport
Description
A container to specify the properties of your S3 Storage Lens metrics export, including the destination, schema, and format.
Members
- S3BucketDestination
-
- Required: Yes
- Type: S3BucketDestination structure
A container for the bucket where the S3 Storage Lens metrics export will be located.
StorageLensDataExportEncryption
Description
A container for the encryption of the S3 Storage Lens metrics exports.
Members
StorageLensTag
Tagging
Description
Members
- TagSet
-
- Required: Yes
- Type: Array of S3Tag structures
A collection for a set of tags.
TooManyRequestsException
TooManyTagsException
Description
Amazon S3 throws this exception if you have too many tags in your tag set.
Members
Transition
Description
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.
Members
- Date
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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
-
- Type: int
Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.
- StorageClass
-
- Type: string
The storage class to which you want the object to transition.