CloudWatchOmni / Client / create_one_time_deep_link_code

create_one_time_deep_link_code

CloudWatchOmni.Client.create_one_time_deep_link_code(**kwargs)

Generates a one-time code for deep-link authentication.

Direct the user’s browser to the returned deepLinkUrl before it expires. The code is exchanged for an authenticated, domain-scoped session and can be used only once.

See also: AWS API Documentation

Request Syntax

response = client.create_one_time_deep_link_code(
    domainId='string',
    ttlSeconds=123,
    redirectUrl='string'
)

Parameters:

• domainId (string) –

  [REQUIRED]

  The ID of the domain to generate the code for.

• ttlSeconds (integer) – How long the code remains valid, in seconds. Defaults to 300.

• redirectUrl (string) – The URL to redirect to after the deep-link code is used. Must be an HTTPS URL in the domain with a path of /auth/callback, and cannot include a query string or fragment. If omitted, no redirect is applied.

Return type:

dict

Returns:

Response Syntax

{
    'code': 'string',
    'deepLinkUrl': 'string',
    'expiresAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • code (string) –

    The one-time deep-link code.

  • deepLinkUrl (string) –

    The deep-link URL containing the one-time code.

  • expiresAt (datetime) –

    The timestamp when the code expires.

Exceptions

• CloudWatchOmni.Client.exceptions.ThrottlingException

• CloudWatchOmni.Client.exceptions.ValidationException

• CloudWatchOmni.Client.exceptions.ResourceNotFoundException

• CloudWatchOmni.Client.exceptions.AccessDeniedException

• CloudWatchOmni.Client.exceptions.InternalServerException