Package-level declarations

Types

Link copied to clipboard

The container for abort incomplete multipart upload

Link copied to clipboard

A container for information about access control for replicas.

Link copied to clipboard

The configuration options of the S3 Access Grants location. It contains the S3SubPrefix field. The grant scope, the data to which you are granting access, is the result of appending the Subprefix field to the scope of the registered location.

Link copied to clipboard

An access point used to access a bucket.

Link copied to clipboard

A container element for the account-level Amazon S3 Storage Lens configuration.

Link copied to clipboard

The container element for Amazon S3 Storage Lens activity metrics. Activity metrics show details about how your storage is requested, such as requests (for example, All requests, Get requests, Put requests), bytes uploaded or downloaded, and errors.

Link copied to clipboard

The container element for Amazon S3 Storage Lens advanced cost-optimization metrics. Advanced cost-optimization metrics provide insights that you can use to manage and optimize your storage costs, for example, lifecycle rule counts for transitions, expirations, and incomplete multipart uploads.

Link copied to clipboard

The container element for Amazon S3 Storage Lens advanced data-protection metrics. Advanced data-protection metrics provide insights that you can use to perform audits and protect your data, for example replication rule counts within and across Regions.

Link copied to clipboard

Error details for the failed asynchronous operation.

Link copied to clipboard

A container for the information about an asynchronous operation.

Link copied to clipboard
sealed class AsyncOperationName
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The requested Outposts bucket name is not available. The bucket namespace is shared by all users of the Outposts in this Region. Select a different name and try again.

Link copied to clipboard

The Outposts bucket you tried to create already exists, and you own it.

Link copied to clipboard
sealed class BucketCannedAcl
Link copied to clipboard

A container for the bucket-level configuration for Amazon S3 Storage Lens.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The container for the bucket configuration.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

A container for the information associated with a CreateMultiRegionAccessPoint request.

Link copied to clipboard

The Amazon Web Services Security Token Service temporary credential that S3 Access Grants vends to grantees and client applications.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Specifies whether S3 on Outposts replicates delete markers. If you specify a Filter element in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication element's Status child element must be set to Disabled, because S3 on Outposts does not support replicating delete markers for tag-based rules.

Link copied to clipboard
Link copied to clipboard

A container for the information associated with a DeleteMultiRegionAccessPoint request.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Specifies information about the replication destination bucket and its settings for an S3 on Outposts replication configuration.

Link copied to clipboard

The container element for Amazon S3 Storage Lens detailed status code metrics. Detailed status code metrics generate metrics for HTTP status codes, such as 200 OK, 403 Forbidden, 503 Service Unavailable and others.

Link copied to clipboard

Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.

Link copied to clipboard

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

Link copied to clipboard
class Exclude

A container for what Amazon S3 Storage Lens will exclude.

Link copied to clipboard

An optional configuration to replicate existing source bucket objects.

Link copied to clipboard
sealed class ExpirationStatus
Link copied to clipboard
sealed class Format
Link copied to clipboard

The encryption configuration to use when storing the generated manifest.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Grantee

The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

Link copied to clipboard
sealed class GranteeType
Link copied to clipboard
class Include

A container for what Amazon S3 Storage Lens configuration includes.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Contains the configuration information for a job's manifest.

Link copied to clipboard
Link copied to clipboard
sealed class JobManifestFormat
Link copied to clipboard

Configures the type of the job's ManifestGenerator.

Link copied to clipboard

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

Link copied to clipboard

Contains the information required to locate a manifest object. Manifests can't be imported from directory buckets. For more information, see Directory buckets.

Link copied to clipboard

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

Link copied to clipboard

The operation that you want this job to perform on every object listed in the manifest. For more information about the available operations, see Operations in the Amazon S3 User Guide.

Link copied to clipboard

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

Link copied to clipboard
class JobReport

Contains the configuration parameters for a job-completion report.

Link copied to clipboard
sealed class JobReportFormat
Link copied to clipboard
sealed class JobReportScope
Link copied to clipboard
sealed class JobStatus
Link copied to clipboard
Link copied to clipboard
class JobTimers

Provides timing details for the job.

Link copied to clipboard

If provided, the generated manifest includes only source bucket objects whose object keys match the string constraints specified for MatchAnyPrefix, MatchAnySuffix, and MatchAnySubstring.

Link copied to clipboard

Contains the configuration parameters for a Lambda Invoke operation.

Link copied to clipboard

The container for the Outposts bucket lifecycle configuration.

Link copied to clipboard

The container of the Outposts bucket lifecycle expiration.

Link copied to clipboard

The container for the Outposts bucket lifecycle rule.

Link copied to clipboard

The container for the Outposts bucket lifecycle rule and operator.

Link copied to clipboard

The container for the filter of the lifecycle rule.

Link copied to clipboard

Information about the access grant.

Link copied to clipboard

Information about the S3 Access Grants instance.

Link copied to clipboard

A container for information about the registered location.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Part of ListStorageLensConfigurationResult. Each entry includes the description of the S3 Storage Lens configuration, its home Region, whether it is enabled, its Amazon Resource Name (ARN), and config ID.

Link copied to clipboard

Each entry contains a Storage Lens group that exists in the specified home Region.

Link copied to clipboard

A filter condition that specifies the object age range of included objects in days. Only integers are supported.

Link copied to clipboard

A filter condition that specifies the object size range of included objects in bytes. Only integers are supported.

Link copied to clipboard
class Metrics

A container that specifies replication metrics-related settings.

Link copied to clipboard
sealed class MetricsStatus
Link copied to clipboard
sealed class MfaDelete
Link copied to clipboard
sealed class MfaDeleteStatus
Link copied to clipboard

The Multi-Region Access Point access control policy.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

A structure for a Multi-Region Access Point that indicates where Amazon S3 traffic can be routed. Routes can be either active or passive. Active routes can process Amazon S3 requests through the Multi-Region Access Point, but passive routes are not eligible to process Amazon S3 requests.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
sealed class NetworkOrigin
Link copied to clipboard

The container of the noncurrent version expiration.

Link copied to clipboard

The container for the noncurrent version transition.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

The alias of an Object Lambda Access Point. For more information, see How to use a bucket-style alias for your S3 bucket Object Lambda Access Point.

Link copied to clipboard
Link copied to clipboard

A configuration used when creating an Object Lambda Access Point.

Link copied to clipboard

A container for AwsLambdaTransformation.

Link copied to clipboard

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

Link copied to clipboard
sealed class OperationName
Link copied to clipboard
sealed class OutputSchemaVersion
Link copied to clipboard
sealed class OwnerOverride
Link copied to clipboard
sealed class Permission
Link copied to clipboard

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

Link copied to clipboard

A container for the prefix-level configuration.

Link copied to clipboard

A container for the prefix-level storage metrics for S3 Storage Lens.

Link copied to clipboard
sealed class Privilege
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

A container for the information associated with a PutMultiRegionAccessPoint request.

Link copied to clipboard
class Region

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

Link copied to clipboard

The container for the regional bucket.

Link copied to clipboard

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

Link copied to clipboard

A filter that you can use to specify whether replica modification sync is enabled. S3 on Outposts replica modification sync can help you keep object metadata synchronized between replicas and source objects. By default, S3 on Outposts replicates metadata from the source objects to the replicas only. When replica modification sync is enabled, S3 on Outposts replicates metadata changes made to the replica copies back to the source object, making the replication bidirectional.

Link copied to clipboard
Link copied to clipboard

A container for one or more replication rules. A replication configuration must have at least one rule and you can add up to 100 rules. The maximum size of a replication configuration is 128 KB.

Link copied to clipboard

Specifies which S3 on Outposts objects to replicate and where to store the replicas.

Link copied to clipboard

A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter.

Link copied to clipboard

A filter that identifies the subset of objects to which the replication rule applies. A Filter element must specify exactly one Prefix, Tag, or And child element.

Link copied to clipboard
Link copied to clipboard
sealed class ReplicationStatus
Link copied to clipboard
Link copied to clipboard

A container that specifies S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated.

Link copied to clipboard
Link copied to clipboard

A container that specifies the time value for S3 Replication Time Control (S3 RTC). This value is also used for the replication metrics EventThreshold element.

Link copied to clipboard
sealed class RequestedJobStatus
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

A container for the bucket where the Amazon S3 Storage Lens metrics export files are located.

Link copied to clipboard
Link copied to clipboard
sealed class S3ChecksumAlgorithm
Link copied to clipboard

Base class for all service related exceptions thrown by the S3Control client

Link copied to clipboard

Contains the configuration parameters for a PUT Copy object operation. S3 Batch Operations passes every object to the underlying CopyObject API operation. For more information about the parameters for this operation, see CopyObject.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
sealed class S3GlacierJobTier
Link copied to clipboard
class S3Grant
Link copied to clipboard
class S3Grantee
Link copied to clipboard
Link copied to clipboard

Contains the configuration parameters for a POST Object restore job. S3 Batch Operations passes every object to the underlying RestoreObject API operation. For more information about the parameters for this operation, see RestoreObject.

Link copied to clipboard

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

Link copied to clipboard

Location details for where the generated manifest should be written.

Link copied to clipboard
sealed class S3MetadataDirective
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
sealed class S3ObjectLockMode
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class S3Permission
Link copied to clipboard
sealed class S3PrefixType
Link copied to clipboard

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

Link copied to clipboard

Contains the S3 Object Lock retention mode to be applied to all objects in the S3 Batch Operations job. If you don't provide Mode and RetainUntilDate data types in your operation, you will remove the retention from your objects. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

Link copied to clipboard

Contains the configuration parameters for a PUT Object ACL operation. S3 Batch Operations passes every object to the underlying PutObjectAcl API operation. For more information about the parameters for this operation, see PutObjectAcl.

Link copied to clipboard

Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes to every object to the underlying PutObjectLegalHold API operation. For more information, see Using S3 Object Lock legal hold with S3 Batch Operations in the Amazon S3 User Guide.

Link copied to clipboard

Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes every object to the underlying PutObjectRetention API operation. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

Link copied to clipboard

Contains the configuration parameters for a PUT Object Tagging operation. S3 Batch Operations passes every object to the underlying PutObjectTagging API operation. For more information about the parameters for this operation, see PutObjectTagging.

Link copied to clipboard
sealed class S3SseAlgorithm
Link copied to clipboard
sealed class S3StorageClass
Link copied to clipboard
class S3Tag

A container for a key-value name pair.

Link copied to clipboard
Link copied to clipboard

A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects.

Link copied to clipboard
class Ssekms
Link copied to clipboard

A container for filter information that you can use to select S3 objects that are encrypted with Key Management Service (KMS).

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
class Sses3
Link copied to clipboard

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

Link copied to clipboard

The Amazon Web Services organization for your S3 Storage Lens.

Link copied to clipboard

A container for the Amazon S3 Storage Lens configuration.

Link copied to clipboard

A container to specify the properties of your S3 Storage Lens metrics export, including the destination, schema, and format.

Link copied to clipboard

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

Link copied to clipboard

A custom grouping of objects that include filters for prefixes, suffixes, object tags, object size, or object age. You can create an S3 Storage Lens group that includes a single filter or multiple filter conditions. To specify multiple filter conditions, you use AND or OR logical operators.

Link copied to clipboard

A logical operator that allows multiple filter conditions to be joined for more complex comparisons of Storage Lens group data.

Link copied to clipboard

The filter element sets the criteria for the Storage Lens group data that is displayed. For multiple filter conditions, the AND or OR logical operator is used.

Link copied to clipboard

Specifies the Storage Lens groups to include in the Storage Lens group aggregation.

Link copied to clipboard

Indicates which Storage Lens group ARNs to include or exclude in the Storage Lens group aggregation. You can only attach Storage Lens groups to your Storage Lens dashboard if they're included in your Storage Lens group aggregation. If this value is left null, then all Storage Lens groups are selected.

Link copied to clipboard

A container element for specifying Or rule conditions. The rule conditions determine the subset of objects to which the Or rule applies. Objects can match any of the listed filter conditions, which are joined by the Or logical operator. Only one of each filter condition is allowed.

Link copied to clipboard
Link copied to clipboard
class Tag

An Amazon Web Services resource tag that's associated with your S3 resource. You can add tags to new objects when you upload them, or you can add object tags to existing objects.

Link copied to clipboard
class Tagging
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

Specifies when an object transitions to a specified storage class. For more information about Amazon S3 Lifecycle configuration rules, see Transitioning objects using Amazon S3 Lifecycle in the Amazon S3 User Guide.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Describes the versioning state of an Amazon S3 on Outposts bucket. For more information, see PutBucketVersioning.

Link copied to clipboard

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