From dd88debc79c912414fb37cd9700917e781b8adc1 Mon Sep 17 00:00:00 2001 From: Zack Elliott Date: Tue, 25 Jul 2023 10:37:15 -0500 Subject: [PATCH 1/2] Update version of benjefferies bot --- .github/workflows/npm-publish.yml | 2 +- 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(+), 68 deletions(-) diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml index 0989404..d127c12 100644 --- a/.github/workflows/npm-publish.yml +++ b/.github/workflows/npm-publish.yml @@ -84,7 +84,7 @@ jobs: tags: true - name: Enable "include administrators" branch protection - uses: benjefferies/branch-protection-bot@76b8a9d745a68c6a6e9b4bf745d4b32ad805e9a1 + uses: benjefferies/branch-protection-bot@1.0.9 if: always() # Force to always run this step to ensure "include administrators" is always turned back on with: access_token: ${{ secrets._GITHUB_TOKEN }} diff --git a/docs/classes/export_.Alks.html b/docs/classes/export_.Alks.html index 4e8d8c2..d9291ba 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 f570327..d6b8ddf 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 dd0259a..0f8d5cd 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 440e8a1..c78415c 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 dabc9b6..018ac89 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 7cc2c78..a79b439 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 61dddc0..1e3df5e 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 a2a881c..e0e0291 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 1606e68..27faad9 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 672a362..1917eaa 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 0adcd5a..424a56b 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 e1b97d6..9c865c7 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 169fa47..831ae06 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 5e19475..b9e5d35 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 cdd72df..1dd8103 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 58db6d3..c458a66 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 04dc953..c6f702f 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 5b21cc5..3893e1d 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 e3922ac..d7319b6 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 5a7dccb..eda1958 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 c8ad255..68ae65f 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 aa8d958..44531df 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 699354f..0131f3e 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 c620698..4a7d641 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 df19140..ea869f4 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 6939afe..832ab5e 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 50c1f2d..537402f 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 bdfda09..0ee9e3f 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 b579b3f..0923fff 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 2677e03..ba083dc 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 fcb2f36..b3f8b80 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 8f013ad..7261b4c 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 e4b171e..7cfabf6 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 f16fb14..f1f0980 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 7a55479..88b1d84 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 5ea14d1..12c8da9 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 0c0853e..a972f86 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[]; trustPolicy?: Record<string, unknown> }

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[]; trustPolicy?: Record<string, unknown> }

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 d869002..6389ea5 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[]; trustPolicy?: Record<string, unknown> }

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[]; trustPolicy?: Record<string, unknown> }

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 From 5009247f04abe8aa0ea99772d84d283e7453c44d Mon Sep 17 00:00:00 2001 From: Zack Elliott Date: Tue, 25 Jul 2023 10:40:00 -0500 Subject: [PATCH 2/2] Update change log --- CHANGELOG.md | 2 +- 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(+), 68 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 88f4faa..8a4bd74 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ # Changelog -* Update Ben Jefferies Branch Protection Action +* Update Ben Jefferies Branch Protection Action Again diff --git a/docs/classes/export_.Alks.html b/docs/classes/export_.Alks.html index d9291ba..b413b87 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 d6b8ddf..bde0f37 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 0f8d5cd..b8ba974 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 c78415c..2f79db3 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 018ac89..3352b6c 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 a79b439..7cc19e7 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

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

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

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AccountUserDetails.html b/docs/interfaces/AccountUserDetails.html index 1e3df5e..f71b6b2 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

  • AccountUserDetails

Index

Properties

Properties

email

email: string

href

href: string

samAccountName

samAccountName: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • AccountUserDetails

Index

Properties

Properties

email

email: string

href

href: string

samAccountName

samAccountName: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AwsAccountRole.html b/docs/interfaces/AwsAccountRole.html index e0e0291..be80687 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

  • AwsAccountRole

Index

Properties

Properties

assumeRolePolicyDocument

assumeRolePolicyDocument: object

isMachineIdentity

isMachineIdentity: boolean

roleArn

roleArn: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • AwsAccountRole

Index

Properties

Properties

assumeRolePolicyDocument

assumeRolePolicyDocument: object

isMachineIdentity

isMachineIdentity: boolean

roleArn

roleArn: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AwsRoleType.html b/docs/interfaces/AwsRoleType.html index 27faad9..c99b389 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

  • AwsRoleType

Index

Properties

Properties

defaultArns

defaultArns: string[]

instanceProfile

instanceProfile: boolean

roleTypeName

roleTypeName: string

Optional templateVariables

templateVariables?: string[]

trustRelationship

trustRelationship: object

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • AwsRoleType

Index

Properties

Properties

defaultArns

defaultArns: string[]

instanceProfile

instanceProfile: boolean

roleTypeName

roleTypeName: string

Optional templateVariables

templateVariables?: string[]

trustRelationship

trustRelationship: object

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/CloudsploitReport.html b/docs/interfaces/CloudsploitReport.html index 1917eaa..5216ea4 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

  • CloudsploitReport

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

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • CloudsploitReport

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

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/CostTotal.html b/docs/interfaces/CostTotal.html index 424a56b..c3d7aa6 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

Legend

  • Property

Settings

Theme

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

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/IamUser.html b/docs/interfaces/IamUser.html index 9c865c7..45284b5 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

Legend

  • Property

Settings

Theme

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

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Key.html b/docs/interfaces/Key.html index 831ae06..d63b8c9 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

  • Key

Index

Properties

Properties

accessKey

accessKey: string

consoleURL

consoleURL: string

secretKey

secretKey: string

sessionTime

sessionTime: number

sessionToken

sessionToken: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • Key

Index

Properties

Properties

accessKey

accessKey: string

consoleURL

consoleURL: string

secretKey

secretKey: string

sessionTime

sessionTime: number

sessionToken

sessionToken: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/LongTermKey.html b/docs/interfaces/LongTermKey.html index b9e5d35..90c36f0 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

  • LongTermKey

Index

Properties

Properties

accessKey

accessKey: string

addedIAMUserToGroup

addedIAMUserToGroup: boolean

iamUserArn

iamUserArn: string

secretKey

secretKey: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • LongTermKey

Index

Properties

Properties

accessKey

accessKey: string

addedIAMUserToGroup

addedIAMUserToGroup: boolean

iamUserArn

iamUserArn: string

secretKey

secretKey: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/MachineIdentity.html b/docs/interfaces/MachineIdentity.html index 1dd8103..1e7a3c7 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

Legend

  • Property

Settings

Theme

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

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/RefreshToken.html b/docs/interfaces/RefreshToken.html index c458a66..c64591a 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

Legend

  • Property

Settings

Theme

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

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Role.html b/docs/interfaces/Role.html index c6f702f..0426dd8 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

  • Role

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[]

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • Role

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[]

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/SkypieaAccount.html b/docs/interfaces/SkypieaAccount.html index 3893e1d..edd510e 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

  • SkypieaAccount

Index

Properties

Properties

accountOwners

accountOwners: export=.AccountUserDetails[]

alias

alias: string

awsAccountId

awsAccountId: string

cloudsploitTrend

cloudsploitTrend: export=.CloudsploitReport[]

label

label: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SkypieaAccount

Index

Properties

Properties

accountOwners

accountOwners: export=.AccountUserDetails[]

alias

alias: string

awsAccountId

awsAccountId: string

cloudsploitTrend

cloudsploitTrend: export=.CloudsploitReport[]

label

label: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Tag.html b/docs/interfaces/Tag.html index d7319b6..336ba54 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

  • Tag

Index

Properties

Properties

key

key: string

value

value: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • Tag

Index

Properties

Properties

key

key: string

value

value: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/User.html b/docs/interfaces/User.html index eda1958..8dee8f8 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

  • User

Index

Properties

Properties

department

department: string

displayName

displayName: string

email

email: string

sAMAccountName

sAMAccountName: string

title

title: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • User

Index

Properties

Properties

department

department: string

displayName

displayName: string

email

email: string

sAMAccountName

sAMAccountName: string

title

title: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.AccessToken.html b/docs/interfaces/export_.AccessToken.html index 68ae65f..89c0926 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

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/export_.Account.html b/docs/interfaces/export_.Account.html index 44531df..a50bad5 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

  • Account

Index

Properties

Properties

account

account: string

iamKeyActive

iamKeyActive: boolean

maxKeyDuration

maxKeyDuration: number

role

role: string

securityLevel

securityLevel: string

skypieaAccount

skypieaAccount: null | export=.SkypieaAccount

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

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

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.AccountUserDetails.html b/docs/interfaces/export_.AccountUserDetails.html index 0131f3e..5ad62a8 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

  • AccountUserDetails

Index

Properties

Properties

email

email: string

href

href: string

samAccountName

samAccountName: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • AccountUserDetails

Index

Properties

Properties

email

email: string

href

href: string

samAccountName

samAccountName: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.AwsAccountRole.html b/docs/interfaces/export_.AwsAccountRole.html index 4a7d641..e8faa34 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

  • AwsAccountRole

Index

Properties

Properties

assumeRolePolicyDocument

assumeRolePolicyDocument: object

isMachineIdentity

isMachineIdentity: boolean

roleArn

roleArn: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • AwsAccountRole

Index

Properties

Properties

assumeRolePolicyDocument

assumeRolePolicyDocument: object

isMachineIdentity

isMachineIdentity: boolean

roleArn

roleArn: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.AwsRoleType.html b/docs/interfaces/export_.AwsRoleType.html index ea869f4..c7ce4a8 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

  • AwsRoleType

Index

Properties

Properties

defaultArns

defaultArns: string[]

instanceProfile

instanceProfile: boolean

roleTypeName

roleTypeName: string

Optional templateVariables

templateVariables?: string[]

trustRelationship

trustRelationship: object

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • AwsRoleType

Index

Properties

Properties

defaultArns

defaultArns: string[]

instanceProfile

instanceProfile: boolean

roleTypeName

roleTypeName: string

Optional templateVariables

templateVariables?: string[]

trustRelationship

trustRelationship: object

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.CloudsploitReport.html b/docs/interfaces/export_.CloudsploitReport.html index 832ab5e..61147f4 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

  • CloudsploitReport

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

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • CloudsploitReport

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

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.CostTotal.html b/docs/interfaces/export_.CostTotal.html index 537402f..df52c4b 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

Legend

  • Property

Settings

Theme

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

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.IamUser.html b/docs/interfaces/export_.IamUser.html index 0ee9e3f..ac7e2d6 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

Legend

  • Property

Settings

Theme

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

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.Key.html b/docs/interfaces/export_.Key.html index 0923fff..476f404 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

  • Key

Index

Properties

Properties

accessKey

accessKey: string

consoleURL

consoleURL: string

secretKey

secretKey: string

sessionTime

sessionTime: number

sessionToken

sessionToken: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • Key

Index

Properties

Properties

accessKey

accessKey: string

consoleURL

consoleURL: string

secretKey

secretKey: string

sessionTime

sessionTime: number

sessionToken

sessionToken: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.LongTermKey.html b/docs/interfaces/export_.LongTermKey.html index ba083dc..f352682 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

  • LongTermKey

Index

Properties

Properties

accessKey

accessKey: string

addedIAMUserToGroup

addedIAMUserToGroup: boolean

iamUserArn

iamUserArn: string

secretKey

secretKey: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • LongTermKey

Index

Properties

Properties

accessKey

accessKey: string

addedIAMUserToGroup

addedIAMUserToGroup: boolean

iamUserArn

iamUserArn: string

secretKey

secretKey: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.MachineIdentity.html b/docs/interfaces/export_.MachineIdentity.html index b3f8b80..ad628fb 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

Legend

  • Property

Settings

Theme

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

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.RefreshToken.html b/docs/interfaces/export_.RefreshToken.html index 7261b4c..88ef9b0 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

Legend

  • Property

Settings

Theme

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

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.Role.html b/docs/interfaces/export_.Role.html index 7cfabf6..f049929 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

  • Role

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[]

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • Role

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[]

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.SkypieaAccount.html b/docs/interfaces/export_.SkypieaAccount.html index f1f0980..054171e 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

  • SkypieaAccount

Index

Properties

Properties

accountOwners

accountOwners: export=.AccountUserDetails[]

alias

alias: string

awsAccountId

awsAccountId: string

cloudsploitTrend

cloudsploitTrend: export=.CloudsploitReport[]

label

label: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SkypieaAccount

Index

Properties

Properties

accountOwners

accountOwners: export=.AccountUserDetails[]

alias

alias: string

awsAccountId

awsAccountId: string

cloudsploitTrend

cloudsploitTrend: export=.CloudsploitReport[]

label

label: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.Tag.html b/docs/interfaces/export_.Tag.html index 88b1d84..b851fd4 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

  • Tag

Index

Properties

Properties

key

key: string

value

value: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • Tag

Index

Properties

Properties

key

key: string

value

value: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/export_.User.html b/docs/interfaces/export_.User.html index 12c8da9..a7dc345 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

  • User

Index

Properties

Properties

department

department: string

displayName

displayName: string

email

email: string

sAMAccountName

sAMAccountName: string

title

title: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • User

Index

Properties

Properties

department

department: string

displayName

displayName: string

email

email: string

sAMAccountName

sAMAccountName: string

title

title: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index a972f86..ec87648 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[]; trustPolicy?: Record<string, unknown> }

VersionProps

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

Legend

  • Property

Settings

Theme

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[]; trustPolicy?: Record<string, unknown> }

VersionProps

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

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/export_.html b/docs/modules/export_.html index 6389ea5..43165c4 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[]; trustPolicy?: Record<string, unknown> }

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

Legend

  • Property

Settings

Theme

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[]; trustPolicy?: Record<string, unknown> }

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

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file