Skip to content

UpdateParticipantAuthenticationRequest

Source code in docs_src/capo_connect/types/update_participant_authentication_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
class UpdateParticipantAuthenticationRequest(TypedDict, closed=True):
    state: "capo_connect.types.participant_token.ParticipantToken"
    """<p>The <code>state</code> query parameter that was provided by Cognito in the <code>redirectUri</code>. This will also match the <code>state</code> parameter provided in the <code>AuthenticationUrl</code> from the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetAuthenticationUrl.html">GetAuthenticationUrl</a> response.</p>"""
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>"""
    code: NotRequired["capo_connect.types.authorization_code.AuthorizationCode"]
    """<p>The <code>code</code> query parameter provided by Cognito in the <code>redirectUri</code>.</p>"""
    error: NotRequired["capo_connect.types.authentication_error.AuthenticationError"]
    """<p>The <code>error</code> query parameter provided by Cognito in the <code>redirectUri</code>.</p>"""
    error_description: NotRequired[
        "capo_connect.types.authentication_error_description.AuthenticationErrorDescription"
    ]
    """<p>The <code>error_description</code> parameter provided by Cognito in the <code>redirectUri</code>.</p>"""

code instance-attribute 

code: NotRequired[AuthorizationCode]

The code query parameter provided by Cognito in the redirectUri.

error instance-attribute 

error: NotRequired[AuthenticationError]

The error query parameter provided by Cognito in the redirectUri.

error_description instance-attribute 

error_description: NotRequired[AuthenticationErrorDescription]

The error_description parameter provided by Cognito in the redirectUri.

instance_id instance-attribute 

instance_id: InstanceId

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

state instance-attribute 

state: ParticipantToken

The state query parameter that was provided by Cognito in the redirectUri. This will also match the state parameter provided in the AuthenticationUrl from the GetAuthenticationUrl response.