AWS SDK for PHP 3.x

Client: Aws\S3Control\S3ControlClient

Service ID: s3control

Version: 2018-08-20

This page describes the parameters and results for the operations of the AWS S3 Control (2018-08-20), and shows how to use the Aws\S3Control\S3ControlClient object to call the described operations. This documentation is specific to the 2018-08-20 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateAccessPoint ( array $params = [] )
Creates an access point and associates it with the specified bucket.
CreateJob ( array $params = [] )
Creates an Amazon S3 batch operations job.
DeleteAccessPoint ( array $params = [] )
Deletes the specified access point.
DeleteAccessPointPolicy ( array $params = [] )
Deletes the access point policy for the specified access point.
DeletePublicAccessBlock ( array $params = [] )
Removes the PublicAccessBlock configuration for an Amazon Web Services account.
DescribeJob ( array $params = [] )
Retrieves the configuration parameters and status for a batch operations job.
GetAccessPoint ( array $params = [] )
Returns configuration information about the specified access point.
GetAccessPointPolicy ( array $params = [] )
Returns the access point policy associated with the specified access point.
GetAccessPointPolicyStatus ( array $params = [] )
Indicates whether the specified access point currently has a policy that allows public access.
GetPublicAccessBlock ( array $params = [] )
Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.
ListAccessPoints ( array $params = [] )
Returns a list of the access points currently associated with the specified bucket.
ListJobs ( array $params = [] )
Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
PutAccessPointPolicy ( array $params = [] )
Associates an access policy with the specified access point.
PutPublicAccessBlock ( array $params = [] )
Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account.
UpdateJobPriority ( array $params = [] )
Updates an existing job's priority.
UpdateJobStatus ( array $params = [] )
Updates the status for the specified job.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListAccessPoints
ListJobs

Operations

CreateAccessPoint

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

Creates an access point and associates it with the specified bucket.

Parameter Syntax

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

Parameter Details

Members

AccountId

Required: Yes
Type: string

The AWS account ID for the owner of the bucket for which you want to create an access point.

Bucket

Required: Yes
Type: string

The name of the bucket that you want to associate this access point with.

Name

Required: Yes
Type: string

The name you want to assign to this access point.

PublicAccessBlockConfiguration

Type: PublicAccessBlockConfiguration structure

The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon Simple Storage Service Developer Guide.

VpcConfiguration

Type: VpcConfiguration structure

If you include this field, Amazon S3 restricts access to this access point to requests from the specified Virtual Private Cloud (VPC).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

CreateJob

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

Creates an Amazon S3 batch operations job.

Parameter Syntax

$result = $client->createJob([
    'AccountId' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>', // REQUIRED
    'ConfirmationRequired' => true || false,
    'Description' => '<string>',
    'Manifest' => [ // REQUIRED
        'Location' => [ // REQUIRED
            'ETag' => '<string>', // REQUIRED
            'ObjectArn' => '<string>', // REQUIRED
            'ObjectVersionId' => '<string>',
        ],
        'Spec' => [ // REQUIRED
            'Fields' => ['<string>', ...],
            'Format' => 'S3BatchOperations_CSV_20180820|S3InventoryReport_CSV_20161130', // REQUIRED
        ],
    ],
    'Operation' => [ // REQUIRED
        'LambdaInvoke' => [
            'FunctionArn' => '<string>',
        ],
        'S3InitiateRestoreObject' => [
            'ExpirationInDays' => <integer>,
            'GlacierJobTier' => 'BULK|STANDARD',
        ],
        'S3PutObjectAcl' => [
            'AccessControlPolicy' => [
                'AccessControlList' => [
                    'Grants' => [
                        [
                            'Grantee' => [
                                'DisplayName' => '<string>',
                                'Identifier' => '<string>',
                                'TypeIdentifier' => 'id|emailAddress|uri',
                            ],
                            'Permission' => 'FULL_CONTROL|READ|WRITE|READ_ACP|WRITE_ACP',
                        ],
                        // ...
                    ],
                    'Owner' => [ // REQUIRED
                        'DisplayName' => '<string>',
                        'ID' => '<string>',
                    ],
                ],
                'CannedAccessControlList' => 'private|public-read|public-read-write|aws-exec-read|authenticated-read|bucket-owner-read|bucket-owner-full-control',
            ],
        ],
        'S3PutObjectCopy' => [
            'AccessControlGrants' => [
                [
                    'Grantee' => [
                        'DisplayName' => '<string>',
                        'Identifier' => '<string>',
                        'TypeIdentifier' => 'id|emailAddress|uri',
                    ],
                    'Permission' => 'FULL_CONTROL|READ|WRITE|READ_ACP|WRITE_ACP',
                ],
                // ...
            ],
            'CannedAccessControlList' => 'private|public-read|public-read-write|aws-exec-read|authenticated-read|bucket-owner-read|bucket-owner-full-control',
            'MetadataDirective' => 'COPY|REPLACE',
            'ModifiedSinceConstraint' => <integer || string || DateTime>,
            'NewObjectMetadata' => [
                'CacheControl' => '<string>',
                'ContentDisposition' => '<string>',
                'ContentEncoding' => '<string>',
                'ContentLanguage' => '<string>',
                'ContentLength' => <integer>,
                'ContentMD5' => '<string>',
                'ContentType' => '<string>',
                'HttpExpiresDate' => <integer || string || DateTime>,
                'RequesterCharged' => true || false,
                'SSEAlgorithm' => 'AES256|KMS',
                'UserMetadata' => ['<string>', ...],
            ],
            'NewObjectTagging' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'ObjectLockLegalHoldStatus' => 'OFF|ON',
            'ObjectLockMode' => 'COMPLIANCE|GOVERNANCE',
            'ObjectLockRetainUntilDate' => <integer || string || DateTime>,
            'RedirectLocation' => '<string>',
            'RequesterPays' => true || false,
            'SSEAwsKmsKeyId' => '<string>',
            'StorageClass' => 'STANDARD|STANDARD_IA|ONEZONE_IA|GLACIER|INTELLIGENT_TIERING|DEEP_ARCHIVE',
            'TargetKeyPrefix' => '<string>',
            'TargetResource' => '<string>',
            'UnModifiedSinceConstraint' => <integer || string || DateTime>,
        ],
        'S3PutObjectTagging' => [
            'TagSet' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
    ],
    'Priority' => <integer>, // REQUIRED
    'Report' => [ // REQUIRED
        'Bucket' => '<string>',
        'Enabled' => true || false, // REQUIRED
        'Format' => 'Report_CSV_20180820',
        'Prefix' => '<string>',
        'ReportScope' => 'AllTasks|FailedTasksOnly',
    ],
    'RoleArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

ClientRequestToken

Required: Yes
Type: string

An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

ConfirmationRequired

Type: boolean

Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

Description

Type: string

A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

Manifest

Required: Yes
Type: JobManifest structure

Configuration parameters for the manifest.

Operation

Required: Yes
Type: JobOperation structure

The operation that you want this job to perform on each object listed in the manifest. For more information about the available operations, see Available Operations in the Amazon Simple Storage Service Developer Guide.

Priority

Required: Yes
Type: int

The numerical priority for this job. Higher numbers indicate higher priority.

Report

Required: Yes
Type: JobReport structure

Configuration parameters for the optional job-completion report.

RoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) Role that batch operations will use to execute this job's operation on each object in the manifest.

Result Syntax

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

Result Details

Members

JobId

Type: string

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

Errors

DeleteAccessPoint

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

Deletes the specified access point.

Parameter Syntax

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

Parameter Details

Members

AccountId

Required: Yes
Type: string

The account ID for the account that owns the specified access point.

Name

Required: Yes
Type: string

The name of the access point you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteAccessPointPolicy

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

Deletes the access point policy for the specified access point.

Parameter Syntax

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

Parameter Details

Members

AccountId

Required: Yes
Type: string

The account ID for the account that owns the specified access point.

Name

Required: Yes
Type: string

The name of the access point whose policy you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeletePublicAccessBlock

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

Removes the PublicAccessBlock configuration for an Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Members

AccountId

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DescribeJob

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

Retrieves the configuration parameters and status for a batch operations job.

Parameter Syntax

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

Parameter Details

Members

AccountId

Required: Yes
Type: string

JobId

Required: Yes
Type: string

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

Result Syntax

[
    'Job' => [
        'ConfirmationRequired' => true || false,
        'CreationTime' => <DateTime>,
        'Description' => '<string>',
        'FailureReasons' => [
            [
                'FailureCode' => '<string>',
                'FailureReason' => '<string>',
            ],
            // ...
        ],
        'JobArn' => '<string>',
        'JobId' => '<string>',
        'Manifest' => [
            'Location' => [
                'ETag' => '<string>',
                'ObjectArn' => '<string>',
                'ObjectVersionId' => '<string>',
            ],
            'Spec' => [
                'Fields' => ['<string>', ...],
                'Format' => 'S3BatchOperations_CSV_20180820|S3InventoryReport_CSV_20161130',
            ],
        ],
        'Operation' => [
            'LambdaInvoke' => [
                'FunctionArn' => '<string>',
            ],
            'S3InitiateRestoreObject' => [
                'ExpirationInDays' => <integer>,
                'GlacierJobTier' => 'BULK|STANDARD',
            ],
            'S3PutObjectAcl' => [
                'AccessControlPolicy' => [
                    'AccessControlList' => [
                        'Grants' => [
                            [
                                'Grantee' => [
                                    'DisplayName' => '<string>',
                                    'Identifier' => '<string>',
                                    'TypeIdentifier' => 'id|emailAddress|uri',
                                ],
                                'Permission' => 'FULL_CONTROL|READ|WRITE|READ_ACP|WRITE_ACP',
                            ],
                            // ...
                        ],
                        'Owner' => [
                            'DisplayName' => '<string>',
                            'ID' => '<string>',
                        ],
                    ],
                    'CannedAccessControlList' => 'private|public-read|public-read-write|aws-exec-read|authenticated-read|bucket-owner-read|bucket-owner-full-control',
                ],
            ],
            'S3PutObjectCopy' => [
                'AccessControlGrants' => [
                    [
                        'Grantee' => [
                            'DisplayName' => '<string>',
                            'Identifier' => '<string>',
                            'TypeIdentifier' => 'id|emailAddress|uri',
                        ],
                        'Permission' => 'FULL_CONTROL|READ|WRITE|READ_ACP|WRITE_ACP',
                    ],
                    // ...
                ],
                'CannedAccessControlList' => 'private|public-read|public-read-write|aws-exec-read|authenticated-read|bucket-owner-read|bucket-owner-full-control',
                'MetadataDirective' => 'COPY|REPLACE',
                'ModifiedSinceConstraint' => <DateTime>,
                'NewObjectMetadata' => [
                    'CacheControl' => '<string>',
                    'ContentDisposition' => '<string>',
                    'ContentEncoding' => '<string>',
                    'ContentLanguage' => '<string>',
                    'ContentLength' => <integer>,
                    'ContentMD5' => '<string>',
                    'ContentType' => '<string>',
                    'HttpExpiresDate' => <DateTime>,
                    'RequesterCharged' => true || false,
                    'SSEAlgorithm' => 'AES256|KMS',
                    'UserMetadata' => ['<string>', ...],
                ],
                'NewObjectTagging' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'ObjectLockLegalHoldStatus' => 'OFF|ON',
                'ObjectLockMode' => 'COMPLIANCE|GOVERNANCE',
                'ObjectLockRetainUntilDate' => <DateTime>,
                'RedirectLocation' => '<string>',
                'RequesterPays' => true || false,
                'SSEAwsKmsKeyId' => '<string>',
                'StorageClass' => 'STANDARD|STANDARD_IA|ONEZONE_IA|GLACIER|INTELLIGENT_TIERING|DEEP_ARCHIVE',
                'TargetKeyPrefix' => '<string>',
                'TargetResource' => '<string>',
                'UnModifiedSinceConstraint' => <DateTime>,
            ],
            'S3PutObjectTagging' => [
                'TagSet' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
        'Priority' => <integer>,
        'ProgressSummary' => [
            'NumberOfTasksFailed' => <integer>,
            'NumberOfTasksSucceeded' => <integer>,
            'TotalNumberOfTasks' => <integer>,
        ],
        'Report' => [
            'Bucket' => '<string>',
            'Enabled' => true || false,
            'Format' => 'Report_CSV_20180820',
            'Prefix' => '<string>',
            'ReportScope' => 'AllTasks|FailedTasksOnly',
        ],
        'RoleArn' => '<string>',
        'Status' => 'Active|Cancelled|Cancelling|Complete|Completing|Failed|Failing|New|Paused|Pausing|Preparing|Ready|Suspended',
        'StatusUpdateReason' => '<string>',
        'SuspendedCause' => '<string>',
        'SuspendedDate' => <DateTime>,
        'TerminationDate' => <DateTime>,
    ],
]

Result Details

Members

Job

Type: JobDescriptor structure

Contains the configuration parameters and status for the job specified in the Describe Job request.

Errors

GetAccessPoint

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

Returns configuration information about the specified access point.

Parameter Syntax

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

Parameter Details

Members

AccountId

Required: Yes
Type: string

The account ID for the account that owns the specified access point.

Name

Required: Yes
Type: string

The name of the access point whose configuration information you want to retrieve.

Result Syntax

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

Result Details

Members

Bucket

Type: string

The name of the bucket associated with the specified access point.

CreationDate

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

The date and time when the specified access point was created.

Name

Type: string

The name of the specified access point.

NetworkOrigin

Type: string

Indicates whether this access point allows access from the public Internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public Internet, subject to the access point and bucket access policies.

PublicAccessBlockConfiguration

Type: PublicAccessBlockConfiguration structure

VpcConfiguration

Type: VpcConfiguration structure

Contains the Virtual Private Cloud (VPC) configuration for the specified access point.

Errors

There are no errors described for this operation.

GetAccessPointPolicy

$result = $client->getAccessPointPolicy([/* ... */]);
$promise = $client->getAccessPointPolicyAsync([/* ... */]);

Returns the access point policy associated with the specified access point.

Parameter Syntax

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

Parameter Details

Members

AccountId

Required: Yes
Type: string

The account ID for the account that owns the specified access point.

Name

Required: Yes
Type: string

The name of the access point whose policy you want to retrieve.

Result Syntax

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

Result Details

Members

Policy

Type: string

The access point policy associated with the specified access point.

Errors

There are no errors described for this operation.

GetAccessPointPolicyStatus

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

Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.

Parameter Syntax

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

Parameter Details

Members

AccountId

Required: Yes
Type: string

The account ID for the account that owns the specified access point.

Name

Required: Yes
Type: string

The name of the access point whose policy status you want to retrieve.

Result Syntax

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

Result Details

Members

PolicyStatus

Type: PolicyStatus structure

Indicates the current policy status of the specified access point.

Errors

There are no errors described for this operation.

GetPublicAccessBlock

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

Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Members

AccountId

Required: Yes
Type: string

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

Result Syntax

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

Result Details

Members

PublicAccessBlockConfiguration

Type: PublicAccessBlockConfiguration structure

The PublicAccessBlock configuration currently in effect for this Amazon Web Services account.

Errors

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

ListAccessPoints

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

Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1000 access points (or the number specified in maxResults, whichever is less), then the response will include a continuation token that you can use to list the additional access points.

Parameter Syntax

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

Parameter Details

Members

AccountId

Required: Yes
Type: string

The AWS account ID for owner of the bucket whose access points you want to list.

Bucket

Type: string

The name of the bucket whose associated access points you want to list.

MaxResults

Type: int

The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.

NextToken

Type: string

A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.

Result Syntax

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

Result Details

Members

AccessPointList

Type: Array of AccessPoint structures

Contains identification and configuration information for one or more access points associated with the specified bucket.

NextToken

Type: string

If the specified bucket has more access points than can be returned in one call to this API, then this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.

Errors

There are no errors described for this operation.

ListJobs

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

Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.

Parameter Syntax

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

Parameter Details

Members

AccountId

Required: Yes
Type: string

JobStatuses

Type: Array of strings

The List Jobs request returns jobs that match the statuses listed in this element.

MaxResults

Type: int

The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.

NextToken

Type: string

A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.

Result Syntax

[
    'Jobs' => [
        [
            'CreationTime' => <DateTime>,
            'Description' => '<string>',
            'JobId' => '<string>',
            'Operation' => 'LambdaInvoke|S3PutObjectCopy|S3PutObjectAcl|S3PutObjectTagging|S3InitiateRestoreObject',
            'Priority' => <integer>,
            'ProgressSummary' => [
                'NumberOfTasksFailed' => <integer>,
                'NumberOfTasksSucceeded' => <integer>,
                'TotalNumberOfTasks' => <integer>,
            ],
            'Status' => 'Active|Cancelled|Cancelling|Complete|Completing|Failed|Failing|New|Paused|Pausing|Preparing|Ready|Suspended',
            'TerminationDate' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Jobs

Type: Array of JobListDescriptor structures

The list of current jobs and jobs that have ended within the last 30 days.

NextToken

Type: string

If the List Jobs request produced more than the maximum number of results, you can pass this value into a subsequent List Jobs request in order to retrieve the next page of results.

Errors

PutAccessPointPolicy

$result = $client->putAccessPointPolicy([/* ... */]);
$promise = $client->putAccessPointPolicyAsync([/* ... */]);

Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.

Parameter Syntax

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

Parameter Details

Members

AccountId

Required: Yes
Type: string

The AWS account ID for owner of the bucket associated with the specified access point.

Name

Required: Yes
Type: string

The name of the access point that you want to associate with the specified policy.

Policy

Required: Yes
Type: string

The policy that you want to apply to the specified access point. For more information about access point policies, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutPublicAccessBlock

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

Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account.

Parameter Syntax

$result = $client->putPublicAccessBlock([
    'AccountId' => '<string>', // REQUIRED
    'PublicAccessBlockConfiguration' => [ // REQUIRED
        'BlockPublicAcls' => true || false,
        'BlockPublicPolicy' => true || false,
        'IgnorePublicAcls' => true || false,
        'RestrictPublicBuckets' => true || false,
    ],
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

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

PublicAccessBlockConfiguration

Required: Yes
Type: PublicAccessBlockConfiguration structure

The PublicAccessBlock configuration that you want to apply to the specified Amazon Web Services account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

UpdateJobPriority

$result = $client->updateJobPriority([/* ... */]);
$promise = $client->updateJobPriorityAsync([/* ... */]);

Updates an existing job's priority.

Parameter Syntax

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

Parameter Details

Members

AccountId

Required: Yes
Type: string

JobId

Required: Yes
Type: string

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

Priority

Required: Yes
Type: int

The priority you want to assign to this job.

Result Syntax

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

Result Details

Members

JobId

Required: Yes
Type: string

The ID for the job whose priority Amazon S3 updated.

Priority

Required: Yes
Type: int

The new priority assigned to the specified job.

Errors

UpdateJobStatus

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

Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job.

Parameter Syntax

$result = $client->updateJobStatus([
    'AccountId' => '<string>', // REQUIRED
    'JobId' => '<string>', // REQUIRED
    'RequestedJobStatus' => 'Cancelled|Ready', // REQUIRED
    'StatusUpdateReason' => '<string>',
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

JobId

Required: Yes
Type: string

The ID of the job whose status you want to update.

RequestedJobStatus

Required: Yes
Type: string

The status that you want to move the specified job to.

StatusUpdateReason

Type: string

A description of the reason why you want to change the specified job's status. This field can be any string up to the maximum length.

Result Syntax

[
    'JobId' => '<string>',
    'Status' => 'Active|Cancelled|Cancelling|Complete|Completing|Failed|Failing|New|Paused|Pausing|Preparing|Ready|Suspended',
    'StatusUpdateReason' => '<string>',
]

Result Details

Members

JobId

Type: string

The ID for the job whose status was updated.

Status

Type: string

The current status for the specified job.

StatusUpdateReason

Type: string

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

Errors

Shapes

AccessPoint

Description

An access point used to access a bucket.

Members

Bucket

Required: Yes
Type: string

The name of the bucket associated with this access point.

Name

Required: Yes
Type: string

The name of this access point.

NetworkOrigin

Required: Yes
Type: string

VpcConfiguration

Type: VpcConfiguration structure

The Virtual Private Cloud (VPC) configuration for this access point, if one exists.

BadRequestException

Description

Members

Message

Type: string

CreateAccessPointRequest

Members

AccountId

Required: Yes
Type: string

The AWS account ID for the owner of the bucket for which you want to create an access point.

Bucket

Required: Yes
Type: string

The name of the bucket that you want to associate this access point with.

Name

Required: Yes
Type: string

The name you want to assign to this access point.

PublicAccessBlockConfiguration

Type: PublicAccessBlockConfiguration structure

VpcConfiguration

Type: VpcConfiguration structure

If you include this field, Amazon S3 restricts access to this access point to requests from the specified Virtual Private Cloud (VPC).

CreateJobRequest

Members

AccountId

Required: Yes
Type: string

ClientRequestToken

Required: Yes
Type: string

An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

ConfirmationRequired

Type: boolean

Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

Description

Type: string

A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

Manifest

Required: Yes
Type: JobManifest structure

Configuration parameters for the manifest.

Operation

Required: Yes
Type: JobOperation structure

Priority

Required: Yes
Type: int

The numerical priority for this job. Higher numbers indicate higher priority.

Report

Required: Yes
Type: JobReport structure

Configuration parameters for the optional job-completion report.

RoleArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) Role that batch operations will use to execute this job's operation on each object in the manifest.

IdempotencyException

Description

Members

Message

Type: string

InternalServiceException

Description

Members

Message

Type: string

InvalidNextTokenException

Description

Members

Message

Type: string

InvalidRequestException

Description

Members

Message

Type: string

JobDescriptor

Description

A container element for the job configuration and status information returned by a Describe Job request.

Members

ConfirmationRequired

Type: boolean

Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.

CreationTime

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

A timestamp indicating when this job was created.

Description

Type: string

The description for this job, if one was provided in this job's Create Job request.

FailureReasons

Type: Array of JobFailure structures

If the specified job failed, this field contains information describing the failure.

JobArn

Type: string

The Amazon Resource Name (ARN) for this job.

JobId

Type: string

The ID for the specified job.

Manifest

Type: JobManifest structure

The configuration information for the specified job's manifest object.

Operation

Type: JobOperation structure

The operation that the specified job is configured to execute on the objects listed in the manifest.

Priority

Type: int

The priority of the specified job.

ProgressSummary

Type: JobProgressSummary structure

Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.

Report

Type: JobReport structure

Contains the configuration information for the job-completion report if you requested one in the Create Job request.

RoleArn

Type: string

The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) Role assigned to execute the tasks for this job.

Status

Type: string

The current status of the specified job.

StatusUpdateReason

Type: string

SuspendedCause

Type: string

The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

SuspendedDate

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

The timestamp when this job was suspended, if it has been suspended.

TerminationDate

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

A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

JobFailure

Description

If this job failed, this element indicates why the job failed.

Members

FailureCode

Type: string

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

FailureReason

Type: string

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

JobListDescriptor

Description

Contains the configuration and status information for a single job retrieved as part of a job list.

Members

CreationTime

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

A timestamp indicating when the specified job was created.

Description

Type: string

The user-specified description that was included in the specified job's Create Job request.

JobId

Type: string

The ID for the specified job.

Operation

Type: string

The operation that the specified job is configured to run on each object listed in the manifest.

Priority

Type: int

The current priority for the specified job.

ProgressSummary

Type: JobProgressSummary structure

Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.

Status

Type: string

The specified job's current status.

TerminationDate

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

A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

JobManifest

Description

Contains the configuration information for a job's manifest.

Members

Location

Required: Yes
Type: JobManifestLocation structure

Contains the information required to locate the specified job's manifest.

Spec

Required: Yes
Type: JobManifestSpec structure

Describes the format of the specified job's manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.

JobManifestLocation

Description

Contains the information required to locate a manifest object.

Members

ETag

Required: Yes
Type: string

The ETag for the specified manifest object.

ObjectArn

Required: Yes
Type: string

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

ObjectVersionId

Type: string

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

JobManifestSpec

Description

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

Members

Fields

Type: Array of strings

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

Format

Required: Yes
Type: string

Indicates which of the available formats the specified manifest uses.

JobOperation

Description

Members

LambdaInvoke

Type: LambdaInvokeOperation structure

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

S3InitiateRestoreObject

Type: S3InitiateRestoreObjectOperation structure

Directs the specified job to execute an Initiate Glacier Restore call on each object in the manifest.

S3PutObjectAcl

Type: S3SetObjectAclOperation structure

Directs the specified job to execute a PUT Object acl call on each object in the manifest.

S3PutObjectCopy

Type: S3CopyObjectOperation structure

Directs the specified job to execute a PUT Copy object call on each object in the manifest.

S3PutObjectTagging

Type: S3SetObjectTaggingOperation structure

Directs the specified job to execute a PUT Object tagging call on each object in the manifest.

JobProgressSummary

Description

Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.

Members

NumberOfTasksFailed

Type: long (int|float)

NumberOfTasksSucceeded

Type: long (int|float)

TotalNumberOfTasks

Type: long (int|float)

JobReport

Description

Contains the configuration parameters for a job-completion report.

Members

Bucket

Type: string

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

Enabled

Required: Yes
Type: boolean

Indicates whether the specified job will generate a job-completion report.

Format

Type: string

The format of the specified job-completion report.

Prefix

Type: string

An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 will store the job-completion report at <prefix>/job-<job-id>/report.json.

ReportScope

Type: string

Indicates whether the job-completion report will include details of all tasks or only failed tasks.

JobStatusException

Description

Members

Message

Type: string

LambdaInvokeOperation

Description

Contains the configuration parameters for a Lambda Invoke operation.

Members

FunctionArn

Type: string

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

NoSuchPublicAccessBlockConfiguration

Description

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

Members

Message

Type: string

NotFoundException

Description

Members

Message

Type: string

PolicyStatus

Description

Indicates whether this access point policy is public. For more information about how Amazon S3 evaluates policies to determine whether they are public, see The Meaning of "Public" in the Amazon Simple Storage Service Developer Guide.

Members

IsPublic

Type: boolean

PublicAccessBlockConfiguration

Description

Members

BlockPublicAcls

Type: boolean

Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
PUT Object calls fail if the request includes a public ACL.
PUT Bucket calls fail if the request includes a public ACL.

Enabling this setting doesn't affect existing policies or ACLs.

BlockPublicPolicy

Type: boolean

Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

Enabling this setting doesn't affect existing bucket policies.

IgnorePublicAcls

Type: boolean

Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

RestrictPublicBuckets

Type: boolean

Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only AWS services and authorized users within this account.

Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

PutAccessPointPolicyRequest

Members

AccountId

Required: Yes
Type: string

The AWS account ID for owner of the bucket associated with the specified access point.

Name

Required: Yes
Type: string

The name of the access point that you want to associate with the specified policy.

Policy

Required: Yes
Type: string

S3AccessControlList

Description

Members

Grants

Type: Array of S3Grant structures

Owner

Required: Yes
Type: S3ObjectOwner structure

S3AccessControlPolicy

Description

Members

AccessControlList

Type: S3AccessControlList structure

CannedAccessControlList

Type: string

S3CopyObjectOperation

Description

Contains the configuration parameters for a PUT Copy object operation. Amazon S3 batch operations passes each value through to the underlying PUT Copy object API. For more information about the parameters for this operation, see PUT Object - Copy.

Members

AccessControlGrants

Type: Array of S3Grant structures

CannedAccessControlList

Type: string

MetadataDirective

Type: string

ModifiedSinceConstraint

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

NewObjectMetadata

Type: S3ObjectMetadata structure

NewObjectTagging

Type: Array of S3Tag structures

ObjectLockLegalHoldStatus

Type: string

ObjectLockMode

Type: string

ObjectLockRetainUntilDate

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

RedirectLocation

Type: string

RequesterPays

Type: boolean

SSEAwsKmsKeyId

Type: string

StorageClass

Type: string

TargetKeyPrefix

Type: string

TargetResource

Type: string

UnModifiedSinceConstraint

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

S3Grant

Description

Members

Grantee

Type: S3Grantee structure

Permission

Type: string

S3Grantee

Description

Members

DisplayName

Type: string

Identifier

Type: string

TypeIdentifier

Type: string

S3InitiateRestoreObjectOperation

Description

Contains the configuration parameters for an Initiate Glacier Restore job. Amazon S3 batch operations passes each value through to the underlying POST Object restore API. For more information about the parameters for this operation, see Restoring Archives.

Members

ExpirationInDays

Type: int

GlacierJobTier

Type: string

S3ObjectMetadata

Description

Members

CacheControl

Type: string

ContentDisposition

Type: string

ContentEncoding

Type: string

ContentLanguage

Type: string

ContentLength

Type: long (int|float)

ContentMD5

Type: string

ContentType

Type: string

HttpExpiresDate

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

RequesterCharged

Type: boolean

SSEAlgorithm

Type: string

UserMetadata

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

S3ObjectOwner

Description

Members

DisplayName

Type: string

ID

Type: string

S3SetObjectAclOperation

Description

Contains the configuration parameters for a Set Object ACL operation. Amazon S3 batch operations passes each value through to the underlying PUT Object acl API. For more information about the parameters for this operation, see PUT Object acl.

Members

AccessControlPolicy

Type: S3AccessControlPolicy structure

S3SetObjectTaggingOperation

Description

Contains the configuration parameters for a Set Object Tagging operation. Amazon S3 batch operations passes each value through to the underlying PUT Object tagging API. For more information about the parameters for this operation, see PUT Object tagging.

Members

TagSet

Type: Array of S3Tag structures

S3Tag

Description

Members

Key

Required: Yes
Type: string

Value

Required: Yes
Type: string

TooManyRequestsException

Description

Members

Message

Type: string

VpcConfiguration

Description

The Virtual Private Cloud (VPC) configuration for an access point.

Members

VpcId

Required: Yes
Type: string

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

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS S3 Control 2018-08-20

Operation Summary

Paginators

Operations

CreateAccessPoint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CreateJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteAccessPoint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteAccessPointPolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeletePublicAccessBlock

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetAccessPoint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetAccessPointPolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetAccessPointPolicyStatus

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetPublicAccessBlock

Parameter Syntax