SSOAdmin / Client / list_permission_set_provisioning_status

list_permission_set_provisioning_status#

SSOAdmin.Client.list_permission_set_provisioning_status(**kwargs)#

Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.

See also: AWS API Documentation

Request Syntax

response = client.list_permission_set_provisioning_status(
    Filter={
        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
    },
    InstanceArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:
  • Filter (dict) –

    Filters results based on the passed attribute value.

    • Status (string) –

      Filters the list operations result based on the status attribute.

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

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

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'PermissionSetsProvisioningStatus': [
        {
            'CreatedDate': datetime(2015, 1, 1),
            'RequestId': 'string',
            'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
        },
    ]
}

Response Structure

  • (dict) –

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

    • PermissionSetsProvisioningStatus (list) –

      The status object for the permission set provisioning operation.

      • (dict) –

        Provides information about the permission set provisioning status.

        • CreatedDate (datetime) –

          The date that the permission set was 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.

Exceptions

  • SSOAdmin.Client.exceptions.ThrottlingException

  • SSOAdmin.Client.exceptions.InternalServerException

  • SSOAdmin.Client.exceptions.ResourceNotFoundException

  • SSOAdmin.Client.exceptions.AccessDeniedException

  • SSOAdmin.Client.exceptions.ValidationException