AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: AWS.SSOAdmin

Inherits:
AWS.Service show all
Identifier:
ssoadmin
API Version:
2020-07-20
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Sending a Request Using SSOAdmin

var ssoadmin = new AWS.SSOAdmin();
ssoadmin.attachManagedPolicyToPermissionSet(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the SSOAdmin object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var ssoadmin = new AWS.SSOAdmin({apiVersion: '2020-07-20'});

You can also set the API version globally in AWS.config.apiVersions using the ssoadmin service identifier:

AWS.config.apiVersions = {
  ssoadmin: '2020-07-20',
  // other service API versions
};

var ssoadmin = new AWS.SSOAdmin();

Version:

  • 2020-07-20

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.SSOAdmin(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a SSOAdmin object

var ssoadmin = new AWS.SSOAdmin({apiVersion: '2020-07-20'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.SSOAdmin.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.SSOAdmin.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.SSOAdmin.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

attachManagedPolicyToPermissionSet(params = {}, callback) ⇒ AWS.Request

Attaches an IAM managed policy ARN to a permission set.

Note: If the permission set is already referenced by one or more account assignments, you will need to call ProvisionPermissionSet after this action to apply the corresponding IAM policy updates to all assigned accounts.

Examples:

Calling the attachManagedPolicyToPermissionSet operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  ManagedPolicyArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE' /* required */
};
ssoadmin.attachManagedPolicyToPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • PermissionSetArn — (String)

      The ARN of the PermissionSet that the managed policy should be attached to.

    • ManagedPolicyArn — (String)

      The IAM managed policy ARN to be attached to a permission set.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createAccountAssignment(params = {}, callback) ⇒ AWS.Request

Assigns access to a principal for a specified AWS account using a specified permission set.

Note: The term principal here refers to a user or group that is defined in AWS SSO.
Note: As part of a successful CreateAccountAssignment call, the specified permission set will automatically be provisioned to the account in the form of an IAM policy attached to the SSO-created IAM role. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you will need to call ProvisionPermissionSet to make these updates.

Service Reference:

Examples:

Calling the createAccountAssignment operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE', /* required */
  PrincipalId: 'STRING_VALUE', /* required */
  PrincipalType: USER | GROUP, /* required */
  TargetId: 'STRING_VALUE', /* required */
  TargetType: AWS_ACCOUNT /* required */
};
ssoadmin.createAccountAssignment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • TargetId — (String)

      TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).

    • TargetType — (String)

      The entity type for which the assignment will be created.

      Possible values include:
      • "AWS_ACCOUNT"
    • PermissionSetArn — (String)

      The ARN of the permission set that the admin wants to grant the principal access to.

    • PrincipalType — (String)

      The entity type for which the assignment will be created.

      Possible values include:
      • "USER"
      • "GROUP"
    • PrincipalId — (String)

      An identifier for an object in AWS SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in AWS SSO, see the AWS SSO Identity Store API Reference.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccountAssignmentCreationStatus — (map)

        The status object for the account assignment creation operation.

        • Status — (String)

          The status of the permission set provisioning process.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
        • RequestId — (String)

          The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

        • FailureReason — (String)

          The message that contains an error or exception in case of an operation failure.

        • TargetId — (String)

          TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).

        • TargetType — (String)

          The entity type for which the assignment will be created.

          Possible values include:
          • "AWS_ACCOUNT"
        • PermissionSetArn — (String)

          The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

        • PrincipalType — (String)

          The entity type for which the assignment will be created.

          Possible values include:
          • "USER"
          • "GROUP"
        • PrincipalId — (String)

          An identifier for an object in AWS SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in AWS SSO, see the AWS SSO Identity Store API Reference.

        • CreatedDate — (Date)

          The date that the permission set was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createPermissionSet(params = {}, callback) ⇒ AWS.Request

Creates a permission set within a specified SSO instance.

Note: To grant users and groups access to AWS account resources, use CreateAccountAssignment .

Service Reference:

Examples:

Calling the createPermissionSet operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  RelayState: 'STRING_VALUE',
  SessionDuration: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
ssoadmin.createPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the PermissionSet.

    • Description — (String)

      The description of the PermissionSet.

    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • SessionDuration — (String)

      The length of time that the application user sessions are valid in the ISO-8601 standard.

    • RelayState — (String)

      Used to redirect users within the application during the federation authentication process.

    • Tags — (Array<map>)

      The tags to attach to the new PermissionSet.

      • Key — (String)

        The key for the tag.

      • Value — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PermissionSet — (map)

        Defines the level of access on an AWS account.

        • Name — (String)

          The name of the permission set.

        • PermissionSetArn — (String)

          The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

        • Description — (String)

          The description of the PermissionSet.

        • CreatedDate — (Date)

          The date that the permission set was created.

        • SessionDuration — (String)

          The length of time that the application user sessions are valid for in the ISO-8601 standard.

        • RelayState — (String)

          Used to redirect users within the application during the federation authentication process.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteAccountAssignment(params = {}, callback) ⇒ AWS.Request

Deletes a principal's access from a specified AWS account using a specified permission set.

Service Reference:

Examples:

Calling the deleteAccountAssignment operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE', /* required */
  PrincipalId: 'STRING_VALUE', /* required */
  PrincipalType: USER | GROUP, /* required */
  TargetId: 'STRING_VALUE', /* required */
  TargetType: AWS_ACCOUNT /* required */
};
ssoadmin.deleteAccountAssignment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • TargetId — (String)

      TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).

    • TargetType — (String)

      The entity type for which the assignment will be deleted.

      Possible values include:
      • "AWS_ACCOUNT"
    • PermissionSetArn — (String)

      The ARN of the permission set that will be used to remove access.

    • PrincipalType — (String)

      The entity type for which the assignment will be deleted.

      Possible values include:
      • "USER"
      • "GROUP"
    • PrincipalId — (String)

      An identifier for an object in AWS SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in AWS SSO, see the AWS SSO Identity Store API Reference.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccountAssignmentDeletionStatus — (map)

        The status object for the account assignment deletion operation.

        • Status — (String)

          The status of the permission set provisioning process.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
        • RequestId — (String)

          The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

        • FailureReason — (String)

          The message that contains an error or exception in case of an operation failure.

        • TargetId — (String)

          TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).

        • TargetType — (String)

          The entity type for which the assignment will be created.

          Possible values include:
          • "AWS_ACCOUNT"
        • PermissionSetArn — (String)

          The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

        • PrincipalType — (String)

          The entity type for which the assignment will be created.

          Possible values include:
          • "USER"
          • "GROUP"
        • PrincipalId — (String)

          An identifier for an object in AWS SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in AWS SSO, see the AWS SSO Identity Store API Reference.

        • CreatedDate — (Date)

          The date that the permission set was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteInlinePolicyFromPermissionSet(params = {}, callback) ⇒ AWS.Request

Deletes the inline policy from a specified permission set.

Examples:

Calling the deleteInlinePolicyFromPermissionSet operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE' /* required */
};
ssoadmin.deleteInlinePolicyFromPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • PermissionSetArn — (String)

      The ARN of the permission set that will be used to remove access.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deletePermissionSet(params = {}, callback) ⇒ AWS.Request

Deletes the specified permission set.

Service Reference:

Examples:

Calling the deletePermissionSet operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE' /* required */
};
ssoadmin.deletePermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • PermissionSetArn — (String)

      The ARN of the permission set that should be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeAccountAssignmentCreationStatus(params = {}, callback) ⇒ AWS.Request

Describes the status of the assignment creation request.

Examples:

Calling the describeAccountAssignmentCreationStatus operation

var params = {
  AccountAssignmentCreationRequestId: 'STRING_VALUE', /* required */
  InstanceArn: 'STRING_VALUE' /* required */
};
ssoadmin.describeAccountAssignmentCreationStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • AccountAssignmentCreationRequestId — (String)

      The identifier that is used to track the request operation progress.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccountAssignmentCreationStatus — (map)

        The status object for the account assignment creation operation.

        • Status — (String)

          The status of the permission set provisioning process.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
        • RequestId — (String)

          The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

        • FailureReason — (String)

          The message that contains an error or exception in case of an operation failure.

        • TargetId — (String)

          TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).

        • TargetType — (String)

          The entity type for which the assignment will be created.

          Possible values include:
          • "AWS_ACCOUNT"
        • PermissionSetArn — (String)

          The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

        • PrincipalType — (String)

          The entity type for which the assignment will be created.

          Possible values include:
          • "USER"
          • "GROUP"
        • PrincipalId — (String)

          An identifier for an object in AWS SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in AWS SSO, see the AWS SSO Identity Store API Reference.

        • CreatedDate — (Date)

          The date that the permission set was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeAccountAssignmentDeletionStatus(params = {}, callback) ⇒ AWS.Request

Describes the status of the assignment deletion request.

Examples:

Calling the describeAccountAssignmentDeletionStatus operation

var params = {
  AccountAssignmentDeletionRequestId: 'STRING_VALUE', /* required */
  InstanceArn: 'STRING_VALUE' /* required */
};
ssoadmin.describeAccountAssignmentDeletionStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • AccountAssignmentDeletionRequestId — (String)

      The identifier that is used to track the request operation progress.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccountAssignmentDeletionStatus — (map)

        The status object for the account assignment deletion operation.

        • Status — (String)

          The status of the permission set provisioning process.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
        • RequestId — (String)

          The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

        • FailureReason — (String)

          The message that contains an error or exception in case of an operation failure.

        • TargetId — (String)

          TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).

        • TargetType — (String)

          The entity type for which the assignment will be created.

          Possible values include:
          • "AWS_ACCOUNT"
        • PermissionSetArn — (String)

          The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

        • PrincipalType — (String)

          The entity type for which the assignment will be created.

          Possible values include:
          • "USER"
          • "GROUP"
        • PrincipalId — (String)

          An identifier for an object in AWS SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in AWS SSO, see the AWS SSO Identity Store API Reference.

        • CreatedDate — (Date)

          The date that the permission set was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describePermissionSet(params = {}, callback) ⇒ AWS.Request

Gets the details of the permission set.

Service Reference:

Examples:

Calling the describePermissionSet operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE' /* required */
};
ssoadmin.describePermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • PermissionSetArn — (String)

      The ARN of the permission set.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PermissionSet — (map)

        Describes the level of access on an AWS account.

        • Name — (String)

          The name of the permission set.

        • PermissionSetArn — (String)

          The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

        • Description — (String)

          The description of the PermissionSet.

        • CreatedDate — (Date)

          The date that the permission set was created.

        • SessionDuration — (String)

          The length of time that the application user sessions are valid for in the ISO-8601 standard.

        • RelayState — (String)

          Used to redirect users within the application during the federation authentication process.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describePermissionSetProvisioningStatus(params = {}, callback) ⇒ AWS.Request

Describes the status for the given permission set provisioning request.

Examples:

Calling the describePermissionSetProvisioningStatus operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  ProvisionPermissionSetRequestId: 'STRING_VALUE' /* required */
};
ssoadmin.describePermissionSetProvisioningStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • ProvisionPermissionSetRequestId — (String)

      The identifier that is provided by the ProvisionPermissionSet call to retrieve the current status of the provisioning workflow.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PermissionSetProvisioningStatus — (map)

        The status object for the permission set provisioning operation.

        • Status — (String)

          The status of the permission set provisioning process.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
        • RequestId — (String)

          The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

        • AccountId — (String)

          The identifier of the AWS account from which to list the assignments.

        • PermissionSetArn — (String)

          The ARN of the permission set that is being provisioned. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

        • FailureReason — (String)

          The message that contains an error or exception in case of an operation failure.

        • CreatedDate — (Date)

          The date that the permission set was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

detachManagedPolicyFromPermissionSet(params = {}, callback) ⇒ AWS.Request

Detaches the attached IAM managed policy ARN from the specified permission set.

Examples:

Calling the detachManagedPolicyFromPermissionSet operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  ManagedPolicyArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE' /* required */
};
ssoadmin.detachManagedPolicyFromPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • PermissionSetArn — (String)

      The ARN of the PermissionSet from which the policy should be detached.

    • ManagedPolicyArn — (String)

      The IAM managed policy ARN to be attached to a permission set.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getInlinePolicyForPermissionSet(params = {}, callback) ⇒ AWS.Request

Obtains the inline policy assigned to the permission set.

Service Reference:

Examples:

Calling the getInlinePolicyForPermissionSet operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE' /* required */
};
ssoadmin.getInlinePolicyForPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • PermissionSetArn — (String)

      The ARN of the permission set.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InlinePolicy — (String)

        The IAM inline policy that is attached to the permission set.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAccountAssignmentCreationStatus(params = {}, callback) ⇒ AWS.Request

Lists the status of the AWS account assignment creation requests for a specified SSO instance.

Examples:

Calling the listAccountAssignmentCreationStatus operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  Filter: {
    Status: IN_PROGRESS | FAILED | SUCCEEDED
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssoadmin.listAccountAssignmentCreationStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • MaxResults — (Integer)

      The maximum number of results to display for the assignment.

    • NextToken — (String)

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    • Filter — (map)

      Filters results based on the passed attribute value.

      • Status — (String)

        Filters the list operations result based on the status attribute.

        Possible values include:
        • "IN_PROGRESS"
        • "FAILED"
        • "SUCCEEDED"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccountAssignmentsCreationStatus — (Array<map>)

        The status object for the account assignment creation operation.

        • Status — (String)

          The status of the permission set provisioning process.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
        • RequestId — (String)

          The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

        • CreatedDate — (Date)

          The date that the permission set was created.

      • NextToken — (String)

        The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAccountAssignmentDeletionStatus(params = {}, callback) ⇒ AWS.Request

Lists the status of the AWS account assignment deletion requests for a specified SSO instance.

Examples:

Calling the listAccountAssignmentDeletionStatus operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  Filter: {
    Status: IN_PROGRESS | FAILED | SUCCEEDED
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssoadmin.listAccountAssignmentDeletionStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • MaxResults — (Integer)

      The maximum number of results to display for the assignment.

    • NextToken — (String)

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    • Filter — (map)

      Filters results based on the passed attribute value.

      • Status — (String)

        Filters the list operations result based on the status attribute.

        Possible values include:
        • "IN_PROGRESS"
        • "FAILED"
        • "SUCCEEDED"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccountAssignmentsDeletionStatus — (Array<map>)

        The status object for the account assignment deletion operation.

        • Status — (String)

          The status of the permission set provisioning process.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
        • RequestId — (String)

          The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

        • CreatedDate — (Date)

          The date that the permission set was created.

      • NextToken — (String)

        The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAccountAssignments(params = {}, callback) ⇒ AWS.Request

Lists the assignee of the specified AWS account with the specified permission set.

Service Reference:

Examples:

Calling the listAccountAssignments operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssoadmin.listAccountAssignments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • AccountId — (String)

      The identifier of the AWS account from which to list the assignments.

    • PermissionSetArn — (String)

      The ARN of the permission set from which to list assignments.

    • MaxResults — (Integer)

      The maximum number of results to display for the assignment.

    • NextToken — (String)

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccountAssignments — (Array<map>)

        The list of assignments that match the input AWS account and permission set.

        • AccountId — (String)

          The identifier of the AWS account.

        • PermissionSetArn — (String)

          The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

        • PrincipalType — (String)

          The entity type for which the assignment will be created.

          Possible values include:
          • "USER"
          • "GROUP"
        • PrincipalId — (String)

          An identifier for an object in AWS SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in AWS SSO, see the AWS SSO Identity Store API Reference.

      • NextToken — (String)

        The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAccountsForProvisionedPermissionSet(params = {}, callback) ⇒ AWS.Request

Lists all the AWS accounts where the specified permission set is provisioned.

Examples:

Calling the listAccountsForProvisionedPermissionSet operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ProvisioningStatus: LATEST_PERMISSION_SET_PROVISIONED | LATEST_PERMISSION_SET_NOT_PROVISIONED
};
ssoadmin.listAccountsForProvisionedPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • PermissionSetArn — (String)

      The ARN of the PermissionSet from which the associated AWS accounts will be listed.

    • ProvisioningStatus — (String)

      The permission set provisioning status for an AWS account.

      Possible values include:
      • "LATEST_PERMISSION_SET_PROVISIONED"
      • "LATEST_PERMISSION_SET_NOT_PROVISIONED"
    • MaxResults — (Integer)

      The maximum number of results to display for the PermissionSet.

    • NextToken — (String)

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccountIds — (Array<String>)

        The list of AWS AccountIds.

      • NextToken — (String)

        The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listInstances(params = {}, callback) ⇒ AWS.Request

Lists the SSO instances that the caller has access to.

Service Reference:

Examples:

Calling the listInstances operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssoadmin.listInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      The maximum number of results to display for the instance.

    • NextToken — (String)

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Instances — (Array<map>)

        Lists the SSO instances that the caller has access to.

        • InstanceArn — (String)

          The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

        • IdentityStoreId — (String)

          The identifier of the identity store that is connected to the SSO instance.

      • NextToken — (String)

        The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listManagedPoliciesInPermissionSet(params = {}, callback) ⇒ AWS.Request

Lists the IAM managed policy that is attached to a specified permission set.

Examples:

Calling the listManagedPoliciesInPermissionSet operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssoadmin.listManagedPoliciesInPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • PermissionSetArn — (String)

      The ARN of the PermissionSet whose managed policies will be listed.

    • MaxResults — (Integer)

      The maximum number of results to display for the PermissionSet.

    • NextToken — (String)

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AttachedManagedPolicies — (Array<map>)

        The array of the AttachedManagedPolicy data type object.

      • NextToken — (String)

        The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listPermissionSetProvisioningStatus(params = {}, callback) ⇒ AWS.Request

Lists the status of the permission set provisioning requests for a specified SSO instance.

Examples:

Calling the listPermissionSetProvisioningStatus operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  Filter: {
    Status: IN_PROGRESS | FAILED | SUCCEEDED
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssoadmin.listPermissionSetProvisioningStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • MaxResults — (Integer)

      The maximum number of results to display for the assignment.

    • NextToken — (String)

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    • Filter — (map)

      Filters results based on the passed attribute value.

      • Status — (String)

        Filters the list operations result based on the status attribute.

        Possible values include:
        • "IN_PROGRESS"
        • "FAILED"
        • "SUCCEEDED"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PermissionSetsProvisioningStatus — (Array<map>)

        The status object for the permission set provisioning operation.

        • Status — (String)

          The status of the permission set provisioning process.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
        • RequestId — (String)

          The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

        • CreatedDate — (Date)

          The date that the permission set was created.

      • NextToken — (String)

        The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listPermissionSets(params = {}, callback) ⇒ AWS.Request

Lists the PermissionSets in an SSO instance.

Service Reference:

Examples:

Calling the listPermissionSets operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssoadmin.listPermissionSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • NextToken — (String)

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    • MaxResults — (Integer)

      The maximum number of results to display for the assignment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PermissionSets — (Array<String>)

        Defines the level of access on an AWS account.

      • NextToken — (String)

        The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listPermissionSetsProvisionedToAccount(params = {}, callback) ⇒ AWS.Request

Lists all the permission sets that are provisioned to a specified AWS account.

Examples:

Calling the listPermissionSetsProvisionedToAccount operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  InstanceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ProvisioningStatus: LATEST_PERMISSION_SET_PROVISIONED | LATEST_PERMISSION_SET_NOT_PROVISIONED
};
ssoadmin.listPermissionSetsProvisionedToAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • AccountId — (String)

      The identifier of the AWS account from which to list the assignments.

    • ProvisioningStatus — (String)

      The status object for the permission set provisioning operation.

      Possible values include:
      • "LATEST_PERMISSION_SET_PROVISIONED"
      • "LATEST_PERMISSION_SET_NOT_PROVISIONED"
    • MaxResults — (Integer)

      The maximum number of results to display for the assignment.

    • NextToken — (String)

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

      • PermissionSets — (Array<String>)

        Defines the level of access that an AWS account has.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags that are attached to a specified resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  ResourceArn: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE'
};
ssoadmin.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • ResourceArn — (String)

      The ARN of the resource with the tags to be listed.

    • NextToken — (String)

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        A set of key-value pairs that are used to manage the resource.

        • Key — (String)

          The key for the tag.

        • Value — (String)

          The value of the tag.

      • NextToken — (String)

        The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

provisionPermissionSet(params = {}, callback) ⇒ AWS.Request

The process by which a specified permission set is provisioned to the specified target.

Service Reference:

Examples:

Calling the provisionPermissionSet operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE', /* required */
  TargetType: AWS_ACCOUNT | ALL_PROVISIONED_ACCOUNTS, /* required */
  TargetId: 'STRING_VALUE'
};
ssoadmin.provisionPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • PermissionSetArn — (String)

      The ARN of the permission set.

    • TargetId — (String)

      TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).

    • TargetType — (String)

      The entity type for which the assignment will be created.

      Possible values include:
      • "AWS_ACCOUNT"
      • "ALL_PROVISIONED_ACCOUNTS"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PermissionSetProvisioningStatus — (map)

        The status object for the permission set provisioning operation.

        • Status — (String)

          The status of the permission set provisioning process.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
        • RequestId — (String)

          The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

        • AccountId — (String)

          The identifier of the AWS account from which to list the assignments.

        • PermissionSetArn — (String)

          The ARN of the permission set that is being provisioned. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

        • FailureReason — (String)

          The message that contains an error or exception in case of an operation failure.

        • CreatedDate — (Date)

          The date that the permission set was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putInlinePolicyToPermissionSet(params = {}, callback) ⇒ AWS.Request

Attaches an IAM inline policy to a permission set.

Note: If the permission set is already referenced by one or more account assignments, you will need to call ProvisionPermissionSet after this action to apply the corresponding IAM policy updates to all assigned accounts.

Service Reference:

Examples:

Calling the putInlinePolicyToPermissionSet operation

var params = {
  InlinePolicy: 'STRING_VALUE', /* required */
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE' /* required */
};
ssoadmin.putInlinePolicyToPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • PermissionSetArn — (String)

      The ARN of the permission set.

    • InlinePolicy — (String)

      The IAM inline policy to attach to a PermissionSet.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Associates a set of tags with a specified resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
ssoadmin.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • ResourceArn — (String)

      The ARN of the resource with the tags to be listed.

    • Tags — (Array<map>)

      A set of key-value pairs that are used to manage the resource.

      • Key — (String)

        The key for the tag.

      • Value — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Disassociates a set of tags from a specified resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ssoadmin.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • ResourceArn — (String)

      The ARN of the resource with the tags to be listed.

    • TagKeys — (Array<String>)

      The keys of tags that are attached to the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updatePermissionSet(params = {}, callback) ⇒ AWS.Request

Updates an existing permission set.

Service Reference:

Examples:

Calling the updatePermissionSet operation

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  RelayState: 'STRING_VALUE',
  SessionDuration: 'STRING_VALUE'
};
ssoadmin.updatePermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InstanceArn — (String)

      The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    • PermissionSetArn — (String)

      The ARN of the permission set.

    • Description — (String)

      The description of the PermissionSet.

    • SessionDuration — (String)

      The length of time that the application user sessions are valid for in the ISO-8601 standard.

    • RelayState — (String)

      Used to redirect users within the application during the federation authentication process.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.