S3Service overview
Added in v1.0.0
Table of contents
constructors
makeS3Service
Signature
export declare const makeS3Service: Effect.Effect<any, unknown, unknown>
Added in v1.0.0
models
S3Service (class)
Signature
export declare class S3Service
Added in v1.0.0
S3Service$ (interface)
Signature
export interface S3Service$ {
/**
* @see {@link AbortMultipartUploadCommand}
*/
abortMultipartUpload(
args: AbortMultipartUploadCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<AbortMultipartUploadCommandOutput, Cause.TimeoutError | SdkError | NoSuchUploadError>
/**
* @see {@link CompleteMultipartUploadCommand}
*/
completeMultipartUpload(
args: CompleteMultipartUploadCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<CompleteMultipartUploadCommandOutput, Cause.TimeoutError | SdkError>
/**
* @see {@link CopyObjectCommand}
*/
copyObject(
args: CopyObjectCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<CopyObjectCommandOutput, Cause.TimeoutError | SdkError | ObjectNotInActiveTierError>
/**
* @see {@link CreateBucketCommand}
*/
createBucket(
args: CreateBucketCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateBucketCommandOutput,
Cause.TimeoutError | SdkError | BucketAlreadyExistsError | BucketAlreadyOwnedByYouError
>
/**
* @see {@link CreateBucketMetadataConfigurationCommand}
*/
createBucketMetadataConfiguration(
args: CreateBucketMetadataConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<CreateBucketMetadataConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link CreateBucketMetadataTableConfigurationCommand}
*/
createBucketMetadataTableConfiguration(
args: CreateBucketMetadataTableConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<CreateBucketMetadataTableConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link CreateMultipartUploadCommand}
*/
createMultipartUpload(
args: CreateMultipartUploadCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<CreateMultipartUploadCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link CreateSessionCommand}
*/
createSession(
args: CreateSessionCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<CreateSessionCommandOutput, Cause.TimeoutError | SdkError | NoSuchBucketError>
/**
* @see {@link DeleteBucketCommand}
*/
deleteBucket(
args: DeleteBucketCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeleteBucketCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link DeleteBucketAnalyticsConfigurationCommand}
*/
deleteBucketAnalyticsConfiguration(
args: DeleteBucketAnalyticsConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeleteBucketAnalyticsConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link DeleteBucketCorsCommand}
*/
deleteBucketCors(
args: DeleteBucketCorsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeleteBucketCorsCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link DeleteBucketEncryptionCommand}
*/
deleteBucketEncryption(
args: DeleteBucketEncryptionCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeleteBucketEncryptionCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link DeleteBucketIntelligentTieringConfigurationCommand}
*/
deleteBucketIntelligentTieringConfiguration(
args: DeleteBucketIntelligentTieringConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteBucketIntelligentTieringConfigurationCommandOutput,
Cause.TimeoutError | SdkError | S3ServiceError
>
/**
* @see {@link DeleteBucketInventoryConfigurationCommand}
*/
deleteBucketInventoryConfiguration(
args: DeleteBucketInventoryConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeleteBucketInventoryConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link DeleteBucketLifecycleCommand}
*/
deleteBucketLifecycle(
args: DeleteBucketLifecycleCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeleteBucketLifecycleCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link DeleteBucketMetadataConfigurationCommand}
*/
deleteBucketMetadataConfiguration(
args: DeleteBucketMetadataConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeleteBucketMetadataConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link DeleteBucketMetadataTableConfigurationCommand}
*/
deleteBucketMetadataTableConfiguration(
args: DeleteBucketMetadataTableConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeleteBucketMetadataTableConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link DeleteBucketMetricsConfigurationCommand}
*/
deleteBucketMetricsConfiguration(
args: DeleteBucketMetricsConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeleteBucketMetricsConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link DeleteBucketOwnershipControlsCommand}
*/
deleteBucketOwnershipControls(
args: DeleteBucketOwnershipControlsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeleteBucketOwnershipControlsCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link DeleteBucketPolicyCommand}
*/
deleteBucketPolicy(
args: DeleteBucketPolicyCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeleteBucketPolicyCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link DeleteBucketReplicationCommand}
*/
deleteBucketReplication(
args: DeleteBucketReplicationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeleteBucketReplicationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link DeleteBucketTaggingCommand}
*/
deleteBucketTagging(
args: DeleteBucketTaggingCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeleteBucketTaggingCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link DeleteBucketWebsiteCommand}
*/
deleteBucketWebsite(
args: DeleteBucketWebsiteCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeleteBucketWebsiteCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link DeleteObjectCommand}
*/
deleteObject(
args: DeleteObjectCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeleteObjectCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link DeleteObjectAnnotationCommand}
*/
deleteObjectAnnotation(
args: DeleteObjectAnnotationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteObjectAnnotationCommandOutput,
Cause.TimeoutError | SdkError | NoSuchBucketError | NoSuchKeyError
>
/**
* @see {@link DeleteObjectTaggingCommand}
*/
deleteObjectTagging(
args: DeleteObjectTaggingCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeleteObjectTaggingCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link DeleteObjectsCommand}
*/
deleteObjects(
args: DeleteObjectsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeleteObjectsCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link DeletePublicAccessBlockCommand}
*/
deletePublicAccessBlock(
args: DeletePublicAccessBlockCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeletePublicAccessBlockCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketAbacCommand}
*/
getBucketAbac(
args: GetBucketAbacCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketAbacCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketAccelerateConfigurationCommand}
*/
getBucketAccelerateConfiguration(
args: GetBucketAccelerateConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketAccelerateConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketAclCommand}
*/
getBucketAcl(
args: GetBucketAclCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketAclCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketAnalyticsConfigurationCommand}
*/
getBucketAnalyticsConfiguration(
args: GetBucketAnalyticsConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketAnalyticsConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketCorsCommand}
*/
getBucketCors(
args: GetBucketCorsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketCorsCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketEncryptionCommand}
*/
getBucketEncryption(
args: GetBucketEncryptionCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketEncryptionCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketIntelligentTieringConfigurationCommand}
*/
getBucketIntelligentTieringConfiguration(
args: GetBucketIntelligentTieringConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
GetBucketIntelligentTieringConfigurationCommandOutput,
Cause.TimeoutError | SdkError | S3ServiceError
>
/**
* @see {@link GetBucketInventoryConfigurationCommand}
*/
getBucketInventoryConfiguration(
args: GetBucketInventoryConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketInventoryConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketLifecycleConfigurationCommand}
*/
getBucketLifecycleConfiguration(
args: GetBucketLifecycleConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketLifecycleConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketLocationCommand}
*/
getBucketLocation(
args: GetBucketLocationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketLocationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketLoggingCommand}
*/
getBucketLogging(
args: GetBucketLoggingCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketLoggingCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketMetadataConfigurationCommand}
*/
getBucketMetadataConfiguration(
args: GetBucketMetadataConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketMetadataConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketMetadataTableConfigurationCommand}
*/
getBucketMetadataTableConfiguration(
args: GetBucketMetadataTableConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketMetadataTableConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketMetricsConfigurationCommand}
*/
getBucketMetricsConfiguration(
args: GetBucketMetricsConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketMetricsConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketNotificationConfigurationCommand}
*/
getBucketNotificationConfiguration(
args: GetBucketNotificationConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketNotificationConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketOwnershipControlsCommand}
*/
getBucketOwnershipControls(
args: GetBucketOwnershipControlsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketOwnershipControlsCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketPolicyCommand}
*/
getBucketPolicy(
args: GetBucketPolicyCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketPolicyCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketPolicyStatusCommand}
*/
getBucketPolicyStatus(
args: GetBucketPolicyStatusCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketPolicyStatusCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketReplicationCommand}
*/
getBucketReplication(
args: GetBucketReplicationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketReplicationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketRequestPaymentCommand}
*/
getBucketRequestPayment(
args: GetBucketRequestPaymentCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketRequestPaymentCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketTaggingCommand}
*/
getBucketTagging(
args: GetBucketTaggingCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketTaggingCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketVersioningCommand}
*/
getBucketVersioning(
args: GetBucketVersioningCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketVersioningCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetBucketWebsiteCommand}
*/
getBucketWebsite(
args: GetBucketWebsiteCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetBucketWebsiteCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetObjectCommand}
*/
getObject(
args: GetObjectCommandInput,
options?: { readonly presigned?: false } & HttpHandlerOptions
): Effect.Effect<GetObjectCommandOutput, Cause.TimeoutError | SdkError | InvalidObjectStateError | NoSuchKeyError>
getObject(
args: GetObjectCommandInput,
options?: { readonly presigned: true } & RequestPresigningArguments
): Effect.Effect<string, SdkError | S3ServiceError>
/**
* @see {@link GetObjectAclCommand}
*/
getObjectAcl(
args: GetObjectAclCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetObjectAclCommandOutput, Cause.TimeoutError | SdkError | NoSuchKeyError>
/**
* @see {@link GetObjectAnnotationCommand}
*/
getObjectAnnotation(
args: GetObjectAnnotationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
GetObjectAnnotationCommandOutput,
Cause.TimeoutError | SdkError | NoSuchAnnotationError | NoSuchBucketError | NoSuchKeyError
>
/**
* @see {@link GetObjectAttributesCommand}
*/
getObjectAttributes(
args: GetObjectAttributesCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetObjectAttributesCommandOutput, Cause.TimeoutError | SdkError | NoSuchKeyError>
/**
* @see {@link GetObjectLegalHoldCommand}
*/
getObjectLegalHold(
args: GetObjectLegalHoldCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetObjectLegalHoldCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetObjectLockConfigurationCommand}
*/
getObjectLockConfiguration(
args: GetObjectLockConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetObjectLockConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetObjectRetentionCommand}
*/
getObjectRetention(
args: GetObjectRetentionCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetObjectRetentionCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetObjectTaggingCommand}
*/
getObjectTagging(
args: GetObjectTaggingCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetObjectTaggingCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetObjectTorrentCommand}
*/
getObjectTorrent(
args: GetObjectTorrentCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetObjectTorrentCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link GetPublicAccessBlockCommand}
*/
getPublicAccessBlock(
args: GetPublicAccessBlockCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetPublicAccessBlockCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link HeadBucketCommand}
*/
headBucket(
args: HeadBucketCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<HeadBucketCommandOutput, Cause.TimeoutError | SdkError | NotFoundError>
/**
* @see {@link HeadObjectCommand}
*/
headObject(
args: HeadObjectCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<HeadObjectCommandOutput, Cause.TimeoutError | SdkError | NotFoundError>
/**
* @see {@link ListBucketAnalyticsConfigurationsCommand}
*/
listBucketAnalyticsConfigurations(
args: ListBucketAnalyticsConfigurationsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<ListBucketAnalyticsConfigurationsCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link ListBucketIntelligentTieringConfigurationsCommand}
*/
listBucketIntelligentTieringConfigurations(
args: ListBucketIntelligentTieringConfigurationsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListBucketIntelligentTieringConfigurationsCommandOutput,
Cause.TimeoutError | SdkError | S3ServiceError
>
/**
* @see {@link ListBucketInventoryConfigurationsCommand}
*/
listBucketInventoryConfigurations(
args: ListBucketInventoryConfigurationsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<ListBucketInventoryConfigurationsCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link ListBucketMetricsConfigurationsCommand}
*/
listBucketMetricsConfigurations(
args: ListBucketMetricsConfigurationsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<ListBucketMetricsConfigurationsCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link ListBucketsCommand}
*/
listBuckets(
args: ListBucketsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<ListBucketsCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
listBucketsStream(
args: ListBucketsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<ListBucketsCommandOutput, Cause.TimeoutError | SdkError>
/**
* @see {@link ListDirectoryBucketsCommand}
*/
listDirectoryBuckets(
args: ListDirectoryBucketsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<ListDirectoryBucketsCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
listDirectoryBucketsStream(
args: ListDirectoryBucketsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<ListDirectoryBucketsCommandOutput, Cause.TimeoutError | SdkError>
/**
* @see {@link ListMultipartUploadsCommand}
*/
listMultipartUploads(
args: ListMultipartUploadsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<ListMultipartUploadsCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link ListObjectAnnotationsCommand}
*/
listObjectAnnotations(
args: ListObjectAnnotationsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListObjectAnnotationsCommandOutput,
Cause.TimeoutError | SdkError | InvalidPrefixError | NoSuchBucketError | NoSuchKeyError
>
listObjectAnnotationsStream(
args: ListObjectAnnotationsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
ListObjectAnnotationsCommandOutput,
Cause.TimeoutError | SdkError | InvalidPrefixError | NoSuchBucketError | NoSuchKeyError
>
/**
* @see {@link ListObjectVersionsCommand}
*/
listObjectVersions(
args: ListObjectVersionsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<ListObjectVersionsCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link ListObjectsCommand}
*/
listObjects(
args: ListObjectsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<ListObjectsCommandOutput, Cause.TimeoutError | SdkError | NoSuchBucketError>
/**
* @see {@link ListObjectsV2Command}
*/
listObjectsV2(
args: ListObjectsV2CommandInput,
options?: HttpHandlerOptions
): Effect.Effect<ListObjectsV2CommandOutput, Cause.TimeoutError | SdkError | NoSuchBucketError>
listObjectsV2Stream(
args: ListObjectsV2CommandInput,
options?: HttpHandlerOptions
): Stream.Stream<ListObjectsV2CommandOutput, Cause.TimeoutError | SdkError | NoSuchBucketError>
/**
* @see {@link ListPartsCommand}
*/
listParts(
args: ListPartsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<ListPartsCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
listPartsStream(
args: ListPartsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<ListPartsCommandOutput, Cause.TimeoutError | SdkError>
/**
* @see {@link PutBucketAbacCommand}
*/
putBucketAbac(
args: PutBucketAbacCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutBucketAbacCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutBucketAccelerateConfigurationCommand}
*/
putBucketAccelerateConfiguration(
args: PutBucketAccelerateConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutBucketAccelerateConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutBucketAclCommand}
*/
putBucketAcl(
args: PutBucketAclCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutBucketAclCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutBucketAnalyticsConfigurationCommand}
*/
putBucketAnalyticsConfiguration(
args: PutBucketAnalyticsConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutBucketAnalyticsConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutBucketCorsCommand}
*/
putBucketCors(
args: PutBucketCorsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutBucketCorsCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutBucketEncryptionCommand}
*/
putBucketEncryption(
args: PutBucketEncryptionCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutBucketEncryptionCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutBucketIntelligentTieringConfigurationCommand}
*/
putBucketIntelligentTieringConfiguration(
args: PutBucketIntelligentTieringConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
PutBucketIntelligentTieringConfigurationCommandOutput,
Cause.TimeoutError | SdkError | S3ServiceError
>
/**
* @see {@link PutBucketInventoryConfigurationCommand}
*/
putBucketInventoryConfiguration(
args: PutBucketInventoryConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutBucketInventoryConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutBucketLifecycleConfigurationCommand}
*/
putBucketLifecycleConfiguration(
args: PutBucketLifecycleConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutBucketLifecycleConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutBucketLoggingCommand}
*/
putBucketLogging(
args: PutBucketLoggingCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutBucketLoggingCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutBucketMetricsConfigurationCommand}
*/
putBucketMetricsConfiguration(
args: PutBucketMetricsConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutBucketMetricsConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutBucketNotificationConfigurationCommand}
*/
putBucketNotificationConfiguration(
args: PutBucketNotificationConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutBucketNotificationConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutBucketOwnershipControlsCommand}
*/
putBucketOwnershipControls(
args: PutBucketOwnershipControlsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutBucketOwnershipControlsCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutBucketPolicyCommand}
*/
putBucketPolicy(
args: PutBucketPolicyCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutBucketPolicyCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutBucketReplicationCommand}
*/
putBucketReplication(
args: PutBucketReplicationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutBucketReplicationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutBucketRequestPaymentCommand}
*/
putBucketRequestPayment(
args: PutBucketRequestPaymentCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutBucketRequestPaymentCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutBucketTaggingCommand}
*/
putBucketTagging(
args: PutBucketTaggingCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutBucketTaggingCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutBucketVersioningCommand}
*/
putBucketVersioning(
args: PutBucketVersioningCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutBucketVersioningCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutBucketWebsiteCommand}
*/
putBucketWebsite(
args: PutBucketWebsiteCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutBucketWebsiteCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutObjectCommand}
*/
putObject(
args: PutObjectCommandInput,
options?: { readonly presigned?: false } & HttpHandlerOptions
): Effect.Effect<
PutObjectCommandOutput,
| Cause.TimeoutError
| SdkError
| EncryptionTypeMismatchError
| InvalidRequestError
| InvalidWriteOffsetError
| TooManyPartsError
>
putObject(
args: PutObjectCommandInput,
options?: { readonly presigned: true } & RequestPresigningArguments
): Effect.Effect<string, SdkError | S3ServiceError>
/**
* @see {@link PutObjectAclCommand}
*/
putObjectAcl(
args: PutObjectAclCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutObjectAclCommandOutput, Cause.TimeoutError | SdkError | NoSuchKeyError>
/**
* @see {@link PutObjectAnnotationCommand}
*/
putObjectAnnotation(
args: PutObjectAnnotationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
PutObjectAnnotationCommandOutput,
| Cause.TimeoutError
| SdkError
| AnnotationLimitExceededError
| AnnotationNameTooLongError
| InvalidAnnotationNameError
| InvalidRequestError
| NoSuchBucketError
| NoSuchKeyError
| UnsupportedMediaTypeError
>
/**
* @see {@link PutObjectLegalHoldCommand}
*/
putObjectLegalHold(
args: PutObjectLegalHoldCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutObjectLegalHoldCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutObjectLockConfigurationCommand}
*/
putObjectLockConfiguration(
args: PutObjectLockConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutObjectLockConfigurationCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutObjectRetentionCommand}
*/
putObjectRetention(
args: PutObjectRetentionCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutObjectRetentionCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutObjectTaggingCommand}
*/
putObjectTagging(
args: PutObjectTaggingCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutObjectTaggingCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link PutPublicAccessBlockCommand}
*/
putPublicAccessBlock(
args: PutPublicAccessBlockCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutPublicAccessBlockCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link RenameObjectCommand}
*/
renameObject(
args: RenameObjectCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<RenameObjectCommandOutput, Cause.TimeoutError | SdkError | IdempotencyParameterMismatchError>
/**
* @see {@link RestoreObjectCommand}
*/
restoreObject(
args: RestoreObjectCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<RestoreObjectCommandOutput, Cause.TimeoutError | SdkError | ObjectAlreadyInActiveTierError>
/**
* @see {@link SelectObjectContentCommand}
*/
selectObjectContent(
args: SelectObjectContentCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<SelectObjectContentCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link UpdateBucketMetadataAnnotationTableConfigurationCommand}
*/
updateBucketMetadataAnnotationTableConfiguration(
args: UpdateBucketMetadataAnnotationTableConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
UpdateBucketMetadataAnnotationTableConfigurationCommandOutput,
Cause.TimeoutError | SdkError | S3ServiceError
>
/**
* @see {@link UpdateBucketMetadataInventoryTableConfigurationCommand}
*/
updateBucketMetadataInventoryTableConfiguration(
args: UpdateBucketMetadataInventoryTableConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
UpdateBucketMetadataInventoryTableConfigurationCommandOutput,
Cause.TimeoutError | SdkError | S3ServiceError
>
/**
* @see {@link UpdateBucketMetadataJournalTableConfigurationCommand}
*/
updateBucketMetadataJournalTableConfiguration(
args: UpdateBucketMetadataJournalTableConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
UpdateBucketMetadataJournalTableConfigurationCommandOutput,
Cause.TimeoutError | SdkError | S3ServiceError
>
/**
* @see {@link UpdateObjectEncryptionCommand}
*/
updateObjectEncryption(
args: UpdateObjectEncryptionCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
UpdateObjectEncryptionCommandOutput,
Cause.TimeoutError | SdkError | AccessDeniedError | InvalidRequestError | NoSuchKeyError
>
/**
* @see {@link UploadPartCommand}
*/
uploadPart(
args: UploadPartCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<UploadPartCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link UploadPartCopyCommand}
*/
uploadPartCopy(
args: UploadPartCopyCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<UploadPartCopyCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
/**
* @see {@link WriteGetObjectResponseCommand}
*/
writeGetObjectResponse(
args: WriteGetObjectResponseCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<WriteGetObjectResponseCommandOutput, Cause.TimeoutError | SdkError | S3ServiceError>
}
Added in v1.0.0
utils
S3Service (namespace)
Added in v1.0.0
Config (interface)
Signature
export interface Config extends Omit<S3ClientConfig, "logger"> {
readonly logger?: ServiceLogger.ServiceLoggerConstructorProps | true
}
Added in v1.0.0
Type (type alias)
Signature
export type Type = S3Service$
Added in v1.0.0