SSOAdmin / Client / provision_permission_set

provision_permission_set#

SSOAdmin.Client.provision_permission_set(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.provision_permission_set(
    InstanceArn='string',
    PermissionSetArn='string',
    TargetId='string',
    TargetType='AWS_ACCOUNT'|'ALL_PROVISIONED_ACCOUNTS'
)
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.

  • TargetId (string) – 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

{
    'PermissionSetProvisioningStatus': {
        'AccountId': 'string',
        'CreatedDate': datetime(2015, 1, 1),
        'FailureReason': 'string',
        'PermissionSetArn': 'string',
        'RequestId': 'string',
        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
    }
}

Response Structure

  • (dict) –

    • PermissionSetProvisioningStatus (dict) –

      The status object for the permission set provisioning operation.

      • AccountId (string) –

        The identifier of the Amazon Web Services account from which to list the assignments.

      • 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 that is being provisioned. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

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

Exceptions