Class Cores

Index

Constructors

constructor

Properties

config

Methods

createCore deleteCore describeCore describeEventStore destroy disableEventStore enableEventStore updateCore updateEventStore

Constructors

constructor

new Cores(configuration: CoresClientConfig): Cores
Parameters
- configuration: CoresClientConfig
Returns Cores
- Defined in clients/cores/src/CoresClient.ts:281

Properties

`Readonly` config

config: CoresClientResolvedConfig

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

Methods

createCore

createCore(args: CreateCoreCommandInput, options?: HttpHandlerOptions): Promise<CreateCoreCommandOutput>
See
CreateCoreCommand
Parameters
- args: CreateCoreCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<CreateCoreCommandOutput>
- Defined in clients/cores/src/Cores.ts:50
createCore(args: CreateCoreCommandInput, cb: ((err: any, data?: CreateCoreCommandOutput) => void)): void
Parameters
- args: CreateCoreCommandInput
- cb: ((err: any, data?: CreateCoreCommandOutput) => void)
  - - (err: any, data?: CreateCoreCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateCoreCommandOutput
      
      Returns void
Returns void
- Defined in clients/cores/src/Cores.ts:51
createCore(args: CreateCoreCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: CreateCoreCommandOutput) => void)): void
Parameters
- args: CreateCoreCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: CreateCoreCommandOutput) => void)
  - - (err: any, data?: CreateCoreCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateCoreCommandOutput
      
      Returns void
Returns void
- Defined in clients/cores/src/Cores.ts:52

deleteCore

deleteCore(args: DeleteCoreCommandInput, options?: HttpHandlerOptions): Promise<DeleteCoreCommandOutput>
See
DeleteCoreCommand
Parameters
- args: DeleteCoreCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteCoreCommandOutput>
- Defined in clients/cores/src/Cores.ts:61
deleteCore(args: DeleteCoreCommandInput, cb: ((err: any, data?: DeleteCoreCommandOutput) => void)): void
Parameters
- args: DeleteCoreCommandInput
- cb: ((err: any, data?: DeleteCoreCommandOutput) => void)
  - - (err: any, data?: DeleteCoreCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteCoreCommandOutput
      
      Returns void
Returns void
- Defined in clients/cores/src/Cores.ts:62
deleteCore(args: DeleteCoreCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteCoreCommandOutput) => void)): void
Parameters
- args: DeleteCoreCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteCoreCommandOutput) => void)
  - - (err: any, data?: DeleteCoreCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteCoreCommandOutput
      
      Returns void
Returns void
- Defined in clients/cores/src/Cores.ts:63

describeCore

describeCore(args: DescribeCoreCommandInput, options?: HttpHandlerOptions): Promise<DescribeCoreCommandOutput>
See
DescribeCoreCommand
Parameters
- args: DescribeCoreCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeCoreCommandOutput>
- Defined in clients/cores/src/Cores.ts:72
describeCore(args: DescribeCoreCommandInput, cb: ((err: any, data?: DescribeCoreCommandOutput) => void)): void
Parameters
- args: DescribeCoreCommandInput
- cb: ((err: any, data?: DescribeCoreCommandOutput) => void)
  - - (err: any, data?: DescribeCoreCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeCoreCommandOutput
      
      Returns void
Returns void
- Defined in clients/cores/src/Cores.ts:73
describeCore(args: DescribeCoreCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeCoreCommandOutput) => void)): void
Parameters
- args: DescribeCoreCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeCoreCommandOutput) => void)
  - - (err: any, data?: DescribeCoreCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeCoreCommandOutput
      
      Returns void
Returns void
- Defined in clients/cores/src/Cores.ts:74

describeEventStore

describeEventStore(args: DescribeEventStoreCommandInput, options?: HttpHandlerOptions): Promise<DescribeEventStoreCommandOutput>
See
DescribeEventStoreCommand
Parameters
- args: DescribeEventStoreCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeEventStoreCommandOutput>
- Defined in clients/cores/src/Cores.ts:83
describeEventStore(args: DescribeEventStoreCommandInput, cb: ((err: any, data?: DescribeEventStoreCommandOutput) => void)): void
Parameters
- args: DescribeEventStoreCommandInput
- cb: ((err: any, data?: DescribeEventStoreCommandOutput) => void)
  - - (err: any, data?: DescribeEventStoreCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeEventStoreCommandOutput
      
      Returns void
Returns void
- Defined in clients/cores/src/Cores.ts:87
describeEventStore(args: DescribeEventStoreCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeEventStoreCommandOutput) => void)): void
Parameters
- args: DescribeEventStoreCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeEventStoreCommandOutput) => void)
  - - (err: any, data?: DescribeEventStoreCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeEventStoreCommandOutput
      
      Returns void
Returns void
- Defined in clients/cores/src/Cores.ts:91

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/cores/src/CoresClient.ts:307

disableEventStore

disableEventStore(args: DisableEventStoreCommandInput, options?: HttpHandlerOptions): Promise<DisableEventStoreCommandOutput>
See
DisableEventStoreCommand
Parameters
- args: DisableEventStoreCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DisableEventStoreCommandOutput>
- Defined in clients/cores/src/Cores.ts:100
disableEventStore(args: DisableEventStoreCommandInput, cb: ((err: any, data?: DisableEventStoreCommandOutput) => void)): void
Parameters
- args: DisableEventStoreCommandInput
- cb: ((err: any, data?: DisableEventStoreCommandOutput) => void)
  - - (err: any, data?: DisableEventStoreCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DisableEventStoreCommandOutput
      
      Returns void
Returns void
- Defined in clients/cores/src/Cores.ts:104
disableEventStore(args: DisableEventStoreCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DisableEventStoreCommandOutput) => void)): void
Parameters
- args: DisableEventStoreCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DisableEventStoreCommandOutput) => void)
  - - (err: any, data?: DisableEventStoreCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DisableEventStoreCommandOutput
      
      Returns void
Returns void
- Defined in clients/cores/src/Cores.ts:108

enableEventStore

enableEventStore(args: EnableEventStoreCommandInput, options?: HttpHandlerOptions): Promise<EnableEventStoreCommandOutput>
See
EnableEventStoreCommand
Parameters
- args: EnableEventStoreCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<EnableEventStoreCommandOutput>
- Defined in clients/cores/src/Cores.ts:117
enableEventStore(args: EnableEventStoreCommandInput, cb: ((err: any, data?: EnableEventStoreCommandOutput) => void)): void
Parameters
- args: EnableEventStoreCommandInput
- cb: ((err: any, data?: EnableEventStoreCommandOutput) => void)
  - - (err: any, data?: EnableEventStoreCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: EnableEventStoreCommandOutput
      
      Returns void
Returns void
- Defined in clients/cores/src/Cores.ts:121
enableEventStore(args: EnableEventStoreCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: EnableEventStoreCommandOutput) => void)): void
Parameters
- args: EnableEventStoreCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: EnableEventStoreCommandOutput) => void)
  - - (err: any, data?: EnableEventStoreCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: EnableEventStoreCommandOutput
      
      Returns void
Returns void
- Defined in clients/cores/src/Cores.ts:125

updateCore

updateCore(args: UpdateCoreCommandInput, options?: HttpHandlerOptions): Promise<UpdateCoreCommandOutput>
See
UpdateCoreCommand
Parameters
- args: UpdateCoreCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<UpdateCoreCommandOutput>
- Defined in clients/cores/src/Cores.ts:134
updateCore(args: UpdateCoreCommandInput, cb: ((err: any, data?: UpdateCoreCommandOutput) => void)): void
Parameters
- args: UpdateCoreCommandInput
- cb: ((err: any, data?: UpdateCoreCommandOutput) => void)
  - - (err: any, data?: UpdateCoreCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateCoreCommandOutput
      
      Returns void
Returns void
- Defined in clients/cores/src/Cores.ts:135
updateCore(args: UpdateCoreCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: UpdateCoreCommandOutput) => void)): void
Parameters
- args: UpdateCoreCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: UpdateCoreCommandOutput) => void)
  - - (err: any, data?: UpdateCoreCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateCoreCommandOutput
      
      Returns void
Returns void
- Defined in clients/cores/src/Cores.ts:136

updateEventStore

updateEventStore(args: UpdateEventStoreCommandInput, options?: HttpHandlerOptions): Promise<UpdateEventStoreCommandOutput>
See
UpdateEventStoreCommand
Parameters
- args: UpdateEventStoreCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<UpdateEventStoreCommandOutput>
- Defined in clients/cores/src/Cores.ts:145
updateEventStore(args: UpdateEventStoreCommandInput, cb: ((err: any, data?: UpdateEventStoreCommandOutput) => void)): void
Parameters
- args: UpdateEventStoreCommandInput
- cb: ((err: any, data?: UpdateEventStoreCommandOutput) => void)
  - - (err: any, data?: UpdateEventStoreCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateEventStoreCommandOutput
      
      Returns void
Returns void
- Defined in clients/cores/src/Cores.ts:149
updateEventStore(args: UpdateEventStoreCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: UpdateEventStoreCommandOutput) => void)): void
Parameters
- args: UpdateEventStoreCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: UpdateEventStoreCommandOutput) => void)
  - - (err: any, data?: UpdateEventStoreCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateEventStoreCommandOutput
      
      Returns void
Returns void
- Defined in clients/cores/src/Cores.ts:153

Class Cores

Hierarchy

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: CoresClientConfig

Returns Cores

Properties

Readonly config

Methods

createCore

See

Parameters

args: CreateCoreCommandInput

Optional options: HttpHandlerOptions

Returns Promise<CreateCoreCommandOutput>

Parameters

args: CreateCoreCommandInput

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

Parameters

err: any

Optional data: CreateCoreCommandOutput

Returns void

Returns void

Parameters

args: CreateCoreCommandInput

options: HttpHandlerOptions

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

Parameters

err: any

Optional data: CreateCoreCommandOutput

Returns void

Returns void

deleteCore

See

Parameters

args: DeleteCoreCommandInput

Optional options: HttpHandlerOptions

Returns Promise<DeleteCoreCommandOutput>

Parameters

args: DeleteCoreCommandInput

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

Parameters

err: any

Optional data: DeleteCoreCommandOutput

Returns void

Returns void

Parameters

args: DeleteCoreCommandInput

options: HttpHandlerOptions

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

Parameters

err: any

Optional data: DeleteCoreCommandOutput

Returns void

Returns void

describeCore

See

Parameters

args: DescribeCoreCommandInput

Optional options: HttpHandlerOptions

Returns Promise<DescribeCoreCommandOutput>

Parameters

args: DescribeCoreCommandInput

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

Parameters

err: any

Optional data: DescribeCoreCommandOutput

Returns void

Returns void

Parameters

args: DescribeCoreCommandInput

options: HttpHandlerOptions

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

`Readonly` config

`Optional` options: HttpHandlerOptions

`Optional` data: CreateCoreCommandOutput

`Optional` data: CreateCoreCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DeleteCoreCommandOutput

`Optional` data: DeleteCoreCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DescribeCoreCommandOutput

`Optional` data: DescribeCoreCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DescribeEventStoreCommandOutput

`Optional` data: DescribeEventStoreCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DisableEventStoreCommandOutput

`Optional` data: DisableEventStoreCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: EnableEventStoreCommandOutput