Skip to content

CreateIdentitySourceRequest

Source code in docs_src/capo_mpa/types/create_identity_source_request.py 
15
16
17
18
19
20
21
22
23
class CreateIdentitySourceRequest(TypedDict, closed=True):
    identity_source_parameters: (
        "capo_mpa.types.identity_source_parameters.IdentitySourceParameters"
    )
    """<p>A <code> IdentitySourceParameters</code> object. Contains details for the resource that provides identities to the identity source. For example, an IAM Identity Center instance.</p>"""
    client_token: NotRequired["capo_mpa.types.token.Token"]
    """<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services populates this field.</p> <note> <p> <b>What is idempotency?</b> </p> <p>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.</p> <p> <i>Idempotency</i> 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.</p> </note>"""
    tags: NotRequired["capo_mpa.types.tags.Tags"]
    """<p>Tag you want to attach to the identity source.</p>"""

client_token instance-attribute 

client_token: NotRequired[Token]

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

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.

identity_source_parameters instance-attribute 

identity_source_parameters: IdentitySourceParameters

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

tags instance-attribute 

tags: NotRequired[Tags]

Tag you want to attach to the identity source.