Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1437140138.4 KB

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

The term principal here refers to a user or group that is defined in IAM Identity Center.

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. That policy is attached to the IAM role created in IAM Identity Center. 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 must call ProvisionPermissionSet to make these updates.

After a successful response, call DescribeAccountAssignmentCreationStatus to describe the status of an assignment creation request.

post/#X-Amz-Target=SWBExternalService.CreateAccountAssignment

Headers

X-Amz-Target'SWBExternalService.CreateAccountAssignment' required

Request body

InstanceArnstring required

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.

TargetIdstring required

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

TargetType'AWS_ACCOUNT' required

The entity type for which the assignment will be created.

PermissionSetArnstring required

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

PrincipalType'USER' | 'GROUP' required

The entity type for which the assignment will be created.

PrincipalIdstring required

An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the <a href="/singlesignon/latest/IdentityStoreAPIReference/welcome.html">IAM Identity Center Identity Store API Reference</a>.

Response

Success