KinesisAnalyticsV2 / Client / create_application_presigned_url

create_application_presigned_url#

KinesisAnalyticsV2.Client.create_application_presigned_url(**kwargs)#

Creates and returns a URL that you can use to connect to an application’s extension.

The IAM role or user used to call this API defines the permissions to access the extension. After the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request that attempts to connect to the extension.

You control the amount of time that the URL will be valid using the SessionExpirationDurationInSeconds parameter. If you do not provide this parameter, the returned URL is valid for twelve hours.

Note

The URL that you get from a call to CreateApplicationPresignedUrl must be used within 3 minutes to be valid. If you first try to use the URL after the 3-minute limit expires, the service returns an HTTP 403 Forbidden error.

See also: AWS API Documentation

Request Syntax

response = client.create_application_presigned_url(
    ApplicationName='string',
    UrlType='FLINK_DASHBOARD_URL'|'ZEPPELIN_UI_URL',
    SessionExpirationDurationInSeconds=123
)
Parameters:

  • ApplicationName (string) –

    [REQUIRED]

    The name of the application.

  • UrlType (string) –

    [REQUIRED]

    The type of the extension for which to create and return a URL. Currently, the only valid extension URL type is FLINK_DASHBOARD_URL.

  • SessionExpirationDurationInSeconds (integer) – The duration in seconds for which the returned URL will be valid.

Return type:

dict

Returns:

Response Syntax

{
    'AuthorizedUrl': 'string'
}

Response Structure

  • (dict) –

    • AuthorizedUrl (string) –

      The URL of the extension.

Exceptions

  • KinesisAnalyticsV2.Client.exceptions.ResourceNotFoundException

  • KinesisAnalyticsV2.Client.exceptions.ResourceInUseException

  • KinesisAnalyticsV2.Client.exceptions.InvalidArgumentException