MultipartyApproval / Client / create_identity_source

create_identity_source

MultipartyApproval.Client.create_identity_source(**kwargs)

Creates a new identity source. For more information, see Identity Source in the Multi-party approval User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_identity_source(
    IdentitySourceParameters={
        'IamIdentityCenter': {
            'InstanceArn': 'string',
            'Region': 'string'
        }
    },
    ClientToken='string',
    Tags={
        'string': 'string'
    }
)
Parameters:

  • IdentitySourceParameters (dict) –

    [REQUIRED]

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

    • IamIdentityCenter (dict) –

      IAM Identity Center credentials.

      • InstanceArn (string) – [REQUIRED]

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

      • Region (string) – [REQUIRED]

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

  • ClientToken (string) –

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services populates this field.

    Note

    What is idempotency?

    When you make a mutating API request, the request typically returns a result before the operation’s asynchronous workflows have completed. Operations might also time out or encounter other server issues before they complete, even though the request has already returned a result. This could make it difficult to determine whether the request succeeded or not, and could lead to multiple retries to ensure that the operation completes successfully. However, if the original request and the subsequent retries are successful, the operation is completed multiple times. This means that you might create more resources than you intended.

    Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.

    This field is autopopulated if not provided.

  • Tags (dict) –

    Tag you want to attach to the identity source.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'IdentitySourceType': 'IAM_IDENTITY_CENTER',
    'IdentitySourceArn': 'string',
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • IdentitySourceType (string) –

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

    • IdentitySourceArn (string) –

      Amazon Resource Name (ARN) for the identity source that was created.

    • CreationTime (datetime) –

      Timestamp when the identity source was created.

Exceptions