Integer daysAfterInitiation
Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload to the Outposts bucket.
String name
The name of this access point.
String networkOrigin
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.
VpcConfiguration vpcConfiguration
The virtual private cloud (VPC) configuration for this access point, if one exists.
This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other AWS services.
String bucket
The name of the bucket associated with this access point.
String accessPointArn
The ARN for the access point.
ActivityMetrics activityMetrics
A container for the S3 Storage Lens activity metrics.
BucketLevel bucketLevel
A container for the S3 Storage Lens bucket-level configuration.
Boolean isEnabled
A container for whether the activity metrics are enabled.
ActivityMetrics activityMetrics
A container for the bucket-level activity metrics for Amazon S3 Storage Lens
PrefixLevel prefixLevel
A container for the bucket-level prefix-level metrics for S3 Storage Lens
String accountId
The AWS account ID for owner of the specified Object Lambda Access Point.
String name
The name you want to assign to this Object Lambda Access Point.
ObjectLambdaConfiguration configuration
Object Lambda Access Point configuration as a JSON document.
String objectLambdaAccessPointArn
Specifies the ARN for the Object Lambda Access Point.
String accountId
The AWS account ID for the owner of the bucket for which you want to create an access point.
String name
The name you want to assign to this access point.
String bucket
The name of the bucket that you want to associate this access point with.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket
accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
VpcConfiguration vpcConfiguration
If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).
This is required for creating an access point for Amazon S3 on Outposts buckets.
PublicAccessBlockConfiguration publicAccessBlockConfiguration
The PublicAccessBlock configuration that you want to apply to the access point.
String accessPointArn
The ARN of the access point.
This is only supported by Amazon S3 on Outposts.
String locationConstraint
Specifies the Region where the bucket will be created. If you are creating a bucket on the US East (N. Virginia) Region (us-east-1), you do not need to specify the location.
This is not supported by Amazon S3 on Outposts buckets.
String aCL
The canned ACL to apply to the bucket.
This is not supported by Amazon S3 on Outposts buckets.
String bucket
The name of the bucket.
CreateBucketConfiguration createBucketConfiguration
The configuration information for the bucket.
This is not supported by Amazon S3 on Outposts buckets.
String grantFullControl
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
This is not supported by Amazon S3 on Outposts buckets.
String grantRead
Allows grantee to list the objects in the bucket.
This is not supported by Amazon S3 on Outposts buckets.
String grantReadACP
Allows grantee to read the bucket ACL.
This is not supported by Amazon S3 on Outposts buckets.
String grantWrite
Allows grantee to create, overwrite, and delete any object in the bucket.
This is not supported by Amazon S3 on Outposts buckets.
String grantWriteACP
Allows grantee to write the ACL for the applicable bucket.
This is not supported by Amazon S3 on Outposts buckets.
Boolean objectLockEnabledForBucket
Specifies whether you want S3 Object Lock to be enabled for the new bucket.
This is not supported by Amazon S3 on Outposts buckets.
String outpostId
The ID of the Outposts where the bucket is being created.
This is required by Amazon S3 on Outposts buckets.
String location
The location of the bucket.
String bucketArn
The Amazon Resource Name (ARN) of the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket
accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
String accountId
The AWS account ID that creates the job.
Boolean confirmationRequired
Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.
JobOperation operation
The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.
JobReport report
Configuration parameters for the optional job-completion report.
String clientRequestToken
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.
JobManifest manifest
Configuration parameters for the manifest.
String description
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.
Integer priority
The numerical priority for this job. Higher numbers indicate higher priority.
String roleArn
The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.
List<E> tags
A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.
String jobId
The ID for this job. Amazon S3 generates this ID automatically and returns it after a successful
Create Job request.
String accountId
The account ID for the account that owns the specified access point.
String name
The name of the access point whose policy you want to delete.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access
point accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>
. For example, to access the access point reports-ap through outpost my-outpost owned
by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must
be URL encoded.
String accountId
The account ID for the account that owns the specified access point.
String name
The name of the access point you want to delete.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access
point accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>
. For example, to access the access point reports-ap through outpost my-outpost owned
by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must
be URL encoded.
String accountId
The account ID of the lifecycle configuration to delete.
String bucket
Specifies the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket
accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
String accountId
The account ID of the Outposts bucket.
String bucket
Specifies the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket
accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
String accountId
The account ID that owns the Outposts bucket.
String bucket
Specifies the bucket being deleted.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket
accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
String accountId
The AWS account ID of the Outposts bucket tag set to be removed.
String bucket
The bucket ARN that has the tag set to be removed.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket
accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
String accountId
The account ID for the AWS account whose PublicAccessBlock configuration you want to remove.
JobDescriptor job
Contains the configuration parameters and status for the job specified in the Describe Job request.
ObjectLambdaConfiguration configuration
Object Lambda Access Point configuration document.
String name
The name of the Object Lambda Access Point.
PublicAccessBlockConfiguration publicAccessBlockConfiguration
Configuration to block all public access. This setting is turned on and can not be edited.
Date creationDate
The date and time when the specified Object Lambda Access Point was created.
String policy
Object Lambda Access Point resource policy document.
String accountId
The account ID for the account that owns the specified access point.
String name
The name of the access point whose policy you want to retrieve.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access
point accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>
. For example, to access the access point reports-ap through outpost my-outpost owned
by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must
be URL encoded.
String policy
The access point policy associated with the specified access point.
PolicyStatus policyStatus
PolicyStatus policyStatus
Indicates the current policy status of the specified access point.
String accountId
The account ID for the account that owns the specified access point.
String name
The name of the access point whose configuration information you want to retrieve.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access
point accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>
. For example, to access the access point reports-ap through outpost my-outpost owned
by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must
be URL encoded.
String name
The name of the specified access point.
String bucket
The name of the bucket associated with the specified access point.
String networkOrigin
Indicates whether this access point allows access from the public internet. If VpcConfiguration is
specified for this access point, then NetworkOrigin is VPC, and the access point
doesn't allow access from the public internet. Otherwise, NetworkOrigin is Internet,
and the access point allows access from the public internet, subject to the access point and bucket access
policies.
This will always be true for an Amazon S3 on Outposts access point
VpcConfiguration vpcConfiguration
Contains the virtual private cloud (VPC) configuration for the specified access point.
This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other AWS services.
PublicAccessBlockConfiguration publicAccessBlockConfiguration
Date creationDate
The date and time when the specified access point was created.
String accountId
The AWS account ID of the Outposts bucket.
String bucket
The Amazon Resource Name (ARN) of the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket
accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
String accountId
The AWS account ID of the Outposts bucket.
String bucket
Specifies the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket
accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
String policy
The policy of the Outposts bucket.
String accountId
The AWS account ID of the Outposts bucket.
String bucket
Specifies the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket
accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
String accountId
The AWS account ID of the Outposts bucket.
String bucket
Specifies the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket
accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
String accountId
The account ID for the AWS account whose PublicAccessBlock configuration you want to retrieve.
PublicAccessBlockConfiguration publicAccessBlockConfiguration
The PublicAccessBlock configuration currently in effect for this AWS account.
StorageLensConfiguration storageLensConfiguration
The S3 Storage Lens configuration requested.
String jobId
The ID for the specified job.
Boolean confirmationRequired
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.
String description
The description for this job, if one was provided in this job's Create Job request.
String jobArn
The Amazon Resource Name (ARN) for this job.
String status
The current status of the specified job.
JobManifest manifest
The configuration information for the specified job's manifest object.
JobOperation operation
The operation that the specified job is configured to run on the objects listed in the manifest.
Integer priority
The priority of the specified job.
JobProgressSummary progressSummary
Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.
String statusUpdateReason
The reason for updating the job.
List<E> failureReasons
If the specified job failed, this field contains information describing the failure.
JobReport report
Contains the configuration information for the job-completion report if you requested one in the
Create Job request.
Date creationTime
A timestamp indicating when this job was created.
Date terminationDate
A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.
String roleArn
The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to run the tasks for this job.
Date suspendedDate
The timestamp when this job was suspended, if it has been suspended.
String suspendedCause
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.
String jobId
The ID for the specified job.
String description
The user-specified description that was included in the specified job's Create Job request.
String operation
The operation that the specified job is configured to run on every object listed in the manifest.
Integer priority
The current priority for the specified job.
String status
The specified job's current status.
Date creationTime
A timestamp indicating when the specified job was created.
Date terminationDate
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.
JobProgressSummary progressSummary
Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.
JobManifestSpec spec
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 location
Contains the information required to locate the specified job's manifest.
String objectArn
The Amazon Resource Name (ARN) for a manifest object.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
String objectVersionId
The optional version ID to identify a specific version of the manifest object.
String eTag
The ETag for the specified manifest object.
LambdaInvokeOperation lambdaInvoke
Directs the specified job to invoke an AWS Lambda function on every object in the manifest.
S3CopyObjectOperation s3PutObjectCopy
Directs the specified job to run a PUT Copy object call on every object in the manifest.
S3SetObjectAclOperation s3PutObjectAcl
Directs the specified job to run a PUT Object acl call on every object in the manifest.
S3SetObjectTaggingOperation s3PutObjectTagging
Directs the specified job to run a PUT Object tagging call on every object in the manifest.
S3DeleteObjectTaggingOperation s3DeleteObjectTagging
Directs the specified job to execute a DELETE Object tagging call on every object in the manifest.
S3InitiateRestoreObjectOperation s3InitiateRestoreObject
Directs the specified job to initiate restore requests for every archived object in the manifest.
S3SetObjectLegalHoldOperation s3PutObjectLegalHold
S3SetObjectRetentionOperation s3PutObjectRetention
String bucket
The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.
String format
The format of the specified job-completion report.
Boolean enabled
Indicates whether the specified job will generate a job-completion report.
String prefix
An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3
stores the job-completion report at <prefix>/job-<job-id>/report.json.
String reportScope
Indicates whether the job-completion report will include details of all tasks or only failed tasks.
String functionArn
The Amazon Resource Name (ARN) for the AWS Lambda function that the specified job will invoke on every object in the manifest.
Date date
Indicates at what date the object is to be deleted. Should be in GMT ISO 8601 format.
Integer days
Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
Boolean expiredObjectDeleteMarker
Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired. If set to false, the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.
LifecycleExpiration expiration
Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.
String iD
Unique identifier for the rule. The value cannot be longer than 255 characters.
LifecycleRuleFilter filter
The container for the filter of lifecycle rule.
String status
If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
List<E> transitions
Specifies when an Amazon S3 object transitions to a specified storage class.
This is not supported by Amazon S3 on Outposts buckets.
List<E> noncurrentVersionTransitions
Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.
This is not supported by Amazon S3 on Outposts buckets.
NoncurrentVersionExpiration noncurrentVersionExpiration
The noncurrent version expiration of the lifecycle rule.
This is not supported by Amazon S3 on Outposts buckets.
AbortIncompleteMultipartUpload abortIncompleteMultipartUpload
Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 waits before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon S3 User Guide.
String prefix
Prefix identifying one or more objects to which the rule applies.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
S3Tag tag
LifecycleRuleAndOperator and
The container for the AND condition for the lifecycle rule.
String accountId
The account ID for the account that owns the specified Object Lambda Access Point.
String nextToken
If the list has more access points than can be returned in one call to this API, this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.
Integer maxResults
The maximum number of access points that you want to include in the list. If there are more than this number of
access points, then the response will include a continuation token in the NextToken field that you
can use to retrieve the next page of access points.
List<E> objectLambdaAccessPointList
Returns list of Object Lambda Access Points.
String nextToken
If the list has more access points than can be returned in one call to this API, this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.
String accountId
The AWS account ID for owner of the bucket whose access points you want to list.
String bucket
The name of the bucket whose associated access points you want to list.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket
accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
String nextToken
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.
Integer maxResults
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.
List<E> accessPointList
Contains identification and configuration information for one or more access points associated with the specified bucket.
String nextToken
If the specified bucket has more access points than can be returned in one call to this API, this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.
String accountId
The AWS account ID associated with the S3 Batch Operations job.
List<E> jobStatuses
The List Jobs request returns jobs that match the statuses listed in this element.
String nextToken
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.
Integer maxResults
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.
String nextToken
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.
List<E> jobs
The list of current jobs and jobs that have ended within the last 30 days.
String id
A container for the S3 Storage Lens configuration ID.
String storageLensArn
The ARN of the S3 Storage Lens configuration. This property is read-only.
String homeRegion
A container for the S3 Storage Lens home Region. Your metrics data is stored and retained in your designated S3 Storage Lens home Region.
Boolean isEnabled
A container for whether the S3 Storage Lens configuration is enabled. This property is required.
String nextToken
If the request produced more than the maximum number of S3 Storage Lens configuration results, you can pass this value into a subsequent request to retrieve the next page of results.
List<E> storageLensConfigurationList
A list of S3 Storage Lens configurations.
Integer noncurrentDays
Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide.
Integer noncurrentDays
Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon S3 User Guide.
String storageClass
The class of storage used to store the object.
String supportingAccessPoint
Standard access point associated with the Object Lambda Access Point.
Boolean cloudWatchMetricsEnabled
A container for whether the CloudWatch metrics configuration is enabled.
List<E> allowedFeatures
A container for allowed features. Valid inputs are GetObject-Range and
GetObject-PartNumber.
List<E> transformationConfigurations
A container for transformation configurations for an Object Lambda Access Point.
AwsLambdaTransformation awsLambda
A container for an AWS Lambda function.
List<E> actions
A container for the action of an Object Lambda Access Point configuration. Valid input is GetObject.
ObjectLambdaContentTransformation contentTransformation
A container for the content transformation of an Object Lambda Access Point configuration.
Boolean isPublic
PrefixLevelStorageMetrics storageMetrics
A container for the prefix-level storage metrics for S3 Storage Lens.
Boolean isEnabled
A container for whether prefix-level storage metrics are enabled.
SelectionCriteria selectionCriteria
Boolean blockPublicAcls
Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting
this element to TRUE causes the following behavior:
PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
PUT Object calls fail if the request includes a public ACL.
PUT Bucket calls fail if the request includes a public ACL.
Enabling this setting doesn't affect existing policies or ACLs.
This is not supported for Amazon S3 on Outposts.
Boolean ignorePublicAcls
Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to
TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they
contain.
Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.
This is not supported for Amazon S3 on Outposts.
Boolean blockPublicPolicy
Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element
to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows
public access.
Enabling this setting doesn't affect existing bucket policies.
This is not supported for Amazon S3 on Outposts.
Boolean restrictPublicBuckets
Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this
element to TRUE restricts access to buckets with public policies to only AWS service principals and
authorized users within this account.
Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.
This is not supported for Amazon S3 on Outposts.
String accountId
The account ID for the account that owns the specified Object Lambda Access Point.
String name
The name of the Object Lambda Access Point.
ObjectLambdaConfiguration configuration
Object Lambda Access Point configuration document.
String accountId
The AWS account ID for owner of the bucket associated with the specified access point.
String name
The name of the access point that you want to associate with the specified policy.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access
point accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>
. For example, to access the access point reports-ap through outpost my-outpost owned
by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must
be URL encoded.
String policy
The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 access points in the Amazon S3 User Guide.
String accountId
The AWS account ID of the Outposts bucket.
String bucket
The name of the bucket for which to set the configuration.
LifecycleConfiguration lifecycleConfiguration
Container for lifecycle rules. You can add as many as 1,000 rules.
String accountId
The AWS account ID of the Outposts bucket.
String bucket
Specifies the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket
accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
Boolean confirmRemoveSelfBucketAccess
Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.
This is not supported by Amazon S3 on Outposts buckets.
String policy
The bucket policy as a JSON document.
String accountId
The AWS account ID of the Outposts bucket.
String bucket
The Amazon Resource Name (ARN) of the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket
accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
Tagging tagging
PublicAccessBlockConfiguration publicAccessBlockConfiguration
The PublicAccessBlock configuration that you want to apply to the specified AWS account.
String accountId
The account ID for the AWS account whose PublicAccessBlock configuration you want to set.
String configId
The ID of the S3 Storage Lens configuration.
String accountId
The account ID of the requester.
StorageLensConfiguration storageLensConfiguration
The S3 Storage Lens configuration.
List<E> tags
The tag set of the S3 Storage Lens configuration.
You can set up to a maximum of 50 tags.
String bucket
String bucketArn
The Amazon Resource Name (ARN) for the regional bucket.
Boolean publicAccessBlockEnabled
Date creationDate
The creation date of the regional bucket
String outpostId
The AWS Outposts ID of the regional bucket.
S3ObjectOwner owner
List<E> grants
S3AccessControlList accessControlList
String cannedAccessControlList
String format
String outputSchemaVersion
The schema version of the export file.
String accountId
The account ID of the owner of the S3 Storage Lens metrics export bucket.
String arn
The Amazon Resource Name (ARN) of the bucket. This property is read-only and follows the following format:
arn:aws:s3:us-east-1:example-account-id:bucket/your-destination-bucket-name
String prefix
The prefix of the destination bucket where the metrics export will be delivered.
StorageLensDataExportEncryption encryption
The container for the type encryption of the metrics exports in this bucket.
String targetResource
Specifies the destination bucket ARN for the batch copy operation. For example, to copy objects to a bucket named "destinationBucket", set the TargetResource to "arn:aws:s3:::destinationBucket".
String cannedAccessControlList
List<E> accessControlGrants
String metadataDirective
Date modifiedSinceConstraint
S3ObjectMetadata newObjectMetadata
List<E> newObjectTagging
String redirectLocation
Specifies an optional metadata property for website redirects, x-amz-website-redirect-location.
Allows webpage redirects if the object is accessed through a website endpoint.
Boolean requesterPays
String storageClass
Date unModifiedSinceConstraint
String sSEAwsKmsKeyId
String targetKeyPrefix
Specifies the folder prefix into which you would like the objects to be copied. For example, to copy objects into a folder named "Folder1" in the destination bucket, set the TargetKeyPrefix to "Folder1/".
String objectLockLegalHoldStatus
The legal hold status to be applied to all objects in the Batch Operations job.
String objectLockMode
The retention mode to be applied to all objects in the Batch Operations job.
Date objectLockRetainUntilDate
The date when the applied object retention configuration expires on all objects in the Batch Operations job.
Integer expirationInDays
This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3.
S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects require
ExpirationInDays set to 1 or greater.
Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs that
target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3
Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying
ExpirationInDays results in restore request failure.
S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the same job. If you need to restore objects of both types you must create separate Batch Operations jobs.
String glacierJobTier
S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the
EXPEDITED retrieval tier.
String status
The Object Lock legal hold status to be applied to all objects in the Batch Operations job.
String cacheControl
String contentDisposition
String contentEncoding
String contentLanguage
Map<K,V> userMetadata
Long contentLength
String contentMD5
String contentType
Date httpExpiresDate
Boolean requesterCharged
String sSEAlgorithm
S3AccessControlPolicy accessControlPolicy
S3ObjectLockLegalHold legalHold
Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.
Boolean bypassGovernanceRetention
Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock
GOVERNANCE type in place.
S3Retention retention
Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.
String delimiter
A container for the delimiter of the selection criteria being used.
Integer maxDepth
The max depth of the selection criteria
Double minStorageBytesPercentage
The minimum number of storage bytes percentage whose metrics will be selected.
You must choose a value greater than or equal to 1.0.
String keyId
A container for the ARN of the SSE-KMS encryption. This property is read-only and follows the following format:
arn:aws:kms:us-east-1:example-account-id:key/example-9a73-4afc-8d29-8f5900cef44e
String arn
A container for the Amazon Resource Name (ARN) of the AWS organization. This property is read-only and follows
the following format:
arn:aws:organizations:us-east-1:example-account-id:organization/o-ex2l495dck
String id
A container for the Amazon S3 Storage Lens configuration ID.
AccountLevel accountLevel
A container for all the account-level configurations of your S3 Storage Lens configuration.
Include include
A container for what is included in this configuration. This container can only be valid if there is no
Exclude container submitted, and it's not empty.
Exclude exclude
A container for what is excluded in this configuration. This container can only be valid if there is no
Include container submitted, and it's not empty.
StorageLensDataExport dataExport
A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.
Boolean isEnabled
A container for whether the S3 Storage Lens configuration is enabled.
StorageLensAwsOrg awsOrg
A container for the AWS organization for this S3 Storage Lens configuration.
String storageLensArn
The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only and follows the
following format:
arn:aws:s3:us-east-1:example-account-id:storage-lens/your-dashboard-name
S3BucketDestination s3BucketDestination
A container for the bucket where the S3 Storage Lens metrics export will be located.
This bucket must be located in the same Region as the storage lens configuration.
Date date
Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.
Integer days
Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.
String storageClass
The storage class to which you want the object to transition.
String accountId
The AWS account ID associated with the S3 Batch Operations job.
String jobId
The ID of the job whose status you want to update.
String requestedJobStatus
The status that you want to move the specified job to.
String statusUpdateReason
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.
String vpcId
If this field is specified, this access point will only allow connections from the specified VPC ID.
Copyright © 2021. All rights reserved.