AssociateAccessGrantsIdentityCenter

$result = $client->associateAccessGrantsIdentityCenter([/* ... */]);
$promise = $client->associateAccessGrantsIdentityCenterAsync([/* ... */]);

Associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance. Use this action if you want to create access grants for users or groups from your corporate identity directory. First, you must add your corporate identity directory to Amazon Web Services IAM Identity Center. Then, you can associate this IAM Identity Center instance with your S3 Access Grants instance.

Permissions

You must have the s3:AssociateAccessGrantsIdentityCenter permission to use this operation.

Additional Permissions

You must also have the following permissions: sso:CreateApplication, sso:PutApplicationGrant, and sso:PutApplicationAuthenticationMethod.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

CreateAccessGrant

$result = $client->createAccessGrant([/* ... */]);
$promise = $client->createAccessGrantAsync([/* ... */]);

Creates an access grant that gives a grantee access to your S3 data. The grantee can be an IAM user or role or a directory user, or group. Before you can create a grant, you must have an S3 Access Grants instance in the same Region as the S3 data. You can create an S3 Access Grants instance using the CreateAccessGrantsInstance. You must also have registered at least one S3 data location in your S3 Access Grants instance using CreateAccessGrantsLocation.

Permissions

You must have the s3:CreateAccessGrant permission to use this operation.

Additional Permissions

For any directory identity - sso:DescribeInstance and sso:DescribeApplication

For directory users - identitystore:DescribeUser

For directory groups - identitystore:DescribeGroup

Parameter Syntax

$result = $client->createAccessGrant([
    'AccessGrantsLocationConfiguration' => [
        'S3SubPrefix' => '<string>',
    ],
    'AccessGrantsLocationId' => '<string>', // REQUIRED
    'AccountId' => '<string>', // REQUIRED
    'ApplicationArn' => '<string>',
    'Grantee' => [ // REQUIRED
        'GranteeIdentifier' => '<string>',
        'GranteeType' => 'DIRECTORY_USER|DIRECTORY_GROUP|IAM',
    ],
    'Permission' => 'READ|WRITE|READWRITE', // REQUIRED
    'S3PrefixType' => 'Object',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'AccessGrantArn' => '<string>',
    'AccessGrantId' => '<string>',
    'AccessGrantsLocationConfiguration' => [
        'S3SubPrefix' => '<string>',
    ],
    'AccessGrantsLocationId' => '<string>',
    'ApplicationArn' => '<string>',
    'CreatedAt' => <DateTime>,
    'GrantScope' => '<string>',
    'Grantee' => [
        'GranteeIdentifier' => '<string>',
        'GranteeType' => 'DIRECTORY_USER|DIRECTORY_GROUP|IAM',
    ],
    'Permission' => 'READ|WRITE|READWRITE',
]

Result Details

Errors

There are no errors described for this operation.

CreateAccessGrantsInstance

$result = $client->createAccessGrantsInstance([/* ... */]);
$promise = $client->createAccessGrantsInstanceAsync([/* ... */]);

Creates an S3 Access Grants instance, which serves as a logical grouping for access grants. You can create one S3 Access Grants instance per Region per account.

Permissions

You must have the s3:CreateAccessGrantsInstance permission to use this operation.

Additional Permissions

To associate an IAM Identity Center instance with your S3 Access Grants instance, you must also have the sso:DescribeInstance, sso:CreateApplication, sso:PutApplicationGrant, and sso:PutApplicationAuthenticationMethod permissions.

Parameter Syntax

$result = $client->createAccessGrantsInstance([
    'AccountId' => '<string>', // REQUIRED
    'IdentityCenterArn' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'AccessGrantsInstanceArn' => '<string>',
    'AccessGrantsInstanceId' => '<string>',
    'CreatedAt' => <DateTime>,
    'IdentityCenterApplicationArn' => '<string>',
    'IdentityCenterArn' => '<string>',
    'IdentityCenterInstanceArn' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

CreateAccessGrantsLocation

$result = $client->createAccessGrantsLocation([/* ... */]);
$promise = $client->createAccessGrantsLocationAsync([/* ... */]);

The S3 data location that you would like to register in your S3 Access Grants instance. Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:

• The default S3 location s3://

• A bucket - S3://<bucket-name>

• A bucket and prefix - S3://<bucket-name>/<prefix>

When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role using a policy. S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.

Permissions

You must have the s3:CreateAccessGrantsLocation permission to use this operation.

Additional Permissions

You must also have the following permission for the specified IAM role: iam:PassRole

Parameter Syntax

$result = $client->createAccessGrantsLocation([
    'AccountId' => '<string>', // REQUIRED
    'IAMRoleArn' => '<string>', // REQUIRED
    'LocationScope' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'AccessGrantsLocationArn' => '<string>',
    'AccessGrantsLocationId' => '<string>',
    'CreatedAt' => <DateTime>,
    'IAMRoleArn' => '<string>',
    'LocationScope' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

CreateAccessPoint

$result = $client->createAccessPoint([/* ... */]);
$promise = $client->createAccessPointAsync([/* ... */]);

Creates an access point and associates it to a specified bucket. For more information, see Managing access to shared datasets with access points or Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide.

To create an access point and attach it to a volume on an Amazon FSx file system, see CreateAndAttachS3AccessPoint in the Amazon FSx API Reference.

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. In addition, you must use 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 by using the access point ARN, see the Examples section.

The following actions are related to CreateAccessPoint:

• GetAccessPoint

• DeleteAccessPoint

• ListAccessPoints

• ListAccessPointsForDirectoryBuckets

Parameter Syntax

$result = $client->createAccessPoint([
    'AccountId' => '<string>', // REQUIRED
    'Bucket' => '<string>', // REQUIRED
    'BucketAccountId' => '<string>',
    'Name' => '<string>', // REQUIRED
    'PublicAccessBlockConfiguration' => [
        'BlockPublicAcls' => true || false,
        'BlockPublicPolicy' => true || false,
        'IgnorePublicAcls' => true || false,
        'RestrictPublicBuckets' => true || false,
    ],
    'Scope' => [
        'Permissions' => ['<string>', ...],
        'Prefixes' => ['<string>', ...],
    ],
    'VpcConfiguration' => [
        'VpcId' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'AccessPointArn' => '<string>',
    'Alias' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

CreateAccessPointForObjectLambda

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

This operation is not supported by directory buckets.

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:

• DeleteAccessPointForObjectLambda

• GetAccessPointForObjectLambda

• ListAccessPointsForObjectLambda

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

Result Syntax

[
    'Alias' => [
        'Status' => 'PROVISIONING|READY',
        'Value' => '<string>',
    ],
    'ObjectLambdaAccessPointArn' => '<string>',
]

Result Details

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:

• PutObject

• GetBucket

• DeleteBucket

• CreateAccessPoint

• PutAccessPointPolicy

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

Result Syntax

[
    'BucketArn' => '<string>',
    'Location' => '<string>',
]

Result Details

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([/* ... */]);

This operation creates an S3 Batch Operations job.

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.

Permissions

For information about permissions required to use the Batch Operations, see Granting permissions for S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

• DescribeJob

• ListJobs

• UpdateJobPriority

• UpdateJobStatus

• JobOperation

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,
                'KeyNameConstraint' => [
                    'MatchAnyPrefix' => ['<string>', ...],
                    'MatchAnySubstring' => ['<string>', ...],
                    'MatchAnySuffix' => ['<string>', ...],
                ],
                'MatchAnyStorageClass' => ['<string>', ...],
                'ObjectReplicationStatuses' => ['<string>', ...],
                'ObjectSizeGreaterThanBytes' => <integer>,
                'ObjectSizeLessThanBytes' => <integer>,
            ],
            '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>',
            'InvocationSchemaVersion' => '<string>',
            'UserArguments' => ['<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|CRC64NVME',
            '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

Result Syntax

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

Result Details

Errors

TooManyRequestsException:

BadRequestException:

IdempotencyException:

InternalServiceException:

CreateMultiRegionAccessPoint

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

This operation is not supported by directory buckets.

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 working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations 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:

• DeleteMultiRegionAccessPoint

• DescribeMultiRegionAccessPointOperation

• GetMultiRegionAccessPoint

• ListMultiRegionAccessPoints

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
                'BucketAccountId' => '<string>',
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

There are no errors described for this operation.

CreateStorageLensGroup

$result = $client->createStorageLensGroup([/* ... */]);
$promise = $client->createStorageLensGroupAsync([/* ... */]);

Creates a new S3 Storage Lens group and associates it with the specified Amazon Web Services account ID. An S3 Storage Lens group is a custom grouping of objects based on prefix, suffix, object tags, object size, object age, or a combination of these filters. For each Storage Lens group that you’ve created, you can also optionally add Amazon Web Services resource tags. For more information about S3 Storage Lens groups, see Working with S3 Storage Lens groups.

To use this operation, you must have the permission to perform the s3:CreateStorageLensGroup action. If you’re trying to create a Storage Lens group with Amazon Web Services resource tags, you must also have permission to perform the s3:TagResource action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.

For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.

Parameter Syntax

$result = $client->createStorageLensGroup([
    'AccountId' => '<string>', // REQUIRED
    'StorageLensGroup' => [ // REQUIRED
        'Filter' => [ // REQUIRED
            'And' => [
                'MatchAnyPrefix' => ['<string>', ...],
                'MatchAnySuffix' => ['<string>', ...],
                'MatchAnyTag' => [
                    [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'MatchObjectAge' => [
                    'DaysGreaterThan' => <integer>,
                    'DaysLessThan' => <integer>,
                ],
                'MatchObjectSize' => [
                    'BytesGreaterThan' => <integer>,
                    'BytesLessThan' => <integer>,
                ],
            ],
            'MatchAnyPrefix' => ['<string>', ...],
            'MatchAnySuffix' => ['<string>', ...],
            'MatchAnyTag' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'MatchObjectAge' => [
                'DaysGreaterThan' => <integer>,
                'DaysLessThan' => <integer>,
            ],
            'MatchObjectSize' => [
                'BytesGreaterThan' => <integer>,
                'BytesLessThan' => <integer>,
            ],
            'Or' => [
                'MatchAnyPrefix' => ['<string>', ...],
                'MatchAnySuffix' => ['<string>', ...],
                'MatchAnyTag' => [
                    [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'MatchObjectAge' => [
                    'DaysGreaterThan' => <integer>,
                    'DaysLessThan' => <integer>,
                ],
                'MatchObjectSize' => [
                    'BytesGreaterThan' => <integer>,
                    'BytesLessThan' => <integer>,
                ],
            ],
        ],
        'Name' => '<string>', // REQUIRED
        'StorageLensGroupArn' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteAccessGrant

$result = $client->deleteAccessGrant([/* ... */]);
$promise = $client->deleteAccessGrantAsync([/* ... */]);

Deletes the access grant from the S3 Access Grants instance. You cannot undo an access grant deletion and the grantee will no longer have access to the S3 data.

Permissions

You must have the s3:DeleteAccessGrant permission to use this operation.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteAccessGrantsInstance

$result = $client->deleteAccessGrantsInstance([/* ... */]);
$promise = $client->deleteAccessGrantsInstanceAsync([/* ... */]);

Deletes your S3 Access Grants instance. You must first delete the access grants and locations before S3 Access Grants can delete the instance. See DeleteAccessGrant and DeleteAccessGrantsLocation. If you have associated an IAM Identity Center instance with your S3 Access Grants instance, you must first dissassociate the Identity Center instance from the S3 Access Grants instance before you can delete the S3 Access Grants instance. See AssociateAccessGrantsIdentityCenter and DissociateAccessGrantsIdentityCenter.

Permissions

You must have the s3:DeleteAccessGrantsInstance permission to use this operation.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteAccessGrantsInstanceResourcePolicy

$result = $client->deleteAccessGrantsInstanceResourcePolicy([/* ... */]);
$promise = $client->deleteAccessGrantsInstanceResourcePolicyAsync([/* ... */]);

Deletes the resource policy of the S3 Access Grants instance. The resource policy is used to manage cross-account access to your S3 Access Grants instance. By deleting the resource policy, you delete any cross-account permissions to your S3 Access Grants instance.

Permissions

You must have the s3:DeleteAccessGrantsInstanceResourcePolicy permission to use this operation.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteAccessGrantsLocation

$result = $client->deleteAccessGrantsLocation([/* ... */]);
$promise = $client->deleteAccessGrantsLocationAsync([/* ... */]);

Deregisters a location from your S3 Access Grants instance. You can only delete a location registration from an S3 Access Grants instance if there are no grants associated with this location. See Delete a grant for information on how to delete grants. You need to have at least one registered location in your S3 Access Grants instance in order to create access grants.

Permissions

You must have the s3:DeleteAccessGrantsLocation permission to use this operation.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteAccessPoint

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

Deletes the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use 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 by using the access point ARN, see the Examples section.

The following actions are related to DeleteAccessPoint:

• CreateAccessPoint

• GetAccessPoint

• ListAccessPoints

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteAccessPointForObjectLambda

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

This operation is not supported by directory buckets.

Deletes the specified Object Lambda Access Point.

The following actions are related to DeleteAccessPointForObjectLambda:

• CreateAccessPointForObjectLambda

• GetAccessPointForObjectLambda

• ListAccessPointsForObjectLambda

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteAccessPointPolicy

$result = $client->deleteAccessPointPolicy([/* ... */]);
$promise = $client->deleteAccessPointPolicyAsync([/* ... */]);

Deletes the access point policy for the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use 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 by using the access point ARN, see the Examples section.

The following actions are related to DeleteAccessPointPolicy:

• PutAccessPointPolicy

• GetAccessPointPolicy

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteAccessPointPolicyForObjectLambda

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

This operation is not supported by directory buckets.

Removes the resource policy for an Object Lambda Access Point.

The following actions are related to DeleteAccessPointPolicyForObjectLambda:

• GetAccessPointPolicyForObjectLambda

• PutAccessPointPolicyForObjectLambda

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteAccessPointScope

$result = $client->deleteAccessPointScope([/* ... */]);
$promise = $client->deleteAccessPointScopeAsync([/* ... */]);

Deletes an existing access point scope for a directory bucket.

To use this operation, you must have the permission to perform the s3express:DeleteAccessPointScope action.

For information about REST API errors, see REST error responses.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

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. In addition, you must use 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 by using the access point ARN, see the Examples section.

Related Resources

• CreateBucket

• GetBucket

• DeleteObject

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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 operation, you must have permission to perform the s3-outposts:PutLifecycleConfiguration action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use 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 by using the access point ARN, see the Examples section.

For more information about object expiration, see Elements to Describe Lifecycle Actions.

Related actions include:

• PutBucketLifecycleConfiguration

• GetBucketLifecycleConfiguration

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

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

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use 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 by using the access point ARN, see the Examples section.

The following actions are related to DeleteBucketPolicy:

• GetBucketPolicy

• PutBucketPolicy

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteBucketReplication

$result = $client->deleteBucketReplication([/* ... */]);
$promise = $client->deleteBucketReplicationAsync([/* ... */]);

This operation deletes an Amazon S3 on Outposts bucket's replication configuration. To delete an S3 bucket's replication configuration, see DeleteBucketReplication in the Amazon S3 API Reference.

Deletes the replication configuration from the specified S3 on Outposts bucket.

To use this operation, you must have permissions to perform the s3-outposts:PutReplicationConfiguration action. The Outposts bucket owner has this permission by default and can grant it to others. For more information about permissions, see Setting up IAM with S3 on Outposts and Managing access to S3 on Outposts buckets 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. In addition, you must use 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 by using the access point ARN, see the Examples section.

For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.

The following operations are related to DeleteBucketReplication:

• PutBucketReplication

• GetBucketReplication

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

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. In addition, you must use 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 by using the access point ARN, see the Examples section.

The following actions are related to DeleteBucketTagging:

• GetBucketTagging

• PutBucketTagging

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteJobTagging

$result = $client->deleteJobTagging([/* ... */]);
$promise = $client->deleteJobTaggingAsync([/* ... */]);

Removes the entire tag set from the specified S3 Batch Operations job.

Permissions

To use the DeleteJobTagging 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:

• CreateJob

• GetJobTagging

• PutJobTagging

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceException:

TooManyRequestsException:

NotFoundException:

DeleteMultiRegionAccessPoint

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

This operation is not supported by directory buckets.

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.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations 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 DeleteMultiRegionAccessPoint:

• CreateMultiRegionAccessPoint

• DescribeMultiRegionAccessPointOperation

• GetMultiRegionAccessPoint

• ListMultiRegionAccessPoints

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

There are no errors described for this operation.

DeletePublicAccessBlock

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

This operation is not supported by directory buckets.

Removes the PublicAccessBlock configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access.

Related actions include:

• GetPublicAccessBlock

• PutPublicAccessBlock

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteStorageLensConfiguration

$result = $client->deleteStorageLensConfiguration([/* ... */]);
$promise = $client->deleteStorageLensConfigurationAsync([/* ... */]);

This operation is not supported by directory buckets.

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteStorageLensConfigurationTagging

$result = $client->deleteStorageLensConfigurationTagging([/* ... */]);
$promise = $client->deleteStorageLensConfigurationTaggingAsync([/* ... */]);

This operation is not supported by directory buckets.

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteStorageLensGroup

$result = $client->deleteStorageLensGroup([/* ... */]);
$promise = $client->deleteStorageLensGroupAsync([/* ... */]);

Deletes an existing S3 Storage Lens group.

To use this operation, you must have the permission to perform the s3:DeleteStorageLensGroup action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.

For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DescribeJob

$result = $client->describeJob([/* ... */]);
$promise = $client->describeJobAsync([/* ... */]);

Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Permissions

To use the DescribeJob operation, you must have permission to perform the s3:DescribeJob action.

Related actions include:

• CreateJob

• ListJobs

• UpdateJobPriority

• UpdateJobStatus

Parameter Syntax

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

Parameter Details

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,
                    'KeyNameConstraint' => [
                        'MatchAnyPrefix' => ['<string>', ...],
                        'MatchAnySubstring' => ['<string>', ...],
                        'MatchAnySuffix' => ['<string>', ...],
                    ],
                    'MatchAnyStorageClass' => ['<string>', ...],
                    'ObjectReplicationStatuses' => ['<string>', ...],
                    'ObjectSizeGreaterThanBytes' => <integer>,
                    'ObjectSizeLessThanBytes' => <integer>,
                ],
                'ManifestOutputLocation' => [
                    'Bucket' => '<string>',
                    'ExpectedManifestBucketOwner' => '<string>',
                    'ManifestEncryption' => [
                        'SSEKMS' => [
                            'KeyId' => '<string>',
                        ],
                        'SSES3' => [
                        ],
                    ],
                    'ManifestFormat' => 'S3InventoryReport_CSV_20211130',
                    'ManifestPrefix' => '<string>',
                ],
                'SourceBucket' => '<string>',
            ],
        ],
        'Operation' => [
            'LambdaInvoke' => [
                'FunctionArn' => '<string>',
                'InvocationSchemaVersion' => '<string>',
                'UserArguments' => ['<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|CRC64NVME',
                '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

Errors

BadRequestException:

TooManyRequestsException:

NotFoundException:

InternalServiceException:

DescribeMultiRegionAccessPointOperation

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

This operation is not supported by directory buckets.

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 Using Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPoint:

• CreateMultiRegionAccessPoint

• DeleteMultiRegionAccessPoint

• GetMultiRegionAccessPoint

• ListMultiRegionAccessPoints

Parameter Syntax

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

Parameter Details

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>',
                        'BucketAccountId' => '<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

Errors

There are no errors described for this operation.

DissociateAccessGrantsIdentityCenter

$result = $client->dissociateAccessGrantsIdentityCenter([/* ... */]);
$promise = $client->dissociateAccessGrantsIdentityCenterAsync([/* ... */]);

Dissociates the Amazon Web Services IAM Identity Center instance from the S3 Access Grants instance.

Permissions

You must have the s3:DissociateAccessGrantsIdentityCenter permission to use this operation.

Additional Permissions

You must have the sso:DeleteApplication permission to use this operation.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

GetAccessGrant

$result = $client->getAccessGrant([/* ... */]);
$promise = $client->getAccessGrantAsync([/* ... */]);

Get the details of an access grant from your S3 Access Grants instance.

Permissions

You must have the s3:GetAccessGrant permission to use this operation.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AccessGrantArn' => '<string>',
    'AccessGrantId' => '<string>',
    'AccessGrantsLocationConfiguration' => [
        'S3SubPrefix' => '<string>',
    ],
    'AccessGrantsLocationId' => '<string>',
    'ApplicationArn' => '<string>',
    'CreatedAt' => <DateTime>,
    'GrantScope' => '<string>',
    'Grantee' => [
        'GranteeIdentifier' => '<string>',
        'GranteeType' => 'DIRECTORY_USER|DIRECTORY_GROUP|IAM',
    ],
    'Permission' => 'READ|WRITE|READWRITE',
]

Result Details

Errors

There are no errors described for this operation.

GetAccessGrantsInstance

$result = $client->getAccessGrantsInstance([/* ... */]);
$promise = $client->getAccessGrantsInstanceAsync([/* ... */]);

Retrieves the S3 Access Grants instance for a Region in your account.

Permissions

You must have the s3:GetAccessGrantsInstance permission to use this operation.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AccessGrantsInstanceArn' => '<string>',
    'AccessGrantsInstanceId' => '<string>',
    'CreatedAt' => <DateTime>,
    'IdentityCenterApplicationArn' => '<string>',
    'IdentityCenterArn' => '<string>',
    'IdentityCenterInstanceArn' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

GetAccessGrantsInstanceForPrefix

$result = $client->getAccessGrantsInstanceForPrefix([/* ... */]);
$promise = $client->getAccessGrantsInstanceForPrefixAsync([/* ... */]);

Retrieve the S3 Access Grants instance that contains a particular prefix.

Permissions

You must have the s3:GetAccessGrantsInstanceForPrefix permission for the caller account to use this operation.

Additional Permissions

The prefix owner account must grant you the following permissions to their S3 Access Grants instance: s3:GetAccessGrantsInstanceForPrefix.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AccessGrantsInstanceArn' => '<string>',
    'AccessGrantsInstanceId' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

GetAccessGrantsInstanceResourcePolicy

$result = $client->getAccessGrantsInstanceResourcePolicy([/* ... */]);
$promise = $client->getAccessGrantsInstanceResourcePolicyAsync([/* ... */]);

Returns the resource policy of the S3 Access Grants instance.

Permissions

You must have the s3:GetAccessGrantsInstanceResourcePolicy permission to use this operation.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'Organization' => '<string>',
    'Policy' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

GetAccessGrantsLocation

$result = $client->getAccessGrantsLocation([/* ... */]);
$promise = $client->getAccessGrantsLocationAsync([/* ... */]);

Retrieves the details of a particular location registered in your S3 Access Grants instance.

Permissions

You must have the s3:GetAccessGrantsLocation permission to use this operation.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AccessGrantsLocationArn' => '<string>',
    'AccessGrantsLocationId' => '<string>',
    'CreatedAt' => <DateTime>,
    'IAMRoleArn' => '<string>',
    'LocationScope' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

GetAccessPoint

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

Returns configuration information about the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use 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 by using the access point ARN, see the Examples section.

The following actions are related to GetAccessPoint:

• CreateAccessPoint

• DeleteAccessPoint

• ListAccessPoints

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AccessPointArn' => '<string>',
    'Alias' => '<string>',
    'Bucket' => '<string>',
    'BucketAccountId' => '<string>',
    'CreationDate' => <DateTime>,
    'DataSourceId' => '<string>',
    'DataSourceType' => '<string>',
    '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

Errors

There are no errors described for this operation.

GetAccessPointConfigurationForObjectLambda

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

This operation is not supported by directory buckets.

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

Result Syntax

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

Result Details

Errors

There are no errors described for this operation.

GetAccessPointForObjectLambda

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

This operation is not supported by directory buckets.

Returns configuration information about the specified Object Lambda Access Point

The following actions are related to GetAccessPointForObjectLambda:

• CreateAccessPointForObjectLambda

• DeleteAccessPointForObjectLambda

• ListAccessPointsForObjectLambda

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Alias' => [
        'Status' => 'PROVISIONING|READY',
        'Value' => '<string>',
    ],
    'CreationDate' => <DateTime>,
    'Name' => '<string>',
    'PublicAccessBlockConfiguration' => [
        'BlockPublicAcls' => true || false,
        'BlockPublicPolicy' => true || false,
        'IgnorePublicAcls' => true || false,
        'RestrictPublicBuckets' => true || false,
    ],
]

Result Details

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:

• PutAccessPointPolicy

• DeleteAccessPointPolicy

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

There are no errors described for this operation.

GetAccessPointPolicyForObjectLambda

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

This operation is not supported by directory buckets.

Returns the resource policy for an Object Lambda Access Point.

The following actions are related to GetAccessPointPolicyForObjectLambda:

• DeleteAccessPointPolicyForObjectLambda

• PutAccessPointPolicyForObjectLambda

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

There are no errors described for this operation.

GetAccessPointPolicyStatus

$result = $client->getAccessPointPolicyStatus([/* ... */]);
$promise = $client->getAccessPointPolicyStatusAsync([/* ... */]);

This operation is not supported by directory buckets.

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

Result Syntax

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

Result Details

Errors

There are no errors described for this operation.

GetAccessPointPolicyStatusForObjectLambda

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

This operation is not supported by directory buckets.

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

Result Syntax

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

Result Details

Errors

There are no errors described for this operation.

GetAccessPointScope

$result = $client->getAccessPointScope([/* ... */]);
$promise = $client->getAccessPointScopeAsync([/* ... */]);

Returns the access point scope for a directory bucket.

To use this operation, you must have the permission to perform the s3express:GetAccessPointScope action.

For information about REST API errors, see REST error responses.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Scope' => [
        'Permissions' => ['<string>', ...],
        'Prefixes' => ['<string>', ...],
    ],
]

Result Details

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:

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. In addition, you must use 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 by using the access point ARN, see the Examples section.

• PutObject

• CreateBucket

• DeleteBucket

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

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. In addition, you must use 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 by using the access point ARN, see the Examples section.

GetBucketLifecycleConfiguration has the following special error:

• Error code: NoSuchLifecycleConfiguration

  • Description: The lifecycle configuration does not exist.

  • HTTP Status Code: 404 Not Found

  • SOAP Fault Code Prefix: Client

The following actions are related to GetBucketLifecycleConfiguration:

• PutBucketLifecycleConfiguration

• DeleteBucketLifecycleConfiguration

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Rules' => [
        [
            'AbortIncompleteMultipartUpload' => [
                'DaysAfterInitiation' => <integer>,
            ],
            'Expiration' => [
                'Date' => <DateTime>,
                'Days' => <integer>,
                'ExpiredObjectDeleteMarker' => true || false,
            ],
            'Filter' => [
                'And' => [
                    'ObjectSizeGreaterThan' => <integer>,
                    'ObjectSizeLessThan' => <integer>,
                    'Prefix' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'ObjectSizeGreaterThan' => <integer>,
                'ObjectSizeLessThan' => <integer>,
                'Prefix' => '<string>',
                'Tag' => [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
            ],
            'ID' => '<string>',
            'NoncurrentVersionExpiration' => [
                'NewerNoncurrentVersions' => <integer>,
                '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

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.

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. In addition, you must use 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 by using the access point ARN, see the Examples section.

The following actions are related to GetBucketPolicy:

• GetObject

• PutBucketPolicy

• DeleteBucketPolicy

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

There are no errors described for this operation.

GetBucketReplication

$result = $client->getBucketReplication([/* ... */]);
$promise = $client->getBucketReplicationAsync([/* ... */]);

This operation gets an Amazon S3 on Outposts bucket's replication configuration. To get an S3 bucket's replication configuration, see GetBucketReplication in the Amazon S3 API Reference.

Returns the replication configuration of an S3 on Outposts bucket. For more information about S3 on Outposts, see Using Amazon S3 on Outposts in the Amazon S3 User Guide. For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide.

This action requires permissions for the s3-outposts:GetReplicationConfiguration action. The Outposts bucket owner has this permission by default and can grant it to others. For more information about permissions, see Setting up IAM with S3 on Outposts and Managing access to S3 on Outposts bucket 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. In addition, you must use 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 by using the access point ARN, see the Examples section.

If you include the Filter element in a replication configuration, you must also include the DeleteMarkerReplication, Status, and Priority elements. The response also returns those elements.

For information about S3 on Outposts replication failure reasons, see Replication failure reasons in the Amazon S3 User Guide.

The following operations are related to GetBucketReplication:

• PutBucketReplication

• DeleteBucketReplication

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ReplicationConfiguration' => [
        'Role' => '<string>',
        'Rules' => [
            [
                'Bucket' => '<string>',
                'DeleteMarkerReplication' => [
                    'Status' => 'Enabled|Disabled',
                ],
                'Destination' => [
                    'AccessControlTranslation' => [
                        'Owner' => 'Destination',
                    ],
                    'Account' => '<string>',
                    'Bucket' => '<string>',
                    'EncryptionConfiguration' => [
                        'ReplicaKmsKeyID' => '<string>',
                    ],
                    'Metrics' => [
                        'EventThreshold' => [
                            'Minutes' => <integer>,
                        ],
                        'Status' => 'Enabled|Disabled',
                    ],
                    'ReplicationTime' => [
                        'Status' => 'Enabled|Disabled',
                        'Time' => [
                            'Minutes' => <integer>,
                        ],
                    ],
                    'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR',
                ],
                'ExistingObjectReplication' => [
                    'Status' => 'Enabled|Disabled',
                ],
                'Filter' => [
                    'And' => [
                        'Prefix' => '<string>',
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'Prefix' => '<string>',
                    'Tag' => [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                ],
                'ID' => '<string>',
                'Prefix' => '<string>',
                'Priority' => <integer>,
                'SourceSelectionCriteria' => [
                    'ReplicaModifications' => [
                        'Status' => 'Enabled|Disabled',
                    ],
                    'SseKmsEncryptedObjects' => [
                        'Status' => 'Enabled|Disabled',
                    ],
                ],
                'Status' => 'Enabled|Disabled',
            ],
            // ...
        ],
    ],
]

Result Details

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.

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. In addition, you must use 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 by using the access point ARN, see the Examples section.

The following actions are related to GetBucketTagging:

• PutBucketTagging

• DeleteBucketTagging

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'TagSet' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

GetBucketVersioning

$result = $client->getBucketVersioning([/* ... */]);
$promise = $client->getBucketVersioningAsync([/* ... */]);

This operation returns the versioning state for S3 on Outposts buckets only. To return the versioning state for an S3 bucket, see GetBucketVersioning in the Amazon S3 API Reference.

Returns the versioning state for an S3 on Outposts bucket. With S3 Versioning, you can save multiple distinct copies of your objects and recover from unintended user actions and application failures.

If you've never set versioning on your bucket, it has no versioning state. In that case, the GetBucketVersioning request does not return a versioning state value.

For more information about versioning, see Versioning 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. In addition, you must use 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 by using the access point ARN, see the Examples section.

The following operations are related to GetBucketVersioning for S3 on Outposts.

• PutBucketVersioning

• PutBucketLifecycleConfiguration

• GetBucketLifecycleConfiguration

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'MFADelete' => 'Enabled|Disabled',
    'Status' => 'Enabled|Suspended',
]

Result Details

Errors

There are no errors described for this operation.

GetDataAccess

$result = $client->getDataAccess([/* ... */]);
$promise = $client->getDataAccessAsync([/* ... */]);

Returns a temporary access credential from S3 Access Grants to the grantee or client application. The temporary credential is an Amazon Web Services STS token that grants them access to the S3 data.

Permissions

You must have the s3:GetDataAccess permission to use this operation.

Additional Permissions

The IAM role that S3 Access Grants assumes must have the following permissions specified in the trust policy when registering the location: sts:AssumeRole, for directory users or groups sts:SetContext, and for IAM users or roles sts:SetSourceIdentity.

Parameter Syntax

$result = $client->getDataAccess([
    'AccountId' => '<string>', // REQUIRED
    'DurationSeconds' => <integer>,
    'Permission' => 'READ|WRITE|READWRITE', // REQUIRED
    'Privilege' => 'Minimal|Default',
    'Target' => '<string>', // REQUIRED
    'TargetType' => 'Object',
]);

Parameter Details

Result Syntax

[
    'Credentials' => [
        'AccessKeyId' => '<string>',
        'Expiration' => <DateTime>,
        'SecretAccessKey' => '<string>',
        'SessionToken' => '<string>',
    ],
    'Grantee' => [
        'GranteeIdentifier' => '<string>',
        'GranteeType' => 'DIRECTORY_USER|DIRECTORY_GROUP|IAM',
    ],
    'MatchedGrantTarget' => '<string>',
]

Result Details

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.

Permissions

To use the GetJobTagging 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:

• CreateJob

• PutJobTagging

• DeleteJobTagging

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServiceException:

TooManyRequestsException:

NotFoundException:

GetMultiRegionAccessPoint

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

This operation is not supported by directory buckets.

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

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

The following actions are related to GetMultiRegionAccessPoint:

• CreateMultiRegionAccessPoint

• DeleteMultiRegionAccessPoint

• DescribeMultiRegionAccessPointOperation

• ListMultiRegionAccessPoints

Parameter Syntax

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

Parameter Details

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>',
                'BucketAccountId' => '<string>',
                'Region' => '<string>',
            ],
            // ...
        ],
        'Status' => 'READY|INCONSISTENT_ACROSS_REGIONS|CREATING|PARTIALLY_CREATED|PARTIALLY_DELETED|DELETING',
    ],
]

Result Details

Errors

There are no errors described for this operation.

GetMultiRegionAccessPointPolicy

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

This operation is not supported by directory buckets.

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

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

The following actions are related to GetMultiRegionAccessPointPolicy:

• GetMultiRegionAccessPointPolicyStatus

• PutMultiRegionAccessPointPolicy

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

There are no errors described for this operation.

GetMultiRegionAccessPointPolicyStatus

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

This operation is not supported by directory buckets.

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

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

The following actions are related to GetMultiRegionAccessPointPolicyStatus:

• GetMultiRegionAccessPointPolicy

• PutMultiRegionAccessPointPolicy

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

There are no errors described for this operation.

GetMultiRegionAccessPointRoutes

$result = $client->getMultiRegionAccessPointRoutes([/* ... */]);
$promise = $client->getMultiRegionAccessPointRoutesAsync([/* ... */]);

This operation is not supported by directory buckets.

Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or passive.

To obtain routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions:

• us-east-1

• us-west-2

• ap-southeast-2

• ap-northeast-1

• eu-west-1

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Mrap' => '<string>',
    'Routes' => [
        [
            'Bucket' => '<string>',
            'Region' => '<string>',
            'TrafficDialPercentage' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

GetPublicAccessBlock

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

This operation is not supported by directory buckets.

Retrieves the PublicAccessBlock configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access.

Related actions include:

• DeletePublicAccessBlock

• PutPublicAccessBlock

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'PublicAccessBlockConfiguration' => [
        'BlockPublicAcls' => true || false,
        'BlockPublicPolicy' => true || false,
        'IgnorePublicAcls' => true || false,
        'RestrictPublicBuckets' => true || false,
    ],
]

Result Details

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([/* ... */]);

This operation is not supported by directory buckets.

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. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'StorageLensConfiguration' => [
        'AccountLevel' => [
            'ActivityMetrics' => [
                'IsEnabled' => true || false,
            ],
            'AdvancedCostOptimizationMetrics' => [
                'IsEnabled' => true || false,
            ],
            'AdvancedDataProtectionMetrics' => [
                'IsEnabled' => true || false,
            ],
            'BucketLevel' => [
                'ActivityMetrics' => [
                    'IsEnabled' => true || false,
                ],
                'AdvancedCostOptimizationMetrics' => [
                    'IsEnabled' => true || false,
                ],
                'AdvancedDataProtectionMetrics' => [
                    'IsEnabled' => true || false,
                ],
                'DetailedStatusCodesMetrics' => [
                    'IsEnabled' => true || false,
                ],
                'PrefixLevel' => [
                    'StorageMetrics' => [
                        'IsEnabled' => true || false,
                        'SelectionCriteria' => [
                            'Delimiter' => '<string>',
                            'MaxDepth' => <integer>,
                            'MinStorageBytesPercentage' => <float>,
                        ],
                    ],
                ],
            ],
            'DetailedStatusCodesMetrics' => [
                'IsEnabled' => true || false,
            ],
            'StorageLensGroupLevel' => [
                'SelectionCriteria' => [
                    'Exclude' => ['<string>', ...],
                    'Include' => ['<string>', ...],
                ],
            ],
        ],
        '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

Errors

There are no errors described for this operation.

GetStorageLensConfigurationTagging

$result = $client->getStorageLensConfigurationTagging([/* ... */]);
$promise = $client->getStorageLensConfigurationTaggingAsync([/* ... */]);

This operation is not supported by directory buckets.

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

GetStorageLensGroup

$result = $client->getStorageLensGroup([/* ... */]);
$promise = $client->getStorageLensGroupAsync([/* ... */]);

Retrieves the Storage Lens group configuration details.

To use this operation, you must have the permission to perform the s3:GetStorageLensGroup action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.

For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'StorageLensGroup' => [
        'Filter' => [
            'And' => [
                'MatchAnyPrefix' => ['<string>', ...],
                'MatchAnySuffix' => ['<string>', ...],
                'MatchAnyTag' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'MatchObjectAge' => [
                    'DaysGreaterThan' => <integer>,
                    'DaysLessThan' => <integer>,
                ],
                'MatchObjectSize' => [
                    'BytesGreaterThan' => <integer>,
                    'BytesLessThan' => <integer>,
                ],
            ],
            'MatchAnyPrefix' => ['<string>', ...],
            'MatchAnySuffix' => ['<string>', ...],
            'MatchAnyTag' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'MatchObjectAge' => [
                'DaysGreaterThan' => <integer>,
                'DaysLessThan' => <integer>,
            ],
            'MatchObjectSize' => [
                'BytesGreaterThan' => <integer>,
                'BytesLessThan' => <integer>,
            ],
            'Or' => [
                'MatchAnyPrefix' => ['<string>', ...],
                'MatchAnySuffix' => ['<string>', ...],
                'MatchAnyTag' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'MatchObjectAge' => [
                    'DaysGreaterThan' => <integer>,
                    'DaysLessThan' => <integer>,
                ],
                'MatchObjectSize' => [
                    'BytesGreaterThan' => <integer>,
                    'BytesLessThan' => <integer>,
                ],
            ],
        ],
        'Name' => '<string>',
        'StorageLensGroupArn' => '<string>',
    ],
]

Result Details

Errors

There are no errors described for this operation.

ListAccessGrants

$result = $client->listAccessGrants([/* ... */]);
$promise = $client->listAccessGrantsAsync([/* ... */]);

Returns the list of access grants in your S3 Access Grants instance.

Permissions

You must have the s3:ListAccessGrants permission to use this operation.

Parameter Syntax

$result = $client->listAccessGrants([
    'AccountId' => '<string>', // REQUIRED
    'ApplicationArn' => '<string>',
    'GrantScope' => '<string>',
    'GranteeIdentifier' => '<string>',
    'GranteeType' => 'DIRECTORY_USER|DIRECTORY_GROUP|IAM',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Permission' => 'READ|WRITE|READWRITE',
]);

Parameter Details

Result Syntax

[
    'AccessGrantsList' => [
        [
            'AccessGrantArn' => '<string>',
            'AccessGrantId' => '<string>',
            'AccessGrantsLocationConfiguration' => [
                'S3SubPrefix' => '<string>',
            ],
            'AccessGrantsLocationId' => '<string>',
            'ApplicationArn' => '<string>',
            'CreatedAt' => <DateTime>,
            'GrantScope' => '<string>',
            'Grantee' => [
                'GranteeIdentifier' => '<string>',
                'GranteeType' => 'DIRECTORY_USER|DIRECTORY_GROUP|IAM',
            ],
            'Permission' => 'READ|WRITE|READWRITE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListAccessGrantsInstances

$result = $client->listAccessGrantsInstances([/* ... */]);
$promise = $client->listAccessGrantsInstancesAsync([/* ... */]);

Returns a list of S3 Access Grants instances. An S3 Access Grants instance serves as a logical grouping for your individual access grants. You can only have one S3 Access Grants instance per Region per account.

Permissions

You must have the s3:ListAccessGrantsInstances permission to use this operation.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AccessGrantsInstancesList' => [
        [
            'AccessGrantsInstanceArn' => '<string>',
            'AccessGrantsInstanceId' => '<string>',
            'CreatedAt' => <DateTime>,
            'IdentityCenterApplicationArn' => '<string>',
            'IdentityCenterArn' => '<string>',
            'IdentityCenterInstanceArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListAccessGrantsLocations

$result = $client->listAccessGrantsLocations([/* ... */]);
$promise = $client->listAccessGrantsLocationsAsync([/* ... */]);

Returns a list of the locations registered in your S3 Access Grants instance.

Permissions

You must have the s3:ListAccessGrantsLocations permission to use this operation.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AccessGrantsLocationsList' => [
        [
            'AccessGrantsLocationArn' => '<string>',
            'AccessGrantsLocationId' => '<string>',
            'CreatedAt' => <DateTime>,
            'IAMRoleArn' => '<string>',
            'LocationScope' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListAccessPoints

$result = $client->listAccessPoints([/* ... */]);
$promise = $client->listAccessPointsAsync([/* ... */]);

This operation is not supported by directory buckets.

Returns a list of the access points. You can retrieve up to 1,000 access points per call. If the call returns 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.

Returns only access points attached to S3 buckets by default. To return all access points specify DataSourceType as ALL.

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. In addition, you must use 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 by using the access point ARN, see the Examples section.

The following actions are related to ListAccessPoints:

• CreateAccessPoint

• DeleteAccessPoint

• GetAccessPoint

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AccessPointList' => [
        [
            'AccessPointArn' => '<string>',
            'Alias' => '<string>',
            'Bucket' => '<string>',
            'BucketAccountId' => '<string>',
            'DataSourceId' => '<string>',
            'DataSourceType' => '<string>',
            'Name' => '<string>',
            'NetworkOrigin' => 'Internet|VPC',
            'VpcConfiguration' => [
                'VpcId' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListAccessPointsForDirectoryBuckets

$result = $client->listAccessPointsForDirectoryBuckets([/* ... */]);
$promise = $client->listAccessPointsForDirectoryBucketsAsync([/* ... */]);

Returns a list of the access points that are owned by the Amazon Web Services account and that are associated with the specified directory bucket.

To list access points for general purpose buckets, see ListAccesspoints.

To use this operation, you must have the permission to perform the s3express:ListAccessPointsForDirectoryBuckets action.

For information about REST API errors, see REST error responses.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AccessPointList' => [
        [
            'AccessPointArn' => '<string>',
            'Alias' => '<string>',
            'Bucket' => '<string>',
            'BucketAccountId' => '<string>',
            'DataSourceId' => '<string>',
            'DataSourceType' => '<string>',
            'Name' => '<string>',
            'NetworkOrigin' => 'Internet|VPC',
            'VpcConfiguration' => [
                'VpcId' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListAccessPointsForObjectLambda

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

This operation is not supported by directory buckets.

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:

• CreateAccessPointForObjectLambda

• DeleteAccessPointForObjectLambda

• GetAccessPointForObjectLambda

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ObjectLambdaAccessPointList' => [
        [
            'Alias' => [
                'Status' => 'PROVISIONING|READY',
                'Value' => '<string>',
            ],
            'Name' => '<string>',
            'ObjectLambdaAccessPointArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

ListCallerAccessGrants

$result = $client->listCallerAccessGrants([/* ... */]);
$promise = $client->listCallerAccessGrantsAsync([/* ... */]);

Use this API to list the access grants that grant the caller access to Amazon S3 data through S3 Access Grants. The caller (grantee) can be an Identity and Access Management (IAM) identity or Amazon Web Services Identity Center corporate directory identity. You must pass the Amazon Web Services account of the S3 data owner (grantor) in the request. You can, optionally, narrow the results by GrantScope, using a fragment of the data's S3 path, and S3 Access Grants will return only the grants with a path that contains the path fragment. You can also pass the AllowedByApplication filter in the request, which returns only the grants authorized for applications, whether the application is the caller's Identity Center application or any other application (ALL). For more information, see List the caller's access grants in the Amazon S3 User Guide.

Permissions

You must have the s3:ListCallerAccessGrants permission to use this operation.

Parameter Syntax

$result = $client->listCallerAccessGrants([
    'AccountId' => '<string>', // REQUIRED
    'AllowedByApplication' => true || false,
    'GrantScope' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CallerAccessGrantsList' => [
        [
            'ApplicationArn' => '<string>',
            'GrantScope' => '<string>',
            'Permission' => 'READ|WRITE|READWRITE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListJobs

$result = $client->listJobs([/* ... */]);
$promise = $client->listJobsAsync([/* ... */]);

Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90 days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Permissions

To use the ListJobs operation, you must have permission to perform the s3:ListJobs action.

Related actions include:

• CreateJob

• DescribeJob

• UpdateJobPriority

• UpdateJobStatus

Parameter Syntax

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

Parameter Details

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

Errors

InvalidRequestException:

InternalServiceException:

InvalidNextTokenException:

ListMultiRegionAccessPoints

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

This operation is not supported by directory buckets.

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.

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

The following actions are related to ListMultiRegionAccessPoint:

• CreateMultiRegionAccessPoint

• DeleteMultiRegionAccessPoint

• DescribeMultiRegionAccessPointOperation

• GetMultiRegionAccessPoint

Parameter Syntax

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

Parameter Details

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>',
                    'BucketAccountId' => '<string>',
                    'Region' => '<string>',
                ],
                // ...
            ],
            'Status' => 'READY|INCONSISTENT_ACROSS_REGIONS|CREATING|PARTIALLY_CREATED|PARTIALLY_DELETED|DELETING',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListRegionalBuckets

$result = $client->listRegionalBuckets([/* ... */]);
$promise = $client->listRegionalBucketsAsync([/* ... */]);

This operation is not supported by directory buckets.

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

Result Syntax

[
    'NextToken' => '<string>',
    'RegionalBucketList' => [
        [
            'Bucket' => '<string>',
            'BucketArn' => '<string>',
            'CreationDate' => <DateTime>,
            'OutpostId' => '<string>',
            'PublicAccessBlockEnabled' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

ListStorageLensConfigurations

$result = $client->listStorageLensConfigurations([/* ... */]);
$promise = $client->listStorageLensConfigurationsAsync([/* ... */]);

This operation is not supported by directory buckets.

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'StorageLensConfigurationList' => [
        [
            'HomeRegion' => '<string>',
            'Id' => '<string>',
            'IsEnabled' => true || false,
            'StorageLensArn' => '<string>',
        ],
        // ...
    ],
]

Result Details