CreateApplicationPresignedUrl - Amazon Kinesis Analytics

CreateApplicationPresignedUrl

Creates and returns a URL that you can use to connect to an application's extension. Currently, the only available extension is the Apache Flink dashboard.

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.

Request Syntax

{ "ApplicationName": "string", "SessionExpirationDurationInSeconds": number, "UrlType": "string" }

Request Parameters

The request accepts the following data in JSON format.

ApplicationName

The name of the application.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

SessionExpirationDurationInSeconds

The duration in seconds for which the returned URL will be valid.

Type: Long

Valid Range: Minimum value of 1800. Maximum value of 43200.

Required: No

UrlType

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

Type: String

Valid Values: FLINK_DASHBOARD_URL

Required: Yes

Response Syntax

{ "AuthorizedUrl": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AuthorizedUrl

The URL of the extension.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

InvalidArgumentException

The specified input parameter value is not valid.

HTTP Status Code: 400

ResourceInUseException

The application is not available for this operation.

HTTP Status Code: 400

ResourceNotFoundException

Specified application can't be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: