SSOAdmin / Client / create_account_assignment

create_account_assignment#

SSOAdmin.Client.create_account_assignment(**kwargs)#

Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.

Note

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

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. 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.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.create_account_assignment(
    InstanceArn='string',
    PermissionSetArn='string',
    PrincipalId='string',
    PrincipalType='USER'|'GROUP',
    TargetId='string',
    TargetType='AWS_ACCOUNT'
)
Parameters:

  • InstanceArn (string) –

    [REQUIRED]

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

  • PermissionSetArn (string) –

    [REQUIRED]

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

  • PrincipalId (string) –

    [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 IAM Identity Center Identity Store API Reference.

  • PrincipalType (string) –

    [REQUIRED]

    The entity type for which the assignment will be created.

  • TargetId (string) –

    [REQUIRED]

    TargetID is an Amazon Web Services account identifier, (For example, 123456789012).

  • TargetType (string) –

    [REQUIRED]

    The entity type for which the assignment will be created.

Return type:

dict

Returns:

Response Syntax

{
    'AccountAssignmentCreationStatus': {
        'CreatedDate': datetime(2015, 1, 1),
        'FailureReason': 'string',
        'PermissionSetArn': 'string',
        'PrincipalId': 'string',
        'PrincipalType': 'USER'|'GROUP',
        'RequestId': 'string',
        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
        'TargetId': 'string',
        'TargetType': 'AWS_ACCOUNT'
    }
}

Response Structure

  • (dict) –

    • AccountAssignmentCreationStatus (dict) –

      The status object for the account assignment creation operation.

      • CreatedDate (datetime) –

        The date that the permission set was created.

      • FailureReason (string) –

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

      • PermissionSetArn (string) –

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

      • PrincipalId (string) –

        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 IAM Identity Center Identity Store API Reference.

      • PrincipalType (string) –

        The entity type for which the assignment will be created.

      • RequestId (string) –

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

      • Status (string) –

        The status of the permission set provisioning process.

      • TargetId (string) –

        TargetID is an Amazon Web Services account identifier, (For example, 123456789012).

      • TargetType (string) –

        The entity type for which the assignment will be created.

Exceptions

  • SSOAdmin.Client.exceptions.ServiceQuotaExceededException

  • SSOAdmin.Client.exceptions.ThrottlingException

  • SSOAdmin.Client.exceptions.InternalServerException

  • SSOAdmin.Client.exceptions.ResourceNotFoundException

  • SSOAdmin.Client.exceptions.AccessDeniedException

  • SSOAdmin.Client.exceptions.ValidationException

  • SSOAdmin.Client.exceptions.ConflictException