AWS SDK for PHP 3.x

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.
CreateAccessPointForObjectLambda ( array $params = [] )
Creates an Object Lambda Access Point.
CreateBucket ( array $params = [] )
This action creates an Amazon S3 on Outposts bucket.
CreateJob ( array $params = [] )
You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects.
CreateMultiRegionAccessPoint ( array $params = [] )
Creates a Multi-Region Access Point and associates it with the specified buckets.
DeleteAccessPoint ( array $params = [] )
Deletes the specified access point.
DeleteAccessPointForObjectLambda ( array $params = [] )
Deletes the specified Object Lambda Access Point.
DeleteAccessPointPolicy ( array $params = [] )
Deletes the access point policy for the specified access point.
DeleteAccessPointPolicyForObjectLambda ( array $params = [] )
Removes the resource policy for an Object Lambda Access Point.
DeleteBucket ( array $params = [] )
This action deletes an Amazon S3 on Outposts bucket.
DeleteBucketLifecycleConfiguration ( array $params = [] )
This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration.
DeleteBucketPolicy ( array $params = [] )
This action deletes an Amazon S3 on Outposts bucket policy.
DeleteBucketTagging ( array $params = [] )
This action deletes an Amazon S3 on Outposts bucket's tags.
DeleteJobTagging ( array $params = [] )
Removes the entire tag set from the specified S3 Batch Operations job.
DeleteMultiRegionAccessPoint ( array $params = [] )
Deletes a Multi-Region Access Point.
DeletePublicAccessBlock ( array $params = [] )
Removes the PublicAccessBlock configuration for an Amazon Web Services 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.
DescribeMultiRegionAccessPointOperation ( array $params = [] )
Retrieves the status of an asynchronous request to manage a Multi-Region Access Point.
GetAccessPoint ( array $params = [] )
Returns configuration information about the specified access point.
GetAccessPointConfigurationForObjectLambda ( array $params = [] )
Returns configuration for an Object Lambda Access Point.
GetAccessPointForObjectLambda ( array $params = [] )
Returns configuration information about the specified Object Lambda Access Point The following actions are related to GetAccessPointForObjectLambda: CreateAccessPointForObjectLambda DeleteAccessPointForObjectLambda ListAccessPointsForObjectLambda
GetAccessPointPolicy ( array $params = [] )
Returns the access point policy associated with the specified access point.
GetAccessPointPolicyForObjectLambda ( array $params = [] )
Returns the resource policy for an Object Lambda Access Point.
GetAccessPointPolicyStatus ( array $params = [] )
Indicates whether the specified access point currently has a policy that allows public access.
GetAccessPointPolicyStatusForObjectLambda ( array $params = [] )
Returns the status of the resource policy associated with an Object Lambda Access Point.
GetBucket ( array $params = [] )
Gets an Amazon S3 on Outposts bucket.
GetBucketLifecycleConfiguration ( array $params = [] )
This action 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 action gets an Amazon S3 on Outposts bucket's tags.
GetJobTagging ( array $params = [] )
Returns the tags on an S3 Batch Operations job.
GetMultiRegionAccessPoint ( array $params = [] )
Returns configuration information about the specified Multi-Region Access Point.
GetMultiRegionAccessPointPolicy ( array $params = [] )
Returns the access control policy of the specified Multi-Region Access Point.
GetMultiRegionAccessPointPolicyStatus ( array $params = [] )
Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access.
GetPublicAccessBlock ( array $params = [] )
Retrieves the PublicAccessBlock configuration for an Amazon Web Services 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.
ListAccessPointsForObjectLambda ( array $params = [] )
Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call.
ListJobs ( array $params = [] )
Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request.
ListMultiRegionAccessPoints ( array $params = [] )
Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account.
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.
PutAccessPointConfigurationForObjectLambda ( array $params = [] )
Replaces configuration for an Object Lambda Access Point.
PutAccessPointPolicy ( array $params = [] )
Associates an access policy with the specified access point.
PutAccessPointPolicyForObjectLambda ( array $params = [] )
Creates or replaces resource policy for an Object Lambda 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.
PutMultiRegionAccessPointPolicy ( array $params = [] )
Associates an access control policy with the specified Multi-Region Access Point.
PutPublicAccessBlock ( array $params = [] )
Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services 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:

ListAccessPoints
ListAccessPointsForObjectLambda
ListJobs
ListMultiRegionAccessPoints
ListRegionalBuckets
ListStorageLensConfigurations

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 S3 User Guide.

S3 on Outposts only supports VPC-style access points.

For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points in the Amazon S3 User 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 Amazon Web Services 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 Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

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 the access point.

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>',
    'Alias' => '<string>',
]

Result Details

Members

AccessPointArn

Type: string

The ARN of the access point.

This is only supported by Amazon S3 on Outposts.

Alias

Type: string

The name or alias of the access point.

Errors

There are no errors described for this operation.

CreateAccessPointForObjectLambda

$result = $client->createAccessPointForObjectLambda([/* ... */]);
$promise = $client->createAccessPointForObjectLambdaAsync([/* ... */]);

Creates an Object Lambda Access Point. For more information, see Transforming objects with Object Lambda Access Points in the Amazon S3 User Guide.

The following actions are related to CreateAccessPointForObjectLambda:

Parameter Syntax

$result = $client->createAccessPointForObjectLambda([
    'AccountId' => '<string>', // REQUIRED
    'Configuration' => [ // REQUIRED
        'AllowedFeatures' => ['<string>', ...],
        'CloudWatchMetricsEnabled' => true || false,
        'SupportingAccessPoint' => '<string>', // REQUIRED
        'TransformationConfigurations' => [ // REQUIRED
            [
                'Actions' => ['<string>', ...], // REQUIRED
                'ContentTransformation' => [ // REQUIRED
                    'AwsLambda' => [
                        'FunctionArn' => '<string>', // REQUIRED
                        'FunctionPayload' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
    ],
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services account ID for owner of the specified Object Lambda Access Point.

Configuration

Required: Yes
Type: ObjectLambdaConfiguration structure

Object Lambda Access Point configuration as a JSON document.

Name

Required: Yes
Type: string

The name you want to assign to this Object Lambda Access Point.

Result Syntax

[
    'ObjectLambdaAccessPointArn' => '<string>',
]

Result Details

Members

ObjectLambdaAccessPointArn

Type: string

Specifies the ARN for the Object Lambda Access Point.

Errors

There are no errors described for this operation.

CreateBucket

$result = $client->createBucket([/* ... */]);
$promise = $client->createBucketAsync([/* ... */]);

This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon S3 API Reference.

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 S3 User 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 support:

Tags
LifecycleConfigurations for deleting expired objects

For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations.

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.

Location

Type: string

The location of the bucket.

Errors

BucketAlreadyExists:
The requested Outposts bucket name is not available. The bucket namespace is shared by all users of the Outposts in this Region. Select a different name and try again.
BucketAlreadyOwnedByYou:
The Outposts bucket you tried to create already exists, and you own it.

CreateJob

$result = $client->createJob([/* ... */]);
$promise = $client->createJobAsync([/* ... */]);

You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

This action creates a S3 Batch Operations job.

Related actions include:

Parameter Syntax

$result = $client->createJob([
    'AccountId' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>', // REQUIRED
    'ConfirmationRequired' => true || false,
    'Description' => '<string>',
    'Manifest' => [
        'Location' => [ // REQUIRED
            'ETag' => '<string>', // REQUIRED
            'ObjectArn' => '<string>', // REQUIRED
            'ObjectVersionId' => '<string>',
        ],
        'Spec' => [ // REQUIRED
            'Fields' => ['<string>', ...],
            'Format' => 'S3BatchOperations_CSV_20180820|S3InventoryReport_CSV_20161130', // REQUIRED
        ],
    ],
    'ManifestGenerator' => [
        'S3JobManifestGenerator' => [
            'EnableManifestOutput' => true || false, // REQUIRED
            'ExpectedBucketOwner' => '<string>',
            'Filter' => [
                'CreatedAfter' => <integer || string || DateTime>,
                'CreatedBefore' => <integer || string || DateTime>,
                'EligibleForReplication' => true || false,
                'ObjectReplicationStatuses' => ['<string>', ...],
            ],
            'ManifestOutputLocation' => [
                'Bucket' => '<string>', // REQUIRED
                'ExpectedManifestBucketOwner' => '<string>',
                'ManifestEncryption' => [
                    'SSEKMS' => [
                        'KeyId' => '<string>', // REQUIRED
                    ],
                    'SSES3' => [
                    ],
                ],
                'ManifestFormat' => 'S3InventoryReport_CSV_20211130', // REQUIRED
                'ManifestPrefix' => '<string>',
            ],
            'SourceBucket' => '<string>', // REQUIRED
        ],
    ],
    'Operation' => [ // REQUIRED
        'LambdaInvoke' => [
            'FunctionArn' => '<string>',
        ],
        'S3DeleteObjectTagging' => [
        ],
        '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',
                ],
                // ...
            ],
            'BucketKeyEnabled' => true || false,
            'CannedAccessControlList' => 'private|public-read|public-read-write|aws-exec-read|authenticated-read|bucket-owner-read|bucket-owner-full-control',
            'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
            '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|GLACIER_IR',
            '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
                ],
                // ...
            ],
        ],
        'S3ReplicateObject' => [
        ],
    ],
    '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 Amazon Web Services 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

Type: JobManifest structure

Configuration parameters for the manifest.

ManifestGenerator

Type: JobManifestGenerator structure

The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

Operation

Required: Yes
Type: JobOperation structure

The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User 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 Identity and Access Management (IAM) role that Batch Operations will use to run this job's action 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

JobId

Type: string

The ID for this job. Amazon S3 generates this ID automatically and returns it after a successful Create Job request.

Errors

CreateMultiRegionAccessPoint

$result = $client->createMultiRegionAccessPoint([/* ... */]);
$promise = $client->createMultiRegionAccessPointAsync([/* ... */]);

Creates a Multi-Region Access Point and associates it with the specified buckets. For more information about creating Multi-Region Access Points, see Creating Multi-Region Access Points in the Amazon S3 User Guide.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

This request is asynchronous, meaning that you might receive a response before the command has completed. When this request provides a response, it provides a token that you can use to monitor the status of the request with DescribeMultiRegionAccessPointOperation.

The following actions are related to CreateMultiRegionAccessPoint:

Parameter Syntax

$result = $client->createMultiRegionAccessPoint([
    'AccountId' => '<string>', // REQUIRED
    'ClientToken' => '<string>', // REQUIRED
    'Details' => [ // REQUIRED
        'Name' => '<string>', // REQUIRED
        'PublicAccessBlock' => [
            'BlockPublicAcls' => true || false,
            'BlockPublicPolicy' => true || false,
            'IgnorePublicAcls' => true || false,
            'RestrictPublicBuckets' => true || false,
        ],
        'Regions' => [ // REQUIRED
            [
                'Bucket' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services account ID for the owner of the Multi-Region Access Point. The owner of the Multi-Region Access Point also must own the underlying buckets.

ClientToken

Required: Yes
Type: string

An idempotency token used to identify the request and guarantee that requests are unique.

Details

Required: Yes
Type: CreateMultiRegionAccessPointInput structure

A container element containing details about the Multi-Region Access Point.

Result Syntax

[
    'RequestTokenARN' => '<string>',
]

Result Details

Members

RequestTokenARN

Type: string

The request token associated with the request. You can use this token with DescribeMultiRegionAccessPointOperation to determine the status of asynchronous requests.

Errors

There are no errors described for this operation.

DeleteAccessPoint

$result = $client->deleteAccessPoint([/* ... */]);
$promise = $client->deleteAccessPointAsync([/* ... */]);

Deletes the specified access point.

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 Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteAccessPointForObjectLambda

$result = $client->deleteAccessPointForObjectLambda([/* ... */]);
$promise = $client->deleteAccessPointForObjectLambdaAsync([/* ... */]);

Deletes the specified Object Lambda Access Point.

The following actions are related to DeleteAccessPointForObjectLambda:

Parameter Syntax

$result = $client->deleteAccessPointForObjectLambda([
    'AccountId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The account ID for the account that owns the specified Object Lambda Access Point.

Name

Required: Yes
Type: string

The name of the access point you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteAccessPointPolicyForObjectLambda

$result = $client->deleteAccessPointPolicyForObjectLambda([/* ... */]);
$promise = $client->deleteAccessPointPolicyForObjectLambdaAsync([/* ... */]);

Removes the resource policy for an Object Lambda Access Point.

The following actions are related to DeleteAccessPointPolicyForObjectLambda:

Parameter Syntax

$result = $client->deleteAccessPointPolicyForObjectLambda([
    'AccountId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The account ID for the account that owns the specified Object Lambda Access Point.

Name

Required: Yes
Type: string

The name of the Object Lambda Access Point you want to delete the policy for.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteBucket

$result = $client->deleteBucket([/* ... */]);
$promise = $client->deleteBucketAsync([/* ... */]);

This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon S3 API Reference.

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 S3 User Guide.

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteBucketLifecycleConfiguration

$result = $client->deleteBucketLifecycleConfiguration([/* ... */]);
$promise = $client->deleteBucketLifecycleConfigurationAsync([/* ... */]);

This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference.

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 S3 User Guide.

To use this action, 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.

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteBucketPolicy

$result = $client->deleteBucketPolicy([/* ... */]);
$promise = $client->deleteBucketPolicyAsync([/* ... */]);

This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon S3 API Reference.

This implementation of the DELETE action 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 Amazon Web Services 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 action. For more information, see Using Amazon S3 on Outposts in Amazon S3 User 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 Amazon Web Services account that owns a bucket can always use this action, 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.

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteBucketTagging

$result = $client->deleteBucketTagging([/* ... */]);
$promise = $client->deleteBucketTaggingAsync([/* ... */]);

This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon S3 API Reference.

Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

To use this action, you must have permission to perform the PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

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 Amazon Web Services 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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 S3 User Guide.

Related actions include:

Parameter Syntax

$result = $client->deleteJobTagging([
    'AccountId' => '<string>', // REQUIRED
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services 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 delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

DeleteMultiRegionAccessPoint

$result = $client->deleteMultiRegionAccessPoint([/* ... */]);
$promise = $client->deleteMultiRegionAccessPointAsync([/* ... */]);

Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point, only the Multi-Region Access Point itself.

The following actions are related to DeleteMultiRegionAccessPoint:

Parameter Syntax

$result = $client->deleteMultiRegionAccessPoint([
    'AccountId' => '<string>', // REQUIRED
    'ClientToken' => '<string>', // REQUIRED
    'Details' => [ // REQUIRED
        'Name' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

ClientToken

Required: Yes
Type: string

An idempotency token used to identify the request and guarantee that requests are unique.

Details

Required: Yes
Type: DeleteMultiRegionAccessPointInput structure

A container element containing details about the Multi-Region Access Point.

Result Syntax

[
    'RequestTokenARN' => '<string>',
]

Result Details

Members

RequestTokenARN

Type: string

The request token associated with the request. You can use this token with DescribeMultiRegionAccessPointOperation to determine the status of asynchronous requests.

Errors

There are no errors described for this operation.

DeletePublicAccessBlock

$result = $client->deletePublicAccessBlock([/* ... */]);
$promise = $client->deletePublicAccessBlockAsync([/* ... */]);

Removes the PublicAccessBlock configuration for an Amazon Web Services 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

AccountId

Required: Yes
Type: string

The account ID for the Amazon Web Services account whose PublicAccessBlock configuration you want to remove.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User 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 S3 User Guide.

Parameter Syntax

$result = $client->deleteStorageLensConfiguration([
    'AccountId' => '<string>', // REQUIRED
    'ConfigId' => '<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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User 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 S3 User Guide.

Parameter Syntax

$result = $client->deleteStorageLensConfigurationTagging([
    'AccountId' => '<string>', // REQUIRED
    'ConfigId' => '<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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 S3 User Guide.

Related actions include:

Parameter Syntax

$result = $client->describeJob([
    'AccountId' => '<string>', // REQUIRED
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services account ID associated with the S3 Batch Operations job.

JobId

Required: Yes
Type: string

The ID for the job whose information you want to retrieve.

Result Syntax

[
    'Job' => [
        'ConfirmationRequired' => true || false,
        'CreationTime' => <DateTime>,
        'Description' => '<string>',
        'FailureReasons' => [
            [
                'FailureCode' => '<string>',
                'FailureReason' => '<string>',
            ],
            // ...
        ],
        'GeneratedManifestDescriptor' => [
            'Format' => 'S3InventoryReport_CSV_20211130',
            'Location' => [
                'ETag' => '<string>',
                'ObjectArn' => '<string>',
                'ObjectVersionId' => '<string>',
            ],
        ],
        'JobArn' => '<string>',
        'JobId' => '<string>',
        'Manifest' => [
            'Location' => [
                'ETag' => '<string>',
                'ObjectArn' => '<string>',
                'ObjectVersionId' => '<string>',
            ],
            'Spec' => [
                'Fields' => ['<string>', ...],
                'Format' => 'S3BatchOperations_CSV_20180820|S3InventoryReport_CSV_20161130',
            ],
        ],
        'ManifestGenerator' => [
            'S3JobManifestGenerator' => [
                'EnableManifestOutput' => true || false,
                'ExpectedBucketOwner' => '<string>',
                'Filter' => [
                    'CreatedAfter' => <DateTime>,
                    'CreatedBefore' => <DateTime>,
                    'EligibleForReplication' => true || false,
                    'ObjectReplicationStatuses' => ['<string>', ...],
                ],
                'ManifestOutputLocation' => [
                    'Bucket' => '<string>',
                    'ExpectedManifestBucketOwner' => '<string>',
                    'ManifestEncryption' => [
                        'SSEKMS' => [
                            'KeyId' => '<string>',
                        ],
                        'SSES3' => [
                        ],
                    ],
                    'ManifestFormat' => 'S3InventoryReport_CSV_20211130',
                    'ManifestPrefix' => '<string>',
                ],
                'SourceBucket' => '<string>',
            ],
        ],
        'Operation' => [
            'LambdaInvoke' => [
                'FunctionArn' => '<string>',
            ],
            'S3DeleteObjectTagging' => [
            ],
            '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',
                    ],
                    // ...
                ],
                'BucketKeyEnabled' => true || false,
                'CannedAccessControlList' => 'private|public-read|public-read-write|aws-exec-read|authenticated-read|bucket-owner-read|bucket-owner-full-control',
                'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
                '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|GLACIER_IR',
                '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>',
                    ],
                    // ...
                ],
            ],
            'S3ReplicateObject' => [
            ],
        ],
        'Priority' => <integer>,
        'ProgressSummary' => [
            'NumberOfTasksFailed' => <integer>,
            'NumberOfTasksSucceeded' => <integer>,
            'Timers' => [
                'ElapsedTimeInActiveSeconds' => <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

DescribeMultiRegionAccessPointOperation

$result = $client->describeMultiRegionAccessPointOperation([/* ... */]);
$promise = $client->describeMultiRegionAccessPointOperationAsync([/* ... */]);

Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information about managing Multi-Region Access Points and how asynchronous requests work, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPoint:

Parameter Syntax

$result = $client->describeMultiRegionAccessPointOperation([
    'AccountId' => '<string>', // REQUIRED
    'RequestTokenARN' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

RequestTokenARN

Required: Yes
Type: string

The request token associated with the request you want to know about. This request token is returned as part of the response when you make an asynchronous request. You provide this token to query about the status of the asynchronous action.

Result Syntax

[
    'AsyncOperation' => [
        'CreationTime' => <DateTime>,
        'Operation' => 'CreateMultiRegionAccessPoint|DeleteMultiRegionAccessPoint|PutMultiRegionAccessPointPolicy',
        'RequestParameters' => [
            'CreateMultiRegionAccessPointRequest' => [
                'Name' => '<string>',
                'PublicAccessBlock' => [
                    'BlockPublicAcls' => true || false,
                    'BlockPublicPolicy' => true || false,
                    'IgnorePublicAcls' => true || false,
                    'RestrictPublicBuckets' => true || false,
                ],
                'Regions' => [
                    [
                        'Bucket' => '<string>',
                    ],
                    // ...
                ],
            ],
            'DeleteMultiRegionAccessPointRequest' => [
                'Name' => '<string>',
            ],
            'PutMultiRegionAccessPointPolicyRequest' => [
                'Name' => '<string>',
                'Policy' => '<string>',
            ],
        ],
        'RequestStatus' => '<string>',
        'RequestTokenARN' => '<string>',
        'ResponseDetails' => [
            'ErrorDetails' => [
                'Code' => '<string>',
                'Message' => '<string>',
                'RequestId' => '<string>',
                'Resource' => '<string>',
            ],
            'MultiRegionAccessPointDetails' => [
                'Regions' => [
                    [
                        'Name' => '<string>',
                        'RequestStatus' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
    ],
]

Result Details

Members

AsyncOperation

Type: AsyncOperation structure

A container element containing the details of the asynchronous operation.

Errors

There are no errors described for this operation.

GetAccessPoint

$result = $client->getAccessPoint([/* ... */]);
$promise = $client->getAccessPointAsync([/* ... */]);

Returns configuration information about the specified access point.

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.

Result Syntax

[
    'AccessPointArn' => '<string>',
    'Alias' => '<string>',
    'Bucket' => '<string>',
    'CreationDate' => <DateTime>,
    'Endpoints' => ['<string>', ...],
    'Name' => '<string>',
    'NetworkOrigin' => 'Internet|VPC',
    'PublicAccessBlockConfiguration' => [
        'BlockPublicAcls' => true || false,
        'BlockPublicPolicy' => true || false,
        'IgnorePublicAcls' => true || false,
        'RestrictPublicBuckets' => true || false,
    ],
    'VpcConfiguration' => [
        'VpcId' => '<string>',
    ],
]

Result Details

Members

AccessPointArn

Type: string

The ARN of the access point.

Alias

Type: string

The name or alias of the access point.

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.

Endpoints

Type: Associative array of custom strings keys (NonEmptyMaxLength64String) to strings

The VPC endpoint for the access point.

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, then NetworkOrigin is VPC, and the access point doesn't allow access from the public internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public internet, subject to the access point and bucket access policies.

This will always be true for an Amazon S3 on Outposts access point

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 S3 User 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.

This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other Amazon Web Services.

Errors

There are no errors described for this operation.

GetAccessPointConfigurationForObjectLambda

$result = $client->getAccessPointConfigurationForObjectLambda([/* ... */]);
$promise = $client->getAccessPointConfigurationForObjectLambdaAsync([/* ... */]);

Returns configuration for an Object Lambda Access Point.

The following actions are related to GetAccessPointConfigurationForObjectLambda:

PutAccessPointConfigurationForObjectLambda

Parameter Syntax

$result = $client->getAccessPointConfigurationForObjectLambda([
    'AccountId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The account ID for the account that owns the specified Object Lambda Access Point.

Name

Required: Yes
Type: string

The name of the Object Lambda Access Point you want to return the configuration for.

Result Syntax

[
    'Configuration' => [
        'AllowedFeatures' => ['<string>', ...],
        'CloudWatchMetricsEnabled' => true || false,
        'SupportingAccessPoint' => '<string>',
        'TransformationConfigurations' => [
            [
                'Actions' => ['<string>', ...],
                'ContentTransformation' => [
                    'AwsLambda' => [
                        'FunctionArn' => '<string>',
                        'FunctionPayload' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members

Configuration

Type: ObjectLambdaConfiguration structure

Object Lambda Access Point configuration document.

Errors

There are no errors described for this operation.

GetAccessPointForObjectLambda

$result = $client->getAccessPointForObjectLambda([/* ... */]);
$promise = $client->getAccessPointForObjectLambdaAsync([/* ... */]);

Returns configuration information about the specified Object Lambda Access Point

The following actions are related to GetAccessPointForObjectLambda:

Parameter Syntax

$result = $client->getAccessPointForObjectLambda([
    'AccountId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The account ID for the account that owns the specified Object Lambda Access Point.

Name

Required: Yes
Type: string

The name of the Object Lambda Access Point.

Result Syntax

[
    'CreationDate' => <DateTime>,
    'Name' => '<string>',
    'PublicAccessBlockConfiguration' => [
        'BlockPublicAcls' => true || false,
        'BlockPublicPolicy' => true || false,
        'IgnorePublicAcls' => true || false,
        'RestrictPublicBuckets' => true || false,
    ],
]

Result Details

Members

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the specified Object Lambda Access Point was created.

Name

Type: string

The name of the Object Lambda Access Point.

PublicAccessBlockConfiguration

Type: PublicAccessBlockConfiguration structure

Configuration to block all public access. This setting is turned on and can not be edited.

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.

Result Syntax

[
    'Policy' => '<string>',
]

Result Details

Members

Policy

Type: string

The access point policy associated with the specified access point.

Errors

There are no errors described for this operation.

GetAccessPointPolicyForObjectLambda

$result = $client->getAccessPointPolicyForObjectLambda([/* ... */]);
$promise = $client->getAccessPointPolicyForObjectLambdaAsync([/* ... */]);

Returns the resource policy for an Object Lambda Access Point.

The following actions are related to GetAccessPointPolicyForObjectLambda:

Parameter Syntax

$result = $client->getAccessPointPolicyForObjectLambda([
    'AccountId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The account ID for the account that owns the specified Object Lambda Access Point.

Name

Required: Yes
Type: string

The name of the Object Lambda Access Point.

Result Syntax

[
    'Policy' => '<string>',
]

Result Details

Members

Policy

Type: string

Object Lambda Access Point resource policy document.

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 S3 User Guide.

Parameter Syntax

$result = $client->getAccessPointPolicyStatus([
    '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 status you want to retrieve.

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.

GetAccessPointPolicyStatusForObjectLambda

$result = $client->getAccessPointPolicyStatusForObjectLambda([/* ... */]);
$promise = $client->getAccessPointPolicyStatusForObjectLambdaAsync([/* ... */]);

Returns the status of the resource policy associated with an Object Lambda Access Point.

Parameter Syntax

$result = $client->getAccessPointPolicyStatusForObjectLambda([
    'AccountId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The account ID for the account that owns the specified Object Lambda Access Point.

Name

Required: Yes
Type: string

The name of the Object Lambda Access Point.

Result Syntax

[
    'PolicyStatus' => [
        'IsPublic' => true || false,
    ],
]

Result Details

Members

PolicyStatus

Type: PolicyStatus structure

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 S3 User Guide.

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 S3 User Guide.

If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the s3-outposts:GetBucket permissions on the specified Outposts bucket and belong to the Outposts bucket owner's account in order to use this action. 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:

Parameter Syntax

$result = $client->getBucket([
    'AccountId' => '<string>', // REQUIRED
    'Bucket' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services 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.

Result Syntax

[
    'Bucket' => '<string>',
    'CreationDate' => <DateTime>,
    'PublicAccessBlockEnabled' => true || false,
]

Result Details

Members

Bucket

Type: string

The Outposts bucket requested.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date of the Outposts bucket.

PublicAccessBlockEnabled

Type: boolean

Errors

There are no errors described for this operation.

GetBucketLifecycleConfiguration

$result = $client->getBucketLifecycleConfiguration([/* ... */]);
$promise = $client->getBucketLifecycleConfigurationAsync([/* ... */]);

This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API Reference.

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 S3 User Guide.

To use this action, 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.

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 Amazon Web Services 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.

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 S3 API Reference.

Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

If you are using an identity other than the root user of the Amazon Web Services 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 action.

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.

For more information about bucket policies, see Using Bucket Policies and User Policies.

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 Amazon Web Services 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.

Result Syntax

[
    'Policy' => '<string>',
]

Result Details

Members

Policy

Type: string

The policy of the Outposts bucket.

Errors

There are no errors described for this operation.

GetBucketTagging

$result = $client->getBucketTagging([/* ... */]);
$promise = $client->getBucketTaggingAsync([/* ... */]);

This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon S3 API Reference.

Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

To use this action, 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.

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 Amazon Web Services 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.

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 S3 User Guide.

Related actions include:

Parameter Syntax

$result = $client->getJobTagging([
    'AccountId' => '<string>', // REQUIRED
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services 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 retrieve.

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

GetMultiRegionAccessPoint

$result = $client->getMultiRegionAccessPoint([/* ... */]);
$promise = $client->getMultiRegionAccessPointAsync([/* ... */]);

Returns configuration information about the specified Multi-Region Access Point.

The following actions are related to GetMultiRegionAccessPoint:

Parameter Syntax

$result = $client->getMultiRegionAccessPoint([
    'AccountId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

Name

Required: Yes
Type: string

The name of the Multi-Region Access Point whose configuration information you want to receive. The name of the Multi-Region Access Point is different from the alias. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

Result Syntax

[
    'AccessPoint' => [
        'Alias' => '<string>',
        'CreatedAt' => <DateTime>,
        'Name' => '<string>',
        'PublicAccessBlock' => [
            'BlockPublicAcls' => true || false,
            'BlockPublicPolicy' => true || false,
            'IgnorePublicAcls' => true || false,
            'RestrictPublicBuckets' => true || false,
        ],
        'Regions' => [
            [
                'Bucket' => '<string>',
                'Region' => '<string>',
            ],
            // ...
        ],
        'Status' => 'READY|INCONSISTENT_ACROSS_REGIONS|CREATING|PARTIALLY_CREATED|PARTIALLY_DELETED|DELETING',
    ],
]

Result Details

Members

AccessPoint

Type: MultiRegionAccessPointReport structure

A container element containing the details of the requested Multi-Region Access Point.

Errors

There are no errors described for this operation.

GetMultiRegionAccessPointPolicy

$result = $client->getMultiRegionAccessPointPolicy([/* ... */]);
$promise = $client->getMultiRegionAccessPointPolicyAsync([/* ... */]);

Returns the access control policy of the specified Multi-Region Access Point.

The following actions are related to GetMultiRegionAccessPointPolicy:

Parameter Syntax

$result = $client->getMultiRegionAccessPointPolicy([
    'AccountId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

Name

Required: Yes
Type: string

Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

Result Syntax

[
    'Policy' => [
        'Established' => [
            'Policy' => '<string>',
        ],
        'Proposed' => [
            'Policy' => '<string>',
        ],
    ],
]

Result Details

Members

Policy

Type: MultiRegionAccessPointPolicyDocument structure

The policy associated with the specified Multi-Region Access Point.

Errors

There are no errors described for this operation.

GetMultiRegionAccessPointPolicyStatus

$result = $client->getMultiRegionAccessPointPolicyStatus([/* ... */]);
$promise = $client->getMultiRegionAccessPointPolicyStatusAsync([/* ... */]);

Indicates whether the specified Multi-Region Access Point has an access control policy that allows public access.

The following actions are related to GetMultiRegionAccessPointPolicyStatus:

Parameter Syntax

$result = $client->getMultiRegionAccessPointPolicyStatus([
    'AccountId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

Name

Required: Yes
Type: string

Result Syntax

[
    'Established' => [
        'IsPublic' => true || false,
    ],
]

Result Details

Members

Established

Type: PolicyStatus structure

Errors

There are no errors described for this operation.

GetPublicAccessBlock

$result = $client->getPublicAccessBlock([/* ... */]);
$promise = $client->getPublicAccessBlockAsync([/* ... */]);

Retrieves the PublicAccessBlock configuration for an Amazon Web Services 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

AccountId

Required: Yes
Type: string

The account ID for the Amazon Web Services account whose PublicAccessBlock configuration you want to retrieve.

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 Amazon Web Services account.

Errors

NoSuchPublicAccessBlockConfiguration:
Amazon S3 throws this exception if you make a GetPublicAccessBlock request against an account that doesn't have a PublicAccessBlockConfiguration set.

GetStorageLensConfiguration

$result = $client->getStorageLensConfiguration([/* ... */]);
$promise = $client->getStorageLensConfigurationAsync([/* ... */]);

Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User 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 S3 User Guide.

Parameter Syntax

$result = $client->getStorageLensConfiguration([
    'AccountId' => '<string>', // REQUIRED
    'ConfigId' => '<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 Amazon S3 Storage Lens configuration.

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' => [
            'CloudWatchMetrics' => [
                'IsEnabled' => true || false,
            ],
            '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 Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User 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 S3 User Guide.

Parameter Syntax

$result = $client->getStorageLensConfigurationTagging([
    'AccountId' => '<string>', // REQUIRED
    'ConfigId' => '<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 Amazon S3 Storage Lens configuration.

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.

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 Amazon Web Services 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.

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 the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.

Result Syntax

[
    'AccessPointList' => [
        [
            'AccessPointArn' => '<string>',
            'Alias' => '<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.

ListAccessPointsForObjectLambda

$result = $client->listAccessPointsForObjectLambda([/* ... */]);
$promise = $client->listAccessPointsForObjectLambdaAsync([/* ... */]);

Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there are more access points than what can be returned in one call, the response will include a continuation token that you can use to list the additional access points.

The following actions are related to ListAccessPointsForObjectLambda:

Parameter Syntax

$result = $client->listAccessPointsForObjectLambda([
    'AccountId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The account ID for the account that owns the specified Object Lambda Access Point.

MaxResults

Type: int

The maximum number of access points that you want to include in the list. The response may contain fewer access points but will never contain more. If there are 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

If the list 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.

Result Syntax

[
    'NextToken' => '<string>',
    'ObjectLambdaAccessPointList' => [
        [
            'Name' => '<string>',
            'ObjectLambdaAccessPointArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

ObjectLambdaAccessPointList

Type: Array of ObjectLambdaAccessPoint structures

Returns list of Object Lambda 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 Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User 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

The Amazon Web Services account ID associated with the S3 Batch Operations job.

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 the NextToken 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 the ListJobsResult from the previous List Jobs request.

Result Syntax

[
    'Jobs' => [
        [
            'CreationTime' => <DateTime>,
            'Description' => '<string>',
            'JobId' => '<string>',
            'Operation' => 'LambdaInvoke|S3PutObjectCopy|S3PutObjectAcl|S3PutObjectTagging|S3DeleteObjectTagging|S3InitiateRestoreObject|S3PutObjectLegalHold|S3PutObjectRetention|S3ReplicateObject',
            'Priority' => <integer>,
            'ProgressSummary' => [
                'NumberOfTasksFailed' => <integer>,
                'NumberOfTasksSucceeded' => <integer>,
                'Timers' => [
                    'ElapsedTimeInActiveSeconds' => <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 subsequent List Jobs request in order to retrieve the next page of results.

Errors

ListMultiRegionAccessPoints

$result = $client->listMultiRegionAccessPoints([/* ... */]);
$promise = $client->listMultiRegionAccessPointsAsync([/* ... */]);

Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account. Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be associated with a single account.

The following actions are related to ListMultiRegionAccessPoint:

Parameter Syntax

$result = $client->listMultiRegionAccessPoints([
    'AccountId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

MaxResults

Type: int

Not currently used. Do not use this parameter.

NextToken

Type: string

Not currently used. Do not use this parameter.

Result Syntax

[
    'AccessPoints' => [
        [
            'Alias' => '<string>',
            'CreatedAt' => <DateTime>,
            'Name' => '<string>',
            'PublicAccessBlock' => [
                'BlockPublicAcls' => true || false,
                'BlockPublicPolicy' => true || false,
                'IgnorePublicAcls' => true || false,
                'RestrictPublicBuckets' => true || false,
            ],
            'Regions' => [
                [
                    'Bucket' => '<string>',
                    'Region' => '<string>',
                ],
                // ...
            ],
            'Status' => 'READY|INCONSISTENT_ACROSS_REGIONS|CREATING|PARTIALLY_CREATED|PARTIALLY_DELETED|DELETING',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

AccessPoints

Type: Array of MultiRegionAccessPointReport structures

The list of Multi-Region Access Points associated with the user.

NextToken

Type: string

If the specified bucket has more Multi-Region Access Points than can be returned in one call to this action, this field contains a continuation token. You can use this token tin subsequent calls to this action to retrieve additional Multi-Region Access Points.

Errors

There are no errors described for this operation.

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 S3 User 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

AccountId

Required: Yes
Type: string

The Amazon Web Services account ID of the Outposts bucket.

MaxResults

Type: int

NextToken

Type: string

OutpostId

Type: string

The ID of the Outposts.

This is required by Amazon S3 on Outposts buckets.

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 when isTruncated is true, which means there are more buckets that can be listed. The next list requests to Amazon S3 can be continued with this NextToken. NextToken is obfuscated and is not a real key.

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 Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User 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 S3 User Guide.

Parameter Syntax

$result = $client->listStorageLensConfigurations([
    'AccountId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The account ID of the requester.

NextToken

Type: string

A pagination token to request the next page of results.

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.

PutAccessPointConfigurationForObjectLambda

$result = $client->putAccessPointConfigurationForObjectLambda([/* ... */]);
$promise = $client->putAccessPointConfigurationForObjectLambdaAsync([/* ... */]);

Replaces configuration for an Object Lambda Access Point.

The following actions are related to PutAccessPointConfigurationForObjectLambda:

GetAccessPointConfigurationForObjectLambda

Parameter Syntax

$result = $client->putAccessPointConfigurationForObjectLambda([
    'AccountId' => '<string>', // REQUIRED
    'Configuration' => [ // REQUIRED
        'AllowedFeatures' => ['<string>', ...],
        'CloudWatchMetricsEnabled' => true || false,
        'SupportingAccessPoint' => '<string>', // REQUIRED
        'TransformationConfigurations' => [ // REQUIRED
            [
                'Actions' => ['<string>', ...], // REQUIRED
                'ContentTransformation' => [ // REQUIRED
                    'AwsLambda' => [
                        'FunctionArn' => '<string>', // REQUIRED
                        'FunctionPayload' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
    ],
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The account ID for the account that owns the specified Object Lambda Access Point.

Configuration

Required: Yes
Type: ObjectLambdaConfiguration structure

Object Lambda Access Point configuration document.

Name

Required: Yes
Type: string

The name of the Object Lambda Access Point.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

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 Amazon Web Services 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.

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 S3 User Guide.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutAccessPointPolicyForObjectLambda

$result = $client->putAccessPointPolicyForObjectLambda([/* ... */]);
$promise = $client->putAccessPointPolicyForObjectLambdaAsync([/* ... */]);

Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points in the Amazon S3 User Guide.

The following actions are related to PutAccessPointPolicyForObjectLambda:

Parameter Syntax

$result = $client->putAccessPointPolicyForObjectLambda([
    'AccountId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Policy' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The account ID for the account that owns the specified Object Lambda Access Point.

Name

Required: Yes
Type: string

The name of the Object Lambda Access Point.

Policy

Required: Yes
Type: string

Object Lambda Access Point resource policy document.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 S3 API Reference.

Creates a new lifecycle configuration for the S3 on 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.

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 Amazon Web Services 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

The results for this operation are always empty.

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 S3 API Reference.

Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

If you are using an identity other than the root user of the Amazon Web Services 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 action.

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.

For more information about bucket policies, see Using Bucket Policies and User Policies.

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 Amazon Web Services 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.

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

The results for this operation are always empty.

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 S3 API Reference.

Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services 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 action, 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 Amazon Web Services-Generated Cost Allocation Tag Restrictions.
Error code: MalformedXMLError
- Description: The XML provided does not match the schema.
Error code: OperationAbortedError
- Description: A conflicting conditional action 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.

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 Amazon Web Services 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.

Tagging

Required: Yes
Type: Tagging structure

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 S3 User 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 Billing and Cost Management User Guide.

To use this action, 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 Amazon Web Services 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

The results for this operation are always empty.

Errors

InternalServiceException:
TooManyRequestsException:
NotFoundException:
TooManyTagsException:
Amazon S3 throws this exception if you have too many tags in your tag set.

PutMultiRegionAccessPointPolicy

$result = $client->putMultiRegionAccessPointPolicy([/* ... */]);
$promise = $client->putMultiRegionAccessPointPolicyAsync([/* ... */]);

Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only one policy, so a request made to this action replaces any existing policy that is associated with the specified Multi-Region Access Point.

The following actions are related to PutMultiRegionAccessPointPolicy:

Parameter Syntax

$result = $client->putMultiRegionAccessPointPolicy([
    'AccountId' => '<string>', // REQUIRED
    'ClientToken' => '<string>', // REQUIRED
    'Details' => [ // REQUIRED
        'Name' => '<string>', // REQUIRED
        'Policy' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

ClientToken

Required: Yes
Type: string

An idempotency token used to identify the request and guarantee that requests are unique.

Details

Required: Yes
Type: PutMultiRegionAccessPointPolicyInput structure

A container element containing the details of the policy for the Multi-Region Access Point.

Result Syntax

[
    'RequestTokenARN' => '<string>',
]

Result Details

Members

RequestTokenARN

Type: string

The request token associated with the request. You can use this token with DescribeMultiRegionAccessPointOperation to determine the status of asynchronous requests.

Errors

There are no errors described for this operation.

PutPublicAccessBlock

$result = $client->putPublicAccessBlock([/* ... */]);
$promise = $client->putPublicAccessBlockAsync([/* ... */]);

Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account. For this operation, users must have the s3:PutBucketPublicAccessBlock permission. 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 Amazon Web Services 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 Amazon Web Services account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 S3 User 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 S3 User 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' => [
            'CloudWatchMetrics' => [
                'IsEnabled' => true || false, // REQUIRED
            ],
            'S3BucketDestination' => [
                '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

The results for this operation are always empty.

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 Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User 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 S3 User 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

The results for this operation are always empty.

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 S3 User Guide.

Related actions include:

Parameter Syntax

$result = $client->updateJobPriority([
    'AccountId' => '<string>', // REQUIRED
    'JobId' => '<string>', // REQUIRED
    'Priority' => <integer>, // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services account ID associated with the S3 Batch Operations job.

JobId

Required: Yes
Type: string

The ID for the job whose priority you want to update.

Priority

Required: Yes
Type: int

The priority you want to assign to this job.

Result Syntax

[
    'JobId' => '<string>',
    'Priority' => <integer>,
]

Result Details

Members

JobId

Required: Yes
Type: string

The ID for the job whose priority Amazon S3 updated.

Priority

Required: Yes
Type: int

The new priority assigned to the specified job.

Errors

UpdateJobStatus

$result = $client->updateJobStatus([/* ... */]);
$promise = $client->updateJobStatusAsync([/* ... */]);

Updates the status for the specified job. Use this action 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 S3 User 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

The Amazon Web Services account ID associated with the S3 Batch Operations job.

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

JobId

Type: string

The ID for the job whose status was updated.

Status

Type: string

The current status for the specified job.

StatusUpdateReason

Type: string

The reason that the specified job's status was updated.

Errors

Shapes

AbortIncompleteMultipartUpload

Description

The container for abort incomplete multipart upload

Members

DaysAfterInitiation

Type: int

Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload to the Outposts bucket.

AccessPoint

Description

An access point used to access a bucket.

Members

AccessPointArn

Type: string

The ARN for the access point.

Alias

Type: string

The name or alias of 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

VpcConfiguration

Type: VpcConfiguration structure

The virtual private cloud (VPC) configuration for this access point, if one exists.

This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other Amazon Web Services.

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

IsEnabled

Type: boolean

A container for whether the activity metrics are enabled.

AsyncErrorDetails

Description

Error details for the failed asynchronous operation.

Members

Code

Type: string

A string that uniquely identifies the error condition.

Message

Type: string

A generic descritpion of the error condition in English.

RequestId

Type: string

The ID of the request associated with the error.

Resource

Type: string

The identifier of the resource associated with the error.

AsyncOperation

Description

A container for the information about an asynchronous operation.

Members

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the request was sent to the service.

Operation

Type: string

The specific operation for the asynchronous request.

RequestParameters

Type: AsyncRequestParameters structure

The parameters associated with the request.

RequestStatus

Type: string

The current status of the request.

RequestTokenARN

Type: string

The request token associated with the request.

ResponseDetails

Type: AsyncResponseDetails structure

The details of the response.

AsyncRequestParameters

Description

A container for the request parameters associated with an asynchronous request.

Members

CreateMultiRegionAccessPointRequest

Type: CreateMultiRegionAccessPointInput structure

A container of the parameters for a CreateMultiRegionAccessPoint request.

DeleteMultiRegionAccessPointRequest

Type: DeleteMultiRegionAccessPointInput structure

A container of the parameters for a DeleteMultiRegionAccessPoint request.

PutMultiRegionAccessPointPolicyRequest

Type: PutMultiRegionAccessPointPolicyInput structure

A container of the parameters for a PutMultiRegionAccessPoint request.

AsyncResponseDetails

Description

A container for the response details that are returned when querying about an asynchronous request.

Members

ErrorDetails

Type: AsyncErrorDetails structure

Error details for an asynchronous request.

MultiRegionAccessPointDetails

Type: MultiRegionAccessPointsAsyncResponse structure

The details for the Multi-Region Access Point.

AwsLambdaTransformation

Description

Lambda function used to transform objects through an Object Lambda Access Point.

Members

FunctionArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Lambda function.

FunctionPayload

Type: string

Additional JSON that provides supplemental data to the Lambda function used to transform objects.

BadRequestException

Description

Members

Message

Type: string

BucketAlreadyExists

Description

The requested Outposts bucket name is not available. The bucket namespace is shared by all users of the 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

CloudWatchMetrics

Description

A container for enabling Amazon CloudWatch publishing for S3 Storage Lens metrics.

For more information about publishing S3 Storage Lens metrics to CloudWatch, see Monitor S3 Storage Lens metrics in CloudWatch in the Amazon S3 User Guide.

Members

IsEnabled

Required: Yes
Type: boolean

A container that indicates whether CloudWatch publishing for S3 Storage Lens metrics is enabled. A value of true indicates that CloudWatch publishing for S3 Storage Lens metrics is enabled.

CreateAccessPointForObjectLambdaRequest

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services account ID for owner of the specified Object Lambda Access Point.

Configuration

Required: Yes
Type: ObjectLambdaConfiguration structure

Object Lambda Access Point configuration as a JSON document.

Name

Required: Yes
Type: string

The name you want to assign to this Object Lambda Access Point.

CreateAccessPointRequest

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services 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.

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 the access point.

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

LocationConstraint

Type: string

Specifies the Region where the bucket will be created. If you are creating a bucket on the US East (N. Virginia) Region (us-east-1), you do not need to specify the location.

This is not supported by Amazon S3 on Outposts buckets.

CreateJobRequest

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services 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

Type: JobManifest structure

Configuration parameters for the manifest.

ManifestGenerator

Type: JobManifestGenerator structure

The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

Operation

Required: Yes
Type: JobOperation structure

The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User 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 Identity and Access Management (IAM) role that Batch Operations will use to run this job's action 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.

CreateMultiRegionAccessPointInput

Description

A container for the information associated with a CreateMultiRegionAccessPoint request.

Members

Name

Required: Yes
Type: string

The name of the Multi-Region Access Point associated with this request.

PublicAccessBlock

Type: PublicAccessBlockConfiguration structure

This is not supported for Amazon S3 on Outposts.

Regions

Required: Yes
Type: Array of Region structures

The buckets in different Regions that are associated with the Multi-Region Access Point.

CreateMultiRegionAccessPointRequest

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services account ID for the owner of the Multi-Region Access Point. The owner of the Multi-Region Access Point also must own the underlying buckets.

ClientToken

Required: Yes
Type: string

An idempotency token used to identify the request and guarantee that requests are unique.

Details

Required: Yes
Type: CreateMultiRegionAccessPointInput structure

A container element containing details about the Multi-Region Access Point.

DeleteMultiRegionAccessPointInput

Description

A container for the information associated with a DeleteMultiRegionAccessPoint request.

Members

Name

Required: Yes
Type: string

The name of the Multi-Region Access Point associated with this request.

DeleteMultiRegionAccessPointRequest

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

ClientToken

Required: Yes
Type: string

An idempotency token used to identify the request and guarantee that requests are unique.

Details

Required: Yes
Type: DeleteMultiRegionAccessPointInput structure

A container element containing details about the Multi-Region Access Point.

EstablishedMultiRegionAccessPointPolicy

Description

The last established access control policy for a Multi-Region Access Point.

When you update the policy, the update is first listed as the proposed policy. After the update is finished and all Regions have been updated, the proposed policy is listed as the established policy. If both policies have the same version number, the proposed policy is the established policy.

Members

Policy

Type: string

The details of the last established policy.

Exclude

Description

A container for what Amazon S3 Storage Lens will exclude.

Members

Buckets

Type: Array of strings

A container for the S3 Storage Lens bucket excludes.

Regions

Type: Array of strings

A container for the S3 Storage Lens Region excludes.

GeneratedManifestEncryption

Description

The encryption configuration to use when storing the generated manifest.

Members

SSEKMS

Type: SSEKMSEncryption structure

Configuration details on how SSE-KMS is used to encrypt generated manifest objects.

SSES3

Type: SSES3Encryption structure

Specifies the use of SSE-S3 to encrypt generated manifest objects.

IdempotencyException

Description

Members

Message

Type: string

Include

Description

A container for what Amazon S3 Storage Lens configuration includes.

Members

Buckets

Type: Array of strings

A container for the S3 Storage Lens bucket includes.

Regions

Type: Array of strings

A container for the S3 Storage Lens Region includes.

InternalServiceException

Description

Members

Message

Type: string

InvalidNextTokenException

Description

Members

Message

Type: string

InvalidRequestException

Description

Members

Message

Type: string

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.

GeneratedManifestDescriptor

Type: S3GeneratedManifestDescriptor structure

The attribute of the JobDescriptor containing details about the job's generated manifest.

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.

ManifestGenerator

Type: JobManifestGenerator structure

The manifest generator that was used to generate a job manifest for this job.

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 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 the Suspended 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

FailureCode

Type: string

The failure code, if any, for the specified job.

FailureReason

Type: string

The failure reason, if any, for the specified job.

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.

JobManifestGenerator

Description

Configures the type of the job's ManifestGenerator.

Members

S3JobManifestGenerator

Type: S3JobManifestGenerator structure

The S3 job ManifestGenerator's configuration details.

JobManifestGeneratorFilter

Description

The filter used to describe a set of objects for the job's manifest.

Members

CreatedAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

If provided, the generated manifest should include only source bucket objects that were created after this time.

CreatedBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

If provided, the generated manifest should include only source bucket objects that were created before this time.

EligibleForReplication

Type: boolean

Include objects in the generated manifest only if they are eligible for replication according to the Replication configuration on the source bucket.

ObjectReplicationStatuses

Type: Array of strings

If provided, the generated manifest should include only source bucket objects that have one of the specified Replication statuses.

JobManifestLocation

Description

Contains the information required to locate a manifest object.

Members

ETag

Required: Yes
Type: string

The ETag for the specified manifest object.

ObjectArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) for a manifest object.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

ObjectVersionId

Type: string

The optional version ID to identify a specific version of the manifest object.

JobManifestSpec

Description

Describes the format of a manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.

Members

Fields

Type: Array of strings

If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.

Format

Required: Yes
Type: string

Indicates which of the available formats the specified manifest uses.

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 S3 User Guide.

Members

LambdaInvoke

Type: LambdaInvokeOperation structure

Directs the specified job to invoke an Lambda function on every object in the manifest.

S3DeleteObjectTagging

Type: S3DeleteObjectTaggingOperation structure

Directs the specified job to execute a DELETE Object tagging call 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 S3 User 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 S3 User Guide.

S3PutObjectTagging

Type: S3SetObjectTaggingOperation structure

Directs the specified job to run a PUT Object tagging call on every object in the manifest.

S3ReplicateObject

Type: S3ReplicateObjectOperation structure

Directs the specified job to invoke ReplicateObject on every object in the job's 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

NumberOfTasksFailed

Type: long (int|float)

NumberOfTasksSucceeded

Type: long (int|float)

Timers

Type: JobTimers structure

The JobTimers attribute of a job's progress summary.

TotalNumberOfTasks

Type: long (int|float)

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

Description

Members

Message

Type: string

JobTimers

Description

Provides timing details for the job.

Members

ElapsedTimeInActiveSeconds

Type: long (int|float)

Indicates the elapsed time in seconds the job has been in the Active job state.

LambdaInvokeOperation

Description

Contains the configuration parameters for a Lambda Invoke operation.

Members

FunctionArn

Type: string

The Amazon Resource Name (ARN) for the Lambda function that the specified job will invoke on every object in the manifest.

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 S3 User 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.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

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.

MultiRegionAccessPointPolicyDocument

Description

The Multi-Region Access Point access control policy.

Members

Established

Type: EstablishedMultiRegionAccessPointPolicy structure

The last established policy for the Multi-Region Access Point.

Proposed

Type: ProposedMultiRegionAccessPointPolicy structure

The proposed policy for the Multi-Region Access Point.

MultiRegionAccessPointRegionalResponse

Description

Status information for a single Multi-Region Access Point Region.

Members

Name

Type: string

The name of the Region in the Multi-Region Access Point.

RequestStatus

Type: string

The current status of the Multi-Region Access Point in this Region.

MultiRegionAccessPointReport

Description

A collection of statuses for a Multi-Region Access Point in the various Regions it supports.

Members

Alias

Type: string

The alias for the Multi-Region Access Point. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Managing Multi-Region Access Points.

CreatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

When the Multi-Region Access Point create request was received.

Name

Type: string

The name of the Multi-Region Access Point.

PublicAccessBlock

Type: PublicAccessBlockConfiguration structure

This is not supported for Amazon S3 on Outposts.

Regions

Type: Array of RegionReport structures

A collection of the Regions and buckets associated with the Multi-Region Access Point.

Status

Type: string

The current status of the Multi-Region Access Point.

CREATING and DELETING are temporary states that exist while the request is propogating and being completed. If a Multi-Region Access Point has a status of PARTIALLY_CREATED, you can retry creation or send a request to delete the Multi-Region Access Point. If a Multi-Region Access Point has a status of PARTIALLY_DELETED, you can retry a delete request to finish the deletion of the Multi-Region Access Point.

MultiRegionAccessPointsAsyncResponse

Description

The Multi-Region Access Point details that are returned when querying about an asynchronous request.

Members

Regions

Type: Array of MultiRegionAccessPointRegionalResponse structures

A collection of status information for the different Regions that a Multi-Region Access Point supports.

NoSuchPublicAccessBlockConfiguration

Description

Amazon S3 throws this exception if you make a GetPublicAccessBlock request against an account that doesn't have a PublicAccessBlockConfiguration set.

Members

Message

Type: string

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 S3 User 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 S3 User Guide.

StorageClass

Type: string

The class of storage used to store the object.

NotFoundException

Description

Members

Message

Type: string

ObjectLambdaAccessPoint

Description

An access point with an attached Lambda function used to access transformed data from an Amazon S3 bucket.

Members

Name

Required: Yes
Type: string

The name of the Object Lambda Access Point.

ObjectLambdaAccessPointArn

Type: string

Specifies the ARN for the Object Lambda Access Point.

ObjectLambdaConfiguration

Description

A configuration used when creating an Object Lambda Access Point.

Members

AllowedFeatures

Type: Array of strings

A container for allowed features. Valid inputs are GetObject-Range and GetObject-PartNumber.

CloudWatchMetricsEnabled

Type: boolean

A container for whether the CloudWatch metrics configuration is enabled.

SupportingAccessPoint

Required: Yes
Type: string

Standard access point associated with the Object Lambda Access Point.

TransformationConfigurations

Required: Yes
Type: Array of ObjectLambdaTransformationConfiguration structures

A container for transformation configurations for an Object Lambda Access Point.

ObjectLambdaContentTransformation

Description

A container for AwsLambdaTransformation.

Members

AwsLambda

Type: AwsLambdaTransformation structure

A container for an Lambda function.

ObjectLambdaTransformationConfiguration

Description

A configuration used when creating an Object Lambda Access Point transformation.

Members

Actions

Required: Yes
Type: Array of strings

A container for the action of an Object Lambda Access Point configuration. Valid input is GetObject.

ContentTransformation

Required: Yes
Type: ObjectLambdaContentTransformation structure

A container for the content transformation of an Object Lambda Access Point configuration.

PolicyStatus

Description

Members

IsPublic

Type: boolean

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

ProposedMultiRegionAccessPointPolicy

Description

The proposed access control policy for the Multi-Region Access Point.

Members

Policy

Type: string

The details of the proposed policy.

PublicAccessBlockConfiguration

Description

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 Amazon Web 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.

PutAccessPointConfigurationForObjectLambdaRequest

Members

AccountId

Required: Yes
Type: string

The account ID for the account that owns the specified Object Lambda Access Point.

Configuration

Required: Yes
Type: ObjectLambdaConfiguration structure

Object Lambda Access Point configuration document.

Name

Required: Yes
Type: string

The name of the Object Lambda Access Point.

PutAccessPointPolicyForObjectLambdaRequest

Members

AccountId

Required: Yes
Type: string

The account ID for the account that owns the specified Object Lambda Access Point.

Name

Required: Yes
Type: string

The name of the Object Lambda Access Point.

Policy

Required: Yes
Type: string

Object Lambda Access Point resource policy document.

PutAccessPointPolicyRequest

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services 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.

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 S3 User Guide.

PutBucketPolicyRequest

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services 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.

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 Amazon Web Services 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.

PutMultiRegionAccessPointPolicyInput

Description

A container for the information associated with a PutMultiRegionAccessPoint request.

Members

Name

Required: Yes
Type: string

The name of the Multi-Region Access Point associated with the request.

Policy

Required: Yes
Type: string

The policy details for the PutMultiRegionAccessPoint request.

PutMultiRegionAccessPointPolicyRequest

Members

AccountId

Required: Yes
Type: string

The Amazon Web Services account ID for the owner of the Multi-Region Access Point.

ClientToken

Required: Yes
Type: string

An idempotency token used to identify the request and guarantee that requests are unique.

Details

Required: Yes
Type: PutMultiRegionAccessPointPolicyInput structure

A container element containing the details of the policy for the Multi-Region Access Point.

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.

Region

Description

A Region that supports a Multi-Region Access Point as well as the associated bucket for the Region.

Members

Bucket

Required: Yes
Type: string

The name of the associated bucket for the Region.

RegionReport

Description

A combination of a bucket and Region that's part of a Multi-Region Access Point.

Members

Bucket

Type: string

The name of the bucket.

Region

Type: string

The name of the Region.

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 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

BucketKeyEnabled

Type: boolean

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

CannedAccessControlList

Type: string

ChecksumAlgorithm

Type: string

Indicates the algorithm you want Amazon S3 to use to create the checksum. For more information see Checking object integrity in the Amazon S3 User Guide.

MetadataDirective

Type: string

ModifiedSinceConstraint

Type: timestamp (string|DateTime or anything parsable by strtotime)

NewObjectMetadata

Type: S3ObjectMetadata structure

If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.

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)

S3DeleteObjectTaggingOperation

Description

Contains no configuration parameters because the DELETE Object tagging API only accepts the bucket name and key name as parameters, which are defined in the job's manifest.

Members

S3GeneratedManifestDescriptor

Description

Describes the specified job's generated manifest. Batch Operations jobs created with a ManifestGenerator populate details of this descriptor after execution of the ManifestGenerator.

Members

Format

Type: string

The format of the generated manifest.

Location

Type: JobManifestLocation structure

Contains the information required to locate a manifest object.

S3Grant

Description

Members

Grantee

Type: S3Grantee structure

Permission

Type: string

S3Grantee

Description

Members

DisplayName

Type: string

Identifier

Type: string

TypeIdentifier

Type: string

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 specifying ExpirationInDays results in restore request failure.

S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the same job. If you need to restore objects of both types you must create separate Batch Operations jobs.

GlacierJobTier

Type: string

S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the EXPEDITED retrieval tier.

S3JobManifestGenerator

Description

The container for the service that will create the S3 manifest.

Members

EnableManifestOutput

Required: Yes
Type: boolean

Determines whether or not to write the job's generated manifest to a bucket.

ExpectedBucketOwner

Type: string

The Amazon Web Services account ID that owns the bucket the generated manifest is written to. If provided the generated manifest bucket's owner Amazon Web Services account ID must match this value, else the job fails.

Filter

Type: JobManifestGeneratorFilter structure

Specifies rules the S3JobManifestGenerator should use to use to decide whether an object in the source bucket should or should not be included in the generated job manifest.

ManifestOutputLocation

Type: S3ManifestOutputLocation structure

Specifies the location the generated manifest will be written to.

SourceBucket

Required: Yes
Type: string

The source bucket used by the ManifestGenerator.

S3ManifestOutputLocation

Description

Location details for where the generated manifest should be written.

Members

Bucket

Required: Yes
Type: string

The bucket ARN the generated manifest should be written to.

ExpectedManifestBucketOwner

Type: string

The Account ID that owns the bucket the generated manifest is written to.

ManifestEncryption

Type: GeneratedManifestEncryption structure

Specifies what encryption should be used when the generated manifest objects are written.

ManifestFormat

Required: Yes
Type: string

The format of the generated manifest.

ManifestPrefix

Type: string

Prefix identifying one or more objects to which the manifest applies.

S3ObjectLockLegalHold

Description

Whether S3 Object Lock legal hold will be applied to objects in an S3 Batch Operations job.

Members

Status

Required: Yes
Type: string

The Object Lock legal hold status to be applied to all objects in the Batch Operations job.

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

Description

Members

DisplayName

Type: string

ID

Type: string

S3ReplicateObjectOperation

Description

Directs the specified job to invoke ReplicateObject on every object in the job's manifest.

Members

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 S3 User Guide.

Members

Mode

Type: string

The Object Lock retention mode to be applied to all objects in the Batch Operations job.

RetainUntilDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

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

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

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 S3 User 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

Description

Members

Key

Required: Yes
Type: string

Value

Required: Yes
Type: string

SSEKMS

Description

Members

KeyId

Required: Yes
Type: string

A container for the ARN of the SSE-KMS encryption. This property is read-only and follows the following format: arn:aws:kms:us-east-1:example-account-id:key/example-9a73-4afc-8d29-8f5900cef44e

SSEKMSEncryption

Description

Configuration for the use of SSE-KMS to encrypt generated manifest objects.

Members

KeyId

Required: Yes
Type: string

Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key to use for encrypting generated manifest objects.

SSES3

Description

Members

SSES3Encryption

Description

Configuration for the use of SSE-S3 to encrypt generated manifest objects.

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 Amazon Web Services organization for your S3 Storage Lens.

Members

Arn

Required: Yes
Type: string

A container for the Amazon Resource Name (ARN) of the Amazon Web Services organization. This property is read-only and follows the following format: arn:aws:organizations:us-east-1:example-account-id:organization/o-ex2l495dck

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 Amazon Web Services 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

CloudWatchMetrics

Type: CloudWatchMetrics structure

A container for enabling Amazon CloudWatch publishing for S3 Storage Lens metrics.

S3BucketDestination

Type: S3BucketDestination structure

A container for the bucket where the S3 Storage Lens metrics export will be located.

This bucket must be located in the same Region as the storage lens configuration.

StorageLensDataExportEncryption

Description

A container for the encryption of the S3 Storage Lens metrics exports.

Members

SSEKMS

Type: SSEKMS structure

SSES3

Type: SSES3 structure

StorageLensTag

Description

Members

Key

Required: Yes
Type: string

Value

Required: Yes
Type: string

Tagging

Description

Members

TagSet

Required: Yes
Type: Array of S3Tag structures

A collection for a set of tags.

TooManyRequestsException

Description

Members

Message

Type: string

TooManyTagsException

Description

Amazon S3 throws this exception if you have too many tags in your tag set.

Members

Message

Type: string

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 S3 User 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.

VpcConfiguration

Description

The virtual private cloud (VPC) configuration for an access point.

Members

VpcId

Required: Yes
Type: string

If this field is specified, this access point will only allow connections from the specified VPC ID.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS S3 Control 2018-08-20

Operation Summary

Paginators

Operations

CreateAccessPoint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateAccessPointForObjectLambda

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateBucket

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateMultiRegionAccessPoint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteAccessPoint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteAccessPointForObjectLambda

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteAccessPointPolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteAccessPointPolicyForObjectLambda

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteBucket

Parameter Syntax