Class Cloud

Index

Constructors

constructor

Properties

config

Methods

createCloud describeCloud describeProductAvailability destroy listAvailableProducts

Constructors

constructor

new Cloud(configuration: CloudClientConfig): Cloud
Parameters
- configuration: CloudClientConfig
Returns Cloud
- Defined in clients/cloud/src/CloudClient.ts:275

Properties

`Readonly` config

config: CloudClientResolvedConfig

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

Methods

createCloud

createCloud(args: CreateCloudCommandInput, options?: HttpHandlerOptions): Promise<CreateCloudCommandOutput>
See
CreateCloudCommand
Parameters
- args: CreateCloudCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<CreateCloudCommandOutput>
- Defined in clients/cloud/src/Cloud.ts:34
createCloud(args: CreateCloudCommandInput, cb: ((err: any, data?: CreateCloudCommandOutput) => void)): void
Parameters
- args: CreateCloudCommandInput
- cb: ((err: any, data?: CreateCloudCommandOutput) => void)
  - - (err: any, data?: CreateCloudCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateCloudCommandOutput
      
      Returns void
Returns void
- Defined in clients/cloud/src/Cloud.ts:35
createCloud(args: CreateCloudCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: CreateCloudCommandOutput) => void)): void
Parameters
- args: CreateCloudCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: CreateCloudCommandOutput) => void)
  - - (err: any, data?: CreateCloudCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateCloudCommandOutput
      
      Returns void
Returns void
- Defined in clients/cloud/src/Cloud.ts:36

describeCloud

describeCloud(args: DescribeCloudCommandInput, options?: HttpHandlerOptions): Promise<DescribeCloudCommandOutput>
See
DescribeCloudCommand
Parameters
- args: DescribeCloudCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeCloudCommandOutput>
- Defined in clients/cloud/src/Cloud.ts:45
describeCloud(args: DescribeCloudCommandInput, cb: ((err: any, data?: DescribeCloudCommandOutput) => void)): void
Parameters
- args: DescribeCloudCommandInput
- cb: ((err: any, data?: DescribeCloudCommandOutput) => void)
  - - (err: any, data?: DescribeCloudCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeCloudCommandOutput
      
      Returns void
Returns void
- Defined in clients/cloud/src/Cloud.ts:46
describeCloud(args: DescribeCloudCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeCloudCommandOutput) => void)): void
Parameters
- args: DescribeCloudCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeCloudCommandOutput) => void)
  - - (err: any, data?: DescribeCloudCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeCloudCommandOutput
      
      Returns void
Returns void
- Defined in clients/cloud/src/Cloud.ts:47

describeProductAvailability

describeProductAvailability(args: DescribeProductAvailabilityCommandInput, options?: HttpHandlerOptions): Promise<DescribeProductAvailabilityCommandOutput>
See
DescribeProductAvailabilityCommand
Parameters
- args: DescribeProductAvailabilityCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeProductAvailabilityCommandOutput>
- Defined in clients/cloud/src/Cloud.ts:56
describeProductAvailability(args: DescribeProductAvailabilityCommandInput, cb: ((err: any, data?: DescribeProductAvailabilityCommandOutput) => void)): void
Parameters
- args: DescribeProductAvailabilityCommandInput
- cb: ((err: any, data?: DescribeProductAvailabilityCommandOutput) => void)
  - - (err: any, data?: DescribeProductAvailabilityCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeProductAvailabilityCommandOutput
      
      Returns void
Returns void
- Defined in clients/cloud/src/Cloud.ts:60
describeProductAvailability(args: DescribeProductAvailabilityCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeProductAvailabilityCommandOutput) => void)): void
Parameters
- args: DescribeProductAvailabilityCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeProductAvailabilityCommandOutput) => void)
  - - (err: any, data?: DescribeProductAvailabilityCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeProductAvailabilityCommandOutput
      
      Returns void
Returns void
- Defined in clients/cloud/src/Cloud.ts:64

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/cloud/src/CloudClient.ts:301

listAvailableProducts

listAvailableProducts(args: ListAvailableProductsCommandInput, options?: HttpHandlerOptions): Promise<ListAvailableProductsCommandOutput>
See
ListAvailableProductsCommand
Parameters
- args: ListAvailableProductsCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ListAvailableProductsCommandOutput>
- Defined in clients/cloud/src/Cloud.ts:73
listAvailableProducts(args: ListAvailableProductsCommandInput, cb: ((err: any, data?: ListAvailableProductsCommandOutput) => void)): void
Parameters
- args: ListAvailableProductsCommandInput
- cb: ((err: any, data?: ListAvailableProductsCommandOutput) => void)
  - - (err: any, data?: ListAvailableProductsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListAvailableProductsCommandOutput
      
      Returns void
Returns void
- Defined in clients/cloud/src/Cloud.ts:77
listAvailableProducts(args: ListAvailableProductsCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ListAvailableProductsCommandOutput) => void)): void
Parameters
- args: ListAvailableProductsCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ListAvailableProductsCommandOutput) => void)
  - - (err: any, data?: ListAvailableProductsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListAvailableProductsCommandOutput
      
      Returns void
Returns void
- Defined in clients/cloud/src/Cloud.ts:81

Class Cloud

Hierarchy

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: CloudClientConfig

Returns Cloud

Properties

Readonly config

Methods

createCloud

See

Parameters

args: CreateCloudCommandInput

Optional options: HttpHandlerOptions

Returns Promise<CreateCloudCommandOutput>

Parameters

args: CreateCloudCommandInput

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

Parameters

err: any

Optional data: CreateCloudCommandOutput

Returns void

Returns void

Parameters

args: CreateCloudCommandInput

options: HttpHandlerOptions

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

Parameters

err: any

Optional data: CreateCloudCommandOutput

Returns void

Returns void

describeCloud

See

Parameters

args: DescribeCloudCommandInput

Optional options: HttpHandlerOptions

Returns Promise<DescribeCloudCommandOutput>

Parameters

args: DescribeCloudCommandInput

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

Parameters

err: any

Optional data: DescribeCloudCommandOutput

Returns void

Returns void

Parameters

args: DescribeCloudCommandInput

options: HttpHandlerOptions

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

Parameters

err: any

Optional data: DescribeCloudCommandOutput

Returns void

Returns void

describeProductAvailability

See

Parameters

args: DescribeProductAvailabilityCommandInput

Optional options: HttpHandlerOptions

Returns Promise<DescribeProductAvailabilityCommandOutput>

Parameters

args: DescribeProductAvailabilityCommandInput

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

Parameters

err: any

Optional data: DescribeProductAvailabilityCommandOutput

Returns void

Returns void

Parameters

args: DescribeProductAvailabilityCommandInput

options: HttpHandlerOptions

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

`Readonly` config

`Optional` options: HttpHandlerOptions

`Optional` data: CreateCloudCommandOutput

`Optional` data: CreateCloudCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DescribeCloudCommandOutput

`Optional` data: DescribeCloudCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DescribeProductAvailabilityCommandOutput

`Optional` data: DescribeProductAvailabilityCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: ListAvailableProductsCommandOutput

`Optional` data: ListAvailableProductsCommandOutput