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 Amazon Web Services.
String bucket
The name of the bucket associated with this access point.
String accessPointArn
The ARN for the access point.
String alias
The name or alias of the access point.
String bucketAccountId
The Amazon Web Services account ID associated with the S3 bucket associated with this access point.
ActivityMetrics activityMetrics
A container for S3 Storage Lens activity metrics.
BucketLevel bucketLevel
A container for the S3 Storage Lens bucket-level configuration.
AdvancedCostOptimizationMetrics advancedCostOptimizationMetrics
A container for S3 Storage Lens advanced cost-optimization metrics.
AdvancedDataProtectionMetrics advancedDataProtectionMetrics
A container for S3 Storage Lens advanced data-protection metrics.
DetailedStatusCodesMetrics detailedStatusCodesMetrics
A container for detailed status code metrics.
Boolean isEnabled
A container that indicates whether activity metrics are enabled.
Boolean isEnabled
A container that indicates whether advanced cost-optimization metrics are enabled.
Boolean isEnabled
A container that indicates whether advanced data-protection metrics are enabled.
String code
A string that uniquely identifies the error condition.
String message
A generic description of the error condition in English.
String resource
The identifier of the resource associated with the error.
String requestId
The ID of the request associated with the error.
Date creationTime
The time that the request was sent to the service.
String operation
The specific operation for the asynchronous request.
String requestTokenARN
The request token associated with the request.
AsyncRequestParameters requestParameters
The parameters associated with the request.
String requestStatus
The current status of the request.
AsyncResponseDetails responseDetails
The details of the response.
CreateMultiRegionAccessPointInput createMultiRegionAccessPointRequest
A container of the parameters for a CreateMultiRegionAccessPoint request.
DeleteMultiRegionAccessPointInput deleteMultiRegionAccessPointRequest
A container of the parameters for a DeleteMultiRegionAccessPoint request.
PutMultiRegionAccessPointPolicyInput putMultiRegionAccessPointPolicyRequest
A container of the parameters for a PutMultiRegionAccessPoint request.
MultiRegionAccessPointsAsyncResponse multiRegionAccessPointDetails
The details for the Multi-Region Access Point.
AsyncErrorDetails errorDetails
Error details for an asynchronous request.
ActivityMetrics activityMetrics
A container for the bucket-level activity metrics for S3 Storage Lens.
PrefixLevel prefixLevel
A container for the prefix-level metrics for S3 Storage Lens.
AdvancedCostOptimizationMetrics advancedCostOptimizationMetrics
A container for bucket-level advanced cost-optimization metrics for S3 Storage Lens.
AdvancedDataProtectionMetrics advancedDataProtectionMetrics
A container for bucket-level advanced data-protection metrics for S3 Storage Lens.
DetailedStatusCodesMetrics detailedStatusCodesMetrics
A container for bucket-level detailed status code metrics for S3 Storage Lens.
Boolean isEnabled
A container that indicates whether CloudWatch publishing for S3 Storage Lens metrics is enabled. A value of
true indicates that CloudWatch publishing for S3 Storage Lens metrics is enabled.
String accountId
The Amazon Web Services 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 Amazon Web Services account ID for the account that owns the specified 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 Amazon Web Services SDK and CLI, you must specify the ARN
of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
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 bucketAccountId
The Amazon Web Services account ID associated with the S3 bucket associated with this access point.
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 ID 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 Amazon Web Services SDK and CLI, you must specify the ARN
of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
String accountId
The Amazon Web Services 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 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.
JobManifestGenerator manifestGenerator
The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.
String jobId
The ID for this job. Amazon S3 generates this ID automatically and returns it after a successful
Create Job request.
String name
The name of the Multi-Region Access Point associated with this request.
PublicAccessBlockConfiguration publicAccessBlock
List<E> regions
The buckets in different Regions that are associated with the Multi-Region Access Point.
String accountId
The Amazon Web Services account ID for the owner of the Multi-Region Access Point. The owner of the Multi-Region Access Point also must own the underlying buckets.
String clientToken
An idempotency token used to identify the request and guarantee that requests are unique.
CreateMultiRegionAccessPointInput details
A container element containing details about the Multi-Region Access Point.
String requestTokenARN
The request token associated with the request. You can use this token with DescribeMultiRegionAccessPointOperation to determine the status of asynchronous requests.
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 Amazon Web Services SDK and CLI, you must specify the ARN
of the access point accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>
. For example, to access the access point reports-ap through outpost my-outpost owned
by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must
be URL encoded.
String accountId
The Amazon Web Services 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 Amazon Web Services SDK and CLI, you must specify the ARN
of the access point accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>
. For example, to access the access point reports-ap through outpost my-outpost owned
by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must
be URL encoded.
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 Amazon Web Services SDK and CLI, you must specify the ARN
of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
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 Amazon Web Services SDK and CLI, you must specify the ARN
of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
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 Amazon Web Services SDK and CLI, you must specify the ARN
of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
String accountId
The Amazon Web Services 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 Amazon Web Services SDK and CLI, you must specify the ARN
of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
String name
The name of the Multi-Region Access Point associated with this request.
String accountId
The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
String clientToken
An idempotency token used to identify the request and guarantee that requests are unique.
DeleteMultiRegionAccessPointInput details
A container element containing details about the Multi-Region Access Point.
String requestTokenARN
The request token associated with the request. You can use this token with DescribeMultiRegionAccessPointOperation to determine the status of asynchronous requests.
String accountId
The account ID for the Amazon Web Services 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.
String accountId
The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
String requestTokenARN
The request token associated with the request you want to know about. This request token is returned as part of the response when you make an asynchronous request. You provide this token to query about the status of the asynchronous action.
AsyncOperation asyncOperation
A container element containing the details of the asynchronous operation.
Boolean isEnabled
A container that indicates whether detailed status code metrics are enabled.
String policy
The details of the last established policy.
SSES3Encryption sSES3
Specifies the use of SSE-S3 to encrypt generated manifest objects.
SSEKMSEncryption sSEKMS
Configuration details on how SSE-KMS is used to encrypt generated manifest objects.
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 Amazon Web Services SDK and CLI, you must specify the ARN
of the access point accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>
. For example, to access the access point reports-ap through outpost my-outpost owned
by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must
be URL encoded.
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 Amazon Web Services 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 Amazon Web Services SDK and CLI, you must specify the ARN
of the access point accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>
. For example, to access the access point reports-ap through outpost my-outpost owned
by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must
be URL encoded.
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 Amazon Web Services.
PublicAccessBlockConfiguration publicAccessBlockConfiguration
Date creationDate
The date and time when the specified access point was created.
String alias
The name or alias of the access point.
String accessPointArn
The ARN of the access point.
Map<K,V> endpoints
The VPC endpoint for the access point.
String bucketAccountId
The Amazon Web Services account ID associated with the S3 bucket associated with this access point.
String accountId
The Amazon Web Services 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 Amazon Web Services SDK and CLI, you must specify the ARN
of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
String accountId
The Amazon Web Services 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 Amazon Web Services SDK and CLI, you must specify the ARN
of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
String policy
The policy of the Outposts bucket.
String accountId
The Amazon Web Services 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 Amazon Web Services SDK and CLI, you must specify the ARN
of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
String accountId
The Amazon Web Services 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 Amazon Web Services SDK and CLI, you must specify the ARN
of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
String status
The versioning state of the S3 on Outposts bucket.
String mFADelete
Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is returned only if the bucket has been configured with MFA delete. If MFA delete has never been configured for the bucket, this element is not returned.
String accountId
The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
String name
Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
MultiRegionAccessPointPolicyDocument policy
The policy associated with the specified Multi-Region Access Point.
String accountId
The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
String name
Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
PolicyStatus established
String accountId
The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
String name
The name of the Multi-Region Access Point whose configuration information you want to receive. The name of the Multi-Region Access Point is different from the alias. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Managing Multi-Region Access Points in the Amazon S3 User Guide.
MultiRegionAccessPointReport accessPoint
A container element containing the details of the requested Multi-Region Access Point.
String accountId
The account ID for the Amazon Web Services account whose PublicAccessBlock configuration you want to
retrieve.
PublicAccessBlockConfiguration publicAccessBlockConfiguration
The PublicAccessBlock configuration currently in effect for this Amazon Web Services 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 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.
JobManifestGenerator manifestGenerator
The manifest generator that was used to generate a job manifest for this job.
S3GeneratedManifestDescriptor generatedManifestDescriptor
The attribute of the JobDescriptor containing details about the job's generated manifest.
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.
S3JobManifestGenerator s3JobManifestGenerator
The S3 job ManifestGenerator's configuration details.
Boolean eligibleForReplication
Include objects in the generated manifest only if they are eligible for replication according to the Replication configuration on the source bucket.
Date createdAfter
If provided, the generated manifest should include only source bucket objects that were created after this time.
Date createdBefore
If provided, the generated manifest should include only source bucket objects that were created before this time.
List<E> objectReplicationStatuses
If provided, the generated manifest should include only source bucket objects that have one of the specified Replication statuses.
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 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 PutObjectAcl 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
S3ReplicateObjectOperation s3ReplicateObject
Directs the specified job to invoke ReplicateObject on every object in the job's manifest.
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.
Long elapsedTimeInActiveSeconds
Indicates the elapsed time in seconds the job has been in the Active job state.
String functionArn
The Amazon Resource Name (ARN) for the 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.
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.
List<E> tags
All of these tags must exist in the object's tag set in order for the rule to apply.
Long objectSizeGreaterThan
Minimum object size to which the rule applies.
Long objectSizeLessThan
Maximum object size to which the rule applies.
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.
Long objectSizeGreaterThan
Minimum object size to which the rule applies.
Long objectSizeLessThan
Maximum object size to which the rule applies.
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. The response may contain fewer access
points but will never contain more. If there are more than this number of access points, then the response will
include a continuation token in the NextToken field that you can use to retrieve the next page of
access points.
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 Amazon Web Services account ID for the account that owns the specified access points.
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 Amazon Web Services SDK and CLI, you must specify the ARN
of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
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 Amazon Web Services 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.
List<E> accessPoints
The list of Multi-Region Access Points associated with the user.
String nextToken
If the specified bucket has more Multi-Region Access Points than can be returned in one call to this action, this field contains a continuation token. You can use this token tin subsequent calls to this action to retrieve additional Multi-Region Access Points.
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.
EstablishedMultiRegionAccessPointPolicy established
The last established policy for the Multi-Region Access Point.
ProposedMultiRegionAccessPointPolicy proposed
The proposed policy for the Multi-Region Access Point.
String name
The name of the Multi-Region Access Point.
String alias
The alias for the Multi-Region Access Point. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Managing Multi-Region Access Points.
Date createdAt
When the Multi-Region Access Point create request was received.
PublicAccessBlockConfiguration publicAccessBlock
String status
The current status of the Multi-Region Access Point.
CREATING and DELETING are temporary states that exist while the request is propagating
and being completed. If a Multi-Region Access Point has a status of PARTIALLY_CREATED, you can retry
creation or send a request to delete the Multi-Region Access Point. If a Multi-Region Access Point has a status
of PARTIALLY_DELETED, you can retry a delete request to finish the deletion of the Multi-Region
Access Point.
List<E> regions
A collection of the Regions and buckets associated with the Multi-Region Access Point.
String bucket
The name of the Amazon S3 bucket for which you'll submit a routing configuration change. Either the
Bucket or the Region value must be provided. If both are provided, the bucket must be
in the specified Region.
String region
The Amazon Web Services Region to which you'll be submitting a routing configuration change. Either the
Bucket or the Region value must be provided. If both are provided, the bucket must be
in the specified Region.
Integer trafficDialPercentage
The traffic state for the specified bucket or Amazon Web Services Region.
A value of 0 indicates a passive state, which means that no new traffic will be routed to the
Region.
A value of 100 indicates an active state, which means that traffic will be routed to the specified
Region.
When the routing configuration for a Region is changed from active to passive, any in-progress operations (uploads, copies, deletes, and so on) to the formerly active Region will continue to run to until a final success or failure status is reached.
If all Regions in the routing configuration are designated as passive, you'll receive an
InvalidRequest error.
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 newerNoncurrentVersions
Specifies how many noncurrent versions S3 on Outposts will retain. If there are this many more recent noncurrent versions, S3 on Outposts will take the associated action. For more information about noncurrent versions, see Lifecycle configuration elements 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,
GetObject-PartNumber, HeadObject-Range, and HeadObject-PartNumber.
List<E> transformationConfigurations
A container for transformation configurations for an Object Lambda Access Point.
AwsLambdaTransformation awsLambda
A container for an Lambda function.
List<E> actions
A container for the action of an Object Lambda Access Point configuration. Valid inputs are
GetObject, ListObjects, HeadObject, and ListObjectsV2.
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
String policy
The details of the proposed policy.
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:
PutBucketAcl and PutObjectAcl 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 property 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 property 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 property 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 Amazon Web Service
principals and authorized users within this account.
Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.
This property 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 Amazon Web Services 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 Amazon Web Services SDK and CLI, you must specify the ARN
of the access point accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>
. For example, to access the access point reports-ap through outpost my-outpost owned
by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must
be URL encoded.
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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services SDK and CLI, you must specify the ARN
of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
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 Amazon Web Services 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 Amazon Web Services SDK and CLI, you must specify the ARN
of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucket reports through outpost my-outpost owned by account
123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL
encoded.
Tagging tagging
String accountId
The Amazon Web Services account ID of the S3 on Outposts bucket.
String bucket
The S3 on Outposts bucket to set the versioning state for.
String mFA
The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
VersioningConfiguration versioningConfiguration
The root-level tag for the VersioningConfiguration parameters.
String accountId
The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
String clientToken
An idempotency token used to identify the request and guarantee that requests are unique.
PutMultiRegionAccessPointPolicyInput details
A container element containing the details of the policy for the Multi-Region Access Point.
String requestTokenARN
The request token associated with the request. You can use this token with DescribeMultiRegionAccessPointOperation to determine the status of asynchronous requests.
PublicAccessBlockConfiguration publicAccessBlockConfiguration
The PublicAccessBlock configuration that you want to apply to the specified Amazon Web Services
account.
String accountId
The account ID for the Amazon Web Services 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
The name of the associated bucket for the Region.
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 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 property to
arn:aws:s3:::destinationBucket.
String cannedAccessControlList
List<E> accessControlGrants
String metadataDirective
Date modifiedSinceConstraint
S3ObjectMetadata newObjectMetadata
If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.
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.
Boolean bucketKeyEnabled
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using
Amazon Web Services KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket
Key for object encryption with SSE-KMS.
Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.
String checksumAlgorithm
Indicates the algorithm you want Amazon S3 to use to create the checksum. For more information see Checking object integrity in the Amazon S3 User Guide.
String format
The format of the generated manifest.
JobManifestLocation location
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 expectedBucketOwner
The Amazon Web Services account ID that owns the bucket the generated manifest is written to. If provided the generated manifest bucket's owner Amazon Web Services account ID must match this value, else the job fails.
String sourceBucket
The source bucket used by the ManifestGenerator.
S3ManifestOutputLocation manifestOutputLocation
Specifies the location the generated manifest will be written to.
JobManifestGeneratorFilter filter
Specifies rules the S3JobManifestGenerator should use to use to decide whether an object in the source bucket should or should not be included in the generated job manifest.
Boolean enableManifestOutput
Determines whether or not to write the job's generated manifest to a bucket.
String expectedManifestBucketOwner
The Account ID that owns the bucket the generated manifest is written to.
String bucket
The bucket ARN the generated manifest should be written to.
String manifestPrefix
Prefix identifying one or more objects to which the manifest applies.
GeneratedManifestEncryption manifestEncryption
Specifies what encryption should be used when the generated manifest objects are written.
String manifestFormat
The format of the generated manifest.
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 keyId
Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key to use for encrypting generated manifest objects.
String arn
A container for the Amazon Resource Name (ARN) of the Amazon Web Services organization. This property is
read-only and follows the following format:
arn:aws:organizations:us-east-1:example-account-id:organization/o-ex2l495dck
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 Amazon Web Services 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.
CloudWatchMetrics cloudWatchMetrics
A container for enabling Amazon CloudWatch publishing for S3 Storage Lens metrics.
String accountId
The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
String mrap
The Multi-Region Access Point ARN.
List<E> routeUpdates
The different routes that make up the new route configuration. Active routes return a value of 100,
and passive routes return a value of 0.
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 Amazon Web Services 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 © 2022. All rights reserved.