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(
    InstanceArn='string',
    MaxResults=123,
    NextToken='string',
    Filter={
        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
    }
)
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 AWS Service Namespaces in the AWS 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.
  • Filter (dict) --

    Filters results based on the passed attribute value.

    • Status (string) --

      Filters the list operations result based on the status attribute.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • PermissionSetsProvisioningStatus (list) --

      The status object for the permission set provisioning operation.

      • (dict) --

        Provides information about the permission set provisioning status.

        • Status (string) --

          The status of the permission set provisioning process.

        • RequestId (string) --

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

        • CreatedDate (datetime) --

          The date that the permission set was created.

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

Exceptions

  • SSOAdmin.Client.exceptions.ResourceNotFoundException
  • SSOAdmin.Client.exceptions.InternalServerException
  • SSOAdmin.Client.exceptions.ThrottlingException
  • SSOAdmin.Client.exceptions.ValidationException
  • SSOAdmin.Client.exceptions.AccessDeniedException