From 7346bd35823695961d8fa737b960d083470c9358 Mon Sep 17 00:00:00 2001 From: Ben Watson Date: Thu, 2 Feb 2023 11:21:43 -0500 Subject: [PATCH] updates changelog --- CHANGELOG.md | 3 +- docs/classes/export_.Alks.html | 60 +++++++++---------- docs/classes/export_.AlksError.html | 2 +- docs/enums/export_.PseudoBoolean.html | 2 +- docs/enums/export_.TrustType.html | 2 +- docs/interfaces/AccessToken.html | 2 +- docs/interfaces/Account.html | 2 +- docs/interfaces/AccountUserDetails.html | 2 +- docs/interfaces/AwsAccountRole.html | 2 +- docs/interfaces/AwsRoleType.html | 2 +- docs/interfaces/CloudsploitReport.html | 2 +- docs/interfaces/CostTotal.html | 2 +- docs/interfaces/IamUser.html | 2 +- docs/interfaces/Key.html | 2 +- docs/interfaces/LongTermKey.html | 2 +- docs/interfaces/MachineIdentity.html | 2 +- docs/interfaces/RefreshToken.html | 2 +- docs/interfaces/Role.html | 2 +- docs/interfaces/SkypieaAccount.html | 2 +- docs/interfaces/Tag.html | 2 +- docs/interfaces/User.html | 2 +- docs/interfaces/export_.AccessToken.html | 2 +- docs/interfaces/export_.Account.html | 2 +- .../export_.AccountUserDetails.html | 2 +- docs/interfaces/export_.AwsAccountRole.html | 2 +- docs/interfaces/export_.AwsRoleType.html | 2 +- .../interfaces/export_.CloudsploitReport.html | 2 +- docs/interfaces/export_.CostTotal.html | 2 +- docs/interfaces/export_.IamUser.html | 2 +- docs/interfaces/export_.Key.html | 2 +- docs/interfaces/export_.LongTermKey.html | 2 +- docs/interfaces/export_.MachineIdentity.html | 2 +- docs/interfaces/export_.RefreshToken.html | 2 +- docs/interfaces/export_.Role.html | 2 +- docs/interfaces/export_.SkypieaAccount.html | 2 +- docs/interfaces/export_.Tag.html | 2 +- docs/interfaces/export_.User.html | 2 +- docs/modules.html | 2 +- docs/modules/export_.html | 2 +- 39 files changed, 68 insertions(+), 69 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a4c4c348..f93f4bc8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,4 @@ # Changelog -- Fix documented method return types -- Adding sessionTime property to getKeys/getIAMKeys response +- Updates types the getAccounts response to include alias and account ID diff --git a/docs/classes/export_.Alks.html b/docs/classes/export_.Alks.html index 2c491236..122b9866 100644 --- a/docs/classes/export_.Alks.html +++ b/docs/classes/export_.Alks.html @@ -1,6 +1,6 @@ Alks | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Alks

ALKS JavaScript API

-

Hierarchy

  • Alks

Index

Constructors

Properties

Methods

Constructors

Private constructor

Properties

Private config

config: export=.AlksProps

Methods

addRoleMachineIdentity

Hierarchy

  • Alks

Index

Constructors

Properties

Methods

Constructors

Private constructor

Properties

Private config

config: export=.AlksProps

Methods

addRoleMachineIdentity

awsAccountRoles

Returns Promise<export=.MachineIdentity>

awsAccountRoles

create

Returns Promise<export=.AwsAccountRole[]>

create

  • Returns a new instance of alks with pre-defined properties (which don't need to be supplied to every method).

    Any of the properties required by other methods can be specified here.

    Properties present on the current object are carried through to the newly created one.

    @@ -39,7 +39,7 @@ })

    Parameters

    • props: export=.AlksProps

      An object containing settings for the new ALKS object

      -

    Returns Alks

createAccessKeys

Returns Alks

createAccessKeys

createNonServiceRole

Returns Promise<export=.LongTermKey>

createNonServiceRole

createRole

Returns Promise<export=.Role>

createRole

deleteIAMUser

Returns Promise<export=.Role>

deleteIAMUser

deleteRole

Returns Promise<boolean>

deleteRole

deleteRoleMachineIdentity

Returns Promise<boolean>

deleteRoleMachineIdentity

getAWSRoleTypes

Returns Promise<export=.MachineIdentity>

getAWSRoleTypes

  • Returns a Promise for an array of available AWS IAM role types

    deprecated

    Replaced by getAllAWSRoleTypes which includes all AWS role types and their details

    example

    alks.getAWSRoleTypes({ @@ -228,7 +228,7 @@ })

    Parameters

    Returns Promise<string[]>

getAccessToken

Returns Promise<string[]>

getAccessToken

getAccountOwners

Returns Promise<export=.AccessToken>

getAccountOwners

getAccountRole

Returns Promise<export=.User[]>

getAccountRole

getAccounts

Returns Promise<export=.Role>

getAccounts

getAllAWSRoleTypes

Returns Promise<export=.Account[]>

getAllAWSRoleTypes

getCostTotals

Returns Promise<export=.AwsRoleType[]>

getCostTotals

  • Returns cost totals for the specified account for the day, week, month, year, and a breakdown of costs by service for the day and month

    example

    alks.getCostTotals({ accountId: '012345678910', @@ -297,7 +297,7 @@ })

    Parameters

    Returns Promise<export=.CostTotal>

getIAMKeys

Returns Promise<export=.CostTotal>

getIAMKeys

getIamUser

Returns Promise<export=.Key>

getIamUser

getKeys

Returns Promise<export=.IamUser>

getKeys

getLoginRole

Returns Promise<export=.Key>

getLoginRole

  • Returns information about one of the roles used to generate keys

    example

    alks.getLoginRole({ ... @@ -344,7 +344,7 @@ })

    Parameters

    Returns Promise<Omit<export=.Account, "skypieaAccount">>

getNonServiceAWSRoleTypes

Returns Promise<Omit<export=.Account, "skypieaAccount">>

getNonServiceAWSRoleTypes

  • Returns a Promise for an array of available custom role types

    deprecated

    Replaced by getAllAWSRoleTypes which includes all AWS role types and their details

    example

    alks.getNonServiceAWSRoleTypes({ @@ -355,7 +355,7 @@ })

    Parameters

    Returns Promise<string[]>

getRefreshTokens

Returns Promise<string[]>

getRefreshTokens

getUserAccess

Returns Promise<export=.RefreshToken[]>

getUserAccess

getUserAccessByRole

Returns Promise<export=.User[]>

getUserAccessByRole

getUserRoleAccess

Returns Promise<Record<string, export=.User[]>>

getUserRoleAccess

Private internalFetch

  • internalFetch(path: string, args?: Partial<export=.AlksProps>, method?: string): Promise<any>

listAWSAccountRoles

Returns Promise<string[]>

Private internalFetch

  • internalFetch(path: string, args?: Partial<export=.AlksProps>, method?: string): Promise<any>

listAWSAccountRoles

  • Returns a Promise for an array of AWS custom AWS IAM account roles

    deprecated

    Replaced by awsAccountRoles which includes AWS account roles and their details

    example

    alks.listAWSAccountRoles({ @@ -411,7 +411,7 @@ })

    Parameters

    Returns Promise<string[]>

revoke

Returns Promise<string[]>

revoke

  • Revokes a refresh or access token

    example

    alks.revoke({ token: '...', @@ -428,7 +428,7 @@ })

    Parameters

    Returns Promise<boolean>

updateIamUser

Returns Promise<boolean>

updateIamUser

updateRole

Returns Promise<export=.IamUser>

updateRole

version

Returns Promise<export=.Role>

version

  • Returns the version of the ALKS Rest API

    example

    alks.version({ ... diff --git a/docs/classes/export_.AlksError.html b/docs/classes/export_.AlksError.html index 05781441..bfba7542 100644 --- a/docs/classes/export_.AlksError.html +++ b/docs/classes/export_.AlksError.html @@ -1,4 +1,4 @@ -AlksError | alks.js

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class AlksError

    Hierarchy

    • Error
      • AlksError

    Indexable

    [s: string]: any

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new AlksError(response: Response, json: any): AlksError

    Properties

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    status

    status: number

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject: object, constructorOpt?: Function): void
    • +AlksError | alks.js
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class AlksError

      Hierarchy

      • Error
        • AlksError

      Indexable

      [s: string]: any

      Index

      Constructors

      Properties

      Methods

      Constructors

      constructor

      • new AlksError(response: Response, json: any): AlksError

      Properties

      message

      message: string

      name

      name: string

      Optional stack

      stack?: string

      status

      status: number

      Static stackTraceLimit

      stackTraceLimit: number

      Methods

      Static captureStackTrace

      • captureStackTrace(targetObject: object, constructorOpt?: Function): void

      • Create .stack property on a target object

        Parameters

        • targetObject: object
        • Optional constructorOpt: Function

        Returns void

      Static Optional prepareStackTrace

      • prepareStackTrace(err: Error, stackTraces: CallSite[]): any

      • Optional override for formatting stack traces

        diff --git a/docs/enums/export_.PseudoBoolean.html b/docs/enums/export_.PseudoBoolean.html index 29572f74..544a9f83 100644 --- a/docs/enums/export_.PseudoBoolean.html +++ b/docs/enums/export_.PseudoBoolean.html @@ -1 +1 @@ -PseudoBoolean | alks.js
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration PseudoBoolean

        Index

        Enumeration members

        Enumeration members

        False

        False = 0

        True

        True = 1

        Legend

        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +PseudoBoolean | alks.js
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration PseudoBoolean

        Index

        Enumeration members

        Enumeration members

        False

        False = 0

        True

        True = 1

        Legend

        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/export_.TrustType.html b/docs/enums/export_.TrustType.html index a899e377..131a8798 100644 --- a/docs/enums/export_.TrustType.html +++ b/docs/enums/export_.TrustType.html @@ -1 +1 @@ -TrustType | alks.js
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration TrustType

        Index

        Enumeration members

        Enumeration members

        CrossAccount

        CrossAccount = "Cross Account"

        InnerAccount

        InnerAccount = "Inner Account"

        Legend

        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +TrustType | alks.js
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration TrustType

        Index

        Enumeration members

        Enumeration members

        CrossAccount

        CrossAccount = "Cross Account"

        InnerAccount

        InnerAccount = "Inner Account"

        Legend

        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/AccessToken.html b/docs/interfaces/AccessToken.html index e32f95d2..f1cc4775 100644 --- a/docs/interfaces/AccessToken.html +++ b/docs/interfaces/AccessToken.html @@ -1 +1 @@ -AccessToken | alks.js
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface AccessToken

        Hierarchy

        • AccessToken

        Index

        Properties

        Properties

        accessToken

        accessToken: string

        expiresIn

        expiresIn: string

        Legend

        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +AccessToken | alks.js
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface AccessToken

        Hierarchy

        • AccessToken

        Index

        Properties

        Properties

        accessToken

        accessToken: string

        expiresIn

        expiresIn: string

        Legend

        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/Account.html b/docs/interfaces/Account.html index 14a5aabe..bbec6901 100644 --- a/docs/interfaces/Account.html +++ b/docs/interfaces/Account.html @@ -5,4 +5,4 @@
    property

    iamKeyActive - Whether credentials with IAM permissions can be provisioned from this account

    property

    maxKeyDuration - The maximum key duration for this account

    property

    skypieaAccount - extra information about the account from Skypiea

    -

Hierarchy

  • Account

Index

Properties

Properties

account

account: string

iamKeyActive

iamKeyActive: boolean

maxKeyDuration

maxKeyDuration: number

role

role: string

securityLevel

securityLevel: string

skypieaAccount

skypieaAccount: null | export=.SkypieaAccount

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

account

account: string

iamKeyActive

iamKeyActive: boolean

maxKeyDuration

maxKeyDuration: number

role

role: string

securityLevel

securityLevel: string

skypieaAccount

skypieaAccount: null | export=.SkypieaAccount

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AccountUserDetails.html b/docs/interfaces/AccountUserDetails.html index 82343f9c..756a9427 100644 --- a/docs/interfaces/AccountUserDetails.html +++ b/docs/interfaces/AccountUserDetails.html @@ -3,4 +3,4 @@
property

samAccountName - the samAccountName of the user

property

email - the email of the user

property

href - the href self link

-

Hierarchy

Index

Properties

Properties

email

email: string

href

href: string

samAccountName

samAccountName: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

email

email: string

href

href: string

samAccountName

samAccountName: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AwsAccountRole.html b/docs/interfaces/AwsAccountRole.html index 796cbd50..0cfffd70 100644 --- a/docs/interfaces/AwsAccountRole.html +++ b/docs/interfaces/AwsAccountRole.html @@ -3,4 +3,4 @@
property

roleArn - The AWS Role ARN

property

isMachineIdentity - true|false value of if this role is a machine identity

property

assumeRolePolicyDocument - The AWS assume role policy document associated with this role

-

Hierarchy

Index

Properties

Properties

assumeRolePolicyDocument

assumeRolePolicyDocument: object

isMachineIdentity

isMachineIdentity: boolean

roleArn

roleArn: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

assumeRolePolicyDocument

assumeRolePolicyDocument: object

isMachineIdentity

isMachineIdentity: boolean

roleArn

roleArn: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AwsRoleType.html b/docs/interfaces/AwsRoleType.html index 2cf93039..77c3fb56 100644 --- a/docs/interfaces/AwsRoleType.html +++ b/docs/interfaces/AwsRoleType.html @@ -5,4 +5,4 @@
property

trustRelationship - The AWS trust policy document associated with this role

property

instanceProfile - Whether this role is an instance profile

property

templateVariables - A list of template variables that exist within the role type's trust policy document

-

Hierarchy

Index

Properties

Properties

defaultArns

defaultArns: string[]

instanceProfile

instanceProfile: boolean

roleTypeName

roleTypeName: string

Optional templateVariables

templateVariables?: string[]

trustRelationship

trustRelationship: object

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

defaultArns

defaultArns: string[]

instanceProfile

instanceProfile: boolean

roleTypeName

roleTypeName: string

Optional templateVariables

templateVariables?: string[]

trustRelationship

trustRelationship: object

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/CloudsploitReport.html b/docs/interfaces/CloudsploitReport.html index 7856907b..691cbba1 100644 --- a/docs/interfaces/CloudsploitReport.html +++ b/docs/interfaces/CloudsploitReport.html @@ -12,4 +12,4 @@
property

warning - the amount of warnings

property

failing - the amount of fails

property

unknown - the amount of unknowns

-

Hierarchy

Index

Properties

Properties

awsAccountId

awsAccountId: string

day

day: number

failing

failing: number

href

href: string

month

month: number

newRisks

newRisks: number

passing

passing: number

scanDate

scanDate: string

scanId

scanId: number

unknown

unknown: number

warning

warning: number

year

year: number

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

awsAccountId

awsAccountId: string

day

day: number

failing

failing: number

href

href: string

month

month: number

newRisks

newRisks: number

passing

passing: number

scanDate

scanDate: string

scanId

scanId: number

unknown

unknown: number

warning

warning: number

year

year: number

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/CostTotal.html b/docs/interfaces/CostTotal.html index 56300821..7beb5543 100644 --- a/docs/interfaces/CostTotal.html +++ b/docs/interfaces/CostTotal.html @@ -1 +1 @@ -CostTotal | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CostTotal

Hierarchy

  • CostTotal

Index

Properties

Properties

awsAccountId

awsAccountId: string

daily

daily: string

dailyCostsByService

dailyCostsByService: Record<string, string>

dd

dd: string

mm

mm: string

monthly

monthly: string

monthlyCostsByService

monthlyCostsByService: Record<string, string>

weekly

weekly: string

yearly

yearly: string

yyyy

yyyy: string

Generated using TypeDoc

\ No newline at end of file +CostTotal | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CostTotal

Hierarchy

  • CostTotal

Index

Properties

Properties

awsAccountId

awsAccountId: string

daily

daily: string

dailyCostsByService

dailyCostsByService: Record<string, string>

dd

dd: string

mm

mm: string

monthly

monthly: string

monthlyCostsByService

monthlyCostsByService: Record<string, string>

weekly

weekly: string

yearly

yearly: string

yyyy

yyyy: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/IamUser.html b/docs/interfaces/IamUser.html index 2e7f5b05..10afa2a8 100644 --- a/docs/interfaces/IamUser.html +++ b/docs/interfaces/IamUser.html @@ -1 +1 @@ -IamUser | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IamUser

Hierarchy

  • IamUser

Index

Properties

Properties

accessKey

accessKey: string

accountId

accountId: string

arn

arn: string

tags

tags: export=.Tag[]

userName

userName: string

Generated using TypeDoc

\ No newline at end of file +IamUser | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IamUser

Hierarchy

  • IamUser

Index

Properties

Properties

accessKey

accessKey: string

accountId

accountId: string

arn

arn: string

tags

tags: export=.Tag[]

userName

userName: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Key.html b/docs/interfaces/Key.html index 228ca6a2..31a9201f 100644 --- a/docs/interfaces/Key.html +++ b/docs/interfaces/Key.html @@ -5,4 +5,4 @@
property

sessionToken - AWS STS session token

property

consoleURL - a URL to the AWS console using these keys

property

sessionTime - the number of hours until the key expires

-

Hierarchy

Index

Properties

Properties

accessKey

accessKey: string

consoleURL

consoleURL: string

secretKey

secretKey: string

sessionTime

sessionTime: number

sessionToken

sessionToken: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

accessKey

accessKey: string

consoleURL

consoleURL: string

secretKey

secretKey: string

sessionTime

sessionTime: number

sessionToken

sessionToken: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/LongTermKey.html b/docs/interfaces/LongTermKey.html index 54fc09ca..21b9307b 100644 --- a/docs/interfaces/LongTermKey.html +++ b/docs/interfaces/LongTermKey.html @@ -4,4 +4,4 @@
property

accessKey - the long term access key

property

secretKey - the secret key for the long term access key

property

addedIAMUserToGroup - whether the user was successfully added to the deny policy group

-

Hierarchy

Index

Properties

Properties

accessKey

accessKey: string

addedIAMUserToGroup

addedIAMUserToGroup: boolean

iamUserArn

iamUserArn: string

secretKey

secretKey: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

accessKey

accessKey: string

addedIAMUserToGroup

addedIAMUserToGroup: boolean

iamUserArn

iamUserArn: string

secretKey

secretKey: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/MachineIdentity.html b/docs/interfaces/MachineIdentity.html index 730ae813..963937a1 100644 --- a/docs/interfaces/MachineIdentity.html +++ b/docs/interfaces/MachineIdentity.html @@ -1 +1 @@ -MachineIdentity | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MachineIdentity

Hierarchy

  • MachineIdentity

Index

Properties

Properties

machineIdentityArn

machineIdentityArn: string

Generated using TypeDoc

\ No newline at end of file +MachineIdentity | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MachineIdentity

Hierarchy

  • MachineIdentity

Index

Properties

Properties

machineIdentityArn

machineIdentityArn: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/RefreshToken.html b/docs/interfaces/RefreshToken.html index f94f24f0..6024127c 100644 --- a/docs/interfaces/RefreshToken.html +++ b/docs/interfaces/RefreshToken.html @@ -1 +1 @@ -RefreshToken | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RefreshToken

Hierarchy

  • RefreshToken

Index

Properties

Properties

clientId

clientId: string

id

id: string

userId

userId: string

value

value: string

Generated using TypeDoc

\ No newline at end of file +RefreshToken | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RefreshToken

Hierarchy

  • RefreshToken

Index

Properties

Properties

clientId

clientId: string

id

id: string

userId

userId: string

value

value: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Role.html b/docs/interfaces/Role.html index 89bfc6eb..6e6f1bad 100644 --- a/docs/interfaces/Role.html +++ b/docs/interfaces/Role.html @@ -5,4 +5,4 @@
property

instanceProfileArn - The Instance Profile ARN associated with this role

property

addedRoleToInstanceProfile - Whether this role was added to an Instance Profile

property

tags - Resource tags associated with the IAM account role

-

Hierarchy

Index

Properties

Properties

Optional addedRoleToInstanceProfile

addedRoleToInstanceProfile?: boolean

Optional denyArns

denyArns?: string

instanceProfileArn

instanceProfileArn: string

Optional isMachineIdentity

isMachineIdentity?: boolean

Optional maxSessionDurationInSeconds

maxSessionDurationInSeconds?: number

roleArn

roleArn: string

Optional tags

tags?: export=.Tag[]

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

Optional addedRoleToInstanceProfile

addedRoleToInstanceProfile?: boolean

Optional denyArns

denyArns?: string

instanceProfileArn

instanceProfileArn: string

Optional isMachineIdentity

isMachineIdentity?: boolean

Optional maxSessionDurationInSeconds

maxSessionDurationInSeconds?: number

roleArn

roleArn: string

Optional tags

tags?: export=.Tag[]

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/SkypieaAccount.html b/docs/interfaces/SkypieaAccount.html index 8760ff5e..d8a63e0d 100644 --- a/docs/interfaces/SkypieaAccount.html +++ b/docs/interfaces/SkypieaAccount.html @@ -3,4 +3,4 @@
property

label - the friendly name of the account

property

accountOwners - the samAccountNames of the account owners

property

cloudsploitTrend - the CloudSploit trends

-

Hierarchy

Index

Properties

Properties

accountOwners

accountOwners: export=.AccountUserDetails[]

alias

alias: string

awsAccountId

awsAccountId: string

cloudsploitTrend

cloudsploitTrend: export=.CloudsploitReport[]

label

label: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

accountOwners

accountOwners: export=.AccountUserDetails[]

alias

alias: string

awsAccountId

awsAccountId: string

cloudsploitTrend

cloudsploitTrend: export=.CloudsploitReport[]

label

label: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Tag.html b/docs/interfaces/Tag.html index a082ea04..e9b1444b 100644 --- a/docs/interfaces/Tag.html +++ b/docs/interfaces/Tag.html @@ -2,4 +2,4 @@

Alks role tags

property

key - The AWS role tag key

property

value - The AWS role tag value

-

Hierarchy

Index

Properties

Properties

key

key: string

value

value: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

key

key: string

value

value: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/User.html b/docs/interfaces/User.html index 6fe0948b..0a908110 100644 --- a/docs/interfaces/User.html +++ b/docs/interfaces/User.html @@ -5,4 +5,4 @@
property

email - The user email

property

title - The user title

property

department - The user department

-

Hierarchy

Index

Properties

Properties

department

department: string

displayName

displayName: string

email

email: string

sAMAccountName

sAMAccountName: string

title

title: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

department

department: string

displayName

displayName: string

email

email: string

sAMAccountName

sAMAccountName: string

title

title: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.AccessToken.html b/docs/interfaces/export_.AccessToken.html index 46f6d89d..30bd8643 100644 --- a/docs/interfaces/export_.AccessToken.html +++ b/docs/interfaces/export_.AccessToken.html @@ -1 +1 @@ -AccessToken | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccessToken

Hierarchy

  • AccessToken

Index

Properties

Properties

accessToken

accessToken: string

expiresIn

expiresIn: string

Generated using TypeDoc

\ No newline at end of file +AccessToken | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccessToken

Hierarchy

  • AccessToken

Index

Properties

Properties

accessToken

accessToken: string

expiresIn

expiresIn: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.Account.html b/docs/interfaces/export_.Account.html index 80c20048..b7945dca 100644 --- a/docs/interfaces/export_.Account.html +++ b/docs/interfaces/export_.Account.html @@ -5,4 +5,4 @@
property

iamKeyActive - Whether credentials with IAM permissions can be provisioned from this account

property

maxKeyDuration - The maximum key duration for this account

property

skypieaAccount - extra information about the account from Skypiea

-

Hierarchy

Index

Properties

Properties

account

account: string

iamKeyActive

iamKeyActive: boolean

maxKeyDuration

maxKeyDuration: number

role

role: string

securityLevel

securityLevel: string

skypieaAccount

skypieaAccount: null | export=.SkypieaAccount

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

account

account: string

iamKeyActive

iamKeyActive: boolean

maxKeyDuration

maxKeyDuration: number

role

role: string

securityLevel

securityLevel: string

skypieaAccount

skypieaAccount: null | export=.SkypieaAccount

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.AccountUserDetails.html b/docs/interfaces/export_.AccountUserDetails.html index b3118ef8..00cc9d18 100644 --- a/docs/interfaces/export_.AccountUserDetails.html +++ b/docs/interfaces/export_.AccountUserDetails.html @@ -3,4 +3,4 @@
property

samAccountName - the samAccountName of the user

property

email - the email of the user

property

href - the href self link

-

Hierarchy

Index

Properties

Properties

email

email: string

href

href: string

samAccountName

samAccountName: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

email

email: string

href

href: string

samAccountName

samAccountName: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.AwsAccountRole.html b/docs/interfaces/export_.AwsAccountRole.html index 6b7a0f87..f28906bc 100644 --- a/docs/interfaces/export_.AwsAccountRole.html +++ b/docs/interfaces/export_.AwsAccountRole.html @@ -3,4 +3,4 @@
property

roleArn - The AWS Role ARN

property

isMachineIdentity - true|false value of if this role is a machine identity

property

assumeRolePolicyDocument - The AWS assume role policy document associated with this role

-

Hierarchy

Index

Properties

Properties

assumeRolePolicyDocument

assumeRolePolicyDocument: object

isMachineIdentity

isMachineIdentity: boolean

roleArn

roleArn: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

assumeRolePolicyDocument

assumeRolePolicyDocument: object

isMachineIdentity

isMachineIdentity: boolean

roleArn

roleArn: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.AwsRoleType.html b/docs/interfaces/export_.AwsRoleType.html index 490e4ceb..fd1b0013 100644 --- a/docs/interfaces/export_.AwsRoleType.html +++ b/docs/interfaces/export_.AwsRoleType.html @@ -5,4 +5,4 @@
property

trustRelationship - The AWS trust policy document associated with this role

property

instanceProfile - Whether this role is an instance profile

property

templateVariables - A list of template variables that exist within the role type's trust policy document

-

Hierarchy

Index

Properties

Properties

defaultArns

defaultArns: string[]

instanceProfile

instanceProfile: boolean

roleTypeName

roleTypeName: string

Optional templateVariables

templateVariables?: string[]

trustRelationship

trustRelationship: object

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

defaultArns

defaultArns: string[]

instanceProfile

instanceProfile: boolean

roleTypeName

roleTypeName: string

Optional templateVariables

templateVariables?: string[]

trustRelationship

trustRelationship: object

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.CloudsploitReport.html b/docs/interfaces/export_.CloudsploitReport.html index 51326481..9587db1f 100644 --- a/docs/interfaces/export_.CloudsploitReport.html +++ b/docs/interfaces/export_.CloudsploitReport.html @@ -12,4 +12,4 @@
property

warning - the amount of warnings

property

failing - the amount of fails

property

unknown - the amount of unknowns

-

Hierarchy

Index

Properties

Properties

awsAccountId

awsAccountId: string

day

day: number

failing

failing: number

href

href: string

month

month: number

newRisks

newRisks: number

passing

passing: number

scanDate

scanDate: string

scanId

scanId: number

unknown

unknown: number

warning

warning: number

year

year: number

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

awsAccountId

awsAccountId: string

day

day: number

failing

failing: number

href

href: string

month

month: number

newRisks

newRisks: number

passing

passing: number

scanDate

scanDate: string

scanId

scanId: number

unknown

unknown: number

warning

warning: number

year

year: number

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.CostTotal.html b/docs/interfaces/export_.CostTotal.html index 261d69e2..db0214b9 100644 --- a/docs/interfaces/export_.CostTotal.html +++ b/docs/interfaces/export_.CostTotal.html @@ -1 +1 @@ -CostTotal | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CostTotal

Hierarchy

  • CostTotal

Index

Properties

Properties

awsAccountId

awsAccountId: string

daily

daily: string

dailyCostsByService

dailyCostsByService: Record<string, string>

dd

dd: string

mm

mm: string

monthly

monthly: string

monthlyCostsByService

monthlyCostsByService: Record<string, string>

weekly

weekly: string

yearly

yearly: string

yyyy

yyyy: string

Generated using TypeDoc

\ No newline at end of file +CostTotal | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CostTotal

Hierarchy

  • CostTotal

Index

Properties

Properties

awsAccountId

awsAccountId: string

daily

daily: string

dailyCostsByService

dailyCostsByService: Record<string, string>

dd

dd: string

mm

mm: string

monthly

monthly: string

monthlyCostsByService

monthlyCostsByService: Record<string, string>

weekly

weekly: string

yearly

yearly: string

yyyy

yyyy: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.IamUser.html b/docs/interfaces/export_.IamUser.html index f2ef30be..5b55cdac 100644 --- a/docs/interfaces/export_.IamUser.html +++ b/docs/interfaces/export_.IamUser.html @@ -1 +1 @@ -IamUser | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IamUser

Hierarchy

  • IamUser

Index

Properties

Properties

accessKey

accessKey: string

accountId

accountId: string

arn

arn: string

tags

tags: export=.Tag[]

userName

userName: string

Generated using TypeDoc

\ No newline at end of file +IamUser | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IamUser

Hierarchy

  • IamUser

Index

Properties

Properties

accessKey

accessKey: string

accountId

accountId: string

arn

arn: string

tags

tags: export=.Tag[]

userName

userName: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.Key.html b/docs/interfaces/export_.Key.html index 77da50b9..d80370f1 100644 --- a/docs/interfaces/export_.Key.html +++ b/docs/interfaces/export_.Key.html @@ -5,4 +5,4 @@
property

sessionToken - AWS STS session token

property

consoleURL - a URL to the AWS console using these keys

property

sessionTime - the number of hours until the key expires

-

Hierarchy

Index

Properties

Properties

accessKey

accessKey: string

consoleURL

consoleURL: string

secretKey

secretKey: string

sessionTime

sessionTime: number

sessionToken

sessionToken: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

accessKey

accessKey: string

consoleURL

consoleURL: string

secretKey

secretKey: string

sessionTime

sessionTime: number

sessionToken

sessionToken: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.LongTermKey.html b/docs/interfaces/export_.LongTermKey.html index 1ff4d10c..ef9ab9c9 100644 --- a/docs/interfaces/export_.LongTermKey.html +++ b/docs/interfaces/export_.LongTermKey.html @@ -4,4 +4,4 @@
property

accessKey - the long term access key

property

secretKey - the secret key for the long term access key

property

addedIAMUserToGroup - whether the user was successfully added to the deny policy group

-

Hierarchy

Index

Properties

Properties

accessKey

accessKey: string

addedIAMUserToGroup

addedIAMUserToGroup: boolean

iamUserArn

iamUserArn: string

secretKey

secretKey: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

accessKey

accessKey: string

addedIAMUserToGroup

addedIAMUserToGroup: boolean

iamUserArn

iamUserArn: string

secretKey

secretKey: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.MachineIdentity.html b/docs/interfaces/export_.MachineIdentity.html index 4b465b8f..310281f2 100644 --- a/docs/interfaces/export_.MachineIdentity.html +++ b/docs/interfaces/export_.MachineIdentity.html @@ -1 +1 @@ -MachineIdentity | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MachineIdentity

Hierarchy

  • MachineIdentity

Index

Properties

Properties

machineIdentityArn

machineIdentityArn: string

Generated using TypeDoc

\ No newline at end of file +MachineIdentity | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MachineIdentity

Hierarchy

  • MachineIdentity

Index

Properties

Properties

machineIdentityArn

machineIdentityArn: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.RefreshToken.html b/docs/interfaces/export_.RefreshToken.html index a3d49e2c..caa02977 100644 --- a/docs/interfaces/export_.RefreshToken.html +++ b/docs/interfaces/export_.RefreshToken.html @@ -1 +1 @@ -RefreshToken | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RefreshToken

Hierarchy

  • RefreshToken

Index

Properties

Properties

clientId

clientId: string

id

id: string

userId

userId: string

value

value: string

Generated using TypeDoc

\ No newline at end of file +RefreshToken | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RefreshToken

Hierarchy

  • RefreshToken

Index

Properties

Properties

clientId

clientId: string

id

id: string

userId

userId: string

value

value: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.Role.html b/docs/interfaces/export_.Role.html index f8e0dd89..5ebfe3b0 100644 --- a/docs/interfaces/export_.Role.html +++ b/docs/interfaces/export_.Role.html @@ -5,4 +5,4 @@
property

instanceProfileArn - The Instance Profile ARN associated with this role

property

addedRoleToInstanceProfile - Whether this role was added to an Instance Profile

property

tags - Resource tags associated with the IAM account role

-

Hierarchy

Index

Properties

Properties

Optional addedRoleToInstanceProfile

addedRoleToInstanceProfile?: boolean

Optional denyArns

denyArns?: string

instanceProfileArn

instanceProfileArn: string

Optional isMachineIdentity

isMachineIdentity?: boolean

Optional maxSessionDurationInSeconds

maxSessionDurationInSeconds?: number

roleArn

roleArn: string

Optional tags

tags?: export=.Tag[]

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

Optional addedRoleToInstanceProfile

addedRoleToInstanceProfile?: boolean

Optional denyArns

denyArns?: string

instanceProfileArn

instanceProfileArn: string

Optional isMachineIdentity

isMachineIdentity?: boolean

Optional maxSessionDurationInSeconds

maxSessionDurationInSeconds?: number

roleArn

roleArn: string

Optional tags

tags?: export=.Tag[]

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.SkypieaAccount.html b/docs/interfaces/export_.SkypieaAccount.html index d7c42798..5e00e468 100644 --- a/docs/interfaces/export_.SkypieaAccount.html +++ b/docs/interfaces/export_.SkypieaAccount.html @@ -3,4 +3,4 @@
property

label - the friendly name of the account

property

accountOwners - the samAccountNames of the account owners

property

cloudsploitTrend - the CloudSploit trends

-

Hierarchy

Index

Properties

Properties

accountOwners

accountOwners: export=.AccountUserDetails[]

alias

alias: string

awsAccountId

awsAccountId: string

cloudsploitTrend

cloudsploitTrend: export=.CloudsploitReport[]

label

label: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

accountOwners

accountOwners: export=.AccountUserDetails[]

alias

alias: string

awsAccountId

awsAccountId: string

cloudsploitTrend

cloudsploitTrend: export=.CloudsploitReport[]

label

label: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.Tag.html b/docs/interfaces/export_.Tag.html index d65d38b4..c3183049 100644 --- a/docs/interfaces/export_.Tag.html +++ b/docs/interfaces/export_.Tag.html @@ -2,4 +2,4 @@

Alks role tags

property

key - The AWS role tag key

property

value - The AWS role tag value

-

Hierarchy

Index

Properties

Properties

key

key: string

value

value: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

key

key: string

value

value: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.User.html b/docs/interfaces/export_.User.html index 2a009400..63e69187 100644 --- a/docs/interfaces/export_.User.html +++ b/docs/interfaces/export_.User.html @@ -5,4 +5,4 @@
property

email - The user email

property

title - The user title

property

department - The user department

-

Hierarchy

Index

Properties

Properties

department

department: string

displayName

displayName: string

email

email: string

sAMAccountName

sAMAccountName: string

title

title: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

department

department: string

displayName

displayName: string

email

email: string

sAMAccountName

sAMAccountName: string

title

title: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index b3a139bb..6505428e 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1 +1 @@ -alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

alks.js

Index

Namespaces

Interfaces

Type aliases

Type aliases

AddRoleMachineIdentityProps

AddRoleMachineIdentityProps: Partial<export=.AlksProps> & { roleARN: string }

AlksProps

AlksProps: BaseConfig & Auth

AwsAccountRolesProps

AwsAccountRolesProps: Partial<export=.AlksProps> & { account: string }

CreateAccessKeysProps

CreateAccessKeysProps: Partial<export=.AlksProps> & { account: string; iamUserName: string; role: string; tags?: export=.Tag[] }

CreateNonServiceRoleProps

CreateNonServiceRoleProps: Partial<export=.AlksProps> & { account: string; enableAlksAccess: boolean; externalId?: string; includeDefaultPolicy: PseudoBoolean; role: string; roleName: string; roleType: TrustType; tags?: export=.Tag[]; trustArn: string }

CreateRoleProps

CreateRoleProps: Partial<export=.AlksProps> & { account: string; enableAlksAccess: boolean; includeDefaultPolicy: PseudoBoolean; role: string; roleName: string; roleType?: string; tags?: export=.Tag[]; templateFields?: Record<string, string>; trustPolicy?: Record<string, unknown> }

DeleteIAMUserProps

DeleteIAMUserProps: Partial<export=.AlksProps> & { account: string; iamUserName: string; role: string }

DeleteRoleMachineIdentityProps

DeleteRoleMachineIdentityProps: Partial<export=.AlksProps> & { roleARN: string }

DeleteRoleProps

DeleteRoleProps: Partial<export=.AlksProps> & { account: string; role: string; roleName: string }

GetAWSRoleTypesProps

GetAWSRoleTypesProps: Partial<export=.AlksProps> & {}

GetAccessTokenProps

GetAccessTokenProps: Partial<export=.AlksProps> & { refreshToken: string }

GetAccountOwnersProps

GetAccountOwnersProps: Partial<export=.AlksProps> & { accountId: string }

GetAccountRoleProps

GetAccountRoleProps: Partial<export=.AlksProps> & { account: string; role: string; roleName: string }

GetAccountsProps

GetAccountsProps: Partial<export=.AlksProps> & {}

GetAllAWSRoleTypesProps

GetAllAWSRoleTypesProps: Partial<export=.AlksProps> & { getDynamicValues?: boolean }

GetCostTotalsProps

GetCostTotalsProps: Partial<export=.AlksProps> & { accountId: string }

GetIAMKeysProps

GetIAMKeysProps: Partial<export=.AlksProps> & { account: string; role: string; sessionTime: number }

GetIamUserProps

GetIamUserProps: Partial<export=.AlksProps> & { account: string; iamUserName: string }

GetKeysProps

GetKeysProps: Partial<export=.AlksProps> & { account: string; role: string; sessionTime: number }

GetLoginRoleProps

GetLoginRoleProps: Partial<export=.AlksProps> & { accountId: string; role: string }

GetNonServiceAWSRoleTypesProps

GetNonServiceAWSRoleTypesProps: Partial<export=.AlksProps> & {}

GetRefreshTokensProps

GetRefreshTokensProps: Partial<export=.AlksProps> & {}

GetUserAccessByRoleProps

GetUserAccessByRoleProps: Partial<export=.AlksProps> & { accountId: string }

GetUserAccessProps

GetUserAccessProps: Partial<export=.AlksProps> & { accountId: string }

GetUserRoleAccessProps

GetUserRoleAccessProps: Partial<export=.AlksProps> & { accountId: string; sAMAccountName: string }

ListAWSAccountRolesProps

ListAWSAccountRolesProps: Partial<export=.AlksProps> & { account: string; role: string }

RevokeByIdProps

RevokeByIdProps: Partial<export=.AlksProps> & { tokenId: string }

RevokeByValueProps

RevokeByValueProps: Partial<export=.AlksProps> & { token: string }

RevokeProps

RevokeProps: export=.RevokeByIdProps | export=.RevokeByValueProps

UpdateIamUserProps

UpdateIamUserProps: Partial<export=.AlksProps> & { account: string; iamUserName: string; tags?: export=.Tag[] }

UpdateRoleProps

UpdateRoleProps: Partial<export=.AlksProps> & { account: string; role: string; roleName: string; tags: export=.Tag[] }

VersionProps

VersionProps: Partial<export=.AlksProps> & {}

Generated using TypeDoc

\ No newline at end of file +alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

alks.js

Index

Namespaces

Interfaces

Type aliases

Type aliases

AddRoleMachineIdentityProps

AddRoleMachineIdentityProps: Partial<export=.AlksProps> & { roleARN: string }

AlksProps

AlksProps: BaseConfig & Auth

AwsAccountRolesProps

AwsAccountRolesProps: Partial<export=.AlksProps> & { account: string }

CreateAccessKeysProps

CreateAccessKeysProps: Partial<export=.AlksProps> & { account: string; iamUserName: string; role: string; tags?: export=.Tag[] }

CreateNonServiceRoleProps

CreateNonServiceRoleProps: Partial<export=.AlksProps> & { account: string; enableAlksAccess: boolean; externalId?: string; includeDefaultPolicy: PseudoBoolean; role: string; roleName: string; roleType: TrustType; tags?: export=.Tag[]; trustArn: string }

CreateRoleProps

CreateRoleProps: Partial<export=.AlksProps> & { account: string; enableAlksAccess: boolean; includeDefaultPolicy: PseudoBoolean; role: string; roleName: string; roleType?: string; tags?: export=.Tag[]; templateFields?: Record<string, string>; trustPolicy?: Record<string, unknown> }

DeleteIAMUserProps

DeleteIAMUserProps: Partial<export=.AlksProps> & { account: string; iamUserName: string; role: string }

DeleteRoleMachineIdentityProps

DeleteRoleMachineIdentityProps: Partial<export=.AlksProps> & { roleARN: string }

DeleteRoleProps

DeleteRoleProps: Partial<export=.AlksProps> & { account: string; role: string; roleName: string }

GetAWSRoleTypesProps

GetAWSRoleTypesProps: Partial<export=.AlksProps> & {}

GetAccessTokenProps

GetAccessTokenProps: Partial<export=.AlksProps> & { refreshToken: string }

GetAccountOwnersProps

GetAccountOwnersProps: Partial<export=.AlksProps> & { accountId: string }

GetAccountRoleProps

GetAccountRoleProps: Partial<export=.AlksProps> & { account: string; role: string; roleName: string }

GetAccountsProps

GetAccountsProps: Partial<export=.AlksProps> & {}

GetAllAWSRoleTypesProps

GetAllAWSRoleTypesProps: Partial<export=.AlksProps> & { getDynamicValues?: boolean }

GetCostTotalsProps

GetCostTotalsProps: Partial<export=.AlksProps> & { accountId: string }

GetIAMKeysProps

GetIAMKeysProps: Partial<export=.AlksProps> & { account: string; role: string; sessionTime: number }

GetIamUserProps

GetIamUserProps: Partial<export=.AlksProps> & { account: string; iamUserName: string }

GetKeysProps

GetKeysProps: Partial<export=.AlksProps> & { account: string; role: string; sessionTime: number }

GetLoginRoleProps

GetLoginRoleProps: Partial<export=.AlksProps> & { accountId: string; role: string }

GetNonServiceAWSRoleTypesProps

GetNonServiceAWSRoleTypesProps: Partial<export=.AlksProps> & {}

GetRefreshTokensProps

GetRefreshTokensProps: Partial<export=.AlksProps> & {}

GetUserAccessByRoleProps

GetUserAccessByRoleProps: Partial<export=.AlksProps> & { accountId: string }

GetUserAccessProps

GetUserAccessProps: Partial<export=.AlksProps> & { accountId: string }

GetUserRoleAccessProps

GetUserRoleAccessProps: Partial<export=.AlksProps> & { accountId: string; sAMAccountName: string }

ListAWSAccountRolesProps

ListAWSAccountRolesProps: Partial<export=.AlksProps> & { account: string; role: string }

RevokeByIdProps

RevokeByIdProps: Partial<export=.AlksProps> & { tokenId: string }

RevokeByValueProps

RevokeByValueProps: Partial<export=.AlksProps> & { token: string }

RevokeProps

RevokeProps: export=.RevokeByIdProps | export=.RevokeByValueProps

UpdateIamUserProps

UpdateIamUserProps: Partial<export=.AlksProps> & { account: string; iamUserName: string; tags?: export=.Tag[] }

UpdateRoleProps

UpdateRoleProps: Partial<export=.AlksProps> & { account: string; role: string; roleName: string; tags: export=.Tag[] }

VersionProps

VersionProps: Partial<export=.AlksProps> & {}

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/export_.html b/docs/modules/export_.html index 334abe10..dad317a5 100644 --- a/docs/modules/export_.html +++ b/docs/modules/export_.html @@ -1 +1 @@ -export= | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace export=

Index

Enumerations

Classes

Interfaces

Type aliases

Functions

Type aliases

AddRoleMachineIdentityProps

AddRoleMachineIdentityProps: Partial<export=.AlksProps> & { roleARN: string }

AlksProps

AlksProps: BaseConfig & Auth

AwsAccountRolesProps

AwsAccountRolesProps: Partial<export=.AlksProps> & { account: string }

CreateAccessKeysProps

CreateAccessKeysProps: Partial<export=.AlksProps> & { account: string; iamUserName: string; role: string; tags?: export=.Tag[] }

CreateNonServiceRoleProps

CreateNonServiceRoleProps: Partial<export=.AlksProps> & { account: string; enableAlksAccess: boolean; externalId?: string; includeDefaultPolicy: PseudoBoolean; role: string; roleName: string; roleType: TrustType; tags?: export=.Tag[]; trustArn: string }

CreateRoleProps

CreateRoleProps: Partial<export=.AlksProps> & { account: string; enableAlksAccess: boolean; includeDefaultPolicy: PseudoBoolean; role: string; roleName: string; roleType?: string; tags?: export=.Tag[]; templateFields?: Record<string, string>; trustPolicy?: Record<string, unknown> }

DeleteIAMUserProps

DeleteIAMUserProps: Partial<export=.AlksProps> & { account: string; iamUserName: string; role: string }

DeleteRoleMachineIdentityProps

DeleteRoleMachineIdentityProps: Partial<export=.AlksProps> & { roleARN: string }

DeleteRoleProps

DeleteRoleProps: Partial<export=.AlksProps> & { account: string; role: string; roleName: string }

GetAWSRoleTypesProps

GetAWSRoleTypesProps: Partial<export=.AlksProps> & {}

GetAccessTokenProps

GetAccessTokenProps: Partial<export=.AlksProps> & { refreshToken: string }

GetAccountOwnersProps

GetAccountOwnersProps: Partial<export=.AlksProps> & { accountId: string }

GetAccountRoleProps

GetAccountRoleProps: Partial<export=.AlksProps> & { account: string; role: string; roleName: string }

GetAccountsProps

GetAccountsProps: Partial<export=.AlksProps> & {}

GetAllAWSRoleTypesProps

GetAllAWSRoleTypesProps: Partial<export=.AlksProps> & { getDynamicValues?: boolean }

GetCostTotalsProps

GetCostTotalsProps: Partial<export=.AlksProps> & { accountId: string }

GetIAMKeysProps

GetIAMKeysProps: Partial<export=.AlksProps> & { account: string; role: string; sessionTime: number }

GetIamUserProps

GetIamUserProps: Partial<export=.AlksProps> & { account: string; iamUserName: string }

GetKeysProps

GetKeysProps: Partial<export=.AlksProps> & { account: string; role: string; sessionTime: number }

GetLoginRoleProps

GetLoginRoleProps: Partial<export=.AlksProps> & { accountId: string; role: string }

GetNonServiceAWSRoleTypesProps

GetNonServiceAWSRoleTypesProps: Partial<export=.AlksProps> & {}

GetRefreshTokensProps

GetRefreshTokensProps: Partial<export=.AlksProps> & {}

GetUserAccessByRoleProps

GetUserAccessByRoleProps: Partial<export=.AlksProps> & { accountId: string }

GetUserAccessProps

GetUserAccessProps: Partial<export=.AlksProps> & { accountId: string }

GetUserRoleAccessProps

GetUserRoleAccessProps: Partial<export=.AlksProps> & { accountId: string; sAMAccountName: string }

ListAWSAccountRolesProps

ListAWSAccountRolesProps: Partial<export=.AlksProps> & { account: string; role: string }

RevokeByIdProps

RevokeByIdProps: Partial<export=.AlksProps> & { tokenId: string }

RevokeByValueProps

RevokeByValueProps: Partial<export=.AlksProps> & { token: string }

RevokeProps

RevokeProps: export=.RevokeByIdProps | export=.RevokeByValueProps

UpdateIamUserProps

UpdateIamUserProps: Partial<export=.AlksProps> & { account: string; iamUserName: string; tags?: export=.Tag[] }

UpdateRoleProps

UpdateRoleProps: Partial<export=.AlksProps> & { account: string; role: string; roleName: string; tags: export=.Tag[] }

VersionProps

VersionProps: Partial<export=.AlksProps> & {}

Functions

addRoleMachineIdentity

awsAccountRoles

create

createAccessKeys

createNonServiceRole

createRole

deleteIAMUser

deleteRole

deleteRoleMachineIdentity

getAWSRoleTypes

getAccessToken

getAccountOwners

getAccountRole

getAccounts

getAllAWSRoleTypes

getCostTotals

getIAMKeys

getIamUser

getKeys

getLoginRole

getNonServiceAWSRoleTypes

getRefreshTokens

getUserAccess

getUserAccessByRole

getUserRoleAccess

listAWSAccountRoles

revoke

updateIamUser

updateRole

version

Generated using TypeDoc

\ No newline at end of file +export= | alks.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace export=

Index

Enumerations

Classes

Interfaces

Type aliases

Functions

Type aliases

AddRoleMachineIdentityProps

AddRoleMachineIdentityProps: Partial<export=.AlksProps> & { roleARN: string }

AlksProps

AlksProps: BaseConfig & Auth

AwsAccountRolesProps

AwsAccountRolesProps: Partial<export=.AlksProps> & { account: string }

CreateAccessKeysProps

CreateAccessKeysProps: Partial<export=.AlksProps> & { account: string; iamUserName: string; role: string; tags?: export=.Tag[] }

CreateNonServiceRoleProps

CreateNonServiceRoleProps: Partial<export=.AlksProps> & { account: string; enableAlksAccess: boolean; externalId?: string; includeDefaultPolicy: PseudoBoolean; role: string; roleName: string; roleType: TrustType; tags?: export=.Tag[]; trustArn: string }

CreateRoleProps

CreateRoleProps: Partial<export=.AlksProps> & { account: string; enableAlksAccess: boolean; includeDefaultPolicy: PseudoBoolean; role: string; roleName: string; roleType?: string; tags?: export=.Tag[]; templateFields?: Record<string, string>; trustPolicy?: Record<string, unknown> }

DeleteIAMUserProps

DeleteIAMUserProps: Partial<export=.AlksProps> & { account: string; iamUserName: string; role: string }

DeleteRoleMachineIdentityProps

DeleteRoleMachineIdentityProps: Partial<export=.AlksProps> & { roleARN: string }

DeleteRoleProps

DeleteRoleProps: Partial<export=.AlksProps> & { account: string; role: string; roleName: string }

GetAWSRoleTypesProps

GetAWSRoleTypesProps: Partial<export=.AlksProps> & {}

GetAccessTokenProps

GetAccessTokenProps: Partial<export=.AlksProps> & { refreshToken: string }

GetAccountOwnersProps

GetAccountOwnersProps: Partial<export=.AlksProps> & { accountId: string }

GetAccountRoleProps

GetAccountRoleProps: Partial<export=.AlksProps> & { account: string; role: string; roleName: string }

GetAccountsProps

GetAccountsProps: Partial<export=.AlksProps> & {}

GetAllAWSRoleTypesProps

GetAllAWSRoleTypesProps: Partial<export=.AlksProps> & { getDynamicValues?: boolean }

GetCostTotalsProps

GetCostTotalsProps: Partial<export=.AlksProps> & { accountId: string }

GetIAMKeysProps

GetIAMKeysProps: Partial<export=.AlksProps> & { account: string; role: string; sessionTime: number }

GetIamUserProps

GetIamUserProps: Partial<export=.AlksProps> & { account: string; iamUserName: string }

GetKeysProps

GetKeysProps: Partial<export=.AlksProps> & { account: string; role: string; sessionTime: number }

GetLoginRoleProps

GetLoginRoleProps: Partial<export=.AlksProps> & { accountId: string; role: string }

GetNonServiceAWSRoleTypesProps

GetNonServiceAWSRoleTypesProps: Partial<export=.AlksProps> & {}

GetRefreshTokensProps

GetRefreshTokensProps: Partial<export=.AlksProps> & {}

GetUserAccessByRoleProps

GetUserAccessByRoleProps: Partial<export=.AlksProps> & { accountId: string }

GetUserAccessProps

GetUserAccessProps: Partial<export=.AlksProps> & { accountId: string }

GetUserRoleAccessProps

GetUserRoleAccessProps: Partial<export=.AlksProps> & { accountId: string; sAMAccountName: string }

ListAWSAccountRolesProps

ListAWSAccountRolesProps: Partial<export=.AlksProps> & { account: string; role: string }

RevokeByIdProps

RevokeByIdProps: Partial<export=.AlksProps> & { tokenId: string }

RevokeByValueProps

RevokeByValueProps: Partial<export=.AlksProps> & { token: string }

RevokeProps

RevokeProps: export=.RevokeByIdProps | export=.RevokeByValueProps

UpdateIamUserProps

UpdateIamUserProps: Partial<export=.AlksProps> & { account: string; iamUserName: string; tags?: export=.Tag[] }

UpdateRoleProps

UpdateRoleProps: Partial<export=.AlksProps> & { account: string; role: string; roleName: string; tags: export=.Tag[] }

VersionProps

VersionProps: Partial<export=.AlksProps> & {}

Functions

addRoleMachineIdentity

awsAccountRoles

create

createAccessKeys

createNonServiceRole

createRole

deleteIAMUser

deleteRole

deleteRoleMachineIdentity

getAWSRoleTypes

getAccessToken

getAccountOwners

getAccountRole

getAccounts

getAllAWSRoleTypes

getCostTotals

getIAMKeys

getIamUser

getKeys

getLoginRole

getNonServiceAWSRoleTypes

getRefreshTokens

getUserAccess

getUserAccessByRole

getUserRoleAccess

listAWSAccountRoles

revoke

updateIamUser

updateRole

version

Generated using TypeDoc

\ No newline at end of file