Class Identity

Index

Constructors

constructor

Properties

config

Methods

createAccessKey createMachineUser deleteAccessKey deleteMachineUser describeMachineUser destroy getAccessKeyLastUsed listAccessKeys listMachineUsers listPolicies updateAccessKey

Constructors

constructor

new Identity(configuration: IdentityClientConfig): Identity
Parameters
- configuration: IdentityClientConfig
Returns Identity
- Defined in clients/identity/src/IdentityClient.ts:293

Properties

`Readonly` config

config: IdentityClientResolvedConfig

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

Methods

createAccessKey

createAccessKey(args: CreateAccessKeyCommandInput, options?: HttpHandlerOptions): Promise<CreateAccessKeyCommandOutput>
See
CreateAccessKeyCommand
Parameters
- args: CreateAccessKeyCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<CreateAccessKeyCommandOutput>
- Defined in clients/identity/src/Identity.ts:74
createAccessKey(args: CreateAccessKeyCommandInput, cb: ((err: any, data?: CreateAccessKeyCommandOutput) => void)): void
Parameters
- args: CreateAccessKeyCommandInput
- cb: ((err: any, data?: CreateAccessKeyCommandOutput) => void)
  - - (err: any, data?: CreateAccessKeyCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateAccessKeyCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:78
createAccessKey(args: CreateAccessKeyCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: CreateAccessKeyCommandOutput) => void)): void
Parameters
- args: CreateAccessKeyCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: CreateAccessKeyCommandOutput) => void)
  - - (err: any, data?: CreateAccessKeyCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateAccessKeyCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:79

createMachineUser

createMachineUser(args: CreateMachineUserCommandInput, options?: HttpHandlerOptions): Promise<CreateMachineUserCommandOutput>
See
CreateMachineUserCommand
Parameters
- args: CreateMachineUserCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<CreateMachineUserCommandOutput>
- Defined in clients/identity/src/Identity.ts:88
createMachineUser(args: CreateMachineUserCommandInput, cb: ((err: any, data?: CreateMachineUserCommandOutput) => void)): void
Parameters
- args: CreateMachineUserCommandInput
- cb: ((err: any, data?: CreateMachineUserCommandOutput) => void)
  - - (err: any, data?: CreateMachineUserCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateMachineUserCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:92
createMachineUser(args: CreateMachineUserCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: CreateMachineUserCommandOutput) => void)): void
Parameters
- args: CreateMachineUserCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: CreateMachineUserCommandOutput) => void)
  - - (err: any, data?: CreateMachineUserCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateMachineUserCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:96

deleteAccessKey

deleteAccessKey(args: DeleteAccessKeyCommandInput, options?: HttpHandlerOptions): Promise<DeleteAccessKeyCommandOutput>
See
DeleteAccessKeyCommand
Parameters
- args: DeleteAccessKeyCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteAccessKeyCommandOutput>
- Defined in clients/identity/src/Identity.ts:105
deleteAccessKey(args: DeleteAccessKeyCommandInput, cb: ((err: any, data?: DeleteAccessKeyCommandOutput) => void)): void
Parameters
- args: DeleteAccessKeyCommandInput
- cb: ((err: any, data?: DeleteAccessKeyCommandOutput) => void)
  - - (err: any, data?: DeleteAccessKeyCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteAccessKeyCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:109
deleteAccessKey(args: DeleteAccessKeyCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteAccessKeyCommandOutput) => void)): void
Parameters
- args: DeleteAccessKeyCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteAccessKeyCommandOutput) => void)
  - - (err: any, data?: DeleteAccessKeyCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteAccessKeyCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:110

deleteMachineUser

deleteMachineUser(args: DeleteMachineUserCommandInput, options?: HttpHandlerOptions): Promise<DeleteMachineUserCommandOutput>
See
DeleteMachineUserCommand
Parameters
- args: DeleteMachineUserCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteMachineUserCommandOutput>
- Defined in clients/identity/src/Identity.ts:119
deleteMachineUser(args: DeleteMachineUserCommandInput, cb: ((err: any, data?: DeleteMachineUserCommandOutput) => void)): void
Parameters
- args: DeleteMachineUserCommandInput
- cb: ((err: any, data?: DeleteMachineUserCommandOutput) => void)
  - - (err: any, data?: DeleteMachineUserCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteMachineUserCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:123
deleteMachineUser(args: DeleteMachineUserCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteMachineUserCommandOutput) => void)): void
Parameters
- args: DeleteMachineUserCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteMachineUserCommandOutput) => void)
  - - (err: any, data?: DeleteMachineUserCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteMachineUserCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:127

describeMachineUser

describeMachineUser(args: DescribeMachineUserCommandInput, options?: HttpHandlerOptions): Promise<DescribeMachineUserCommandOutput>
See
DescribeMachineUserCommand
Parameters
- args: DescribeMachineUserCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeMachineUserCommandOutput>
- Defined in clients/identity/src/Identity.ts:136
describeMachineUser(args: DescribeMachineUserCommandInput, cb: ((err: any, data?: DescribeMachineUserCommandOutput) => void)): void
Parameters
- args: DescribeMachineUserCommandInput
- cb: ((err: any, data?: DescribeMachineUserCommandOutput) => void)
  - - (err: any, data?: DescribeMachineUserCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeMachineUserCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:140
describeMachineUser(args: DescribeMachineUserCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeMachineUserCommandOutput) => void)): void
Parameters
- args: DescribeMachineUserCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeMachineUserCommandOutput) => void)
  - - (err: any, data?: DescribeMachineUserCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeMachineUserCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:144

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/identity/src/IdentityClient.ts:319

getAccessKeyLastUsed

getAccessKeyLastUsed(args: GetAccessKeyLastUsedCommandInput, options?: HttpHandlerOptions): Promise<GetAccessKeyLastUsedCommandOutput>
See
GetAccessKeyLastUsedCommand
Parameters
- args: GetAccessKeyLastUsedCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<GetAccessKeyLastUsedCommandOutput>
- Defined in clients/identity/src/Identity.ts:153
getAccessKeyLastUsed(args: GetAccessKeyLastUsedCommandInput, cb: ((err: any, data?: GetAccessKeyLastUsedCommandOutput) => void)): void
Parameters
- args: GetAccessKeyLastUsedCommandInput
- cb: ((err: any, data?: GetAccessKeyLastUsedCommandOutput) => void)
  - - (err: any, data?: GetAccessKeyLastUsedCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: GetAccessKeyLastUsedCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:157
getAccessKeyLastUsed(args: GetAccessKeyLastUsedCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: GetAccessKeyLastUsedCommandOutput) => void)): void
Parameters
- args: GetAccessKeyLastUsedCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: GetAccessKeyLastUsedCommandOutput) => void)
  - - (err: any, data?: GetAccessKeyLastUsedCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: GetAccessKeyLastUsedCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:161

listAccessKeys

listAccessKeys(args: ListAccessKeysCommandInput, options?: HttpHandlerOptions): Promise<ListAccessKeysCommandOutput>
See
ListAccessKeysCommand
Parameters
- args: ListAccessKeysCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ListAccessKeysCommandOutput>
- Defined in clients/identity/src/Identity.ts:170
listAccessKeys(args: ListAccessKeysCommandInput, cb: ((err: any, data?: ListAccessKeysCommandOutput) => void)): void
Parameters
- args: ListAccessKeysCommandInput
- cb: ((err: any, data?: ListAccessKeysCommandOutput) => void)
  - - (err: any, data?: ListAccessKeysCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListAccessKeysCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:174
listAccessKeys(args: ListAccessKeysCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ListAccessKeysCommandOutput) => void)): void
Parameters
- args: ListAccessKeysCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ListAccessKeysCommandOutput) => void)
  - - (err: any, data?: ListAccessKeysCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListAccessKeysCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:175

listMachineUsers

listMachineUsers(args: ListMachineUsersCommandInput, options?: HttpHandlerOptions): Promise<ListMachineUsersCommandOutput>
See
ListMachineUsersCommand
Parameters
- args: ListMachineUsersCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ListMachineUsersCommandOutput>
- Defined in clients/identity/src/Identity.ts:184
listMachineUsers(args: ListMachineUsersCommandInput, cb: ((err: any, data?: ListMachineUsersCommandOutput) => void)): void
Parameters
- args: ListMachineUsersCommandInput
- cb: ((err: any, data?: ListMachineUsersCommandOutput) => void)
  - - (err: any, data?: ListMachineUsersCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListMachineUsersCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:188
listMachineUsers(args: ListMachineUsersCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ListMachineUsersCommandOutput) => void)): void
Parameters
- args: ListMachineUsersCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ListMachineUsersCommandOutput) => void)
  - - (err: any, data?: ListMachineUsersCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListMachineUsersCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:192

listPolicies

listPolicies(args: ListPoliciesCommandInput, options?: HttpHandlerOptions): Promise<ListPoliciesCommandOutput>
See
ListPoliciesCommand
Parameters
- args: ListPoliciesCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ListPoliciesCommandOutput>
- Defined in clients/identity/src/Identity.ts:201
listPolicies(args: ListPoliciesCommandInput, cb: ((err: any, data?: ListPoliciesCommandOutput) => void)): void
Parameters
- args: ListPoliciesCommandInput
- cb: ((err: any, data?: ListPoliciesCommandOutput) => void)
  - - (err: any, data?: ListPoliciesCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListPoliciesCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:202
listPolicies(args: ListPoliciesCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ListPoliciesCommandOutput) => void)): void
Parameters
- args: ListPoliciesCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ListPoliciesCommandOutput) => void)
  - - (err: any, data?: ListPoliciesCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListPoliciesCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:203

updateAccessKey

updateAccessKey(args: UpdateAccessKeyCommandInput, options?: HttpHandlerOptions): Promise<UpdateAccessKeyCommandOutput>
See
UpdateAccessKeyCommand
Parameters
- args: UpdateAccessKeyCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<UpdateAccessKeyCommandOutput>
- Defined in clients/identity/src/Identity.ts:212
updateAccessKey(args: UpdateAccessKeyCommandInput, cb: ((err: any, data?: UpdateAccessKeyCommandOutput) => void)): void
Parameters
- args: UpdateAccessKeyCommandInput
- cb: ((err: any, data?: UpdateAccessKeyCommandOutput) => void)
  - - (err: any, data?: UpdateAccessKeyCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateAccessKeyCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:216
updateAccessKey(args: UpdateAccessKeyCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: UpdateAccessKeyCommandOutput) => void)): void
Parameters
- args: UpdateAccessKeyCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: UpdateAccessKeyCommandOutput) => void)
  - - (err: any, data?: UpdateAccessKeyCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateAccessKeyCommandOutput
      
      Returns void
Returns void
- Defined in clients/identity/src/Identity.ts:217

Class Identity

Hierarchy

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: IdentityClientConfig

Returns Identity

Properties

Readonly config

Methods

createAccessKey

See

Parameters

args: CreateAccessKeyCommandInput

Optional options: HttpHandlerOptions

Returns Promise<CreateAccessKeyCommandOutput>

Parameters

args: CreateAccessKeyCommandInput

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

Parameters

err: any

Optional data: CreateAccessKeyCommandOutput

Returns void

Returns void

Parameters

args: CreateAccessKeyCommandInput

options: HttpHandlerOptions

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

Parameters

err: any

Optional data: CreateAccessKeyCommandOutput

Returns void

Returns void

createMachineUser

See

Parameters

args: CreateMachineUserCommandInput

Optional options: HttpHandlerOptions

Returns Promise<CreateMachineUserCommandOutput>

Parameters

args: CreateMachineUserCommandInput

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

Parameters

err: any

Optional data: CreateMachineUserCommandOutput

Returns void

Returns void

Parameters

args: CreateMachineUserCommandInput

options: HttpHandlerOptions

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

Parameters

err: any

Optional data: CreateMachineUserCommandOutput

Returns void

Returns void

deleteAccessKey

See

Parameters

args: DeleteAccessKeyCommandInput

Optional options: HttpHandlerOptions

Returns Promise<DeleteAccessKeyCommandOutput>

Parameters

args: DeleteAccessKeyCommandInput

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

Parameters

err: any

Optional data: DeleteAccessKeyCommandOutput

Returns void

Returns void

Parameters

args: DeleteAccessKeyCommandInput

options: HttpHandlerOptions

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

`Readonly` config

`Optional` options: HttpHandlerOptions

`Optional` data: CreateAccessKeyCommandOutput

`Optional` data: CreateAccessKeyCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: CreateMachineUserCommandOutput

`Optional` data: CreateMachineUserCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DeleteAccessKeyCommandOutput

`Optional` data: DeleteAccessKeyCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DeleteMachineUserCommandOutput

`Optional` data: DeleteMachineUserCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DescribeMachineUserCommandOutput

`Optional` data: DescribeMachineUserCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: GetAccessKeyLastUsedCommandOutput