Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.4/services/s3control.ts?docs=full";

§Classes

S3Control

§Interfaces

AbortIncompleteMultipartUpload

The container for abort incomplete multipart upload

AccessPoint

An access point used to access a bucket.

AccountLevel

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

ActivityMetrics

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.

AdvancedCostOptimizationMetrics

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.

AdvancedDataProtectionMetrics

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.

AsyncErrorDetails

Error details for the failed asynchronous operation.

AsyncOperation

A container for the information about an asynchronous operation.

AsyncRequestParameters

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

AsyncResponseDetails

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

AwsLambdaTransformation

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

BucketLevel

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

CloudWatchMetrics

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

CreateAccessPointForObjectLambdaRequest
CreateAccessPointForObjectLambdaResult
CreateAccessPointRequest
CreateAccessPointResult
CreateBucketConfiguration

The container for the bucket configuration.

CreateBucketRequest
CreateBucketResult
CreateJobRequest
CreateJobResult
CreateMultiRegionAccessPointInput

A container for the information associated with a CreateMultiRegionAccessPoint request.

CreateMultiRegionAccessPointRequest
CreateMultiRegionAccessPointResult
DeleteAccessPointForObjectLambdaRequest
DeleteAccessPointPolicyForObjectLambdaRequest
DeleteAccessPointPolicyRequest
DeleteAccessPointRequest
DeleteBucketLifecycleConfigurationRequest
DeleteBucketPolicyRequest
DeleteBucketRequest
DeleteBucketTaggingRequest
DeleteJobTaggingRequest
DeleteMultiRegionAccessPointInput

A container for the information associated with a DeleteMultiRegionAccessPoint request.

DeleteMultiRegionAccessPointRequest
DeleteMultiRegionAccessPointResult
DeletePublicAccessBlockRequest
DeleteStorageLensConfigurationRequest
DeleteStorageLensConfigurationTaggingRequest
DescribeJobRequest
DescribeJobResult
DescribeMultiRegionAccessPointOperationRequest
DescribeMultiRegionAccessPointOperationResult
DetailedStatusCodesMetrics

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.

EstablishedMultiRegionAccessPointPolicy

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

Exclude

A container for what Amazon S3 Storage Lens will exclude.

GeneratedManifestEncryption

The encryption configuration to use when storing the generated manifest.

GetAccessPointConfigurationForObjectLambdaRequest
GetAccessPointConfigurationForObjectLambdaResult
GetAccessPointForObjectLambdaRequest
GetAccessPointForObjectLambdaResult
GetAccessPointPolicyForObjectLambdaRequest
GetAccessPointPolicyForObjectLambdaResult
GetAccessPointPolicyRequest
GetAccessPointPolicyResult
GetAccessPointPolicyStatusForObjectLambdaRequest
GetAccessPointPolicyStatusForObjectLambdaResult
GetAccessPointPolicyStatusRequest
GetAccessPointPolicyStatusResult
GetAccessPointRequest
GetAccessPointResult
GetBucketLifecycleConfigurationRequest
GetBucketLifecycleConfigurationResult
GetBucketPolicyRequest
GetBucketPolicyResult
GetBucketRequest
GetBucketResult
GetBucketTaggingRequest
GetBucketTaggingResult
GetBucketVersioningRequest
GetBucketVersioningResult
GetJobTaggingRequest
GetJobTaggingResult
GetMultiRegionAccessPointPolicyRequest
GetMultiRegionAccessPointPolicyResult
GetMultiRegionAccessPointPolicyStatusRequest
GetMultiRegionAccessPointPolicyStatusResult
GetMultiRegionAccessPointRequest
GetMultiRegionAccessPointResult
GetMultiRegionAccessPointRoutesRequest
GetMultiRegionAccessPointRoutesResult
GetPublicAccessBlockOutput
GetPublicAccessBlockRequest
GetStorageLensConfigurationRequest
GetStorageLensConfigurationResult
GetStorageLensConfigurationTaggingRequest
GetStorageLensConfigurationTaggingResult
Include

A container for what Amazon S3 Storage Lens configuration includes.

JobDescriptor

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

JobFailure

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

JobListDescriptor

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

JobManifest

Contains the configuration information for a job's manifest.

JobManifestGenerator

Configures the type of the job's ManifestGenerator.

JobManifestGeneratorFilter

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

JobManifestLocation

Contains the information required to locate a manifest object.

JobManifestSpec

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

JobOperation

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.

JobProgressSummary

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.

JobReport

Contains the configuration parameters for a job-completion report.

JobTimers

Provides timing details for the job.

LambdaInvokeOperation

Contains the configuration parameters for a Lambda Invoke operation.

LifecycleConfiguration

The container for the Outposts bucket lifecycle configuration.

LifecycleExpiration

The container of the Outposts bucket lifecycle expiration.

LifecycleRule

The container for the Outposts bucket lifecycle rule.

LifecycleRuleAndOperator

The container for the Outposts bucket lifecycle rule and operator.

LifecycleRuleFilter

The container for the filter of the lifecycle rule.

ListAccessPointsForObjectLambdaRequest
ListAccessPointsForObjectLambdaResult
ListAccessPointsRequest
ListAccessPointsResult
ListJobsRequest
ListJobsResult
ListMultiRegionAccessPointsRequest
ListMultiRegionAccessPointsResult
ListRegionalBucketsRequest
ListRegionalBucketsResult
ListStorageLensConfigurationEntry

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.

ListStorageLensConfigurationsRequest
ListStorageLensConfigurationsResult
MultiRegionAccessPointPolicyDocument

The Multi-Region Access Point access control policy.

MultiRegionAccessPointRegionalResponse

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

MultiRegionAccessPointReport

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

MultiRegionAccessPointRoute

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.

MultiRegionAccessPointsAsyncResponse

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

NoncurrentVersionExpiration

The container of the noncurrent version expiration.

NoncurrentVersionTransition

The container for the noncurrent version transition.

ObjectLambdaAccessPoint

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

ObjectLambdaConfiguration

A configuration used when creating an Object Lambda Access Point.

ObjectLambdaContentTransformation

A container for AwsLambdaTransformation.

ObjectLambdaTransformationConfiguration

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

PolicyStatus

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.

PrefixLevel

A container for the prefix-level configuration.

PrefixLevelStorageMetrics

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

ProposedMultiRegionAccessPointPolicy

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

PublicAccessBlockConfiguration

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.

PutAccessPointConfigurationForObjectLambdaRequest
PutAccessPointPolicyForObjectLambdaRequest
PutAccessPointPolicyRequest
PutBucketLifecycleConfigurationRequest
PutBucketPolicyRequest
PutBucketTaggingRequest
PutBucketVersioningRequest
PutJobTaggingRequest
PutMultiRegionAccessPointPolicyInput

A container for the information associated with a PutMultiRegionAccessPoint request.

PutMultiRegionAccessPointPolicyRequest
PutMultiRegionAccessPointPolicyResult
PutPublicAccessBlockRequest
PutStorageLensConfigurationRequest
PutStorageLensConfigurationTaggingRequest
Region

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

RegionalBucket

The container for the regional bucket.

RegionReport

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

S3AccessControlList
S3AccessControlPolicy
S3BucketDestination

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

S3CopyObjectOperation

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

S3DeleteObjectTaggingOperation

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

S3GeneratedManifestDescriptor

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

S3Grant
S3Grantee
S3InitiateRestoreObjectOperation

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

S3JobManifestGenerator

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

S3ManifestOutputLocation

Location details for where the generated manifest should be written.

S3ObjectLockLegalHold

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

S3ObjectMetadata
S3ObjectOwner
S3ReplicateObjectOperation

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

S3Retention

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.

S3SetObjectAclOperation

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

S3SetObjectLegalHoldOperation

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

S3SetObjectRetentionOperation

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. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

S3SetObjectTaggingOperation

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

S3Tag

A container for a key-value name pair.

SelectionCriteria
SSEKMS
SSEKMSEncryption

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

SSES3
SSES3Encryption

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

StorageLensAwsOrg

The Amazon Web Services organization for your S3 Storage Lens.

StorageLensConfiguration

A container for the Amazon S3 Storage Lens configuration.

StorageLensDataExport

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

StorageLensDataExportEncryption

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

StorageLensTag
SubmitMultiRegionAccessPointRoutesRequest
Tagging
Transition

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.

UpdateJobPriorityRequest
UpdateJobPriorityResult
UpdateJobStatusRequest
UpdateJobStatusResult
VersioningConfiguration

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

VpcConfiguration

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

§Type Aliases

AsyncOperationName
BucketCannedACL
BucketLocationConstraint
BucketVersioningStatus
ExpirationStatus
Format
GeneratedManifestFormat
JobManifestFieldName
JobManifestFormat
JobReportFormat
JobReportScope
JobStatus
MFADelete
MFADeleteStatus
MultiRegionAccessPointStatus
NetworkOrigin
ObjectLambdaAllowedFeature
ObjectLambdaTransformationConfigurationAction
OperationName
OutputSchemaVersion
ReplicationStatus
RequestedJobStatus
S3CannedAccessControlList
S3ChecksumAlgorithm
S3GlacierJobTier
S3GranteeTypeIdentifier
S3MetadataDirective
S3ObjectLockLegalHoldStatus
S3ObjectLockMode
S3ObjectLockRetentionMode
S3Permission
S3SSEAlgorithm
S3StorageClass
TransitionStorageClass