ListAccountsForProvisionedPermissionSet - AWS Single Sign-On

ListAccountsForProvisionedPermissionSet

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

Request Syntax

{ "InstanceArn": "string", "MaxResults": number, "NextToken": "string", "PermissionSetArn": "string", "ProvisioningStatus": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

InstanceArn

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.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 1224.

Pattern: arn:aws:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}

Required: Yes

MaxResults

The maximum number of results to display for the PermissionSet.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

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

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^[-a-zA-Z0-9+=/]*

Required: No

PermissionSetArn

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

Type: String

Length Constraints: Minimum length of 10. Maximum length of 1224.

Pattern: arn:aws:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}

Required: Yes

ProvisioningStatus

The permission set provisioning status for an AWS account.

Type: String

Valid Values: LATEST_PERMISSION_SET_PROVISIONED | LATEST_PERMISSION_SET_NOT_PROVISIONED

Required: No

Response Syntax

{ "AccountIds": [ "string" ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AccountIds

The list of AWS AccountIds.

Type: Array of strings

Pattern: \d{12}

NextToken

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

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^[-a-zA-Z0-9+=/]*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception, or failure with an internal server.

HTTP Status Code: 400

ResourceNotFoundException

Indicates that a requested resource is not found.

HTTP Status Code: 400

ThrottlingException

Indicates that the principal has crossed the throttling limits of the API operations.

HTTP Status Code: 400

ValidationException

The request failed because it contains a syntax error.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: