@datafire/amazonaws_s3

5.0.0 • Public • Published

@datafire/amazonaws_s3

Client library for Amazon Simple Storage Service

Installation and Usage

npm install --save @datafire/amazonaws_s3
let amazonaws_s3 = require('@datafire/amazonaws_s3').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_s3.ListBuckets({}).then(data => {
  console.log(data);
});

Description

Actions

ListBuckets

amazonaws_s3.ListBuckets({}, context)

Input

  • input object

Output

DeleteBucket

amazonaws_s3.DeleteBucket({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

Output schema unknown

CreateBucket

amazonaws_s3.CreateBucket({
  "Bucket": ""
}, context)

Input

Output

HeadBucket

amazonaws_s3.HeadBucket({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

Output schema unknown

ListObjects

amazonaws_s3.ListObjects({
  "Bucket": ""
}, context)

Input

  • input object
    • MaxKeys string
    • Marker string
    • Bucket required string

Output

AbortMultipartUpload

amazonaws_s3.AbortMultipartUpload({
  "Bucket": "",
  "Key": []
}, context)

Input

  • input object
    • Bucket required string
    • Key required array

Output

CompleteMultipartUpload

amazonaws_s3.CompleteMultipartUpload({
  "Bucket": "",
  "Key": []
}, context)

Input

Output

CopyObject

amazonaws_s3.CopyObject({
  "Bucket": "",
  "Key": []
}, context)

Input

  • input object
    • Bucket required string
    • Key required array

Output

DeleteObject

amazonaws_s3.DeleteObject({
  "Bucket": "",
  "Key": ""
}, context)

Input

  • input object
    • Bucket required string
    • Key required string

Output

GetObject

amazonaws_s3.GetObject({
  "Bucket": "",
  "Key": ""
}, context)

Input

  • input object
    • Bucket required string
    • Key required string

Output

HeadObject

amazonaws_s3.HeadObject({
  "Bucket": "",
  "Key": ""
}, context)

Input

  • input object
    • Bucket required string
    • Key required string

Output

ListParts

amazonaws_s3.ListParts({
  "Bucket": "",
  "Key": ""
}, context)

Input

  • input object
    • MaxParts string
    • PartNumberMarker string
    • Bucket required string
    • Key required string

Output

PutObject

amazonaws_s3.PutObject({
  "Bucket": "",
  "Key": ""
}, context)

Input

  • input object
    • Bucket required string
    • Key required string
    • Body Body

Output

UploadPart

amazonaws_s3.UploadPart({
  "Bucket": "",
  "Key": ""
}, context)

Input

  • input object
    • Bucket required string
    • Key required string
    • Body Body

Output

UploadPartCopy

amazonaws_s3.UploadPartCopy({
  "Bucket": "",
  "Key": ""
}, context)

Input

  • input object
    • Bucket required string
    • Key required string

Output

GetObjectAcl

amazonaws_s3.GetObjectAcl({
  "Bucket": "",
  "Key": ""
}, context)

Input

  • input object
    • Bucket required string
    • Key required string

Output

PutObjectAcl

amazonaws_s3.PutObjectAcl({
  "Bucket": "",
  "Key": ""
}, context)

Input

  • input object

Output

RestoreObject

amazonaws_s3.RestoreObject({
  "Bucket": "",
  "Key": ""
}, context)

Input

  • input object
    • Bucket required string
    • Key required string
    • RestoreRequest RestoreRequest

Output

DeleteObjectTagging

amazonaws_s3.DeleteObjectTagging({
  "Bucket": "",
  "Key": ""
}, context)

Input

  • input object
    • Bucket required string
    • Key required string

Output

GetObjectTagging

amazonaws_s3.GetObjectTagging({
  "Bucket": "",
  "Key": ""
}, context)

Input

  • input object
    • Bucket required string
    • Key required string

Output

PutObjectTagging

amazonaws_s3.PutObjectTagging({
  "Bucket": "",
  "Key": "",
  "Tagging": {
    "TagSet": []
  }
}, context)

Input

  • input object
    • Bucket required string
    • Key required string
    • Tagging required Tagging

Output

GetObjectTorrent

amazonaws_s3.GetObjectTorrent({
  "Bucket": "",
  "Key": ""
}, context)

Input

  • input object
    • Bucket required string
    • Key required string

Output

CreateMultipartUpload

amazonaws_s3.CreateMultipartUpload({
  "Bucket": "",
  "Key": []
}, context)

Input

  • input object
    • Bucket required string
    • Key required array

Output

GetBucketAccelerateConfiguration

amazonaws_s3.GetBucketAccelerateConfiguration({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

PutBucketAccelerateConfiguration

amazonaws_s3.PutBucketAccelerateConfiguration({
  "Bucket": "",
  "AccelerateConfiguration": {}
}, context)

Input

Output

Output schema unknown

GetBucketAcl

amazonaws_s3.GetBucketAcl({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

PutBucketAcl

amazonaws_s3.PutBucketAcl({
  "Bucket": ""
}, context)

Input

Output

Output schema unknown

DeleteBucketAnalyticsConfiguration

amazonaws_s3.DeleteBucketAnalyticsConfiguration({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

Output schema unknown

GetBucketAnalyticsConfiguration

amazonaws_s3.GetBucketAnalyticsConfiguration({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

ListBucketAnalyticsConfigurations

amazonaws_s3.ListBucketAnalyticsConfigurations({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

PutBucketAnalyticsConfiguration

amazonaws_s3.PutBucketAnalyticsConfiguration({
  "Bucket": "",
  "AnalyticsConfiguration": {
    "Id": "",
    "StorageClassAnalysis": {}
  }
}, context)

Input

Output

Output schema unknown

DeleteBucketCors

amazonaws_s3.DeleteBucketCors({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

Output schema unknown

GetBucketCors

amazonaws_s3.GetBucketCors({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

PutBucketCors

amazonaws_s3.PutBucketCors({
  "Bucket": "",
  "CORSConfiguration": {
    "CORSRules": []
  }
}, context)

Input

Output

Output schema unknown

DeleteObjects

amazonaws_s3.DeleteObjects({
  "Bucket": "",
  "Delete": {
    "Objects": []
  }
}, context)

Input

  • input object
    • Bucket required string
    • Delete required Delete

Output

DeleteBucketEncryption

amazonaws_s3.DeleteBucketEncryption({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

Output schema unknown

GetBucketEncryption

amazonaws_s3.GetBucketEncryption({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

PutBucketEncryption

amazonaws_s3.PutBucketEncryption({
  "Bucket": "",
  "ServerSideEncryptionConfiguration": {
    "Rules": []
  }
}, context)

Input

Output

Output schema unknown

DeleteBucketInventoryConfiguration

amazonaws_s3.DeleteBucketInventoryConfiguration({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

Output schema unknown

GetBucketInventoryConfiguration

amazonaws_s3.GetBucketInventoryConfiguration({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

ListBucketInventoryConfigurations

amazonaws_s3.ListBucketInventoryConfigurations({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

PutBucketInventoryConfiguration

amazonaws_s3.PutBucketInventoryConfiguration({
  "Bucket": "",
  "InventoryConfiguration": {
    "Destination": {
      "S3BucketDestination": {
        "Bucket": "",
        "Format": ""
      }
    },
    "IsEnabled": true,
    "Id": "",
    "IncludedObjectVersions": "",
    "Schedule": {
      "Frequency": ""
    }
  }
}, context)

Input

Output

Output schema unknown

DeleteBucketLifecycle

amazonaws_s3.DeleteBucketLifecycle({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

Output schema unknown

GetBucketLifecycle

amazonaws_s3.GetBucketLifecycle({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

GetBucketLifecycleConfiguration

amazonaws_s3.GetBucketLifecycleConfiguration({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

PutBucketLifecycle

amazonaws_s3.PutBucketLifecycle({
  "Bucket": ""
}, context)

Input

Output

Output schema unknown

PutBucketLifecycleConfiguration

amazonaws_s3.PutBucketLifecycleConfiguration({
  "Bucket": ""
}, context)

Input

Output

Output schema unknown

ListObjectsV2

amazonaws_s3.ListObjectsV2({
  "Bucket": ""
}, context)

Input

  • input object
    • MaxKeys string
    • ContinuationToken string
    • Bucket required string

Output

GetBucketLocation

amazonaws_s3.GetBucketLocation({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

GetBucketLogging

amazonaws_s3.GetBucketLogging({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

PutBucketLogging

amazonaws_s3.PutBucketLogging({
  "Bucket": "",
  "BucketLoggingStatus": {}
}, context)

Input

Output

Output schema unknown

DeleteBucketMetricsConfiguration

amazonaws_s3.DeleteBucketMetricsConfiguration({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

Output schema unknown

GetBucketMetricsConfiguration

amazonaws_s3.GetBucketMetricsConfiguration({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

ListBucketMetricsConfigurations

amazonaws_s3.ListBucketMetricsConfigurations({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

PutBucketMetricsConfiguration

amazonaws_s3.PutBucketMetricsConfiguration({
  "Bucket": "",
  "MetricsConfiguration": {
    "Id": ""
  }
}, context)

Input

Output

Output schema unknown

GetBucketNotification

amazonaws_s3.GetBucketNotification({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

GetBucketNotificationConfiguration

amazonaws_s3.GetBucketNotificationConfiguration({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

PutBucketNotification

amazonaws_s3.PutBucketNotification({
  "Bucket": "",
  "NotificationConfiguration": {}
}, context)

Input

Output

Output schema unknown

PutBucketNotificationConfiguration

amazonaws_s3.PutBucketNotificationConfiguration({
  "Bucket": "",
  "NotificationConfiguration": {}
}, context)

Input

Output

Output schema unknown

DeleteBucketPolicy

amazonaws_s3.DeleteBucketPolicy({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

Output schema unknown

GetBucketPolicy

amazonaws_s3.GetBucketPolicy({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

PutBucketPolicy

amazonaws_s3.PutBucketPolicy({
  "Bucket": "",
  "Policy": ""
}, context)

Input

  • input object
    • Bucket required string
    • Policy required Policy

Output

Output schema unknown

DeleteBucketReplication

amazonaws_s3.DeleteBucketReplication({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

Output schema unknown

GetBucketReplication

amazonaws_s3.GetBucketReplication({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

PutBucketReplication

amazonaws_s3.PutBucketReplication({
  "Bucket": "",
  "ReplicationConfiguration": {
    "Role": "",
    "Rules": []
  }
}, context)

Input

Output

Output schema unknown

GetBucketRequestPayment

amazonaws_s3.GetBucketRequestPayment({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

PutBucketRequestPayment

amazonaws_s3.PutBucketRequestPayment({
  "Bucket": "",
  "RequestPaymentConfiguration": {
    "Payer": ""
  }
}, context)

Input

Output

Output schema unknown

DeleteBucketTagging

amazonaws_s3.DeleteBucketTagging({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

Output schema unknown

GetBucketTagging

amazonaws_s3.GetBucketTagging({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

PutBucketTagging

amazonaws_s3.PutBucketTagging({
  "Bucket": "",
  "Tagging": {
    "TagSet": []
  }
}, context)

Input

  • input object
    • Bucket required string
    • Tagging required Tagging

Output

Output schema unknown

ListMultipartUploads

amazonaws_s3.ListMultipartUploads({
  "Bucket": ""
}, context)

Input

  • input object
    • MaxUploads string
    • KeyMarker string
    • UploadIdMarker string
    • Bucket required string

Output

GetBucketVersioning

amazonaws_s3.GetBucketVersioning({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

PutBucketVersioning

amazonaws_s3.PutBucketVersioning({
  "Bucket": "",
  "VersioningConfiguration": {}
}, context)

Input

Output

Output schema unknown

ListObjectVersions

amazonaws_s3.ListObjectVersions({
  "Bucket": ""
}, context)

Input

  • input object
    • MaxKeys string
    • KeyMarker string
    • VersionIdMarker string
    • Bucket required string

Output

DeleteBucketWebsite

amazonaws_s3.DeleteBucketWebsite({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

Output schema unknown

GetBucketWebsite

amazonaws_s3.GetBucketWebsite({
  "Bucket": ""
}, context)

Input

  • input object
    • Bucket required string

Output

PutBucketWebsite

amazonaws_s3.PutBucketWebsite({
  "Bucket": "",
  "WebsiteConfiguration": {}
}, context)

Input

Output

Output schema unknown

Definitions

AbortDate

  • AbortDate string

AbortIncompleteMultipartUpload

  • AbortIncompleteMultipartUpload object: Specifies the days since the initiation of an Incomplete Multipart Upload that Lifecycle will wait before permanently removing all parts of the upload.

AbortMultipartUploadOutput

  • AbortMultipartUploadOutput object

AbortMultipartUploadRequest

  • AbortMultipartUploadRequest object

AbortRuleId

  • AbortRuleId string

AccelerateConfiguration

AcceptRanges

  • AcceptRanges string

AccessControlPolicy

AccessControlTranslation

  • AccessControlTranslation object: Container for information regarding the access control for replicas.

AccountId

  • AccountId string

AllowedHeader

  • AllowedHeader string

AllowedHeaders

AllowedMethod

  • AllowedMethod string

AllowedMethods

AllowedOrigin

  • AllowedOrigin string

AllowedOrigins

AnalyticsAndOperator

AnalyticsConfiguration

AnalyticsConfigurationList

AnalyticsExportDestination

AnalyticsFilter

AnalyticsId

  • AnalyticsId string

AnalyticsS3BucketDestination

AnalyticsS3ExportFileFormat

  • AnalyticsS3ExportFileFormat string (values: CSV)

Body

  • Body string

Bucket

BucketAccelerateStatus

  • BucketAccelerateStatus string (values: Enabled, Suspended)

BucketAlreadyExists

  • BucketAlreadyExists object: The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.

BucketAlreadyOwnedByYou

  • BucketAlreadyOwnedByYou object

BucketCannedACL

  • BucketCannedACL string (values: private, public-read, public-read-write, authenticated-read)

BucketLifecycleConfiguration

BucketLocationConstraint

  • BucketLocationConstraint string (values: EU, eu-west-1, us-west-1, us-west-2, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1, cn-north-1, eu-central-1)

BucketLoggingStatus

BucketLogsPermission

  • BucketLogsPermission string (values: FULL_CONTROL, READ, WRITE)

BucketName

  • BucketName string

BucketVersioningStatus

  • BucketVersioningStatus string (values: Enabled, Suspended)

Buckets

CORSConfiguration

  • CORSConfiguration object

CORSRule

CORSRules

CSVInput

CSVOutput

CacheControl

  • CacheControl string

CloudFunction

  • CloudFunction string

CloudFunctionConfiguration

CloudFunctionInvocationRole

  • CloudFunctionInvocationRole string

Code

  • Code string

Comments

  • Comments string

CommonPrefix

  • CommonPrefix object

CommonPrefixList

CompleteMultipartUploadOutput

CompleteMultipartUploadRequest

CompletedMultipartUpload

CompletedPart

CompletedPartList

Condition

ConfirmRemoveSelfBucketAccess

  • ConfirmRemoveSelfBucketAccess boolean

ContentDisposition

  • ContentDisposition string

ContentEncoding

  • ContentEncoding string

ContentLanguage

  • ContentLanguage string

ContentLength

  • ContentLength integer

ContentMD5

  • ContentMD5 string

ContentRange

  • ContentRange string

ContentType

  • ContentType string

CopyObjectOutput

CopyObjectRequest

  • CopyObjectRequest object

CopyObjectResult

CopyPartResult

CopySource

  • CopySource string

CopySourceIfMatch

  • CopySourceIfMatch string

CopySourceIfModifiedSince

  • CopySourceIfModifiedSince string

CopySourceIfNoneMatch

  • CopySourceIfNoneMatch string

CopySourceIfUnmodifiedSince

  • CopySourceIfUnmodifiedSince string

CopySourceRange

  • CopySourceRange string

CopySourceSSECustomerAlgorithm

  • CopySourceSSECustomerAlgorithm string

CopySourceSSECustomerKey

  • CopySourceSSECustomerKey string

CopySourceSSECustomerKeyMD5

  • CopySourceSSECustomerKeyMD5 string

CopySourceVersionId

  • CopySourceVersionId string

CreateBucketConfiguration

CreateBucketOutput

  • CreateBucketOutput object

CreateBucketRequest

CreateMultipartUploadOutput

CreateMultipartUploadRequest

  • CreateMultipartUploadRequest object

CreationDate

  • CreationDate string

Date

  • Date string

Days

  • Days integer

DaysAfterInitiation

  • DaysAfterInitiation integer

Delete

DeleteBucketAnalyticsConfigurationRequest

  • DeleteBucketAnalyticsConfigurationRequest object

DeleteBucketCorsRequest

  • DeleteBucketCorsRequest object

DeleteBucketEncryptionRequest

  • DeleteBucketEncryptionRequest object

DeleteBucketInventoryConfigurationRequest

  • DeleteBucketInventoryConfigurationRequest object

DeleteBucketLifecycleRequest

  • DeleteBucketLifecycleRequest object

DeleteBucketMetricsConfigurationRequest

  • DeleteBucketMetricsConfigurationRequest object

DeleteBucketPolicyRequest

  • DeleteBucketPolicyRequest object

DeleteBucketReplicationRequest

  • DeleteBucketReplicationRequest object

DeleteBucketRequest

  • DeleteBucketRequest object

DeleteBucketTaggingRequest

  • DeleteBucketTaggingRequest object

DeleteBucketWebsiteRequest

  • DeleteBucketWebsiteRequest object

DeleteMarker

  • DeleteMarker boolean

DeleteMarkerEntry

DeleteMarkerVersionId

  • DeleteMarkerVersionId string

DeleteMarkers

DeleteObjectOutput

  • DeleteObjectOutput object

DeleteObjectRequest

  • DeleteObjectRequest object

DeleteObjectTaggingOutput

  • DeleteObjectTaggingOutput object

DeleteObjectTaggingRequest

  • DeleteObjectTaggingRequest object

DeleteObjectsOutput

DeleteObjectsRequest

  • DeleteObjectsRequest object

DeletedObject

DeletedObjects

Delimiter

  • Delimiter string

Description

  • Description string

Destination

DisplayName

  • DisplayName string

ETag

  • ETag string

EmailAddress

  • EmailAddress string

EncodingType

  • EncodingType string (values: url): Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

Encryption

EncryptionConfiguration

  • EncryptionConfiguration object: Container for information regarding encryption based configuration for replicas.

Error

ErrorDocument

  • ErrorDocument object

Errors

  • Errors array

Event

  • Event string (values: s3:ReducedRedundancyLostObject, s3:ObjectCreated:, s3:ObjectCreated:Put, s3:ObjectCreated:Post, s3:ObjectCreated:Copy, s3:ObjectCreated:CompleteMultipartUpload, s3:ObjectRemoved:, s3:ObjectRemoved:Delete, s3:ObjectRemoved:DeleteMarkerCreated): Bucket event for which to send notifications.

EventList

  • EventList array

Expiration

  • Expiration string

ExpirationStatus

  • ExpirationStatus string (values: Enabled, Disabled)

ExpiredObjectDeleteMarker

  • ExpiredObjectDeleteMarker boolean

Expires

  • Expires string

ExposeHeader

  • ExposeHeader string

ExposeHeaders

Expression

  • Expression string

ExpressionType

  • ExpressionType string (values: SQL)

FetchOwner

  • FetchOwner boolean

FieldDelimiter

  • FieldDelimiter string

FileHeaderInfo

  • FileHeaderInfo string (values: USE, IGNORE, NONE)

FilterRule

FilterRuleList

  • FilterRuleList array: A list of containers for key value pair that defines the criteria for the filter rule.

FilterRuleName

  • FilterRuleName string (values: prefix, suffix)

FilterRuleValue

  • FilterRuleValue string

GetBucketAccelerateConfigurationOutput

GetBucketAccelerateConfigurationRequest

  • GetBucketAccelerateConfigurationRequest object

GetBucketAclOutput

GetBucketAclRequest

  • GetBucketAclRequest object

GetBucketAnalyticsConfigurationOutput

GetBucketAnalyticsConfigurationRequest

  • GetBucketAnalyticsConfigurationRequest object

GetBucketCorsOutput

  • GetBucketCorsOutput object

GetBucketCorsRequest

  • GetBucketCorsRequest object

GetBucketEncryptionOutput

GetBucketEncryptionRequest

  • GetBucketEncryptionRequest object

GetBucketInventoryConfigurationOutput

GetBucketInventoryConfigurationRequest

  • GetBucketInventoryConfigurationRequest object

GetBucketLifecycleConfigurationOutput

GetBucketLifecycleConfigurationRequest

  • GetBucketLifecycleConfigurationRequest object

GetBucketLifecycleOutput

  • GetBucketLifecycleOutput object

GetBucketLifecycleRequest

  • GetBucketLifecycleRequest object

GetBucketLocationOutput

GetBucketLocationRequest

  • GetBucketLocationRequest object

GetBucketLoggingOutput

GetBucketLoggingRequest

  • GetBucketLoggingRequest object

GetBucketMetricsConfigurationOutput

GetBucketMetricsConfigurationRequest

  • GetBucketMetricsConfigurationRequest object

GetBucketNotificationConfigurationRequest

  • GetBucketNotificationConfigurationRequest object

GetBucketPolicyOutput

  • GetBucketPolicyOutput object

GetBucketPolicyRequest

  • GetBucketPolicyRequest object

GetBucketReplicationOutput

GetBucketReplicationRequest

  • GetBucketReplicationRequest object

GetBucketRequestPaymentOutput

  • GetBucketRequestPaymentOutput object

GetBucketRequestPaymentRequest

  • GetBucketRequestPaymentRequest object

GetBucketTaggingOutput

  • GetBucketTaggingOutput object

GetBucketTaggingRequest

  • GetBucketTaggingRequest object

GetBucketVersioningOutput

GetBucketVersioningRequest

  • GetBucketVersioningRequest object

GetBucketWebsiteOutput

GetBucketWebsiteRequest

  • GetBucketWebsiteRequest object

GetObjectAclOutput

GetObjectAclRequest

  • GetObjectAclRequest object

GetObjectOutput

  • GetObjectOutput object

GetObjectRequest

  • GetObjectRequest object

GetObjectTaggingOutput

  • GetObjectTaggingOutput object

GetObjectTaggingRequest

  • GetObjectTaggingRequest object

GetObjectTorrentOutput

  • GetObjectTorrentOutput object

GetObjectTorrentRequest

  • GetObjectTorrentRequest object

GlacierJobParameters

  • GlacierJobParameters object
    • Tier required Tier

Grant

GrantFullControl

  • GrantFullControl string

GrantRead

  • GrantRead string

GrantReadACP

  • GrantReadACP string

GrantWrite

  • GrantWrite string

GrantWriteACP

  • GrantWriteACP string

Grantee

Grants

  • Grants array

HeadBucketRequest

  • HeadBucketRequest object

HeadObjectOutput

  • HeadObjectOutput object

HeadObjectRequest

  • HeadObjectRequest object

HostName

  • HostName string

HttpErrorCodeReturnedEquals

  • HttpErrorCodeReturnedEquals string

HttpRedirectCode

  • HttpRedirectCode string

ID

  • ID string

IfMatch

  • IfMatch string

IfModifiedSince

  • IfModifiedSince string

IfNoneMatch

  • IfNoneMatch string

IfUnmodifiedSince

  • IfUnmodifiedSince string

IndexDocument

  • IndexDocument object

Initiated

  • Initiated string

Initiator

InputSerialization

  • InputSerialization object: Describes the serialization format of the object.

InventoryConfiguration

InventoryConfigurationList

InventoryDestination

InventoryEncryption

  • InventoryEncryption object: Contains the type of server-side encryption used to encrypt the inventory results.

InventoryFilter

  • InventoryFilter object

InventoryFormat

  • InventoryFormat string (values: CSV, ORC)

InventoryFrequency

  • InventoryFrequency string (values: Daily, Weekly)

InventoryId

  • InventoryId string

InventoryIncludedObjectVersions

  • InventoryIncludedObjectVersions string (values: All, Current)

InventoryOptionalField

  • InventoryOptionalField string (values: Size, LastModifiedDate, StorageClass, ETag, IsMultipartUploaded, ReplicationStatus, EncryptionStatus)

InventoryOptionalFields

InventoryS3BucketDestination

InventorySchedule

IsEnabled

  • IsEnabled boolean

IsLatest

  • IsLatest boolean

IsTruncated

  • IsTruncated boolean

KMSContext

  • KMSContext string

KeyCount

  • KeyCount integer

KeyMarker

  • KeyMarker string

KeyPrefixEquals

  • KeyPrefixEquals string

LambdaFunctionArn

  • LambdaFunctionArn string

LambdaFunctionConfiguration

LambdaFunctionConfigurationList

LastModified

  • LastModified string

LifecycleConfiguration

  • LifecycleConfiguration object

LifecycleExpiration

LifecycleRule

LifecycleRuleAndOperator

  • LifecycleRuleAndOperator object: This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.

LifecycleRuleFilter

  • LifecycleRuleFilter object: The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified.

LifecycleRules

ListBucketAnalyticsConfigurationsOutput

ListBucketAnalyticsConfigurationsRequest

  • ListBucketAnalyticsConfigurationsRequest object

ListBucketInventoryConfigurationsOutput

ListBucketInventoryConfigurationsRequest

  • ListBucketInventoryConfigurationsRequest object

ListBucketMetricsConfigurationsOutput

ListBucketMetricsConfigurationsRequest

  • ListBucketMetricsConfigurationsRequest object

ListBucketsOutput

ListMultipartUploadsOutput

ListMultipartUploadsRequest

  • ListMultipartUploadsRequest object

ListObjectVersionsOutput

ListObjectVersionsRequest

  • ListObjectVersionsRequest object

ListObjectsOutput

ListObjectsRequest

  • ListObjectsRequest object

ListObjectsV2Output

ListObjectsV2Request

  • ListObjectsV2Request object

ListPartsOutput

ListPartsRequest

  • ListPartsRequest object

Location

  • Location string

LocationPrefix

  • LocationPrefix string

LoggingEnabled

MFA

  • MFA string

MFADelete

  • MFADelete string (values: Enabled, Disabled)

MFADeleteStatus

  • MFADeleteStatus string (values: Enabled, Disabled)

Marker

  • Marker string

MaxAgeSeconds

  • MaxAgeSeconds integer

MaxKeys

  • MaxKeys integer

MaxParts

  • MaxParts integer

MaxUploads

  • MaxUploads integer

Message

  • Message string

Metadata

MetadataDirective

  • MetadataDirective string (values: COPY, REPLACE)

MetadataEntry

MetadataKey

  • MetadataKey string

MetadataValue

  • MetadataValue string

MetricsAndOperator

MetricsConfiguration

MetricsConfigurationList

MetricsFilter

MetricsId

  • MetricsId string

MissingMeta

  • MissingMeta integer

MultipartUpload

MultipartUploadId

  • MultipartUploadId string

MultipartUploadList

NextKeyMarker

  • NextKeyMarker string

NextMarker

  • NextMarker string

NextPartNumberMarker

  • NextPartNumberMarker integer

NextToken

  • NextToken string

NextUploadIdMarker

  • NextUploadIdMarker string

NextVersionIdMarker

  • NextVersionIdMarker string

NoSuchBucket

  • NoSuchBucket object: The specified bucket does not exist.

NoSuchKey

  • NoSuchKey object: The specified key does not exist.

NoSuchUpload

  • NoSuchUpload object: The specified multipart upload does not exist.

NoncurrentVersionExpiration

  • NoncurrentVersionExpiration object: Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.
    • NoncurrentDays Days

NoncurrentVersionTransition

  • NoncurrentVersionTransition object: Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA or GLACIER 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 the STANDARD_IA or GLACIER storage class at a specific period in the object's lifetime.

NoncurrentVersionTransitionList

NotificationConfiguration

NotificationConfigurationDeprecated

NotificationConfigurationFilter

  • NotificationConfigurationFilter object: Container for object key name filtering rules. For information about key name filtering, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.

NotificationId

  • NotificationId string: Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

Object

ObjectAlreadyInActiveTierError

  • ObjectAlreadyInActiveTierError object: This operation is not allowed against this storage tier

ObjectCannedACL

  • ObjectCannedACL string (values: private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control)

ObjectIdentifier

ObjectIdentifierList

ObjectKey

  • ObjectKey string

ObjectList

  • ObjectList array

ObjectNotInActiveTierError

  • ObjectNotInActiveTierError object: The source object of the COPY operation is not in the active tier and is only stored in Amazon Glacier.

ObjectStorageClass

  • ObjectStorageClass string (values: STANDARD, REDUCED_REDUNDANCY, GLACIER)

ObjectVersion

ObjectVersionId

  • ObjectVersionId string

ObjectVersionList

ObjectVersionStorageClass

  • ObjectVersionStorageClass string (values: STANDARD)

OutputLocation

  • OutputLocation object: Describes the location where the restore job's output is stored.

OutputSerialization

  • OutputSerialization object: Describes how results of the Select job are serialized.

Owner

OwnerOverride

  • OwnerOverride string (values: Destination)

Part

PartNumber

  • PartNumber integer

PartNumberMarker

  • PartNumberMarker integer

Parts

  • Parts array

PartsCount

  • PartsCount integer

Payer

  • Payer string (values: Requester, BucketOwner)

Permission

  • Permission string (values: FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP)

Policy

  • Policy string

Prefix

  • Prefix string

Protocol

  • Protocol string (values: http, https)

PutBucketAccelerateConfigurationRequest

PutBucketAclRequest

PutBucketAnalyticsConfigurationRequest

PutBucketCorsRequest

PutBucketEncryptionRequest

PutBucketInventoryConfigurationRequest

PutBucketLifecycleConfigurationRequest

PutBucketLifecycleRequest

PutBucketLoggingRequest

PutBucketMetricsConfigurationRequest

PutBucketNotificationConfigurationRequest

PutBucketNotificationRequest

PutBucketPolicyRequest

  • PutBucketPolicyRequest object

PutBucketReplicationRequest

PutBucketRequestPaymentRequest

PutBucketTaggingRequest

  • PutBucketTaggingRequest object

PutBucketVersioningRequest

PutBucketWebsiteRequest

PutObjectAclOutput

  • PutObjectAclOutput object

PutObjectAclRequest

PutObjectOutput

  • PutObjectOutput object

PutObjectRequest

  • PutObjectRequest object

PutObjectTaggingOutput

  • PutObjectTaggingOutput object

PutObjectTaggingRequest

  • PutObjectTaggingRequest object

QueueArn

  • QueueArn string

QueueConfiguration

QueueConfigurationDeprecated

QueueConfigurationList

Quiet

  • Quiet boolean

QuoteCharacter

  • QuoteCharacter string

QuoteEscapeCharacter

  • QuoteEscapeCharacter string

QuoteFields

  • QuoteFields string (values: ALWAYS, ASNEEDED)

Range

  • Range string

RecordDelimiter

  • RecordDelimiter string

Redirect

RedirectAllRequestsTo

ReplaceKeyPrefixWith

  • ReplaceKeyPrefixWith string

ReplaceKeyWith

  • ReplaceKeyWith string

ReplicaKmsKeyID

  • ReplicaKmsKeyID string

ReplicationConfiguration

  • ReplicationConfiguration object: Container for replication rules. You can add as many as 1,000 rules. Total replication configuration size can be up to 2 MB.

ReplicationRule

ReplicationRuleStatus

  • ReplicationRuleStatus string (values: Enabled, Disabled)

ReplicationRules

ReplicationStatus

  • ReplicationStatus string (values: COMPLETE, PENDING, FAILED, REPLICA)

RequestCharged

  • RequestCharged string (values: requester): If present, indicates that the requester was successfully charged for the request.

RequestPayer

RequestPaymentConfiguration

  • RequestPaymentConfiguration object

ResponseCacheControl

  • ResponseCacheControl string

ResponseContentDisposition

  • ResponseContentDisposition string

ResponseContentEncoding

  • ResponseContentEncoding string

ResponseContentLanguage

  • ResponseContentLanguage string

ResponseContentType

  • ResponseContentType string

ResponseExpires

  • ResponseExpires string

Restore

  • Restore string

RestoreObjectOutput

  • RestoreObjectOutput object

RestoreObjectRequest

RestoreOutputPath

  • RestoreOutputPath string

RestoreRequest

RestoreRequestType

  • RestoreRequestType string (values: SELECT)

Role

  • Role string

RoutingRule

RoutingRules

Rule

Rules

  • Rules array

S3KeyFilter

  • S3KeyFilter object: Container for object key name prefix and suffix filtering rules.

S3Location

SSECustomerAlgorithm

  • SSECustomerAlgorithm string

SSECustomerKey

  • SSECustomerKey string

SSECustomerKeyMD5

  • SSECustomerKeyMD5 string

SSEKMS

  • SSEKMS object: Specifies the use of SSE-KMS to encrypt delievered Inventory reports.

SSEKMSKeyId

  • SSEKMSKeyId string

SSES3

  • SSES3 object: Specifies the use of SSE-S3 to encrypt delievered Inventory reports.

SelectParameters

ServerSideEncryption

  • ServerSideEncryption string (values: AES256, aws:kms)

ServerSideEncryptionByDefault

  • ServerSideEncryptionByDefault object: Describes the default server-side encryption to apply to new objects in the bucket. If Put Object request does not specify any server-side encryption, this default encryption will be applied.

ServerSideEncryptionConfiguration

  • ServerSideEncryptionConfiguration object: Container for server-side encryption configuration rules. Currently S3 supports one rule only.

ServerSideEncryptionRule

  • ServerSideEncryptionRule object: Container for information about a particular server-side encryption configuration rule.

ServerSideEncryptionRules

Size

  • Size integer

SourceSelectionCriteria

  • SourceSelectionCriteria object: Container for filters that define which source objects should be replicated.

SseKmsEncryptedObjects

  • SseKmsEncryptedObjects object: Container for filter information of selection of KMS Encrypted S3 objects.

SseKmsEncryptedObjectsStatus

  • SseKmsEncryptedObjectsStatus string (values: Enabled, Disabled)

StartAfter

  • StartAfter string

StorageClass

  • StorageClass string (values: STANDARD, REDUCED_REDUNDANCY, STANDARD_IA)

StorageClassAnalysis

StorageClassAnalysisDataExport

StorageClassAnalysisSchemaVersion

  • StorageClassAnalysisSchemaVersion string (values: V_1)

Suffix

  • Suffix string

Tag

TagCount

  • TagCount integer

TagSet

  • TagSet array

Tagging

  • Tagging object

TaggingDirective

  • TaggingDirective string (values: COPY, REPLACE)

TaggingHeader

  • TaggingHeader string

TargetBucket

  • TargetBucket string

TargetGrant

TargetGrants

TargetPrefix

  • TargetPrefix string

Tier

  • Tier string (values: Standard, Bulk, Expedited)

Token

  • Token string

TopicArn

  • TopicArn string

TopicConfiguration

TopicConfigurationDeprecated

TopicConfigurationList

Transition

TransitionList

TransitionStorageClass

  • TransitionStorageClass string (values: GLACIER, STANDARD_IA)

Type

  • Type string (values: CanonicalUser, AmazonCustomerByEmail, Group)

URI

  • URI string

UploadIdMarker

  • UploadIdMarker string

UploadPartCopyOutput

UploadPartCopyRequest

  • UploadPartCopyRequest object

UploadPartOutput

  • UploadPartOutput object

UploadPartRequest

  • UploadPartRequest object

UserMetadata

Value

  • Value string

VersionIdMarker

  • VersionIdMarker string

VersioningConfiguration

WebsiteConfiguration

WebsiteRedirectLocation

  • WebsiteRedirectLocation string

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/amazonaws_s3

Weekly Downloads

1

Version

5.0.0

License

MIT

Unpacked Size

301 kB

Total Files

5

Last publish

Collaborators

  • datafire