Class Functions

Index

Constructors

constructor

Properties

config

Methods

createFunction deleteFunction describeFunction describeFunctionPackage destroy getAccountSettings invokeFunction listFunctions updateFunction

Constructors

constructor

new Functions(configuration: FunctionsClientConfig): Functions
Parameters
- configuration: FunctionsClientConfig
Returns Functions
- Defined in clients/functions/src/FunctionsClient.ts:284

Properties

`Readonly` config

config: FunctionsClientResolvedConfig

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

Methods

createFunction

createFunction(args: CreateFunctionCommandInput, options?: HttpHandlerOptions): Promise<CreateFunctionCommandOutput>
See
CreateFunctionCommand
Parameters
- args: CreateFunctionCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<CreateFunctionCommandOutput>
- Defined in clients/functions/src/Functions.ts:62
createFunction(args: CreateFunctionCommandInput, cb: ((err: any, data?: CreateFunctionCommandOutput) => void)): void
Parameters
- args: CreateFunctionCommandInput
- cb: ((err: any, data?: CreateFunctionCommandOutput) => void)
  - - (err: any, data?: CreateFunctionCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateFunctionCommandOutput
      
      Returns void
Returns void
- Defined in clients/functions/src/Functions.ts:66
createFunction(args: CreateFunctionCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: CreateFunctionCommandOutput) => void)): void
Parameters
- args: CreateFunctionCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: CreateFunctionCommandOutput) => void)
  - - (err: any, data?: CreateFunctionCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateFunctionCommandOutput
      
      Returns void
Returns void
- Defined in clients/functions/src/Functions.ts:67

deleteFunction

deleteFunction(args: DeleteFunctionCommandInput, options?: HttpHandlerOptions): Promise<DeleteFunctionCommandOutput>
See
DeleteFunctionCommand
Parameters
- args: DeleteFunctionCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteFunctionCommandOutput>
- Defined in clients/functions/src/Functions.ts:76
deleteFunction(args: DeleteFunctionCommandInput, cb: ((err: any, data?: DeleteFunctionCommandOutput) => void)): void
Parameters
- args: DeleteFunctionCommandInput
- cb: ((err: any, data?: DeleteFunctionCommandOutput) => void)
  - - (err: any, data?: DeleteFunctionCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteFunctionCommandOutput
      
      Returns void
Returns void
- Defined in clients/functions/src/Functions.ts:80
deleteFunction(args: DeleteFunctionCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteFunctionCommandOutput) => void)): void
Parameters
- args: DeleteFunctionCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteFunctionCommandOutput) => void)
  - - (err: any, data?: DeleteFunctionCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteFunctionCommandOutput
      
      Returns void
Returns void
- Defined in clients/functions/src/Functions.ts:81

describeFunction

describeFunction(args: DescribeFunctionCommandInput, options?: HttpHandlerOptions): Promise<DescribeFunctionCommandOutput>
See
DescribeFunctionCommand
Parameters
- args: DescribeFunctionCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeFunctionCommandOutput>
- Defined in clients/functions/src/Functions.ts:90
describeFunction(args: DescribeFunctionCommandInput, cb: ((err: any, data?: DescribeFunctionCommandOutput) => void)): void
Parameters
- args: DescribeFunctionCommandInput
- cb: ((err: any, data?: DescribeFunctionCommandOutput) => void)
  - - (err: any, data?: DescribeFunctionCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeFunctionCommandOutput
      
      Returns void
Returns void
- Defined in clients/functions/src/Functions.ts:94
describeFunction(args: DescribeFunctionCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeFunctionCommandOutput) => void)): void
Parameters
- args: DescribeFunctionCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeFunctionCommandOutput) => void)
  - - (err: any, data?: DescribeFunctionCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeFunctionCommandOutput
      
      Returns void
Returns void
- Defined in clients/functions/src/Functions.ts:98

describeFunctionPackage

describeFunctionPackage(args: DescribeFunctionPackageCommandInput, options?: HttpHandlerOptions): Promise<DescribeFunctionPackageCommandOutput>
See
DescribeFunctionPackageCommand
Parameters
- args: DescribeFunctionPackageCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeFunctionPackageCommandOutput>
- Defined in clients/functions/src/Functions.ts:107
describeFunctionPackage(args: DescribeFunctionPackageCommandInput, cb: ((err: any, data?: DescribeFunctionPackageCommandOutput) => void)): void
Parameters
- args: DescribeFunctionPackageCommandInput
- cb: ((err: any, data?: DescribeFunctionPackageCommandOutput) => void)
  - - (err: any, data?: DescribeFunctionPackageCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeFunctionPackageCommandOutput
      
      Returns void
Returns void
- Defined in clients/functions/src/Functions.ts:111
describeFunctionPackage(args: DescribeFunctionPackageCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeFunctionPackageCommandOutput) => void)): void
Parameters
- args: DescribeFunctionPackageCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeFunctionPackageCommandOutput) => void)
  - - (err: any, data?: DescribeFunctionPackageCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeFunctionPackageCommandOutput
      
      Returns void
Returns void
- Defined in clients/functions/src/Functions.ts:115

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/functions/src/FunctionsClient.ts:310

getAccountSettings

getAccountSettings(args: GetAccountSettingsCommandInput, options?: HttpHandlerOptions): Promise<GetAccountSettingsCommandOutput>
See
GetAccountSettingsCommand
Parameters
- args: GetAccountSettingsCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<GetAccountSettingsCommandOutput>
- Defined in clients/functions/src/Functions.ts:124
getAccountSettings(args: GetAccountSettingsCommandInput, cb: ((err: any, data?: GetAccountSettingsCommandOutput) => void)): void
Parameters
- args: GetAccountSettingsCommandInput
- cb: ((err: any, data?: GetAccountSettingsCommandOutput) => void)
  - - (err: any, data?: GetAccountSettingsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: GetAccountSettingsCommandOutput
      
      Returns void
Returns void
- Defined in clients/functions/src/Functions.ts:128
getAccountSettings(args: GetAccountSettingsCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: GetAccountSettingsCommandOutput) => void)): void
Parameters
- args: GetAccountSettingsCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: GetAccountSettingsCommandOutput) => void)
  - - (err: any, data?: GetAccountSettingsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: GetAccountSettingsCommandOutput
      
      Returns void
Returns void
- Defined in clients/functions/src/Functions.ts:132

invokeFunction

invokeFunction(args: InvokeFunctionCommandInput, options?: HttpHandlerOptions): Promise<InvokeFunctionCommandOutput>
See
InvokeFunctionCommand
Parameters
- args: InvokeFunctionCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<InvokeFunctionCommandOutput>
- Defined in clients/functions/src/Functions.ts:141
invokeFunction(args: InvokeFunctionCommandInput, cb: ((err: any, data?: InvokeFunctionCommandOutput) => void)): void
Parameters
- args: InvokeFunctionCommandInput
- cb: ((err: any, data?: InvokeFunctionCommandOutput) => void)
  - - (err: any, data?: InvokeFunctionCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: InvokeFunctionCommandOutput
      
      Returns void
Returns void
- Defined in clients/functions/src/Functions.ts:145
invokeFunction(args: InvokeFunctionCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: InvokeFunctionCommandOutput) => void)): void
Parameters
- args: InvokeFunctionCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: InvokeFunctionCommandOutput) => void)
  - - (err: any, data?: InvokeFunctionCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: InvokeFunctionCommandOutput
      
      Returns void
Returns void
- Defined in clients/functions/src/Functions.ts:146

listFunctions

listFunctions(args: ListFunctionsCommandInput, options?: HttpHandlerOptions): Promise<ListFunctionsCommandOutput>
See
ListFunctionsCommand
Parameters
- args: ListFunctionsCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ListFunctionsCommandOutput>
- Defined in clients/functions/src/Functions.ts:155
listFunctions(args: ListFunctionsCommandInput, cb: ((err: any, data?: ListFunctionsCommandOutput) => void)): void
Parameters
- args: ListFunctionsCommandInput
- cb: ((err: any, data?: ListFunctionsCommandOutput) => void)
  - - (err: any, data?: ListFunctionsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListFunctionsCommandOutput
      
      Returns void
Returns void
- Defined in clients/functions/src/Functions.ts:156
listFunctions(args: ListFunctionsCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ListFunctionsCommandOutput) => void)): void
Parameters
- args: ListFunctionsCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ListFunctionsCommandOutput) => void)
  - - (err: any, data?: ListFunctionsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListFunctionsCommandOutput
      
      Returns void
Returns void
- Defined in clients/functions/src/Functions.ts:157

updateFunction

updateFunction(args: UpdateFunctionCommandInput, options?: HttpHandlerOptions): Promise<UpdateFunctionCommandOutput>
See
UpdateFunctionCommand
Parameters
- args: UpdateFunctionCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<UpdateFunctionCommandOutput>
- Defined in clients/functions/src/Functions.ts:166
updateFunction(args: UpdateFunctionCommandInput, cb: ((err: any, data?: UpdateFunctionCommandOutput) => void)): void
Parameters
- args: UpdateFunctionCommandInput
- cb: ((err: any, data?: UpdateFunctionCommandOutput) => void)
  - - (err: any, data?: UpdateFunctionCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateFunctionCommandOutput
      
      Returns void
Returns void
- Defined in clients/functions/src/Functions.ts:170
updateFunction(args: UpdateFunctionCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: UpdateFunctionCommandOutput) => void)): void
Parameters
- args: UpdateFunctionCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: UpdateFunctionCommandOutput) => void)
  - - (err: any, data?: UpdateFunctionCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateFunctionCommandOutput
      
      Returns void
Returns void
- Defined in clients/functions/src/Functions.ts:171

Class Functions

Hierarchy

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: FunctionsClientConfig

Returns Functions

Properties

Readonly config

Methods

createFunction

See

Parameters

args: CreateFunctionCommandInput

Optional options: HttpHandlerOptions

Returns Promise<CreateFunctionCommandOutput>

Parameters

args: CreateFunctionCommandInput

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

Parameters

err: any

Optional data: CreateFunctionCommandOutput

Returns void

Returns void

Parameters

args: CreateFunctionCommandInput

options: HttpHandlerOptions

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

Parameters

err: any

Optional data: CreateFunctionCommandOutput

Returns void

Returns void

deleteFunction

See

Parameters

args: DeleteFunctionCommandInput

Optional options: HttpHandlerOptions

Returns Promise<DeleteFunctionCommandOutput>

Parameters

args: DeleteFunctionCommandInput

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

Parameters

err: any

Optional data: DeleteFunctionCommandOutput

Returns void

Returns void

Parameters

args: DeleteFunctionCommandInput

options: HttpHandlerOptions

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

Parameters

err: any

Optional data: DeleteFunctionCommandOutput

Returns void

Returns void

describeFunction

See

Parameters

args: DescribeFunctionCommandInput

Optional options: HttpHandlerOptions

Returns Promise<DescribeFunctionCommandOutput>

Parameters

args: DescribeFunctionCommandInput

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

Parameters

err: any

Optional data: DescribeFunctionCommandOutput

Returns void

Returns void

Parameters

args: DescribeFunctionCommandInput

options: HttpHandlerOptions

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

`Readonly` config

`Optional` options: HttpHandlerOptions

`Optional` data: CreateFunctionCommandOutput

`Optional` data: CreateFunctionCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DeleteFunctionCommandOutput

`Optional` data: DeleteFunctionCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DescribeFunctionCommandOutput

`Optional` data: DescribeFunctionCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DescribeFunctionPackageCommandOutput

`Optional` data: DescribeFunctionPackageCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: GetAccountSettingsCommandOutput

`Optional` data: GetAccountSettingsCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: InvokeFunctionCommandOutput