MultipartyApproval / Client / list_identity_sources

list_identity_sources

MultipartyApproval.Client.list_identity_sources(**kwargs)

Returns a list of identity sources. For more information, see Identity Source in the Multi-party approval User Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_identity_sources(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

  • NextToken (string) – If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    '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) –

    • NextToken (string) –

      If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a next call to the operation to get more output. You can repeat this until the NextToken response element returns null.

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

Exceptions