Skip to content

Latest commit

 

History

History

amazonaws_sso_admin

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
index.js
index.js
 
 
openapi.json
openapi.json
 
 
package.json
package.json
 
 

README.md

@datafire/amazonaws_sso_admin

Client library for AWS Single Sign-On Admin

Installation and Usage

npm install --save @datafire/amazonaws_sso_admin
let amazonaws_sso_admin = require('@datafire/amazonaws_sso_admin').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

AttachManagedPolicyToPermissionSet

amazonaws_sso_admin.AttachManagedPolicyToPermissionSet({
  "InstanceArn": null,
  "PermissionSetArn": null,
  "ManagedPolicyArn": null
}, context)

Input

  • input object
    • InstanceArn required
    • ManagedPolicyArn required
    • PermissionSetArn required

Output

CreateAccountAssignment

amazonaws_sso_admin.CreateAccountAssignment({
  "InstanceArn": null,
  "TargetId": null,
  "TargetType": null,
  "PermissionSetArn": null,
  "PrincipalType": null,
  "PrincipalId": null
}, context)

Input

  • input object
    • InstanceArn required
    • PermissionSetArn required
    • PrincipalId required
    • PrincipalType required
    • TargetId required
    • TargetType required

Output

CreateInstanceAccessControlAttributeConfiguration

amazonaws_sso_admin.CreateInstanceAccessControlAttributeConfiguration({
  "InstanceArn": null,
  "InstanceAccessControlAttributeConfiguration": null
}, context)

Input

  • input object
    • InstanceAccessControlAttributeConfiguration required
    • InstanceArn required

Output

CreatePermissionSet

amazonaws_sso_admin.CreatePermissionSet({
  "Name": null,
  "InstanceArn": null
}, context)

Input

  • input object
    • Description
    • InstanceArn required
    • Name required
    • RelayState
    • SessionDuration
    • Tags

Output

DeleteAccountAssignment

amazonaws_sso_admin.DeleteAccountAssignment({
  "InstanceArn": null,
  "TargetId": null,
  "TargetType": null,
  "PermissionSetArn": null,
  "PrincipalType": null,
  "PrincipalId": null
}, context)

Input

  • input object
    • InstanceArn required
    • PermissionSetArn required
    • PrincipalId required
    • PrincipalType required
    • TargetId required
    • TargetType required

Output

DeleteInlinePolicyFromPermissionSet

amazonaws_sso_admin.DeleteInlinePolicyFromPermissionSet({
  "InstanceArn": null,
  "PermissionSetArn": null
}, context)

Input

  • input object
    • InstanceArn required
    • PermissionSetArn required

Output

DeleteInstanceAccessControlAttributeConfiguration

amazonaws_sso_admin.DeleteInstanceAccessControlAttributeConfiguration({
  "InstanceArn": null
}, context)

Input

  • input object
    • InstanceArn required

Output

DeletePermissionSet

amazonaws_sso_admin.DeletePermissionSet({
  "InstanceArn": null,
  "PermissionSetArn": null
}, context)

Input

  • input object
    • InstanceArn required
    • PermissionSetArn required

Output

DescribeAccountAssignmentCreationStatus

amazonaws_sso_admin.DescribeAccountAssignmentCreationStatus({
  "InstanceArn": null,
  "AccountAssignmentCreationRequestId": null
}, context)

Input

  • input object
    • AccountAssignmentCreationRequestId required
    • InstanceArn required

Output

DescribeAccountAssignmentDeletionStatus

amazonaws_sso_admin.DescribeAccountAssignmentDeletionStatus({
  "InstanceArn": null,
  "AccountAssignmentDeletionRequestId": null
}, context)

Input

  • input object
    • AccountAssignmentDeletionRequestId required
    • InstanceArn required

Output

DescribeInstanceAccessControlAttributeConfiguration

amazonaws_sso_admin.DescribeInstanceAccessControlAttributeConfiguration({
  "InstanceArn": null
}, context)

Input

  • input object
    • InstanceArn required

Output

DescribePermissionSet

amazonaws_sso_admin.DescribePermissionSet({
  "InstanceArn": null,
  "PermissionSetArn": null
}, context)

Input

  • input object
    • InstanceArn required
    • PermissionSetArn required

Output

DescribePermissionSetProvisioningStatus

amazonaws_sso_admin.DescribePermissionSetProvisioningStatus({
  "InstanceArn": null,
  "ProvisionPermissionSetRequestId": null
}, context)

Input

  • input object
    • InstanceArn required
    • ProvisionPermissionSetRequestId required

Output

DetachManagedPolicyFromPermissionSet

amazonaws_sso_admin.DetachManagedPolicyFromPermissionSet({
  "InstanceArn": null,
  "PermissionSetArn": null,
  "ManagedPolicyArn": null
}, context)

Input

  • input object
    • InstanceArn required
    • ManagedPolicyArn required
    • PermissionSetArn required

Output

GetInlinePolicyForPermissionSet

amazonaws_sso_admin.GetInlinePolicyForPermissionSet({
  "InstanceArn": null,
  "PermissionSetArn": null
}, context)

Input

  • input object
    • InstanceArn required
    • PermissionSetArn required

Output

ListAccountAssignmentCreationStatus

amazonaws_sso_admin.ListAccountAssignmentCreationStatus({
  "InstanceArn": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filter
      • Status
    • InstanceArn required
    • MaxResults
    • NextToken

Output

ListAccountAssignmentDeletionStatus

amazonaws_sso_admin.ListAccountAssignmentDeletionStatus({
  "InstanceArn": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filter
      • Status
    • InstanceArn required
    • MaxResults
    • NextToken

Output

ListAccountAssignments

amazonaws_sso_admin.ListAccountAssignments({
  "InstanceArn": null,
  "AccountId": null,
  "PermissionSetArn": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • AccountId required
    • InstanceArn required
    • MaxResults
    • NextToken
    • PermissionSetArn required

Output

ListAccountsForProvisionedPermissionSet

amazonaws_sso_admin.ListAccountsForProvisionedPermissionSet({
  "InstanceArn": null,
  "PermissionSetArn": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • InstanceArn required
    • MaxResults
    • NextToken
    • PermissionSetArn required
    • ProvisioningStatus

Output

ListInstances

amazonaws_sso_admin.ListInstances({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken

Output

ListManagedPoliciesInPermissionSet

amazonaws_sso_admin.ListManagedPoliciesInPermissionSet({
  "InstanceArn": null,
  "PermissionSetArn": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • InstanceArn required
    • MaxResults
    • NextToken
    • PermissionSetArn required

Output

ListPermissionSetProvisioningStatus

amazonaws_sso_admin.ListPermissionSetProvisioningStatus({
  "InstanceArn": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filter
      • Status
    • InstanceArn required
    • MaxResults
    • NextToken

Output

ListPermissionSets

amazonaws_sso_admin.ListPermissionSets({
  "InstanceArn": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • InstanceArn required
    • MaxResults
    • NextToken

Output

ListPermissionSetsProvisionedToAccount

amazonaws_sso_admin.ListPermissionSetsProvisionedToAccount({
  "InstanceArn": null,
  "AccountId": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • AccountId required
    • InstanceArn required
    • MaxResults
    • NextToken
    • ProvisioningStatus

Output

ListTagsForResource

amazonaws_sso_admin.ListTagsForResource({
  "InstanceArn": null,
  "ResourceArn": null
}, context)

Input

  • input object
    • NextToken string
    • InstanceArn required
    • NextToken
    • ResourceArn required

Output

ProvisionPermissionSet

amazonaws_sso_admin.ProvisionPermissionSet({
  "InstanceArn": null,
  "PermissionSetArn": null,
  "TargetType": null
}, context)

Input

  • input object
    • InstanceArn required
    • PermissionSetArn required
    • TargetId
    • TargetType required

Output

PutInlinePolicyToPermissionSet

amazonaws_sso_admin.PutInlinePolicyToPermissionSet({
  "InstanceArn": null,
  "PermissionSetArn": null,
  "InlinePolicy": null
}, context)

Input

  • input object
    • InlinePolicy required
    • InstanceArn required
    • PermissionSetArn required

Output

TagResource

amazonaws_sso_admin.TagResource({
  "InstanceArn": null,
  "ResourceArn": null,
  "Tags": null
}, context)

Input

  • input object
    • InstanceArn required
    • ResourceArn required
    • Tags required

Output

UntagResource

amazonaws_sso_admin.UntagResource({
  "InstanceArn": null,
  "ResourceArn": null,
  "TagKeys": null
}, context)

Input

  • input object
    • InstanceArn required
    • ResourceArn required
    • TagKeys required

Output

UpdateInstanceAccessControlAttributeConfiguration

amazonaws_sso_admin.UpdateInstanceAccessControlAttributeConfiguration({
  "InstanceArn": null,
  "InstanceAccessControlAttributeConfiguration": null
}, context)

Input

  • input object
    • InstanceAccessControlAttributeConfiguration required
    • InstanceArn required

Output

UpdatePermissionSet

amazonaws_sso_admin.UpdatePermissionSet({
  "InstanceArn": null,
  "PermissionSetArn": null
}, context)

Input

  • input object
    • Description
    • InstanceArn required
    • PermissionSetArn required
    • RelayState
    • SessionDuration

Output

Definitions

AccessControlAttribute

  • AccessControlAttribute object: These are AWS SSO identity store attributes that you can configure for use in attributes-based access control (ABAC). You can create permission policies that determine who can access your AWS resources based upon the configured attribute value(s). When you enable ABAC and specify AccessControlAttributes, AWS SSO passes the attribute(s) value of the authenticated user into IAM for use in policy evaluation.

AccessControlAttributeKey

  • AccessControlAttributeKey string

AccessControlAttributeList

AccessControlAttributeValue

  • AccessControlAttributeValue object: The value used for mapping a specified attribute to an identity source.

AccessControlAttributeValueSource

  • AccessControlAttributeValueSource string

AccessControlAttributeValueSourceList

AccessDeniedException

AccountAssignment

  • AccountAssignment object:

    The assignment that indicates a principal's limited access to a specified AWS account with a specified permission set.

    The term principal here refers to a user or group that is defined in AWS SSO.

    • AccountId
    • PermissionSetArn
    • PrincipalId
    • PrincipalType

AccountAssignmentList

AccountAssignmentOperationStatus

  • AccountAssignmentOperationStatus object: The status of the creation or deletion operation of an assignment that a principal needs to access an account.
    • CreatedDate
    • FailureReason
    • PermissionSetArn
    • PrincipalId
    • PrincipalType
    • RequestId
    • Status
    • TargetId
    • TargetType

AccountAssignmentOperationStatusList

AccountAssignmentOperationStatusMetadata

  • AccountAssignmentOperationStatusMetadata object: Provides information about the AccountAssignment creation request.
    • CreatedDate
    • RequestId
    • Status

AccountId

  • AccountId string

AccountList

AttachManagedPolicyToPermissionSetRequest

  • AttachManagedPolicyToPermissionSetRequest object
    • InstanceArn required
    • ManagedPolicyArn required
    • PermissionSetArn required

AttachManagedPolicyToPermissionSetResponse

  • AttachManagedPolicyToPermissionSetResponse object

AttachedManagedPolicy

  • AttachedManagedPolicy object: A structure that stores the details of the IAM managed policy.
    • Arn
    • Name

AttachedManagedPolicyList

ConflictException

CreateAccountAssignmentRequest

  • CreateAccountAssignmentRequest object
    • InstanceArn required
    • PermissionSetArn required
    • PrincipalId required
    • PrincipalType required
    • TargetId required
    • TargetType required

CreateAccountAssignmentResponse

  • CreateAccountAssignmentResponse object
    • AccountAssignmentCreationStatus
      • CreatedDate
      • FailureReason
      • PermissionSetArn
      • PrincipalId
      • PrincipalType
      • RequestId
      • Status
      • TargetId
      • TargetType

CreateInstanceAccessControlAttributeConfigurationRequest

  • CreateInstanceAccessControlAttributeConfigurationRequest object
    • InstanceAccessControlAttributeConfiguration required
    • InstanceArn required

CreateInstanceAccessControlAttributeConfigurationResponse

  • CreateInstanceAccessControlAttributeConfigurationResponse object

CreatePermissionSetRequest

  • CreatePermissionSetRequest object
    • Description
    • InstanceArn required
    • Name required
    • RelayState
    • SessionDuration
    • Tags

CreatePermissionSetResponse

  • CreatePermissionSetResponse object
    • PermissionSet
      • CreatedDate
      • Description
      • Name
      • PermissionSetArn
      • RelayState
      • SessionDuration

Date

  • Date string

DeleteAccountAssignmentRequest

  • DeleteAccountAssignmentRequest object
    • InstanceArn required
    • PermissionSetArn required
    • PrincipalId required
    • PrincipalType required
    • TargetId required
    • TargetType required

DeleteAccountAssignmentResponse

  • DeleteAccountAssignmentResponse object
    • AccountAssignmentDeletionStatus
      • CreatedDate
      • FailureReason
      • PermissionSetArn
      • PrincipalId
      • PrincipalType
      • RequestId
      • Status
      • TargetId
      • TargetType

DeleteInlinePolicyFromPermissionSetRequest

  • DeleteInlinePolicyFromPermissionSetRequest object
    • InstanceArn required
    • PermissionSetArn required

DeleteInlinePolicyFromPermissionSetResponse

  • DeleteInlinePolicyFromPermissionSetResponse object

DeleteInstanceAccessControlAttributeConfigurationRequest

  • DeleteInstanceAccessControlAttributeConfigurationRequest object
    • InstanceArn required

DeleteInstanceAccessControlAttributeConfigurationResponse

  • DeleteInstanceAccessControlAttributeConfigurationResponse object

DeletePermissionSetRequest

  • DeletePermissionSetRequest object
    • InstanceArn required
    • PermissionSetArn required

DeletePermissionSetResponse

  • DeletePermissionSetResponse object

DescribeAccountAssignmentCreationStatusRequest

  • DescribeAccountAssignmentCreationStatusRequest object
    • AccountAssignmentCreationRequestId required
    • InstanceArn required

DescribeAccountAssignmentCreationStatusResponse

  • DescribeAccountAssignmentCreationStatusResponse object
    • AccountAssignmentCreationStatus
      • CreatedDate
      • FailureReason
      • PermissionSetArn
      • PrincipalId
      • PrincipalType
      • RequestId
      • Status
      • TargetId
      • TargetType

DescribeAccountAssignmentDeletionStatusRequest

  • DescribeAccountAssignmentDeletionStatusRequest object
    • AccountAssignmentDeletionRequestId required
    • InstanceArn required

DescribeAccountAssignmentDeletionStatusResponse

  • DescribeAccountAssignmentDeletionStatusResponse object
    • AccountAssignmentDeletionStatus
      • CreatedDate
      • FailureReason
      • PermissionSetArn
      • PrincipalId
      • PrincipalType
      • RequestId
      • Status
      • TargetId
      • TargetType

DescribeInstanceAccessControlAttributeConfigurationRequest

  • DescribeInstanceAccessControlAttributeConfigurationRequest object
    • InstanceArn required

DescribeInstanceAccessControlAttributeConfigurationResponse

  • DescribeInstanceAccessControlAttributeConfigurationResponse object
    • InstanceAccessControlAttributeConfiguration
    • Status
    • StatusReason

DescribePermissionSetProvisioningStatusRequest

  • DescribePermissionSetProvisioningStatusRequest object
    • InstanceArn required
    • ProvisionPermissionSetRequestId required

DescribePermissionSetProvisioningStatusResponse

  • DescribePermissionSetProvisioningStatusResponse object
    • PermissionSetProvisioningStatus
      • AccountId
      • CreatedDate
      • FailureReason
      • PermissionSetArn
      • RequestId
      • Status

DescribePermissionSetRequest

  • DescribePermissionSetRequest object
    • InstanceArn required
    • PermissionSetArn required

DescribePermissionSetResponse

  • DescribePermissionSetResponse object
    • PermissionSet
      • CreatedDate
      • Description
      • Name
      • PermissionSetArn
      • RelayState
      • SessionDuration

DetachManagedPolicyFromPermissionSetRequest

  • DetachManagedPolicyFromPermissionSetRequest object
    • InstanceArn required
    • ManagedPolicyArn required
    • PermissionSetArn required

DetachManagedPolicyFromPermissionSetResponse

  • DetachManagedPolicyFromPermissionSetResponse object

Duration

  • Duration string

GeneralArn

  • GeneralArn string

GetInlinePolicyForPermissionSetRequest

  • GetInlinePolicyForPermissionSetRequest object
    • InstanceArn required
    • PermissionSetArn required

GetInlinePolicyForPermissionSetResponse

  • GetInlinePolicyForPermissionSetResponse object
    • InlinePolicy

Id

  • Id string

InstanceAccessControlAttributeConfiguration

  • InstanceAccessControlAttributeConfiguration object: Specifies the attributes to add to your attribute-based access control (ABAC) configuration.

InstanceAccessControlAttributeConfigurationStatus

  • InstanceAccessControlAttributeConfigurationStatus string (values: ENABLED, CREATION_IN_PROGRESS, CREATION_FAILED)

InstanceAccessControlAttributeConfigurationStatusReason

  • InstanceAccessControlAttributeConfigurationStatusReason string

InstanceArn

  • InstanceArn string

InstanceList

InstanceMetadata

  • InstanceMetadata object: Provides information about the SSO instance.
    • IdentityStoreId
    • InstanceArn

InternalServerException

ListAccountAssignmentCreationStatusRequest

  • ListAccountAssignmentCreationStatusRequest object
    • Filter
      • Status
    • InstanceArn required
    • MaxResults
    • NextToken

ListAccountAssignmentCreationStatusResponse

ListAccountAssignmentDeletionStatusRequest

  • ListAccountAssignmentDeletionStatusRequest object
    • Filter
      • Status
    • InstanceArn required
    • MaxResults
    • NextToken

ListAccountAssignmentDeletionStatusResponse

ListAccountAssignmentsRequest

  • ListAccountAssignmentsRequest object
    • AccountId required
    • InstanceArn required
    • MaxResults
    • NextToken
    • PermissionSetArn required

ListAccountAssignmentsResponse

  • ListAccountAssignmentsResponse object

ListAccountsForProvisionedPermissionSetRequest

  • ListAccountsForProvisionedPermissionSetRequest object
    • InstanceArn required
    • MaxResults
    • NextToken
    • PermissionSetArn required
    • ProvisioningStatus

ListAccountsForProvisionedPermissionSetResponse

  • ListAccountsForProvisionedPermissionSetResponse object

ListInstancesRequest

  • ListInstancesRequest object
    • MaxResults
    • NextToken

ListInstancesResponse

ListManagedPoliciesInPermissionSetRequest

  • ListManagedPoliciesInPermissionSetRequest object
    • InstanceArn required
    • MaxResults
    • NextToken
    • PermissionSetArn required

ListManagedPoliciesInPermissionSetResponse

  • ListManagedPoliciesInPermissionSetResponse object

ListPermissionSetProvisioningStatusRequest

  • ListPermissionSetProvisioningStatusRequest object
    • Filter
      • Status
    • InstanceArn required
    • MaxResults
    • NextToken

ListPermissionSetProvisioningStatusResponse

ListPermissionSetsProvisionedToAccountRequest

  • ListPermissionSetsProvisionedToAccountRequest object
    • AccountId required
    • InstanceArn required
    • MaxResults
    • NextToken
    • ProvisioningStatus

ListPermissionSetsProvisionedToAccountResponse

  • ListPermissionSetsProvisionedToAccountResponse object

ListPermissionSetsRequest

  • ListPermissionSetsRequest object
    • InstanceArn required
    • MaxResults
    • NextToken

ListPermissionSetsResponse

  • ListPermissionSetsResponse object

ListTagsForResourceRequest

  • ListTagsForResourceRequest object
    • InstanceArn required
    • NextToken
    • ResourceArn required

ListTagsForResourceResponse

  • ListTagsForResourceResponse object
    • NextToken
    • Tags

ManagedPolicyArn

  • ManagedPolicyArn string

MaxResults

  • MaxResults integer

Name

  • Name string

OperationStatusFilter

  • OperationStatusFilter object: Filters he operation status list based on the passed attribute value.
    • Status

PermissionSet

  • PermissionSet object: An entity that contains IAM policies.
    • CreatedDate
    • Description
    • Name
    • PermissionSetArn
    • RelayState
    • SessionDuration

PermissionSetArn

  • PermissionSetArn string

PermissionSetDescription

  • PermissionSetDescription string

PermissionSetList

PermissionSetName

  • PermissionSetName string

PermissionSetPolicyDocument

  • PermissionSetPolicyDocument string

PermissionSetProvisioningStatus

  • PermissionSetProvisioningStatus object: A structure that is used to provide the status of the provisioning operation for a specified permission set.
    • AccountId
    • CreatedDate
    • FailureReason
    • PermissionSetArn
    • RequestId
    • Status

PermissionSetProvisioningStatusList

PermissionSetProvisioningStatusMetadata

  • PermissionSetProvisioningStatusMetadata object: Provides information about the permission set provisioning status.
    • CreatedDate
    • RequestId
    • Status

PrincipalId

  • PrincipalId string

PrincipalType

  • PrincipalType string (values: USER, GROUP)

ProvisionPermissionSetRequest

  • ProvisionPermissionSetRequest object
    • InstanceArn required
    • PermissionSetArn required
    • TargetId
    • TargetType required

ProvisionPermissionSetResponse

  • ProvisionPermissionSetResponse object
    • PermissionSetProvisioningStatus
      • AccountId
      • CreatedDate
      • FailureReason
      • PermissionSetArn
      • RequestId
      • Status

ProvisionTargetType

  • ProvisionTargetType string (values: AWS_ACCOUNT, ALL_PROVISIONED_ACCOUNTS)

ProvisioningStatus

  • ProvisioningStatus string (values: LATEST_PERMISSION_SET_PROVISIONED, LATEST_PERMISSION_SET_NOT_PROVISIONED)

PutInlinePolicyToPermissionSetRequest

  • PutInlinePolicyToPermissionSetRequest object
    • InlinePolicy required
    • InstanceArn required
    • PermissionSetArn required

PutInlinePolicyToPermissionSetResponse

  • PutInlinePolicyToPermissionSetResponse object

Reason

  • Reason string

RelayState

  • RelayState string

ResourceNotFoundException

ServiceQuotaExceededException

StatusValues

  • StatusValues string (values: IN_PROGRESS, FAILED, SUCCEEDED)

Tag

  • Tag object: A set of key-value pairs that are used to manage the resource. Tags can only be applied to permission sets and cannot be applied to corresponding roles that AWS SSO creates in AWS accounts.
    • Key
    • Value

TagKey

  • TagKey string

TagKeyList

  • TagKeyList array

TagList

  • TagList array

TagResourceRequest

  • TagResourceRequest object
    • InstanceArn required
    • ResourceArn required
    • Tags required

TagResourceResponse

  • TagResourceResponse object

TagValue

  • TagValue string

TargetId

  • TargetId string

TargetType

  • TargetType string (values: AWS_ACCOUNT)

ThrottlingException

Token

  • Token string

UUId

  • UUId string

UntagResourceRequest

  • UntagResourceRequest object
    • InstanceArn required
    • ResourceArn required
    • TagKeys required

UntagResourceResponse

  • UntagResourceResponse object

UpdateInstanceAccessControlAttributeConfigurationRequest

  • UpdateInstanceAccessControlAttributeConfigurationRequest object
    • InstanceAccessControlAttributeConfiguration required
    • InstanceArn required

UpdateInstanceAccessControlAttributeConfigurationResponse

  • UpdateInstanceAccessControlAttributeConfigurationResponse object

UpdatePermissionSetRequest

  • UpdatePermissionSetRequest object
    • Description
    • InstanceArn required
    • PermissionSetArn required
    • RelayState
    • SessionDuration

UpdatePermissionSetResponse

  • UpdatePermissionSetResponse object

ValidationException