MultipartyApproval / Paginator / ListIdentitySources

ListIdentitySources

class MultipartyApproval.Paginator.ListIdentitySources

paginator = client.get_paginator('list_identity_sources')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MultipartyApproval.Client.list_identity_sources().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'IdentitySources': [
        {
            'IdentitySourceType': 'IAM_IDENTITY_CENTER',
            'IdentitySourceParameters': {
                'IamIdentityCenter': {
                    'InstanceArn': 'string',
                    'ApprovalPortalUrl': 'string',
                    'Region': 'string'
                }
            },
            'IdentitySourceArn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'Status': 'CREATING'|'ACTIVE'|'DELETING'|'ERROR',
            'StatusCode': 'ACCESS_DENIED'|'DELETION_FAILED'|'IDC_INSTANCE_NOT_FOUND'|'IDC_INSTANCE_NOT_VALID',
            'StatusMessage': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • IdentitySources (list) –

    A IdentitySources. Contains details for identity sources.

    • (dict) –

      Contains details for an identity source. For more information, see Identity source in the Multi-party approval User Guide.

      • IdentitySourceType (string) –

        The type of resource that provided identities to the identity source. For example, an IAM Identity Center instance.

      • IdentitySourceParameters (dict) –

        A IdentitySourceParametersForList object. Contains details for the resource that provides identities to the identity source. For example, an IAM Identity Center instance.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: IamIdentityCenter. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • IamIdentityCenter (dict) –

          IAM Identity Center credentials.

          • InstanceArn (string) –

            Amazon Resource Name (ARN) for the IAM Identity Center instance.

          • ApprovalPortalUrl (string) –

            URL for the approval portal associated with the IAM Identity Center instance.

          • Region (string) –

            Amazon Web Services Region where the IAM Identity Center instance is located.

      • IdentitySourceArn (string) –

        Amazon Resource Name (ARN) for the identity source.

      • CreationTime (datetime) –

        Timestamp when the identity source was created.

      • Status (string) –

        Status for the identity source. For example, if the identity source is ACTIVE.

      • StatusCode (string) –

        Status code of the identity source.

      • StatusMessage (string) –

        Message describing the status for the identity source.