Class Mappings

Mappings lets you map JSON documents from one schema to another, using JSONata for its mapping expressions.

Index

Constructors

constructor

Properties

config

Methods

createMapping deleteMapping destroy getMapping listMappingVersions listMappings lockMapping mapDocument publishMapping revertMapping unlockMapping updateMapping

Constructors

constructor

new Mappings(configuration: MappingsClientConfig): Mappings
Parameters
- configuration: MappingsClientConfig
Returns Mappings
- Defined in MappingsClient.ts:266

Properties

`Readonly` config

config: MappingsClientResolvedConfig

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

Methods

createMapping

createMapping(args: CreateMappingCommandInput, options?: HttpHandlerOptions): Promise<CreateMappingCommandOutput>
See
CreateMappingCommand
Parameters
- args: CreateMappingCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<CreateMappingCommandOutput>
- Defined in Mappings.ts:68
createMapping(args: CreateMappingCommandInput, cb: ((err: any, data?: CreateMappingCommandOutput) => void)): void
Parameters
- args: CreateMappingCommandInput
- cb: ((err: any, data?: CreateMappingCommandOutput) => void)
  - - (err: any, data?: CreateMappingCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateMappingCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:69
createMapping(args: CreateMappingCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: CreateMappingCommandOutput) => void)): void
Parameters
- args: CreateMappingCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: CreateMappingCommandOutput) => void)
  - - (err: any, data?: CreateMappingCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateMappingCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:70

deleteMapping

deleteMapping(args: DeleteMappingCommandInput, options?: HttpHandlerOptions): Promise<DeleteMappingCommandOutput>
See
DeleteMappingCommand
Parameters
- args: DeleteMappingCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteMappingCommandOutput>
- Defined in Mappings.ts:79
deleteMapping(args: DeleteMappingCommandInput, cb: ((err: any, data?: DeleteMappingCommandOutput) => void)): void
Parameters
- args: DeleteMappingCommandInput
- cb: ((err: any, data?: DeleteMappingCommandOutput) => void)
  - - (err: any, data?: DeleteMappingCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteMappingCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:80
deleteMapping(args: DeleteMappingCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteMappingCommandOutput) => void)): void
Parameters
- args: DeleteMappingCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteMappingCommandOutput) => void)
  - - (err: any, data?: DeleteMappingCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteMappingCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:81

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 MappingsClient.ts:290

getMapping

getMapping(args: GetMappingCommandInput, options?: HttpHandlerOptions): Promise<GetMappingCommandOutput>
See
GetMappingCommand
Parameters
- args: GetMappingCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<GetMappingCommandOutput>
- Defined in Mappings.ts:90
getMapping(args: GetMappingCommandInput, cb: ((err: any, data?: GetMappingCommandOutput) => void)): void
Parameters
- args: GetMappingCommandInput
- cb: ((err: any, data?: GetMappingCommandOutput) => void)
  - - (err: any, data?: GetMappingCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: GetMappingCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:91
getMapping(args: GetMappingCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: GetMappingCommandOutput) => void)): void
Parameters
- args: GetMappingCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: GetMappingCommandOutput) => void)
  - - (err: any, data?: GetMappingCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: GetMappingCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:92

listMappingVersions

listMappingVersions(args: ListMappingVersionsCommandInput, options?: HttpHandlerOptions): Promise<ListMappingVersionsCommandOutput>
See
ListMappingVersionsCommand
Parameters
- args: ListMappingVersionsCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ListMappingVersionsCommandOutput>
- Defined in Mappings.ts:112
listMappingVersions(args: ListMappingVersionsCommandInput, cb: ((err: any, data?: ListMappingVersionsCommandOutput) => void)): void
Parameters
- args: ListMappingVersionsCommandInput
- cb: ((err: any, data?: ListMappingVersionsCommandOutput) => void)
  - - (err: any, data?: ListMappingVersionsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListMappingVersionsCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:116
listMappingVersions(args: ListMappingVersionsCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ListMappingVersionsCommandOutput) => void)): void
Parameters
- args: ListMappingVersionsCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ListMappingVersionsCommandOutput) => void)
  - - (err: any, data?: ListMappingVersionsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListMappingVersionsCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:120

listMappings

listMappings(args: ListMappingsCommandInput, options?: HttpHandlerOptions): Promise<ListMappingsCommandOutput>
See
ListMappingsCommand
Parameters
- args: ListMappingsCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ListMappingsCommandOutput>
- Defined in Mappings.ts:101
listMappings(args: ListMappingsCommandInput, cb: ((err: any, data?: ListMappingsCommandOutput) => void)): void
Parameters
- args: ListMappingsCommandInput
- cb: ((err: any, data?: ListMappingsCommandOutput) => void)
  - - (err: any, data?: ListMappingsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListMappingsCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:102
listMappings(args: ListMappingsCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ListMappingsCommandOutput) => void)): void
Parameters
- args: ListMappingsCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ListMappingsCommandOutput) => void)
  - - (err: any, data?: ListMappingsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListMappingsCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:103

lockMapping

lockMapping(args: LockMappingCommandInput, options?: HttpHandlerOptions): Promise<LockMappingCommandOutput>
See
LockMappingCommand
Parameters
- args: LockMappingCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<LockMappingCommandOutput>
- Defined in Mappings.ts:129
lockMapping(args: LockMappingCommandInput, cb: ((err: any, data?: LockMappingCommandOutput) => void)): void
Parameters
- args: LockMappingCommandInput
- cb: ((err: any, data?: LockMappingCommandOutput) => void)
  - - (err: any, data?: LockMappingCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: LockMappingCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:130
lockMapping(args: LockMappingCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: LockMappingCommandOutput) => void)): void
Parameters
- args: LockMappingCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: LockMappingCommandOutput) => void)
  - - (err: any, data?: LockMappingCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: LockMappingCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:131

mapDocument

mapDocument(args: MapDocumentCommandInput, options?: HttpHandlerOptions): Promise<MapDocumentCommandOutput>
See
MapDocumentCommand
Parameters
- args: MapDocumentCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<MapDocumentCommandOutput>
- Defined in Mappings.ts:140
mapDocument(args: MapDocumentCommandInput, cb: ((err: any, data?: MapDocumentCommandOutput) => void)): void
Parameters
- args: MapDocumentCommandInput
- cb: ((err: any, data?: MapDocumentCommandOutput) => void)
  - - (err: any, data?: MapDocumentCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: MapDocumentCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:141
mapDocument(args: MapDocumentCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: MapDocumentCommandOutput) => void)): void
Parameters
- args: MapDocumentCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: MapDocumentCommandOutput) => void)
  - - (err: any, data?: MapDocumentCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: MapDocumentCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:142

publishMapping

publishMapping(args: PublishMappingCommandInput, options?: HttpHandlerOptions): Promise<PublishMappingCommandOutput>
See
PublishMappingCommand
Parameters
- args: PublishMappingCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<PublishMappingCommandOutput>
- Defined in Mappings.ts:151
publishMapping(args: PublishMappingCommandInput, cb: ((err: any, data?: PublishMappingCommandOutput) => void)): void
Parameters
- args: PublishMappingCommandInput
- cb: ((err: any, data?: PublishMappingCommandOutput) => void)
  - - (err: any, data?: PublishMappingCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: PublishMappingCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:155
publishMapping(args: PublishMappingCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: PublishMappingCommandOutput) => void)): void
Parameters
- args: PublishMappingCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: PublishMappingCommandOutput) => void)
  - - (err: any, data?: PublishMappingCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: PublishMappingCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:156

revertMapping

revertMapping(args: RevertMappingCommandInput, options?: HttpHandlerOptions): Promise<RevertMappingCommandOutput>
See
RevertMappingCommand
Parameters
- args: RevertMappingCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<RevertMappingCommandOutput>
- Defined in Mappings.ts:165
revertMapping(args: RevertMappingCommandInput, cb: ((err: any, data?: RevertMappingCommandOutput) => void)): void
Parameters
- args: RevertMappingCommandInput
- cb: ((err: any, data?: RevertMappingCommandOutput) => void)
  - - (err: any, data?: RevertMappingCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: RevertMappingCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:166
revertMapping(args: RevertMappingCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: RevertMappingCommandOutput) => void)): void
Parameters
- args: RevertMappingCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: RevertMappingCommandOutput) => void)
  - - (err: any, data?: RevertMappingCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: RevertMappingCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:167

unlockMapping

unlockMapping(args: UnlockMappingCommandInput, options?: HttpHandlerOptions): Promise<UnlockMappingCommandOutput>
See
UnlockMappingCommand
Parameters
- args: UnlockMappingCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<UnlockMappingCommandOutput>
- Defined in Mappings.ts:176
unlockMapping(args: UnlockMappingCommandInput, cb: ((err: any, data?: UnlockMappingCommandOutput) => void)): void
Parameters
- args: UnlockMappingCommandInput
- cb: ((err: any, data?: UnlockMappingCommandOutput) => void)
  - - (err: any, data?: UnlockMappingCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UnlockMappingCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:177
unlockMapping(args: UnlockMappingCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: UnlockMappingCommandOutput) => void)): void
Parameters
- args: UnlockMappingCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: UnlockMappingCommandOutput) => void)
  - - (err: any, data?: UnlockMappingCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UnlockMappingCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:178

updateMapping

updateMapping(args: UpdateMappingCommandInput, options?: HttpHandlerOptions): Promise<UpdateMappingCommandOutput>
See
UpdateMappingCommand
Parameters
- args: UpdateMappingCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<UpdateMappingCommandOutput>
- Defined in Mappings.ts:187
updateMapping(args: UpdateMappingCommandInput, cb: ((err: any, data?: UpdateMappingCommandOutput) => void)): void
Parameters
- args: UpdateMappingCommandInput
- cb: ((err: any, data?: UpdateMappingCommandOutput) => void)
  - - (err: any, data?: UpdateMappingCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateMappingCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:188
updateMapping(args: UpdateMappingCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: UpdateMappingCommandOutput) => void)): void
Parameters
- args: UpdateMappingCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: UpdateMappingCommandOutput) => void)
  - - (err: any, data?: UpdateMappingCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateMappingCommandOutput
      
      Returns void
Returns void
- Defined in Mappings.ts:189

Class Mappings

Hierarchy

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: MappingsClientConfig

Returns Mappings

Properties

Readonly config

Methods

createMapping

See

Parameters

args: CreateMappingCommandInput

Optional options: HttpHandlerOptions

Returns Promise<CreateMappingCommandOutput>

Parameters

args: CreateMappingCommandInput

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

Parameters

err: any

Optional data: CreateMappingCommandOutput

Returns void

Returns void

Parameters

args: CreateMappingCommandInput

options: HttpHandlerOptions

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

Parameters

err: any

Optional data: CreateMappingCommandOutput

Returns void

Returns void

deleteMapping

See

Parameters

args: DeleteMappingCommandInput

Optional options: HttpHandlerOptions

Returns Promise<DeleteMappingCommandOutput>

Parameters

args: DeleteMappingCommandInput

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

Parameters

err: any

Optional data: DeleteMappingCommandOutput

Returns void

Returns void

Parameters

args: DeleteMappingCommandInput

options: HttpHandlerOptions

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

Parameters

err: any

Optional data: DeleteMappingCommandOutput

Returns void

Returns void

destroy

Returns void

getMapping

See

Parameters

args: GetMappingCommandInput

Optional options: HttpHandlerOptions

Returns Promise<GetMappingCommandOutput>

Parameters

args: GetMappingCommandInput

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

Parameters

err: any

Optional data: GetMappingCommandOutput

Returns void

Returns void

Parameters

args: GetMappingCommandInput

`Readonly` config

`Optional` options: HttpHandlerOptions

`Optional` data: CreateMappingCommandOutput

`Optional` data: CreateMappingCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DeleteMappingCommandOutput

`Optional` data: DeleteMappingCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: GetMappingCommandOutput

`Optional` data: GetMappingCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: ListMappingVersionsCommandOutput

`Optional` data: ListMappingVersionsCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: ListMappingsCommandOutput

`Optional` data: ListMappingsCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: LockMappingCommandOutput