Class Buckets

Index

Constructors

constructor

Properties

config

Methods

checkBucketNameAvailability copyObject createBucket deleteBucket deleteObject deleteObjects describeBucket destroy getObject listBuckets listObjects putObject updateBucket

Constructors

constructor

new Buckets(configuration: BucketsClientConfig): Buckets
Parameters
- configuration: BucketsClientConfig
Returns Buckets
- Defined in clients/buckets/src/BucketsClient.ts:303

Properties

`Readonly` config

config: BucketsClientResolvedConfig

The resolved configuration of BucketsClient class. This is resolved and normalized from the constructor configuration interface.

Methods

checkBucketNameAvailability

checkBucketNameAvailability(args: CheckBucketNameAvailabilityCommandInput, options?: HttpHandlerOptions): Promise<CheckBucketNameAvailabilityCommandOutput>
See
CheckBucketNameAvailabilityCommand
Parameters
- args: CheckBucketNameAvailabilityCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<CheckBucketNameAvailabilityCommandOutput>
- Defined in clients/buckets/src/Buckets.ts:66
checkBucketNameAvailability(args: CheckBucketNameAvailabilityCommandInput, cb: ((err: any, data?: CheckBucketNameAvailabilityCommandOutput) => void)): void
Parameters
- args: CheckBucketNameAvailabilityCommandInput
- cb: ((err: any, data?: CheckBucketNameAvailabilityCommandOutput) => void)
  - - (err: any, data?: CheckBucketNameAvailabilityCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CheckBucketNameAvailabilityCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:70
checkBucketNameAvailability(args: CheckBucketNameAvailabilityCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: CheckBucketNameAvailabilityCommandOutput) => void)): void
Parameters
- args: CheckBucketNameAvailabilityCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: CheckBucketNameAvailabilityCommandOutput) => void)
  - - (err: any, data?: CheckBucketNameAvailabilityCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CheckBucketNameAvailabilityCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:74

copyObject

copyObject(args: CopyObjectCommandInput, options?: HttpHandlerOptions): Promise<CopyObjectCommandOutput>
See
CopyObjectCommand
Parameters
- args: CopyObjectCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<CopyObjectCommandOutput>
- Defined in clients/buckets/src/Buckets.ts:83
copyObject(args: CopyObjectCommandInput, cb: ((err: any, data?: CopyObjectCommandOutput) => void)): void
Parameters
- args: CopyObjectCommandInput
- cb: ((err: any, data?: CopyObjectCommandOutput) => void)
  - - (err: any, data?: CopyObjectCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CopyObjectCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:84
copyObject(args: CopyObjectCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: CopyObjectCommandOutput) => void)): void
Parameters
- args: CopyObjectCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: CopyObjectCommandOutput) => void)
  - - (err: any, data?: CopyObjectCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CopyObjectCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:85

createBucket

createBucket(args: CreateBucketCommandInput, options?: HttpHandlerOptions): Promise<CreateBucketCommandOutput>
See
CreateBucketCommand
Parameters
- args: CreateBucketCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<CreateBucketCommandOutput>
- Defined in clients/buckets/src/Buckets.ts:94
createBucket(args: CreateBucketCommandInput, cb: ((err: any, data?: CreateBucketCommandOutput) => void)): void
Parameters
- args: CreateBucketCommandInput
- cb: ((err: any, data?: CreateBucketCommandOutput) => void)
  - - (err: any, data?: CreateBucketCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateBucketCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:95
createBucket(args: CreateBucketCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: CreateBucketCommandOutput) => void)): void
Parameters
- args: CreateBucketCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: CreateBucketCommandOutput) => void)
  - - (err: any, data?: CreateBucketCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateBucketCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:96

deleteBucket

deleteBucket(args: DeleteBucketCommandInput, options?: HttpHandlerOptions): Promise<DeleteBucketCommandOutput>
See
DeleteBucketCommand
Parameters
- args: DeleteBucketCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteBucketCommandOutput>
- Defined in clients/buckets/src/Buckets.ts:105
deleteBucket(args: DeleteBucketCommandInput, cb: ((err: any, data?: DeleteBucketCommandOutput) => void)): void
Parameters
- args: DeleteBucketCommandInput
- cb: ((err: any, data?: DeleteBucketCommandOutput) => void)
  - - (err: any, data?: DeleteBucketCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteBucketCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:106
deleteBucket(args: DeleteBucketCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteBucketCommandOutput) => void)): void
Parameters
- args: DeleteBucketCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteBucketCommandOutput) => void)
  - - (err: any, data?: DeleteBucketCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteBucketCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:107

deleteObject

deleteObject(args: DeleteObjectCommandInput, options?: HttpHandlerOptions): Promise<DeleteObjectCommandOutput>
See
DeleteObjectCommand
Parameters
- args: DeleteObjectCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteObjectCommandOutput>
- Defined in clients/buckets/src/Buckets.ts:116
deleteObject(args: DeleteObjectCommandInput, cb: ((err: any, data?: DeleteObjectCommandOutput) => void)): void
Parameters
- args: DeleteObjectCommandInput
- cb: ((err: any, data?: DeleteObjectCommandOutput) => void)
  - - (err: any, data?: DeleteObjectCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteObjectCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:117
deleteObject(args: DeleteObjectCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteObjectCommandOutput) => void)): void
Parameters
- args: DeleteObjectCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteObjectCommandOutput) => void)
  - - (err: any, data?: DeleteObjectCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteObjectCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:118

deleteObjects

deleteObjects(args: DeleteObjectsCommandInput, options?: HttpHandlerOptions): Promise<DeleteObjectsCommandOutput>
See
DeleteObjectsCommand
Parameters
- args: DeleteObjectsCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteObjectsCommandOutput>
- Defined in clients/buckets/src/Buckets.ts:127
deleteObjects(args: DeleteObjectsCommandInput, cb: ((err: any, data?: DeleteObjectsCommandOutput) => void)): void
Parameters
- args: DeleteObjectsCommandInput
- cb: ((err: any, data?: DeleteObjectsCommandOutput) => void)
  - - (err: any, data?: DeleteObjectsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteObjectsCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:128
deleteObjects(args: DeleteObjectsCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteObjectsCommandOutput) => void)): void
Parameters
- args: DeleteObjectsCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteObjectsCommandOutput) => void)
  - - (err: any, data?: DeleteObjectsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteObjectsCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:129

describeBucket

describeBucket(args: DescribeBucketCommandInput, options?: HttpHandlerOptions): Promise<DescribeBucketCommandOutput>
See
DescribeBucketCommand
Parameters
- args: DescribeBucketCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeBucketCommandOutput>
- Defined in clients/buckets/src/Buckets.ts:138
describeBucket(args: DescribeBucketCommandInput, cb: ((err: any, data?: DescribeBucketCommandOutput) => void)): void
Parameters
- args: DescribeBucketCommandInput
- cb: ((err: any, data?: DescribeBucketCommandOutput) => void)
  - - (err: any, data?: DescribeBucketCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeBucketCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:142
describeBucket(args: DescribeBucketCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeBucketCommandOutput) => void)): void
Parameters
- args: DescribeBucketCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeBucketCommandOutput) => void)
  - - (err: any, data?: DescribeBucketCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeBucketCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:143

destroy

destroy(): void
Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

Returns void
- Defined in clients/buckets/src/BucketsClient.ts:329

getObject

getObject(args: GetObjectCommandInput, options?: HttpHandlerOptions): Promise<GetObjectCommandOutput>
See
GetObjectCommand
Parameters
- args: GetObjectCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<GetObjectCommandOutput>
- Defined in clients/buckets/src/Buckets.ts:152
getObject(args: GetObjectCommandInput, cb: ((err: any, data?: GetObjectCommandOutput) => void)): void
Parameters
- args: GetObjectCommandInput
- cb: ((err: any, data?: GetObjectCommandOutput) => void)
  - - (err: any, data?: GetObjectCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: GetObjectCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:153
getObject(args: GetObjectCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: GetObjectCommandOutput) => void)): void
Parameters
- args: GetObjectCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: GetObjectCommandOutput) => void)
  - - (err: any, data?: GetObjectCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: GetObjectCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:154

listBuckets

listBuckets(args: ListBucketsCommandInput, options?: HttpHandlerOptions): Promise<ListBucketsCommandOutput>
See
ListBucketsCommand
Parameters
- args: ListBucketsCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ListBucketsCommandOutput>
- Defined in clients/buckets/src/Buckets.ts:163
listBuckets(args: ListBucketsCommandInput, cb: ((err: any, data?: ListBucketsCommandOutput) => void)): void
Parameters
- args: ListBucketsCommandInput
- cb: ((err: any, data?: ListBucketsCommandOutput) => void)
  - - (err: any, data?: ListBucketsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListBucketsCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:164
listBuckets(args: ListBucketsCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ListBucketsCommandOutput) => void)): void
Parameters
- args: ListBucketsCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ListBucketsCommandOutput) => void)
  - - (err: any, data?: ListBucketsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListBucketsCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:165

listObjects

listObjects(args: ListObjectsCommandInput, options?: HttpHandlerOptions): Promise<ListObjectsCommandOutput>
See
ListObjectsCommand
Parameters
- args: ListObjectsCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ListObjectsCommandOutput>
- Defined in clients/buckets/src/Buckets.ts:174
listObjects(args: ListObjectsCommandInput, cb: ((err: any, data?: ListObjectsCommandOutput) => void)): void
Parameters
- args: ListObjectsCommandInput
- cb: ((err: any, data?: ListObjectsCommandOutput) => void)
  - - (err: any, data?: ListObjectsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListObjectsCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:175
listObjects(args: ListObjectsCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ListObjectsCommandOutput) => void)): void
Parameters
- args: ListObjectsCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ListObjectsCommandOutput) => void)
  - - (err: any, data?: ListObjectsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListObjectsCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:176

putObject

putObject(args: PutObjectCommandInput, options?: HttpHandlerOptions): Promise<PutObjectCommandOutput>
See
PutObjectCommand
Parameters
- args: PutObjectCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<PutObjectCommandOutput>
- Defined in clients/buckets/src/Buckets.ts:185
putObject(args: PutObjectCommandInput, cb: ((err: any, data?: PutObjectCommandOutput) => void)): void
Parameters
- args: PutObjectCommandInput
- cb: ((err: any, data?: PutObjectCommandOutput) => void)
  - - (err: any, data?: PutObjectCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: PutObjectCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:186
putObject(args: PutObjectCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: PutObjectCommandOutput) => void)): void
Parameters
- args: PutObjectCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: PutObjectCommandOutput) => void)
  - - (err: any, data?: PutObjectCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: PutObjectCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:187

updateBucket

updateBucket(args: UpdateBucketCommandInput, options?: HttpHandlerOptions): Promise<UpdateBucketCommandOutput>
See
UpdateBucketCommand
Parameters
- args: UpdateBucketCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<UpdateBucketCommandOutput>
- Defined in clients/buckets/src/Buckets.ts:196
updateBucket(args: UpdateBucketCommandInput, cb: ((err: any, data?: UpdateBucketCommandOutput) => void)): void
Parameters
- args: UpdateBucketCommandInput
- cb: ((err: any, data?: UpdateBucketCommandOutput) => void)
  - - (err: any, data?: UpdateBucketCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateBucketCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:197
updateBucket(args: UpdateBucketCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: UpdateBucketCommandOutput) => void)): void
Parameters
- args: UpdateBucketCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: UpdateBucketCommandOutput) => void)
  - - (err: any, data?: UpdateBucketCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateBucketCommandOutput
      
      Returns void
Returns void
- Defined in clients/buckets/src/Buckets.ts:198

Class Buckets

Hierarchy

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: BucketsClientConfig

Returns Buckets

Properties

Readonly config

Methods

checkBucketNameAvailability

See

Parameters

args: CheckBucketNameAvailabilityCommandInput

Optional options: HttpHandlerOptions

Returns Promise<CheckBucketNameAvailabilityCommandOutput>

Parameters

args: CheckBucketNameAvailabilityCommandInput

cb: ((err: any, data?: CheckBucketNameAvailabilityCommandOutput) => void)

Parameters

err: any

Optional data: CheckBucketNameAvailabilityCommandOutput

Returns void

Returns void

Parameters

args: CheckBucketNameAvailabilityCommandInput

options: HttpHandlerOptions

cb: ((err: any, data?: CheckBucketNameAvailabilityCommandOutput) => void)

Parameters

err: any

Optional data: CheckBucketNameAvailabilityCommandOutput

Returns void

Returns void

copyObject

See

Parameters

args: CopyObjectCommandInput

Optional options: HttpHandlerOptions

Returns Promise<CopyObjectCommandOutput>

Parameters

args: CopyObjectCommandInput

cb: ((err: any, data?: CopyObjectCommandOutput) => void)

Parameters

err: any

Optional data: CopyObjectCommandOutput

Returns void

Returns void

Parameters

args: CopyObjectCommandInput

options: HttpHandlerOptions

cb: ((err: any, data?: CopyObjectCommandOutput) => void)

Parameters

err: any

Optional data: CopyObjectCommandOutput

Returns void

Returns void

createBucket

See

Parameters

args: CreateBucketCommandInput

Optional options: HttpHandlerOptions

Returns Promise<CreateBucketCommandOutput>

Parameters

args: CreateBucketCommandInput

cb: ((err: any, data?: CreateBucketCommandOutput) => void)

Parameters

err: any

Optional data: CreateBucketCommandOutput

Returns void

Returns void

Parameters

args: CreateBucketCommandInput

options: HttpHandlerOptions

cb: ((err: any, data?: CreateBucketCommandOutput) => void)

`Readonly` config

`Optional` options: HttpHandlerOptions

`Optional` data: CheckBucketNameAvailabilityCommandOutput

`Optional` data: CheckBucketNameAvailabilityCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: CopyObjectCommandOutput

`Optional` data: CopyObjectCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: CreateBucketCommandOutput

`Optional` data: CreateBucketCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DeleteBucketCommandOutput

`Optional` data: DeleteBucketCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DeleteObjectCommandOutput

`Optional` data: DeleteObjectCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DeleteObjectsCommandOutput