AWS SDK for PHP 3.x

Client: Aws\KinesisAnalyticsV2\KinesisAnalyticsV2Client

Service ID: kinesisanalyticsv2

Version: 2018-05-23

This page describes the parameters and results for the operations of the Amazon Kinesis Analytics (2018-05-23), and shows how to use the Aws\KinesisAnalyticsV2\KinesisAnalyticsV2Client object to call the described operations. This documentation is specific to the 2018-05-23 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AddApplicationCloudWatchLoggingOption ( array $params = [] )
Adds an Amazon CloudWatch log stream to monitor application configuration errors.
AddApplicationInput ( array $params = [] )
Adds a streaming source to your SQL-based Kinesis Data Analytics application.
AddApplicationInputProcessingConfiguration ( array $params = [] )
Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application.
AddApplicationOutput ( array $params = [] )
Adds an external destination to your SQL-based Kinesis Data Analytics application.
AddApplicationReferenceDataSource ( array $params = [] )
Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.
AddApplicationVpcConfiguration ( array $params = [] )
Adds a Virtual Private Cloud (VPC) configuration to the application.
CreateApplication ( array $params = [] )
Creates a Kinesis Data Analytics application.
CreateApplicationPresignedUrl ( array $params = [] )
Creates and returns a URL that you can use to connect to an application's extension.
CreateApplicationSnapshot ( array $params = [] )
Creates a snapshot of the application's state data.
DeleteApplication ( array $params = [] )
Deletes the specified application.
DeleteApplicationCloudWatchLoggingOption ( array $params = [] )
Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.
DeleteApplicationInputProcessingConfiguration ( array $params = [] )
Deletes an InputProcessingConfiguration from an input.
DeleteApplicationOutput ( array $params = [] )
Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration.
DeleteApplicationReferenceDataSource ( array $params = [] )
Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration.
DeleteApplicationSnapshot ( array $params = [] )
Deletes a snapshot of application state.
DeleteApplicationVpcConfiguration ( array $params = [] )
Removes a VPC configuration from a Kinesis Data Analytics application.
DescribeApplication ( array $params = [] )
Returns information about a specific Kinesis Data Analytics application.
DescribeApplicationSnapshot ( array $params = [] )
Returns information about a snapshot of application state data.
DescribeApplicationVersion ( array $params = [] )
Provides a detailed description of a specified version of the application.
DiscoverInputSchema ( array $params = [] )
Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object.
ListApplicationSnapshots ( array $params = [] )
Lists information about the current application snapshots.
ListApplicationVersions ( array $params = [] )
Lists all the versions for the specified application, including versions that were rolled back.
ListApplications ( array $params = [] )
Returns a list of Kinesis Data Analytics applications in your account.
ListTagsForResource ( array $params = [] )
Retrieves the list of key-value tags assigned to the application.
RollbackApplication ( array $params = [] )
Reverts the application to the previous running version.
StartApplication ( array $params = [] )
Starts the specified Kinesis Data Analytics application.
StopApplication ( array $params = [] )
Stops the application from processing data.
TagResource ( array $params = [] )
Adds one or more key-value tags to a Kinesis Data Analytics application.
UntagResource ( array $params = [] )
Removes one or more tags from a Kinesis Data Analytics application.
UpdateApplication ( array $params = [] )
Updates an existing Kinesis Data Analytics application.
UpdateApplicationMaintenanceConfiguration ( array $params = [] )
Updates the maintenance configuration of the Kinesis Data Analytics application.

Operations

AddApplicationCloudWatchLoggingOption

$result = $client->addApplicationCloudWatchLoggingOption([/* ... */]);
$promise = $client->addApplicationCloudWatchLoggingOptionAsync([/* ... */]);

Adds an Amazon CloudWatch log stream to monitor application configuration errors.

Parameter Syntax

$result = $client->addApplicationCloudWatchLoggingOption([
    'ApplicationName' => '<string>', // REQUIRED
    'CloudWatchLoggingOption' => [ // REQUIRED
        'LogStreamARN' => '<string>', // REQUIRED
    ],
    'ConditionalToken' => '<string>',
    'CurrentApplicationVersionId' => <integer>,
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The Kinesis Data Analytics application name.

CloudWatchLoggingOption

Required: Yes
Type: CloudWatchLoggingOption structure

Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN).

ConditionalToken

Type: string

A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get the application's current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

CurrentApplicationVersionId

Type: long (int|float)

The version ID of the Kinesis Data Analytics application. You must provide the CurrentApplicationVersionId or the ConditionalToken.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

Result Syntax

[
    'ApplicationARN' => '<string>',
    'ApplicationVersionId' => <integer>,
    'CloudWatchLoggingOptionDescriptions' => [
        [
            'CloudWatchLoggingOptionId' => '<string>',
            'LogStreamARN' => '<string>',
            'RoleARN' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

ApplicationARN

Type: string

The application's ARN.

ApplicationVersionId

Type: long (int|float)

The new version ID of the Kinesis Data Analytics application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options.

CloudWatchLoggingOptionDescriptions

Type: Array of CloudWatchLoggingOptionDescription structures

The descriptions of the current CloudWatch logging options for the Kinesis Data Analytics application.

Errors

ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
InvalidArgumentException:
The specified input parameter value is not valid.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
InvalidRequestException:
The request JSON is not valid for the operation.
InvalidApplicationConfigurationException:
The user-provided application configuration is not valid.

AddApplicationInput

$result = $client->addApplicationInput([/* ... */]);
$promise = $client->addApplicationInputAsync([/* ... */]);

Adds a streaming source to your SQL-based Kinesis Data Analytics application.

You can add a streaming source when you create an application, or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication.

Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.

Parameter Syntax

$result = $client->addApplicationInput([
    'ApplicationName' => '<string>', // REQUIRED
    'CurrentApplicationVersionId' => <integer>, // REQUIRED
    'Input' => [ // REQUIRED
        'InputParallelism' => [
            'Count' => <integer>,
        ],
        'InputProcessingConfiguration' => [
            'InputLambdaProcessor' => [ // REQUIRED
                'ResourceARN' => '<string>', // REQUIRED
            ],
        ],
        'InputSchema' => [ // REQUIRED
            'RecordColumns' => [ // REQUIRED
                [
                    'Mapping' => '<string>',
                    'Name' => '<string>', // REQUIRED
                    'SqlType' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'RecordEncoding' => '<string>',
            'RecordFormat' => [ // REQUIRED
                'MappingParameters' => [
                    'CSVMappingParameters' => [
                        'RecordColumnDelimiter' => '<string>', // REQUIRED
                        'RecordRowDelimiter' => '<string>', // REQUIRED
                    ],
                    'JSONMappingParameters' => [
                        'RecordRowPath' => '<string>', // REQUIRED
                    ],
                ],
                'RecordFormatType' => 'JSON|CSV', // REQUIRED
            ],
        ],
        'KinesisFirehoseInput' => [
            'ResourceARN' => '<string>', // REQUIRED
        ],
        'KinesisStreamsInput' => [
            'ResourceARN' => '<string>', // REQUIRED
        ],
        'NamePrefix' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of your existing application to which you want to add the streaming source.

CurrentApplicationVersionId

Required: Yes
Type: long (int|float)

The current version of your application. You must provide the ApplicationVersionID or the ConditionalToken.You can use the DescribeApplication operation to find the current application version.

Input

Required: Yes
Type: Input structure

The Input to add.

Result Syntax

[
    'ApplicationARN' => '<string>',
    'ApplicationVersionId' => <integer>,
    'InputDescriptions' => [
        [
            'InAppStreamNames' => ['<string>', ...],
            'InputId' => '<string>',
            'InputParallelism' => [
                'Count' => <integer>,
            ],
            'InputProcessingConfigurationDescription' => [
                'InputLambdaProcessorDescription' => [
                    'ResourceARN' => '<string>',
                    'RoleARN' => '<string>',
                ],
            ],
            'InputSchema' => [
                'RecordColumns' => [
                    [
                        'Mapping' => '<string>',
                        'Name' => '<string>',
                        'SqlType' => '<string>',
                    ],
                    // ...
                ],
                'RecordEncoding' => '<string>',
                'RecordFormat' => [
                    'MappingParameters' => [
                        'CSVMappingParameters' => [
                            'RecordColumnDelimiter' => '<string>',
                            'RecordRowDelimiter' => '<string>',
                        ],
                        'JSONMappingParameters' => [
                            'RecordRowPath' => '<string>',
                        ],
                    ],
                    'RecordFormatType' => 'JSON|CSV',
                ],
            ],
            'InputStartingPositionConfiguration' => [
                'InputStartingPosition' => 'NOW|TRIM_HORIZON|LAST_STOPPED_POINT',
            ],
            'KinesisFirehoseInputDescription' => [
                'ResourceARN' => '<string>',
                'RoleARN' => '<string>',
            ],
            'KinesisStreamsInputDescription' => [
                'ResourceARN' => '<string>',
                'RoleARN' => '<string>',
            ],
            'NamePrefix' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

ApplicationARN

Type: string

The Amazon Resource Name (ARN) of the application.

ApplicationVersionId

Type: long (int|float)

Provides the current application version.

InputDescriptions

Type: Array of InputDescription structures

Describes the application input configuration.

Errors

ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
InvalidArgumentException:
The specified input parameter value is not valid.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
CodeValidationException:
The user-provided application code (query) is not valid. This can be a simple syntax error.
InvalidRequestException:
The request JSON is not valid for the operation.

AddApplicationInputProcessingConfiguration

$result = $client->addApplicationInputProcessingConfiguration([/* ... */]);
$promise = $client->addApplicationInputProcessingConfigurationAsync([/* ... */]);

Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only input processor available is Amazon Lambda.

Parameter Syntax

$result = $client->addApplicationInputProcessingConfiguration([
    'ApplicationName' => '<string>', // REQUIRED
    'CurrentApplicationVersionId' => <integer>, // REQUIRED
    'InputId' => '<string>', // REQUIRED
    'InputProcessingConfiguration' => [ // REQUIRED
        'InputLambdaProcessor' => [ // REQUIRED
            'ResourceARN' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of the application to which you want to add the input processing configuration.

CurrentApplicationVersionId

Required: Yes
Type: long (int|float)

The version of the application to which you want to add the input processing configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

InputId

Required: Yes
Type: string

The ID of the input configuration to add the input processing configuration to. You can get a list of the input IDs for an application using the DescribeApplication operation.

InputProcessingConfiguration

Required: Yes
Type: InputProcessingConfiguration structure

The InputProcessingConfiguration to add to the application.

Result Syntax

[
    'ApplicationARN' => '<string>',
    'ApplicationVersionId' => <integer>,
    'InputId' => '<string>',
    'InputProcessingConfigurationDescription' => [
        'InputLambdaProcessorDescription' => [
            'ResourceARN' => '<string>',
            'RoleARN' => '<string>',
        ],
    ],
]

Result Details

Members

ApplicationARN

Type: string

The Amazon Resource Name (ARN) of the application.

ApplicationVersionId

Type: long (int|float)

Provides the current application version.

InputId

Type: string

The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.

InputProcessingConfigurationDescription

Type: InputProcessingConfigurationDescription structure

The description of the preprocessor that executes on records in this input before the application's code is run.

Errors

ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
InvalidArgumentException:
The specified input parameter value is not valid.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
InvalidRequestException:
The request JSON is not valid for the operation.

AddApplicationOutput

$result = $client->addApplicationOutput([/* ... */]);
$promise = $client->addApplicationOutputAsync([/* ... */]);

Adds an external destination to your SQL-based Kinesis Data Analytics application.

If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.

You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors.

Parameter Syntax

$result = $client->addApplicationOutput([
    'ApplicationName' => '<string>', // REQUIRED
    'CurrentApplicationVersionId' => <integer>, // REQUIRED
    'Output' => [ // REQUIRED
        'DestinationSchema' => [ // REQUIRED
            'RecordFormatType' => 'JSON|CSV', // REQUIRED
        ],
        'KinesisFirehoseOutput' => [
            'ResourceARN' => '<string>', // REQUIRED
        ],
        'KinesisStreamsOutput' => [
            'ResourceARN' => '<string>', // REQUIRED
        ],
        'LambdaOutput' => [
            'ResourceARN' => '<string>', // REQUIRED
        ],
        'Name' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of the application to which you want to add the output configuration.

CurrentApplicationVersionId

Required: Yes
Type: long (int|float)

The version of the application to which you want to add the output configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

Output

Required: Yes
Type: Output structure

An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, a Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda function), and record the formation to use when writing to the destination.

Result Syntax

[
    'ApplicationARN' => '<string>',
    'ApplicationVersionId' => <integer>,
    'OutputDescriptions' => [
        [
            'DestinationSchema' => [
                'RecordFormatType' => 'JSON|CSV',
            ],
            'KinesisFirehoseOutputDescription' => [
                'ResourceARN' => '<string>',
                'RoleARN' => '<string>',
            ],
            'KinesisStreamsOutputDescription' => [
                'ResourceARN' => '<string>',
                'RoleARN' => '<string>',
            ],
            'LambdaOutputDescription' => [
                'ResourceARN' => '<string>',
                'RoleARN' => '<string>',
            ],
            'Name' => '<string>',
            'OutputId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

ApplicationARN

Type: string

The application Amazon Resource Name (ARN).

ApplicationVersionId

Type: long (int|float)

The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.

OutputDescriptions

Type: Array of OutputDescription structures

Describes the application output configuration. For more information, see Configuring Application Output.

Errors

ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
InvalidArgumentException:
The specified input parameter value is not valid.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
InvalidRequestException:
The request JSON is not valid for the operation.

AddApplicationReferenceDataSource

$result = $client->addApplicationReferenceDataSource([/* ... */]);
$promise = $client->addApplicationReferenceDataSourceAsync([/* ... */]);

Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.

Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in an Amazon S3 object maps to columns in the resulting in-application table.

Parameter Syntax

$result = $client->addApplicationReferenceDataSource([
    'ApplicationName' => '<string>', // REQUIRED
    'CurrentApplicationVersionId' => <integer>, // REQUIRED
    'ReferenceDataSource' => [ // REQUIRED
        'ReferenceSchema' => [ // REQUIRED
            'RecordColumns' => [ // REQUIRED
                [
                    'Mapping' => '<string>',
                    'Name' => '<string>', // REQUIRED
                    'SqlType' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'RecordEncoding' => '<string>',
            'RecordFormat' => [ // REQUIRED
                'MappingParameters' => [
                    'CSVMappingParameters' => [
                        'RecordColumnDelimiter' => '<string>', // REQUIRED
                        'RecordRowDelimiter' => '<string>', // REQUIRED
                    ],
                    'JSONMappingParameters' => [
                        'RecordRowPath' => '<string>', // REQUIRED
                    ],
                ],
                'RecordFormatType' => 'JSON|CSV', // REQUIRED
            ],
        ],
        'S3ReferenceDataSource' => [
            'BucketARN' => '<string>',
            'FileKey' => '<string>',
        ],
        'TableName' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of an existing application.

CurrentApplicationVersionId

Required: Yes
Type: long (int|float)

The version of the application for which you are adding the reference data source. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

ReferenceDataSource

Required: Yes
Type: ReferenceDataSource structure

The reference data source can be an object in your Amazon S3 bucket. Kinesis Data Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created.

Result Syntax

[
    'ApplicationARN' => '<string>',
    'ApplicationVersionId' => <integer>,
    'ReferenceDataSourceDescriptions' => [
        [
            'ReferenceId' => '<string>',
            'ReferenceSchema' => [
                'RecordColumns' => [
                    [
                        'Mapping' => '<string>',
                        'Name' => '<string>',
                        'SqlType' => '<string>',
                    ],
                    // ...
                ],
                'RecordEncoding' => '<string>',
                'RecordFormat' => [
                    'MappingParameters' => [
                        'CSVMappingParameters' => [
                            'RecordColumnDelimiter' => '<string>',
                            'RecordRowDelimiter' => '<string>',
                        ],
                        'JSONMappingParameters' => [
                            'RecordRowPath' => '<string>',
                        ],
                    ],
                    'RecordFormatType' => 'JSON|CSV',
                ],
            ],
            'S3ReferenceDataSourceDescription' => [
                'BucketARN' => '<string>',
                'FileKey' => '<string>',
                'ReferenceRoleARN' => '<string>',
            ],
            'TableName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

ApplicationARN

Type: string

The application Amazon Resource Name (ARN).

ApplicationVersionId

Type: long (int|float)

The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.

ReferenceDataSourceDescriptions

Type: Array of ReferenceDataSourceDescription structures

Describes reference data sources configured for the application.

Errors

ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
InvalidArgumentException:
The specified input parameter value is not valid.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
InvalidRequestException:
The request JSON is not valid for the operation.

AddApplicationVpcConfiguration

$result = $client->addApplicationVpcConfiguration([/* ... */]);
$promise = $client->addApplicationVpcConfigurationAsync([/* ... */]);

Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely.

Note the following about VPC configurations for Kinesis Data Analytics applications:

VPC configurations are not supported for SQL applications.
When a VPC is added to a Kinesis Data Analytics application, the application can no longer be accessed from the Internet directly. To enable Internet access to the application, add an Internet gateway to your VPC.

Parameter Syntax

$result = $client->addApplicationVpcConfiguration([
    'ApplicationName' => '<string>', // REQUIRED
    'ConditionalToken' => '<string>',
    'CurrentApplicationVersionId' => <integer>,
    'VpcConfiguration' => [ // REQUIRED
        'SecurityGroupIds' => ['<string>', ...], // REQUIRED
        'SubnetIds' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of an existing application.

ConditionalToken

Type: string

A value you use to implement strong concurrency for application updates. You must provide the ApplicationVersionID or the ConditionalToken. You get the application's current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

CurrentApplicationVersionId

Type: long (int|float)

The version of the application to which you want to add the VPC configuration. You must provide the CurrentApplicationVersionId or the ConditionalToken. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

VpcConfiguration

Required: Yes
Type: VpcConfiguration structure

Description of the VPC to add to the application.

Result Syntax

[
    'ApplicationARN' => '<string>',
    'ApplicationVersionId' => <integer>,
    'VpcConfigurationDescription' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
        'VpcConfigurationId' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

Members

ApplicationARN

Type: string

The ARN of the application.

ApplicationVersionId

Type: long (int|float)

Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

VpcConfigurationDescription

Type: VpcConfigurationDescription structure

The parameters of the new VPC configuration.

Errors

ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
InvalidArgumentException:
The specified input parameter value is not valid.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
InvalidApplicationConfigurationException:
The user-provided application configuration is not valid.

CreateApplication

$result = $client->createApplication([/* ... */]);
$promise = $client->createApplicationAsync([/* ... */]);

Creates a Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application.

Parameter Syntax

$result = $client->createApplication([
    'ApplicationConfiguration' => [
        'ApplicationCodeConfiguration' => [
            'CodeContent' => [
                'S3ContentLocation' => [
                    'BucketARN' => '<string>', // REQUIRED
                    'FileKey' => '<string>', // REQUIRED
                    'ObjectVersion' => '<string>',
                ],
                'TextContent' => '<string>',
                'ZipFileContent' => <string || resource || Psr\Http\Message\StreamInterface>,
            ],
            'CodeContentType' => 'PLAINTEXT|ZIPFILE', // REQUIRED
        ],
        'ApplicationSnapshotConfiguration' => [
            'SnapshotsEnabled' => true || false, // REQUIRED
        ],
        'EnvironmentProperties' => [
            'PropertyGroups' => [ // REQUIRED
                [
                    'PropertyGroupId' => '<string>', // REQUIRED
                    'PropertyMap' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
        ],
        'FlinkApplicationConfiguration' => [
            'CheckpointConfiguration' => [
                'CheckpointInterval' => <integer>,
                'CheckpointingEnabled' => true || false,
                'ConfigurationType' => 'DEFAULT|CUSTOM', // REQUIRED
                'MinPauseBetweenCheckpoints' => <integer>,
            ],
            'MonitoringConfiguration' => [
                'ConfigurationType' => 'DEFAULT|CUSTOM', // REQUIRED
                'LogLevel' => 'INFO|WARN|ERROR|DEBUG',
                'MetricsLevel' => 'APPLICATION|TASK|OPERATOR|PARALLELISM',
            ],
            'ParallelismConfiguration' => [
                'AutoScalingEnabled' => true || false,
                'ConfigurationType' => 'DEFAULT|CUSTOM', // REQUIRED
                'Parallelism' => <integer>,
                'ParallelismPerKPU' => <integer>,
            ],
        ],
        'SqlApplicationConfiguration' => [
            'Inputs' => [
                [
                    'InputParallelism' => [
                        'Count' => <integer>,
                    ],
                    'InputProcessingConfiguration' => [
                        'InputLambdaProcessor' => [ // REQUIRED
                            'ResourceARN' => '<string>', // REQUIRED
                        ],
                    ],
                    'InputSchema' => [ // REQUIRED
                        'RecordColumns' => [ // REQUIRED
                            [
                                'Mapping' => '<string>',
                                'Name' => '<string>', // REQUIRED
                                'SqlType' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'RecordEncoding' => '<string>',
                        'RecordFormat' => [ // REQUIRED
                            'MappingParameters' => [
                                'CSVMappingParameters' => [
                                    'RecordColumnDelimiter' => '<string>', // REQUIRED
                                    'RecordRowDelimiter' => '<string>', // REQUIRED
                                ],
                                'JSONMappingParameters' => [
                                    'RecordRowPath' => '<string>', // REQUIRED
                                ],
                            ],
                            'RecordFormatType' => 'JSON|CSV', // REQUIRED
                        ],
                    ],
                    'KinesisFirehoseInput' => [
                        'ResourceARN' => '<string>', // REQUIRED
                    ],
                    'KinesisStreamsInput' => [
                        'ResourceARN' => '<string>', // REQUIRED
                    ],
                    'NamePrefix' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'Outputs' => [
                [
                    'DestinationSchema' => [ // REQUIRED
                        'RecordFormatType' => 'JSON|CSV', // REQUIRED
                    ],
                    'KinesisFirehoseOutput' => [
                        'ResourceARN' => '<string>', // REQUIRED
                    ],
                    'KinesisStreamsOutput' => [
                        'ResourceARN' => '<string>', // REQUIRED
                    ],
                    'LambdaOutput' => [
                        'ResourceARN' => '<string>', // REQUIRED
                    ],
                    'Name' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'ReferenceDataSources' => [
                [
                    'ReferenceSchema' => [ // REQUIRED
                        'RecordColumns' => [ // REQUIRED
                            [
                                'Mapping' => '<string>',
                                'Name' => '<string>', // REQUIRED
                                'SqlType' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'RecordEncoding' => '<string>',
                        'RecordFormat' => [ // REQUIRED
                            'MappingParameters' => [
                                'CSVMappingParameters' => [
                                    'RecordColumnDelimiter' => '<string>', // REQUIRED
                                    'RecordRowDelimiter' => '<string>', // REQUIRED
                                ],
                                'JSONMappingParameters' => [
                                    'RecordRowPath' => '<string>', // REQUIRED
                                ],
                            ],
                            'RecordFormatType' => 'JSON|CSV', // REQUIRED
                        ],
                    ],
                    'S3ReferenceDataSource' => [
                        'BucketARN' => '<string>',
                        'FileKey' => '<string>',
                    ],
                    'TableName' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        'VpcConfigurations' => [
            [
                'SecurityGroupIds' => ['<string>', ...], // REQUIRED
                'SubnetIds' => ['<string>', ...], // REQUIRED
            ],
            // ...
        ],
        'ZeppelinApplicationConfiguration' => [
            'CatalogConfiguration' => [
                'GlueDataCatalogConfiguration' => [ // REQUIRED
                    'DatabaseARN' => '<string>', // REQUIRED
                ],
            ],
            'CustomArtifactsConfiguration' => [
                [
                    'ArtifactType' => 'UDF|DEPENDENCY_JAR', // REQUIRED
                    'MavenReference' => [
                        'ArtifactId' => '<string>', // REQUIRED
                        'GroupId' => '<string>', // REQUIRED
                        'Version' => '<string>', // REQUIRED
                    ],
                    'S3ContentLocation' => [
                        'BucketARN' => '<string>', // REQUIRED
                        'FileKey' => '<string>', // REQUIRED
                        'ObjectVersion' => '<string>',
                    ],
                ],
                // ...
            ],
            'DeployAsApplicationConfiguration' => [
                'S3ContentLocation' => [ // REQUIRED
                    'BasePath' => '<string>',
                    'BucketARN' => '<string>', // REQUIRED
                ],
            ],
            'MonitoringConfiguration' => [
                'LogLevel' => 'INFO|WARN|ERROR|DEBUG', // REQUIRED
            ],
        ],
    ],
    'ApplicationDescription' => '<string>',
    'ApplicationMode' => 'STREAMING|INTERACTIVE',
    'ApplicationName' => '<string>', // REQUIRED
    'CloudWatchLoggingOptions' => [
        [
            'LogStreamARN' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'RuntimeEnvironment' => 'SQL-1_0|FLINK-1_6|FLINK-1_8|ZEPPELIN-FLINK-1_0|FLINK-1_11|FLINK-1_13|ZEPPELIN-FLINK-2_0|FLINK-1_15', // REQUIRED
    'ServiceExecutionRole' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

ApplicationConfiguration

Type: ApplicationConfiguration structure

Use this parameter to configure the application.

ApplicationDescription

Type: string

A summary description of the application.

ApplicationMode

Type: string

Use the STREAMING mode to create a Kinesis Data Analytics For Flink application. To create a Kinesis Data Analytics Studio notebook, use the INTERACTIVE mode.

ApplicationName

Required: Yes
Type: string

The name of your application (for example, sample-app).

CloudWatchLoggingOptions

Type: Array of CloudWatchLoggingOption structures

Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.

RuntimeEnvironment

Required: Yes
Type: string

The runtime environment for the application.

ServiceExecutionRole

Required: Yes
Type: string

The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.

Tags

Type: Array of Tag structures

A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.

Result Syntax

[
    'ApplicationDetail' => [
        'ApplicationARN' => '<string>',
        'ApplicationConfigurationDescription' => [
            'ApplicationCodeConfigurationDescription' => [
                'CodeContentDescription' => [
                    'CodeMD5' => '<string>',
                    'CodeSize' => <integer>,
                    'S3ApplicationCodeLocationDescription' => [
                        'BucketARN' => '<string>',
                        'FileKey' => '<string>',
                        'ObjectVersion' => '<string>',
                    ],
                    'TextContent' => '<string>',
                ],
                'CodeContentType' => 'PLAINTEXT|ZIPFILE',
            ],
            'ApplicationSnapshotConfigurationDescription' => [
                'SnapshotsEnabled' => true || false,
            ],
            'EnvironmentPropertyDescriptions' => [
                'PropertyGroupDescriptions' => [
                    [
                        'PropertyGroupId' => '<string>',
                        'PropertyMap' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'FlinkApplicationConfigurationDescription' => [
                'CheckpointConfigurationDescription' => [
                    'CheckpointInterval' => <integer>,
                    'CheckpointingEnabled' => true || false,
                    'ConfigurationType' => 'DEFAULT|CUSTOM',
                    'MinPauseBetweenCheckpoints' => <integer>,
                ],
                'JobPlanDescription' => '<string>',
                'MonitoringConfigurationDescription' => [
                    'ConfigurationType' => 'DEFAULT|CUSTOM',
                    'LogLevel' => 'INFO|WARN|ERROR|DEBUG',
                    'MetricsLevel' => 'APPLICATION|TASK|OPERATOR|PARALLELISM',
                ],
                'ParallelismConfigurationDescription' => [
                    'AutoScalingEnabled' => true || false,
                    'ConfigurationType' => 'DEFAULT|CUSTOM',
                    'CurrentParallelism' => <integer>,
                    'Parallelism' => <integer>,
                    'ParallelismPerKPU' => <integer>,
                ],
            ],
            'RunConfigurationDescription' => [
                'ApplicationRestoreConfigurationDescription' => [
                    'ApplicationRestoreType' => 'SKIP_RESTORE_FROM_SNAPSHOT|RESTORE_FROM_LATEST_SNAPSHOT|RESTORE_FROM_CUSTOM_SNAPSHOT',
                    'SnapshotName' => '<string>',
                ],
                'FlinkRunConfigurationDescription' => [
                    'AllowNonRestoredState' => true || false,
                ],
            ],
            'SqlApplicationConfigurationDescription' => [
                'InputDescriptions' => [
                    [
                        'InAppStreamNames' => ['<string>', ...],
                        'InputId' => '<string>',
                        'InputParallelism' => [
                            'Count' => <integer>,
                        ],
                        'InputProcessingConfigurationDescription' => [
                            'InputLambdaProcessorDescription' => [
                                'ResourceARN' => '<string>',
                                'RoleARN' => '<string>',
                            ],
                        ],
                        'InputSchema' => [
                            'RecordColumns' => [
                                [
                                    'Mapping' => '<string>',
                                    'Name' => '<string>',
                                    'SqlType' => '<string>',
                                ],
                                // ...
                            ],
                            'RecordEncoding' => '<string>',
                            'RecordFormat' => [
                                'MappingParameters' => [
                                    'CSVMappingParameters' => [
                                        'RecordColumnDelimiter' => '<string>',
                                        'RecordRowDelimiter' => '<string>',
                                    ],
                                    'JSONMappingParameters' => [
                                        'RecordRowPath' => '<string>',
                                    ],
                                ],
                                'RecordFormatType' => 'JSON|CSV',
                            ],
                        ],
                        'InputStartingPositionConfiguration' => [
                            'InputStartingPosition' => 'NOW|TRIM_HORIZON|LAST_STOPPED_POINT',
                        ],
                        'KinesisFirehoseInputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'KinesisStreamsInputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'NamePrefix' => '<string>',
                    ],
                    // ...
                ],
                'OutputDescriptions' => [
                    [
                        'DestinationSchema' => [
                            'RecordFormatType' => 'JSON|CSV',
                        ],
                        'KinesisFirehoseOutputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'KinesisStreamsOutputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'LambdaOutputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'Name' => '<string>',
                        'OutputId' => '<string>',
                    ],
                    // ...
                ],
                'ReferenceDataSourceDescriptions' => [
                    [
                        'ReferenceId' => '<string>',
                        'ReferenceSchema' => [
                            'RecordColumns' => [
                                [
                                    'Mapping' => '<string>',
                                    'Name' => '<string>',
                                    'SqlType' => '<string>',
                                ],
                                // ...
                            ],
                            'RecordEncoding' => '<string>',
                            'RecordFormat' => [
                                'MappingParameters' => [
                                    'CSVMappingParameters' => [
                                        'RecordColumnDelimiter' => '<string>',
                                        'RecordRowDelimiter' => '<string>',
                                    ],
                                    'JSONMappingParameters' => [
                                        'RecordRowPath' => '<string>',
                                    ],
                                ],
                                'RecordFormatType' => 'JSON|CSV',
                            ],
                        ],
                        'S3ReferenceDataSourceDescription' => [
                            'BucketARN' => '<string>',
                            'FileKey' => '<string>',
                            'ReferenceRoleARN' => '<string>',
                        ],
                        'TableName' => '<string>',
                    ],
                    // ...
                ],
            ],
            'VpcConfigurationDescriptions' => [
                [
                    'SecurityGroupIds' => ['<string>', ...],
                    'SubnetIds' => ['<string>', ...],
                    'VpcConfigurationId' => '<string>',
                    'VpcId' => '<string>',
                ],
                // ...
            ],
            'ZeppelinApplicationConfigurationDescription' => [
                'CatalogConfigurationDescription' => [
                    'GlueDataCatalogConfigurationDescription' => [
                        'DatabaseARN' => '<string>',
                    ],
                ],
                'CustomArtifactsConfigurationDescription' => [
                    [
                        'ArtifactType' => 'UDF|DEPENDENCY_JAR',
                        'MavenReferenceDescription' => [
                            'ArtifactId' => '<string>',
                            'GroupId' => '<string>',
                            'Version' => '<string>',
                        ],
                        'S3ContentLocationDescription' => [
                            'BucketARN' => '<string>',
                            'FileKey' => '<string>',
                            'ObjectVersion' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'DeployAsApplicationConfigurationDescription' => [
                    'S3ContentLocationDescription' => [
                        'BasePath' => '<string>',
                        'BucketARN' => '<string>',
                    ],
                ],
                'MonitoringConfigurationDescription' => [
                    'LogLevel' => 'INFO|WARN|ERROR|DEBUG',
                ],
            ],
        ],
        'ApplicationDescription' => '<string>',
        'ApplicationMaintenanceConfigurationDescription' => [
            'ApplicationMaintenanceWindowEndTime' => '<string>',
            'ApplicationMaintenanceWindowStartTime' => '<string>',
        ],
        'ApplicationMode' => 'STREAMING|INTERACTIVE',
        'ApplicationName' => '<string>',
        'ApplicationStatus' => 'DELETING|STARTING|STOPPING|READY|RUNNING|UPDATING|AUTOSCALING|FORCE_STOPPING|ROLLING_BACK|MAINTENANCE|ROLLED_BACK',
        'ApplicationVersionId' => <integer>,
        'ApplicationVersionRolledBackFrom' => <integer>,
        'ApplicationVersionRolledBackTo' => <integer>,
        'ApplicationVersionUpdatedFrom' => <integer>,
        'CloudWatchLoggingOptionDescriptions' => [
            [
                'CloudWatchLoggingOptionId' => '<string>',
                'LogStreamARN' => '<string>',
                'RoleARN' => '<string>',
            ],
            // ...
        ],
        'ConditionalToken' => '<string>',
        'CreateTimestamp' => <DateTime>,
        'LastUpdateTimestamp' => <DateTime>,
        'RuntimeEnvironment' => 'SQL-1_0|FLINK-1_6|FLINK-1_8|ZEPPELIN-FLINK-1_0|FLINK-1_11|FLINK-1_13|ZEPPELIN-FLINK-2_0|FLINK-1_15',
        'ServiceExecutionRole' => '<string>',
    ],
]

Result Details

Members

ApplicationDetail

Required: Yes
Type: ApplicationDetail structure

In response to your CreateApplication request, Kinesis Data Analytics returns a response with details of the application it created.

Errors

CodeValidationException:
The user-provided application code (query) is not valid. This can be a simple syntax error.
ResourceInUseException:
The application is not available for this operation.
LimitExceededException:
The number of allowed resources has been exceeded.
InvalidArgumentException:
The specified input parameter value is not valid.
InvalidRequestException:
The request JSON is not valid for the operation.
TooManyTagsException:
Application created with too many tags, or too many tags added to an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

CreateApplicationPresignedUrl

$result = $client->createApplicationPresignedUrl([/* ... */]);
$promise = $client->createApplicationPresignedUrlAsync([/* ... */]);

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.

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.

Parameter Syntax

$result = $client->createApplicationPresignedUrl([
    'ApplicationName' => '<string>', // REQUIRED
    'SessionExpirationDurationInSeconds' => <integer>,
    'UrlType' => 'FLINK_DASHBOARD_URL|ZEPPELIN_UI_URL', // REQUIRED
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of the application.

SessionExpirationDurationInSeconds

Type: long (int|float)

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

UrlType

Required: Yes
Type: string

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

Result Syntax

[
    'AuthorizedUrl' => '<string>',
]

Result Details

Members

AuthorizedUrl

Type: string

The URL of the extension.

Errors

ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
InvalidArgumentException:
The specified input parameter value is not valid.

CreateApplicationSnapshot

$result = $client->createApplicationSnapshot([/* ... */]);
$promise = $client->createApplicationSnapshotAsync([/* ... */]);

Creates a snapshot of the application's state data.

Parameter Syntax

$result = $client->createApplicationSnapshot([
    'ApplicationName' => '<string>', // REQUIRED
    'SnapshotName' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of an existing application

SnapshotName

Required: Yes
Type: string

An identifier for the application snapshot.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceInUseException:
The application is not available for this operation.
ResourceNotFoundException:
Specified application can't be found.
LimitExceededException:
The number of allowed resources has been exceeded.
InvalidArgumentException:
The specified input parameter value is not valid.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
InvalidRequestException:
The request JSON is not valid for the operation.
InvalidApplicationConfigurationException:
The user-provided application configuration is not valid.

DeleteApplication

$result = $client->deleteApplication([/* ... */]);
$promise = $client->deleteApplicationAsync([/* ... */]);

Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application.

Parameter Syntax

$result = $client->deleteApplication([
    'ApplicationName' => '<string>', // REQUIRED
    'CreateTimestamp' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of the application to delete.

CreateTimestamp

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Use the DescribeApplication operation to get this value.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
InvalidArgumentException:
The specified input parameter value is not valid.
InvalidRequestException:
The request JSON is not valid for the operation.
InvalidApplicationConfigurationException:
The user-provided application configuration is not valid.

DeleteApplicationCloudWatchLoggingOption

$result = $client->deleteApplicationCloudWatchLoggingOption([/* ... */]);
$promise = $client->deleteApplicationCloudWatchLoggingOptionAsync([/* ... */]);

Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.

Parameter Syntax

$result = $client->deleteApplicationCloudWatchLoggingOption([
    'ApplicationName' => '<string>', // REQUIRED
    'CloudWatchLoggingOptionId' => '<string>', // REQUIRED
    'ConditionalToken' => '<string>',
    'CurrentApplicationVersionId' => <integer>,
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The application name.

CloudWatchLoggingOptionId

Required: Yes
Type: string

The CloudWatchLoggingOptionId of the Amazon CloudWatch logging option to delete. You can get the CloudWatchLoggingOptionId by using the DescribeApplication operation.

ConditionalToken

Type: string

CurrentApplicationVersionId

Type: long (int|float)

The version ID of the application. You must provide the CurrentApplicationVersionId or the ConditionalToken. You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

Result Syntax

[
    'ApplicationARN' => '<string>',
    'ApplicationVersionId' => <integer>,
    'CloudWatchLoggingOptionDescriptions' => [
        [
            'CloudWatchLoggingOptionId' => '<string>',
            'LogStreamARN' => '<string>',
            'RoleARN' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

ApplicationARN

Type: string

The application's Amazon Resource Name (ARN).

ApplicationVersionId

Type: long (int|float)

The version ID of the application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options.

CloudWatchLoggingOptionDescriptions

Type: Array of CloudWatchLoggingOptionDescription structures

The descriptions of the remaining CloudWatch logging options for the application.

Errors

ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
InvalidArgumentException:
The specified input parameter value is not valid.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
InvalidRequestException:
The request JSON is not valid for the operation.
InvalidApplicationConfigurationException:
The user-provided application configuration is not valid.

DeleteApplicationInputProcessingConfiguration

$result = $client->deleteApplicationInputProcessingConfiguration([/* ... */]);
$promise = $client->deleteApplicationInputProcessingConfigurationAsync([/* ... */]);

Deletes an InputProcessingConfiguration from an input.

Parameter Syntax

$result = $client->deleteApplicationInputProcessingConfiguration([
    'ApplicationName' => '<string>', // REQUIRED
    'CurrentApplicationVersionId' => <integer>, // REQUIRED
    'InputId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of the application.

CurrentApplicationVersionId

Required: Yes
Type: long (int|float)

The application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

InputId

Required: Yes
Type: string

The ID of the input configuration from which to delete the input processing configuration. You can get a list of the input IDs for an application by using the DescribeApplication operation.

Result Syntax

[
    'ApplicationARN' => '<string>',
    'ApplicationVersionId' => <integer>,
]

Result Details

Members

ApplicationARN

Type: string

The Amazon Resource Name (ARN) of the application.

ApplicationVersionId

Type: long (int|float)

The current application version ID.

Errors

ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
InvalidArgumentException:
The specified input parameter value is not valid.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
InvalidRequestException:
The request JSON is not valid for the operation.

DeleteApplicationOutput

$result = $client->deleteApplicationOutput([/* ... */]);
$promise = $client->deleteApplicationOutputAsync([/* ... */]);

Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination.

Parameter Syntax

$result = $client->deleteApplicationOutput([
    'ApplicationName' => '<string>', // REQUIRED
    'CurrentApplicationVersionId' => <integer>, // REQUIRED
    'OutputId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The application name.

CurrentApplicationVersionId

Required: Yes
Type: long (int|float)

OutputId

Required: Yes
Type: string

The ID of the configuration to delete. Each output configuration that is added to the application (either when the application is created or later) using the AddApplicationOutput operation has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the DescribeApplication operation to get the specific OutputId.

Result Syntax

[
    'ApplicationARN' => '<string>',
    'ApplicationVersionId' => <integer>,
]

Result Details

Members

ApplicationARN

Type: string

The application Amazon Resource Name (ARN).

ApplicationVersionId

Type: long (int|float)

The current application version ID.

Errors

ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
InvalidArgumentException:
The specified input parameter value is not valid.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
InvalidRequestException:
The request JSON is not valid for the operation.

DeleteApplicationReferenceDataSource

$result = $client->deleteApplicationReferenceDataSource([/* ... */]);
$promise = $client->deleteApplicationReferenceDataSourceAsync([/* ... */]);

Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration.

If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.

Parameter Syntax

$result = $client->deleteApplicationReferenceDataSource([
    'ApplicationName' => '<string>', // REQUIRED
    'CurrentApplicationVersionId' => <integer>, // REQUIRED
    'ReferenceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of an existing application.

CurrentApplicationVersionId

Required: Yes
Type: long (int|float)

The current application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

ReferenceId

Required: Yes
Type: string

The ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Kinesis Data Analytics assigns an ID. You can use the DescribeApplication operation to get the reference ID.

Result Syntax

[
    'ApplicationARN' => '<string>',
    'ApplicationVersionId' => <integer>,
]

Result Details

Members

ApplicationARN

Type: string

The application Amazon Resource Name (ARN).

ApplicationVersionId

Type: long (int|float)

The updated version ID of the application.

Errors

ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
InvalidArgumentException:
The specified input parameter value is not valid.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
InvalidRequestException:
The request JSON is not valid for the operation.

DeleteApplicationSnapshot

$result = $client->deleteApplicationSnapshot([/* ... */]);
$promise = $client->deleteApplicationSnapshotAsync([/* ... */]);

Deletes a snapshot of application state.

Parameter Syntax

$result = $client->deleteApplicationSnapshot([
    'ApplicationName' => '<string>', // REQUIRED
    'SnapshotCreationTimestamp' => <integer || string || DateTime>, // REQUIRED
    'SnapshotName' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of an existing application.

SnapshotCreationTimestamp

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation timestamp of the application snapshot to delete. You can retrieve this value using or .

SnapshotName

Required: Yes
Type: string

The identifier for the snapshot delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceInUseException:
The application is not available for this operation.
InvalidArgumentException:
The specified input parameter value is not valid.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
InvalidRequestException:
The request JSON is not valid for the operation.
ResourceNotFoundException:
Specified application can't be found.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.

DeleteApplicationVpcConfiguration

$result = $client->deleteApplicationVpcConfiguration([/* ... */]);
$promise = $client->deleteApplicationVpcConfigurationAsync([/* ... */]);

Removes a VPC configuration from a Kinesis Data Analytics application.

Parameter Syntax

$result = $client->deleteApplicationVpcConfiguration([
    'ApplicationName' => '<string>', // REQUIRED
    'ConditionalToken' => '<string>',
    'CurrentApplicationVersionId' => <integer>,
    'VpcConfigurationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of an existing application.

ConditionalToken

Type: string

CurrentApplicationVersionId

Type: long (int|float)

The current application version ID. You must provide the CurrentApplicationVersionId or the ConditionalToken. You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

VpcConfigurationId

Required: Yes
Type: string

The ID of the VPC configuration to delete.

Result Syntax

[
    'ApplicationARN' => '<string>',
    'ApplicationVersionId' => <integer>,
]

Result Details

Members

ApplicationARN

Type: string

The ARN of the Kinesis Data Analytics application.

ApplicationVersionId

Type: long (int|float)

The updated version ID of the application.

Errors

ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
InvalidArgumentException:
The specified input parameter value is not valid.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
InvalidApplicationConfigurationException:
The user-provided application configuration is not valid.

DescribeApplication

$result = $client->describeApplication([/* ... */]);
$promise = $client->describeApplicationAsync([/* ... */]);

Returns information about a specific Kinesis Data Analytics application.

If you want to retrieve a list of all applications in your account, use the ListApplications operation.

Parameter Syntax

$result = $client->describeApplication([
    'ApplicationName' => '<string>', // REQUIRED
    'IncludeAdditionalDetails' => true || false,
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of the application.

IncludeAdditionalDetails

Type: boolean

Displays verbose information about a Kinesis Data Analytics application, including the application's job plan.

Result Syntax

[
    'ApplicationDetail' => [
        'ApplicationARN' => '<string>',
        'ApplicationConfigurationDescription' => [
            'ApplicationCodeConfigurationDescription' => [
                'CodeContentDescription' => [
                    'CodeMD5' => '<string>',
                    'CodeSize' => <integer>,
                    'S3ApplicationCodeLocationDescription' => [
                        'BucketARN' => '<string>',
                        'FileKey' => '<string>',
                        'ObjectVersion' => '<string>',
                    ],
                    'TextContent' => '<string>',
                ],
                'CodeContentType' => 'PLAINTEXT|ZIPFILE',
            ],
            'ApplicationSnapshotConfigurationDescription' => [
                'SnapshotsEnabled' => true || false,
            ],
            'EnvironmentPropertyDescriptions' => [
                'PropertyGroupDescriptions' => [
                    [
                        'PropertyGroupId' => '<string>',
                        'PropertyMap' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'FlinkApplicationConfigurationDescription' => [
                'CheckpointConfigurationDescription' => [
                    'CheckpointInterval' => <integer>,
                    'CheckpointingEnabled' => true || false,
                    'ConfigurationType' => 'DEFAULT|CUSTOM',
                    'MinPauseBetweenCheckpoints' => <integer>,
                ],
                'JobPlanDescription' => '<string>',
                'MonitoringConfigurationDescription' => [
                    'ConfigurationType' => 'DEFAULT|CUSTOM',
                    'LogLevel' => 'INFO|WARN|ERROR|DEBUG',
                    'MetricsLevel' => 'APPLICATION|TASK|OPERATOR|PARALLELISM',
                ],
                'ParallelismConfigurationDescription' => [
                    'AutoScalingEnabled' => true || false,
                    'ConfigurationType' => 'DEFAULT|CUSTOM',
                    'CurrentParallelism' => <integer>,
                    'Parallelism' => <integer>,
                    'ParallelismPerKPU' => <integer>,
                ],
            ],
            'RunConfigurationDescription' => [
                'ApplicationRestoreConfigurationDescription' => [
                    'ApplicationRestoreType' => 'SKIP_RESTORE_FROM_SNAPSHOT|RESTORE_FROM_LATEST_SNAPSHOT|RESTORE_FROM_CUSTOM_SNAPSHOT',
                    'SnapshotName' => '<string>',
                ],
                'FlinkRunConfigurationDescription' => [
                    'AllowNonRestoredState' => true || false,
                ],
            ],
            'SqlApplicationConfigurationDescription' => [
                'InputDescriptions' => [
                    [
                        'InAppStreamNames' => ['<string>', ...],
                        'InputId' => '<string>',
                        'InputParallelism' => [
                            'Count' => <integer>,
                        ],
                        'InputProcessingConfigurationDescription' => [
                            'InputLambdaProcessorDescription' => [
                                'ResourceARN' => '<string>',
                                'RoleARN' => '<string>',
                            ],
                        ],
                        'InputSchema' => [
                            'RecordColumns' => [
                                [
                                    'Mapping' => '<string>',
                                    'Name' => '<string>',
                                    'SqlType' => '<string>',
                                ],
                                // ...
                            ],
                            'RecordEncoding' => '<string>',
                            'RecordFormat' => [
                                'MappingParameters' => [
                                    'CSVMappingParameters' => [
                                        'RecordColumnDelimiter' => '<string>',
                                        'RecordRowDelimiter' => '<string>',
                                    ],
                                    'JSONMappingParameters' => [
                                        'RecordRowPath' => '<string>',
                                    ],
                                ],
                                'RecordFormatType' => 'JSON|CSV',
                            ],
                        ],
                        'InputStartingPositionConfiguration' => [
                            'InputStartingPosition' => 'NOW|TRIM_HORIZON|LAST_STOPPED_POINT',
                        ],
                        'KinesisFirehoseInputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'KinesisStreamsInputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'NamePrefix' => '<string>',
                    ],
                    // ...
                ],
                'OutputDescriptions' => [
                    [
                        'DestinationSchema' => [
                            'RecordFormatType' => 'JSON|CSV',
                        ],
                        'KinesisFirehoseOutputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'KinesisStreamsOutputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'LambdaOutputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'Name' => '<string>',
                        'OutputId' => '<string>',
                    ],
                    // ...
                ],
                'ReferenceDataSourceDescriptions' => [
                    [
                        'ReferenceId' => '<string>',
                        'ReferenceSchema' => [
                            'RecordColumns' => [
                                [
                                    'Mapping' => '<string>',
                                    'Name' => '<string>',
                                    'SqlType' => '<string>',
                                ],
                                // ...
                            ],
                            'RecordEncoding' => '<string>',
                            'RecordFormat' => [
                                'MappingParameters' => [
                                    'CSVMappingParameters' => [
                                        'RecordColumnDelimiter' => '<string>',
                                        'RecordRowDelimiter' => '<string>',
                                    ],
                                    'JSONMappingParameters' => [
                                        'RecordRowPath' => '<string>',
                                    ],
                                ],
                                'RecordFormatType' => 'JSON|CSV',
                            ],
                        ],
                        'S3ReferenceDataSourceDescription' => [
                            'BucketARN' => '<string>',
                            'FileKey' => '<string>',
                            'ReferenceRoleARN' => '<string>',
                        ],
                        'TableName' => '<string>',
                    ],
                    // ...
                ],
            ],
            'VpcConfigurationDescriptions' => [
                [
                    'SecurityGroupIds' => ['<string>', ...],
                    'SubnetIds' => ['<string>', ...],
                    'VpcConfigurationId' => '<string>',
                    'VpcId' => '<string>',
                ],
                // ...
            ],
            'ZeppelinApplicationConfigurationDescription' => [
                'CatalogConfigurationDescription' => [
                    'GlueDataCatalogConfigurationDescription' => [
                        'DatabaseARN' => '<string>',
                    ],
                ],
                'CustomArtifactsConfigurationDescription' => [
                    [
                        'ArtifactType' => 'UDF|DEPENDENCY_JAR',
                        'MavenReferenceDescription' => [
                            'ArtifactId' => '<string>',
                            'GroupId' => '<string>',
                            'Version' => '<string>',
                        ],
                        'S3ContentLocationDescription' => [
                            'BucketARN' => '<string>',
                            'FileKey' => '<string>',
                            'ObjectVersion' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'DeployAsApplicationConfigurationDescription' => [
                    'S3ContentLocationDescription' => [
                        'BasePath' => '<string>',
                        'BucketARN' => '<string>',
                    ],
                ],
                'MonitoringConfigurationDescription' => [
                    'LogLevel' => 'INFO|WARN|ERROR|DEBUG',
                ],
            ],
        ],
        'ApplicationDescription' => '<string>',
        'ApplicationMaintenanceConfigurationDescription' => [
            'ApplicationMaintenanceWindowEndTime' => '<string>',
            'ApplicationMaintenanceWindowStartTime' => '<string>',
        ],
        'ApplicationMode' => 'STREAMING|INTERACTIVE',
        'ApplicationName' => '<string>',
        'ApplicationStatus' => 'DELETING|STARTING|STOPPING|READY|RUNNING|UPDATING|AUTOSCALING|FORCE_STOPPING|ROLLING_BACK|MAINTENANCE|ROLLED_BACK',
        'ApplicationVersionId' => <integer>,
        'ApplicationVersionRolledBackFrom' => <integer>,
        'ApplicationVersionRolledBackTo' => <integer>,
        'ApplicationVersionUpdatedFrom' => <integer>,
        'CloudWatchLoggingOptionDescriptions' => [
            [
                'CloudWatchLoggingOptionId' => '<string>',
                'LogStreamARN' => '<string>',
                'RoleARN' => '<string>',
            ],
            // ...
        ],
        'ConditionalToken' => '<string>',
        'CreateTimestamp' => <DateTime>,
        'LastUpdateTimestamp' => <DateTime>,
        'RuntimeEnvironment' => 'SQL-1_0|FLINK-1_6|FLINK-1_8|ZEPPELIN-FLINK-1_0|FLINK-1_11|FLINK-1_13|ZEPPELIN-FLINK-2_0|FLINK-1_15',
        'ServiceExecutionRole' => '<string>',
    ],
]

Result Details

Members

ApplicationDetail

Required: Yes
Type: ApplicationDetail structure

Provides a description of the application, such as the application's Amazon Resource Name (ARN), status, and latest version.

Errors

ResourceNotFoundException:
Specified application can't be found.
InvalidArgumentException:
The specified input parameter value is not valid.
InvalidRequestException:
The request JSON is not valid for the operation.

DescribeApplicationSnapshot

$result = $client->describeApplicationSnapshot([/* ... */]);
$promise = $client->describeApplicationSnapshotAsync([/* ... */]);

Returns information about a snapshot of application state data.

Parameter Syntax

$result = $client->describeApplicationSnapshot([
    'ApplicationName' => '<string>', // REQUIRED
    'SnapshotName' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of an existing application.

SnapshotName

Required: Yes
Type: string

The identifier of an application snapshot. You can retrieve this value using .

Result Syntax

[
    'SnapshotDetails' => [
        'ApplicationVersionId' => <integer>,
        'SnapshotCreationTimestamp' => <DateTime>,
        'SnapshotName' => '<string>',
        'SnapshotStatus' => 'CREATING|READY|DELETING|FAILED',
    ],
]

Result Details

Members

SnapshotDetails

Required: Yes
Type: SnapshotDetails structure

An object containing information about the application snapshot.

Errors

ResourceNotFoundException:
Specified application can't be found.
InvalidArgumentException:
The specified input parameter value is not valid.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

DescribeApplicationVersion

$result = $client->describeApplicationVersion([/* ... */]);
$promise = $client->describeApplicationVersionAsync([/* ... */]);

Provides a detailed description of a specified version of the application. To see a list of all the versions of an application, invoke the ListApplicationVersions operation.

This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink.

Parameter Syntax

$result = $client->describeApplicationVersion([
    'ApplicationName' => '<string>', // REQUIRED
    'ApplicationVersionId' => <integer>, // REQUIRED
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of the application for which you want to get the version description.

ApplicationVersionId

Required: Yes
Type: long (int|float)

The ID of the application version for which you want to get the description.

Result Syntax

[
    'ApplicationVersionDetail' => [
        'ApplicationARN' => '<string>',
        'ApplicationConfigurationDescription' => [
            'ApplicationCodeConfigurationDescription' => [
                'CodeContentDescription' => [
                    'CodeMD5' => '<string>',
                    'CodeSize' => <integer>,
                    'S3ApplicationCodeLocationDescription' => [
                        'BucketARN' => '<string>',
                        'FileKey' => '<string>',
                        'ObjectVersion' => '<string>',
                    ],
                    'TextContent' => '<string>',
                ],
                'CodeContentType' => 'PLAINTEXT|ZIPFILE',
            ],
            'ApplicationSnapshotConfigurationDescription' => [
                'SnapshotsEnabled' => true || false,
            ],
            'EnvironmentPropertyDescriptions' => [
                'PropertyGroupDescriptions' => [
                    [
                        'PropertyGroupId' => '<string>',
                        'PropertyMap' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'FlinkApplicationConfigurationDescription' => [
                'CheckpointConfigurationDescription' => [
                    'CheckpointInterval' => <integer>,
                    'CheckpointingEnabled' => true || false,
                    'ConfigurationType' => 'DEFAULT|CUSTOM',
                    'MinPauseBetweenCheckpoints' => <integer>,
                ],
                'JobPlanDescription' => '<string>',
                'MonitoringConfigurationDescription' => [
                    'ConfigurationType' => 'DEFAULT|CUSTOM',
                    'LogLevel' => 'INFO|WARN|ERROR|DEBUG',
                    'MetricsLevel' => 'APPLICATION|TASK|OPERATOR|PARALLELISM',
                ],
                'ParallelismConfigurationDescription' => [
                    'AutoScalingEnabled' => true || false,
                    'ConfigurationType' => 'DEFAULT|CUSTOM',
                    'CurrentParallelism' => <integer>,
                    'Parallelism' => <integer>,
                    'ParallelismPerKPU' => <integer>,
                ],
            ],
            'RunConfigurationDescription' => [
                'ApplicationRestoreConfigurationDescription' => [
                    'ApplicationRestoreType' => 'SKIP_RESTORE_FROM_SNAPSHOT|RESTORE_FROM_LATEST_SNAPSHOT|RESTORE_FROM_CUSTOM_SNAPSHOT',
                    'SnapshotName' => '<string>',
                ],
                'FlinkRunConfigurationDescription' => [
                    'AllowNonRestoredState' => true || false,
                ],
            ],
            'SqlApplicationConfigurationDescription' => [
                'InputDescriptions' => [
                    [
                        'InAppStreamNames' => ['<string>', ...],
                        'InputId' => '<string>',
                        'InputParallelism' => [
                            'Count' => <integer>,
                        ],
                        'InputProcessingConfigurationDescription' => [
                            'InputLambdaProcessorDescription' => [
                                'ResourceARN' => '<string>',
                                'RoleARN' => '<string>',
                            ],
                        ],
                        'InputSchema' => [
                            'RecordColumns' => [
                                [
                                    'Mapping' => '<string>',
                                    'Name' => '<string>',
                                    'SqlType' => '<string>',
                                ],
                                // ...
                            ],
                            'RecordEncoding' => '<string>',
                            'RecordFormat' => [
                                'MappingParameters' => [
                                    'CSVMappingParameters' => [
                                        'RecordColumnDelimiter' => '<string>',
                                        'RecordRowDelimiter' => '<string>',
                                    ],
                                    'JSONMappingParameters' => [
                                        'RecordRowPath' => '<string>',
                                    ],
                                ],
                                'RecordFormatType' => 'JSON|CSV',
                            ],
                        ],
                        'InputStartingPositionConfiguration' => [
                            'InputStartingPosition' => 'NOW|TRIM_HORIZON|LAST_STOPPED_POINT',
                        ],
                        'KinesisFirehoseInputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'KinesisStreamsInputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'NamePrefix' => '<string>',
                    ],
                    // ...
                ],
                'OutputDescriptions' => [
                    [
                        'DestinationSchema' => [
                            'RecordFormatType' => 'JSON|CSV',
                        ],
                        'KinesisFirehoseOutputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'KinesisStreamsOutputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'LambdaOutputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'Name' => '<string>',
                        'OutputId' => '<string>',
                    ],
                    // ...
                ],
                'ReferenceDataSourceDescriptions' => [
                    [
                        'ReferenceId' => '<string>',
                        'ReferenceSchema' => [
                            'RecordColumns' => [
                                [
                                    'Mapping' => '<string>',
                                    'Name' => '<string>',
                                    'SqlType' => '<string>',
                                ],
                                // ...
                            ],
                            'RecordEncoding' => '<string>',
                            'RecordFormat' => [
                                'MappingParameters' => [
                                    'CSVMappingParameters' => [
                                        'RecordColumnDelimiter' => '<string>',
                                        'RecordRowDelimiter' => '<string>',
                                    ],
                                    'JSONMappingParameters' => [
                                        'RecordRowPath' => '<string>',
                                    ],
                                ],
                                'RecordFormatType' => 'JSON|CSV',
                            ],
                        ],
                        'S3ReferenceDataSourceDescription' => [
                            'BucketARN' => '<string>',
                            'FileKey' => '<string>',
                            'ReferenceRoleARN' => '<string>',
                        ],
                        'TableName' => '<string>',
                    ],
                    // ...
                ],
            ],
            'VpcConfigurationDescriptions' => [
                [
                    'SecurityGroupIds' => ['<string>', ...],
                    'SubnetIds' => ['<string>', ...],
                    'VpcConfigurationId' => '<string>',
                    'VpcId' => '<string>',
                ],
                // ...
            ],
            'ZeppelinApplicationConfigurationDescription' => [
                'CatalogConfigurationDescription' => [
                    'GlueDataCatalogConfigurationDescription' => [
                        'DatabaseARN' => '<string>',
                    ],
                ],
                'CustomArtifactsConfigurationDescription' => [
                    [
                        'ArtifactType' => 'UDF|DEPENDENCY_JAR',
                        'MavenReferenceDescription' => [
                            'ArtifactId' => '<string>',
                            'GroupId' => '<string>',
                            'Version' => '<string>',
                        ],
                        'S3ContentLocationDescription' => [
                            'BucketARN' => '<string>',
                            'FileKey' => '<string>',
                            'ObjectVersion' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'DeployAsApplicationConfigurationDescription' => [
                    'S3ContentLocationDescription' => [
                        'BasePath' => '<string>',
                        'BucketARN' => '<string>',
                    ],
                ],
                'MonitoringConfigurationDescription' => [
                    'LogLevel' => 'INFO|WARN|ERROR|DEBUG',
                ],
            ],
        ],
        'ApplicationDescription' => '<string>',
        'ApplicationMaintenanceConfigurationDescription' => [
            'ApplicationMaintenanceWindowEndTime' => '<string>',
            'ApplicationMaintenanceWindowStartTime' => '<string>',
        ],
        'ApplicationMode' => 'STREAMING|INTERACTIVE',
        'ApplicationName' => '<string>',
        'ApplicationStatus' => 'DELETING|STARTING|STOPPING|READY|RUNNING|UPDATING|AUTOSCALING|FORCE_STOPPING|ROLLING_BACK|MAINTENANCE|ROLLED_BACK',
        'ApplicationVersionId' => <integer>,
        'ApplicationVersionRolledBackFrom' => <integer>,
        'ApplicationVersionRolledBackTo' => <integer>,
        'ApplicationVersionUpdatedFrom' => <integer>,
        'CloudWatchLoggingOptionDescriptions' => [
            [
                'CloudWatchLoggingOptionId' => '<string>',
                'LogStreamARN' => '<string>',
                'RoleARN' => '<string>',
            ],
            // ...
        ],
        'ConditionalToken' => '<string>',
        'CreateTimestamp' => <DateTime>,
        'LastUpdateTimestamp' => <DateTime>,
        'RuntimeEnvironment' => 'SQL-1_0|FLINK-1_6|FLINK-1_8|ZEPPELIN-FLINK-1_0|FLINK-1_11|FLINK-1_13|ZEPPELIN-FLINK-2_0|FLINK-1_15',
        'ServiceExecutionRole' => '<string>',
    ],
]

Result Details

Members

ApplicationVersionDetail

Type: ApplicationDetail structure

Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.

Errors

InvalidArgumentException:
The specified input parameter value is not valid.
ResourceNotFoundException:
Specified application can't be found.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

DiscoverInputSchema

$result = $client->discoverInputSchema([/* ... */]);
$promise = $client->discoverInputSchemaAsync([/* ... */]);

Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema.

You can use the inferred schema when configuring a streaming source for your application. When you create an application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show it in the console user interface.

Parameter Syntax

$result = $client->discoverInputSchema([
    'InputProcessingConfiguration' => [
        'InputLambdaProcessor' => [ // REQUIRED
            'ResourceARN' => '<string>', // REQUIRED
        ],
    ],
    'InputStartingPositionConfiguration' => [
        'InputStartingPosition' => 'NOW|TRIM_HORIZON|LAST_STOPPED_POINT',
    ],
    'ResourceARN' => '<string>',
    'S3Configuration' => [
        'BucketARN' => '<string>', // REQUIRED
        'FileKey' => '<string>', // REQUIRED
    ],
    'ServiceExecutionRole' => '<string>', // REQUIRED
]);

Parameter Details

Members

InputProcessingConfiguration

Type: InputProcessingConfiguration structure

The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.

InputStartingPositionConfiguration

Type: InputStartingPositionConfiguration structure

The point at which you want Kinesis Data Analytics to start reading records from the specified streaming source discovery purposes.

ResourceARN

Type: string

The Amazon Resource Name (ARN) of the streaming source.

S3Configuration

Type: S3Configuration structure

Specify this parameter to discover a schema from data in an Amazon S3 object.

ServiceExecutionRole

Required: Yes
Type: string

The ARN of the role that is used to access the streaming source.

Result Syntax

[
    'InputSchema' => [
        'RecordColumns' => [
            [
                'Mapping' => '<string>',
                'Name' => '<string>',
                'SqlType' => '<string>',
            ],
            // ...
        ],
        'RecordEncoding' => '<string>',
        'RecordFormat' => [
            'MappingParameters' => [
                'CSVMappingParameters' => [
                    'RecordColumnDelimiter' => '<string>',
                    'RecordRowDelimiter' => '<string>',
                ],
                'JSONMappingParameters' => [
                    'RecordRowPath' => '<string>',
                ],
            ],
            'RecordFormatType' => 'JSON|CSV',
        ],
    ],
    'ParsedInputRecords' => [
        ['<string>', ...],
        // ...
    ],
    'ProcessedInputRecords' => ['<string>', ...],
    'RawInputRecords' => ['<string>', ...],
]

Result Details

Members

InputSchema

Type: SourceSchema structure

The schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.

ParsedInputRecords

Type: Array of stringss

An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).

ProcessedInputRecords

Type: Array of strings

The stream data that was modified by the processor specified in the InputProcessingConfiguration parameter.

RawInputRecords

Type: Array of strings

The raw stream data that was sampled to infer the schema.

Errors

InvalidArgumentException:
The specified input parameter value is not valid.
UnableToDetectSchemaException:
The data format is not valid. Kinesis Data Analytics cannot detect the schema for the given streaming source.
ResourceProvisionedThroughputExceededException:
Discovery failed to get a record from the streaming source because of the Kinesis Streams ProvisionedThroughputExceededException. For more information, see GetRecords in the Amazon Kinesis Streams API Reference.
ServiceUnavailableException:
The service cannot complete the request.
InvalidRequestException:
The request JSON is not valid for the operation.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

ListApplicationSnapshots

$result = $client->listApplicationSnapshots([/* ... */]);
$promise = $client->listApplicationSnapshotsAsync([/* ... */]);

Lists information about the current application snapshots.

Parameter Syntax

$result = $client->listApplicationSnapshots([
    'ApplicationName' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of an existing application.

Limit

Type: int

The maximum number of application snapshots to list.

NextToken

Type: string

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

Result Syntax

[
    'NextToken' => '<string>',
    'SnapshotSummaries' => [
        [
            'ApplicationVersionId' => <integer>,
            'SnapshotCreationTimestamp' => <DateTime>,
            'SnapshotName' => '<string>',
            'SnapshotStatus' => 'CREATING|READY|DELETING|FAILED',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token for the next set of results, or null if there are no additional results.

SnapshotSummaries

Type: Array of SnapshotDetails structures

A collection of objects containing information about the application snapshots.

Errors

InvalidArgumentException:
The specified input parameter value is not valid.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

ListApplicationVersions

$result = $client->listApplicationVersions([/* ... */]);
$promise = $client->listApplicationVersionsAsync([/* ... */]);

Lists all the versions for the specified application, including versions that were rolled back. The response also includes a summary of the configuration associated with each version.

To get the complete description of a specific application version, invoke the DescribeApplicationVersion operation.

This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink.

Parameter Syntax

$result = $client->listApplicationVersions([
    'ApplicationName' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of the application for which you want to list all versions.

Limit

Type: int

The maximum number of versions to list in this invocation of the operation.

NextToken

Type: string

If a previous invocation of this operation returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.

Result Syntax

[
    'ApplicationVersionSummaries' => [
        [
            'ApplicationStatus' => 'DELETING|STARTING|STOPPING|READY|RUNNING|UPDATING|AUTOSCALING|FORCE_STOPPING|ROLLING_BACK|MAINTENANCE|ROLLED_BACK',
            'ApplicationVersionId' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ApplicationVersionSummaries

Type: Array of ApplicationVersionSummary structures

A list of the application versions and the associated configuration summaries. The list includes application versions that were rolled back.

To get the complete description of a specific application version, invoke the DescribeApplicationVersion operation.

NextToken

Type: string

The pagination token for the next set of results, or null if there are no additional results. To retrieve the next set of items, pass this token into a subsequent invocation of this operation. For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.

Errors

InvalidArgumentException:
The specified input parameter value is not valid.
ResourceNotFoundException:
Specified application can't be found.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

ListApplications

$result = $client->listApplications([/* ... */]);
$promise = $client->listApplicationsAsync([/* ... */]);

Returns a list of Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status.

If you want detailed information about a specific application, use DescribeApplication.

Parameter Syntax

$result = $client->listApplications([
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Limit

Type: int

The maximum number of applications to list.

NextToken

Type: string

If a previous command returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.

Result Syntax

[
    'ApplicationSummaries' => [
        [
            'ApplicationARN' => '<string>',
            'ApplicationMode' => 'STREAMING|INTERACTIVE',
            'ApplicationName' => '<string>',
            'ApplicationStatus' => 'DELETING|STARTING|STOPPING|READY|RUNNING|UPDATING|AUTOSCALING|FORCE_STOPPING|ROLLING_BACK|MAINTENANCE|ROLLED_BACK',
            'ApplicationVersionId' => <integer>,
            'RuntimeEnvironment' => 'SQL-1_0|FLINK-1_6|FLINK-1_8|ZEPPELIN-FLINK-1_0|FLINK-1_11|FLINK-1_13|ZEPPELIN-FLINK-2_0|FLINK-1_15',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ApplicationSummaries

Required: Yes
Type: Array of ApplicationSummary structures

A list of ApplicationSummary objects.

NextToken

Type: string

The pagination token for the next set of results, or null if there are no additional results. Pass this token into a subsequent command to retrieve the next set of items For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.

Errors

InvalidRequestException:
The request JSON is not valid for the operation.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceARN

Required: Yes
Type: string

The ARN of the application for which to retrieve tags.

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Tags

Type: Array of Tag structures

The key-value tags assigned to the application.

Errors

ResourceNotFoundException:
Specified application can't be found.
InvalidArgumentException:
The specified input parameter value is not valid.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.

RollbackApplication

$result = $client->rollbackApplication([/* ... */]);
$promise = $client->rollbackApplicationAsync([/* ... */]);

Reverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status.

You can roll back an application only if it is in the UPDATING or AUTOSCALING status.

When you rollback an application, it loads state data from the last successful snapshot. If the application has no snapshots, Kinesis Data Analytics rejects the rollback request.

This action is not supported for Kinesis Data Analytics for SQL applications.

Parameter Syntax

$result = $client->rollbackApplication([
    'ApplicationName' => '<string>', // REQUIRED
    'CurrentApplicationVersionId' => <integer>, // REQUIRED
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of the application.

CurrentApplicationVersionId

Required: Yes
Type: long (int|float)

The current application version ID. You can retrieve the application version ID using DescribeApplication.

Result Syntax

[
    'ApplicationDetail' => [
        'ApplicationARN' => '<string>',
        'ApplicationConfigurationDescription' => [
            'ApplicationCodeConfigurationDescription' => [
                'CodeContentDescription' => [
                    'CodeMD5' => '<string>',
                    'CodeSize' => <integer>,
                    'S3ApplicationCodeLocationDescription' => [
                        'BucketARN' => '<string>',
                        'FileKey' => '<string>',
                        'ObjectVersion' => '<string>',
                    ],
                    'TextContent' => '<string>',
                ],
                'CodeContentType' => 'PLAINTEXT|ZIPFILE',
            ],
            'ApplicationSnapshotConfigurationDescription' => [
                'SnapshotsEnabled' => true || false,
            ],
            'EnvironmentPropertyDescriptions' => [
                'PropertyGroupDescriptions' => [
                    [
                        'PropertyGroupId' => '<string>',
                        'PropertyMap' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'FlinkApplicationConfigurationDescription' => [
                'CheckpointConfigurationDescription' => [
                    'CheckpointInterval' => <integer>,
                    'CheckpointingEnabled' => true || false,
                    'ConfigurationType' => 'DEFAULT|CUSTOM',
                    'MinPauseBetweenCheckpoints' => <integer>,
                ],
                'JobPlanDescription' => '<string>',
                'MonitoringConfigurationDescription' => [
                    'ConfigurationType' => 'DEFAULT|CUSTOM',
                    'LogLevel' => 'INFO|WARN|ERROR|DEBUG',
                    'MetricsLevel' => 'APPLICATION|TASK|OPERATOR|PARALLELISM',
                ],
                'ParallelismConfigurationDescription' => [
                    'AutoScalingEnabled' => true || false,
                    'ConfigurationType' => 'DEFAULT|CUSTOM',
                    'CurrentParallelism' => <integer>,
                    'Parallelism' => <integer>,
                    'ParallelismPerKPU' => <integer>,
                ],
            ],
            'RunConfigurationDescription' => [
                'ApplicationRestoreConfigurationDescription' => [
                    'ApplicationRestoreType' => 'SKIP_RESTORE_FROM_SNAPSHOT|RESTORE_FROM_LATEST_SNAPSHOT|RESTORE_FROM_CUSTOM_SNAPSHOT',
                    'SnapshotName' => '<string>',
                ],
                'FlinkRunConfigurationDescription' => [
                    'AllowNonRestoredState' => true || false,
                ],
            ],
            'SqlApplicationConfigurationDescription' => [
                'InputDescriptions' => [
                    [
                        'InAppStreamNames' => ['<string>', ...],
                        'InputId' => '<string>',
                        'InputParallelism' => [
                            'Count' => <integer>,
                        ],
                        'InputProcessingConfigurationDescription' => [
                            'InputLambdaProcessorDescription' => [
                                'ResourceARN' => '<string>',
                                'RoleARN' => '<string>',
                            ],
                        ],
                        'InputSchema' => [
                            'RecordColumns' => [
                                [
                                    'Mapping' => '<string>',
                                    'Name' => '<string>',
                                    'SqlType' => '<string>',
                                ],
                                // ...
                            ],
                            'RecordEncoding' => '<string>',
                            'RecordFormat' => [
                                'MappingParameters' => [
                                    'CSVMappingParameters' => [
                                        'RecordColumnDelimiter' => '<string>',
                                        'RecordRowDelimiter' => '<string>',
                                    ],
                                    'JSONMappingParameters' => [
                                        'RecordRowPath' => '<string>',
                                    ],
                                ],
                                'RecordFormatType' => 'JSON|CSV',
                            ],
                        ],
                        'InputStartingPositionConfiguration' => [
                            'InputStartingPosition' => 'NOW|TRIM_HORIZON|LAST_STOPPED_POINT',
                        ],
                        'KinesisFirehoseInputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'KinesisStreamsInputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'NamePrefix' => '<string>',
                    ],
                    // ...
                ],
                'OutputDescriptions' => [
                    [
                        'DestinationSchema' => [
                            'RecordFormatType' => 'JSON|CSV',
                        ],
                        'KinesisFirehoseOutputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'KinesisStreamsOutputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'LambdaOutputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'Name' => '<string>',
                        'OutputId' => '<string>',
                    ],
                    // ...
                ],
                'ReferenceDataSourceDescriptions' => [
                    [
                        'ReferenceId' => '<string>',
                        'ReferenceSchema' => [
                            'RecordColumns' => [
                                [
                                    'Mapping' => '<string>',
                                    'Name' => '<string>',
                                    'SqlType' => '<string>',
                                ],
                                // ...
                            ],
                            'RecordEncoding' => '<string>',
                            'RecordFormat' => [
                                'MappingParameters' => [
                                    'CSVMappingParameters' => [
                                        'RecordColumnDelimiter' => '<string>',
                                        'RecordRowDelimiter' => '<string>',
                                    ],
                                    'JSONMappingParameters' => [
                                        'RecordRowPath' => '<string>',
                                    ],
                                ],
                                'RecordFormatType' => 'JSON|CSV',
                            ],
                        ],
                        'S3ReferenceDataSourceDescription' => [
                            'BucketARN' => '<string>',
                            'FileKey' => '<string>',
                            'ReferenceRoleARN' => '<string>',
                        ],
                        'TableName' => '<string>',
                    ],
                    // ...
                ],
            ],
            'VpcConfigurationDescriptions' => [
                [
                    'SecurityGroupIds' => ['<string>', ...],
                    'SubnetIds' => ['<string>', ...],
                    'VpcConfigurationId' => '<string>',
                    'VpcId' => '<string>',
                ],
                // ...
            ],
            'ZeppelinApplicationConfigurationDescription' => [
                'CatalogConfigurationDescription' => [
                    'GlueDataCatalogConfigurationDescription' => [
                        'DatabaseARN' => '<string>',
                    ],
                ],
                'CustomArtifactsConfigurationDescription' => [
                    [
                        'ArtifactType' => 'UDF|DEPENDENCY_JAR',
                        'MavenReferenceDescription' => [
                            'ArtifactId' => '<string>',
                            'GroupId' => '<string>',
                            'Version' => '<string>',
                        ],
                        'S3ContentLocationDescription' => [
                            'BucketARN' => '<string>',
                            'FileKey' => '<string>',
                            'ObjectVersion' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'DeployAsApplicationConfigurationDescription' => [
                    'S3ContentLocationDescription' => [
                        'BasePath' => '<string>',
                        'BucketARN' => '<string>',
                    ],
                ],
                'MonitoringConfigurationDescription' => [
                    'LogLevel' => 'INFO|WARN|ERROR|DEBUG',
                ],
            ],
        ],
        'ApplicationDescription' => '<string>',
        'ApplicationMaintenanceConfigurationDescription' => [
            'ApplicationMaintenanceWindowEndTime' => '<string>',
            'ApplicationMaintenanceWindowStartTime' => '<string>',
        ],
        'ApplicationMode' => 'STREAMING|INTERACTIVE',
        'ApplicationName' => '<string>',
        'ApplicationStatus' => 'DELETING|STARTING|STOPPING|READY|RUNNING|UPDATING|AUTOSCALING|FORCE_STOPPING|ROLLING_BACK|MAINTENANCE|ROLLED_BACK',
        'ApplicationVersionId' => <integer>,
        'ApplicationVersionRolledBackFrom' => <integer>,
        'ApplicationVersionRolledBackTo' => <integer>,
        'ApplicationVersionUpdatedFrom' => <integer>,
        'CloudWatchLoggingOptionDescriptions' => [
            [
                'CloudWatchLoggingOptionId' => '<string>',
                'LogStreamARN' => '<string>',
                'RoleARN' => '<string>',
            ],
            // ...
        ],
        'ConditionalToken' => '<string>',
        'CreateTimestamp' => <DateTime>,
        'LastUpdateTimestamp' => <DateTime>,
        'RuntimeEnvironment' => 'SQL-1_0|FLINK-1_6|FLINK-1_8|ZEPPELIN-FLINK-1_0|FLINK-1_11|FLINK-1_13|ZEPPELIN-FLINK-2_0|FLINK-1_15',
        'ServiceExecutionRole' => '<string>',
    ],
]

Result Details

Members

ApplicationDetail

Required: Yes
Type: ApplicationDetail structure

Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.

Errors

ResourceNotFoundException:
Specified application can't be found.
InvalidArgumentException:
The specified input parameter value is not valid.
ResourceInUseException:
The application is not available for this operation.
InvalidRequestException:
The request JSON is not valid for the operation.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

StartApplication

$result = $client->startApplication([/* ... */]);
$promise = $client->startApplicationAsync([/* ... */]);

Starts the specified Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application.

Parameter Syntax

$result = $client->startApplication([
    'ApplicationName' => '<string>', // REQUIRED
    'RunConfiguration' => [
        'ApplicationRestoreConfiguration' => [
            'ApplicationRestoreType' => 'SKIP_RESTORE_FROM_SNAPSHOT|RESTORE_FROM_LATEST_SNAPSHOT|RESTORE_FROM_CUSTOM_SNAPSHOT', // REQUIRED
            'SnapshotName' => '<string>',
        ],
        'FlinkRunConfiguration' => [
            'AllowNonRestoredState' => true || false,
        ],
        'SqlRunConfigurations' => [
            [
                'InputId' => '<string>', // REQUIRED
                'InputStartingPositionConfiguration' => [ // REQUIRED
                    'InputStartingPosition' => 'NOW|TRIM_HORIZON|LAST_STOPPED_POINT',
                ],
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of the application.

RunConfiguration

Type: RunConfiguration structure

Identifies the run configuration (start parameters) of a Kinesis Data Analytics application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
InvalidArgumentException:
The specified input parameter value is not valid.
InvalidApplicationConfigurationException:
The user-provided application configuration is not valid.
InvalidRequestException:
The request JSON is not valid for the operation.

StopApplication

$result = $client->stopApplication([/* ... */]);
$promise = $client->stopApplicationAsync([/* ... */]);

Stops the application from processing data. You can stop an application only if it is in the running status, unless you set the Force parameter to true.

You can use the DescribeApplication operation to find the application status.

Kinesis Data Analytics takes a snapshot when the application is stopped, unless Force is set to true.

Parameter Syntax

$result = $client->stopApplication([
    'ApplicationName' => '<string>', // REQUIRED
    'Force' => true || false,
]);

Parameter Details

Members

ApplicationName

Required: Yes
Type: string

The name of the running application to stop.

Force

Type: boolean

Set to true to force the application to stop. If you set Force to true, Kinesis Data Analytics stops the application without taking a snapshot.

Force-stopping your application may lead to data loss or duplication. To prevent data loss or duplicate processing of data during application restarts, we recommend you to take frequent snapshots of your application.

You can only force stop a Flink-based Kinesis Data Analytics application. You can't force stop a SQL-based Kinesis Data Analytics application.

The application must be in the STARTING, UPDATING, STOPPING, AUTOSCALING, or RUNNING status.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
InvalidArgumentException:
The specified input parameter value is not valid.
InvalidRequestException:
The request JSON is not valid for the operation.
InvalidApplicationConfigurationException:
The user-provided application configuration is not valid.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds one or more key-value tags to a Kinesis Data Analytics application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceARN

Required: Yes
Type: string

The ARN of the application to assign the tags.

Tags

Required: Yes
Type: Array of Tag structures

The key-value tags to assign to the application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
TooManyTagsException:
Application created with too many tags, or too many tags added to an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.
InvalidArgumentException:
The specified input parameter value is not valid.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from a Kinesis Data Analytics application. For more information, see Using Tagging.

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceARN

Required: Yes
Type: string

The ARN of the Kinesis Data Analytics application from which to remove the tags.

TagKeys

Required: Yes
Type: Array of strings

A list of keys of tags to remove from the specified application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
TooManyTagsException:
Application created with too many tags, or too many tags added to an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.
InvalidArgumentException:
The specified input parameter value is not valid.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.

UpdateApplication

$result = $client->updateApplication([/* ... */]);
$promise = $client->updateApplicationAsync([/* ... */]);

Updates an existing Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration.

Kinesis Data Analytics updates the ApplicationVersionId each time you update your application.

You cannot update the RuntimeEnvironment of an existing application. If you need to update an application's RuntimeEnvironment, you must delete the application and create it again.

Parameter Syntax

$result = $client->updateApplication([
    'ApplicationConfigurationUpdate' => [
        'ApplicationCodeConfigurationUpdate' => [
            'CodeContentTypeUpdate' => 'PLAINTEXT|ZIPFILE',
            'CodeContentUpdate' => [
                'S3ContentLocationUpdate' => [
                    'BucketARNUpdate' => '<string>',
                    'FileKeyUpdate' => '<string>',
                    'ObjectVersionUpdate' => '<string>',
                ],
                'TextContentUpdate' => '<string>',
                'ZipFileContentUpdate' => <string || resource || Psr\Http\Message\StreamInterface>,
            ],
        ],
        'ApplicationSnapshotConfigurationUpdate' => [
            'SnapshotsEnabledUpdate' => true || false, // REQUIRED
        ],
        'EnvironmentPropertyUpdates' => [
            'PropertyGroups' => [ // REQUIRED
                [
                    'PropertyGroupId' => '<string>', // REQUIRED
                    'PropertyMap' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
        ],
        'FlinkApplicationConfigurationUpdate' => [
            'CheckpointConfigurationUpdate' => [
                'CheckpointIntervalUpdate' => <integer>,
                'CheckpointingEnabledUpdate' => true || false,
                'ConfigurationTypeUpdate' => 'DEFAULT|CUSTOM',
                'MinPauseBetweenCheckpointsUpdate' => <integer>,
            ],
            'MonitoringConfigurationUpdate' => [
                'ConfigurationTypeUpdate' => 'DEFAULT|CUSTOM',
                'LogLevelUpdate' => 'INFO|WARN|ERROR|DEBUG',
                'MetricsLevelUpdate' => 'APPLICATION|TASK|OPERATOR|PARALLELISM',
            ],
            'ParallelismConfigurationUpdate' => [
                'AutoScalingEnabledUpdate' => true || false,
                'ConfigurationTypeUpdate' => 'DEFAULT|CUSTOM',
                'ParallelismPerKPUUpdate' => <integer>,
                'ParallelismUpdate' => <integer>,
            ],
        ],
        'SqlApplicationConfigurationUpdate' => [
            'InputUpdates' => [
                [
                    'InputId' => '<string>', // REQUIRED
                    'InputParallelismUpdate' => [
                        'CountUpdate' => <integer>, // REQUIRED
                    ],
                    'InputProcessingConfigurationUpdate' => [
                        'InputLambdaProcessorUpdate' => [ // REQUIRED
                            'ResourceARNUpdate' => '<string>', // REQUIRED
                        ],
                    ],
                    'InputSchemaUpdate' => [
                        'RecordColumnUpdates' => [
                            [
                                'Mapping' => '<string>',
                                'Name' => '<string>', // REQUIRED
                                'SqlType' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'RecordEncodingUpdate' => '<string>',
                        'RecordFormatUpdate' => [
                            'MappingParameters' => [
                                'CSVMappingParameters' => [
                                    'RecordColumnDelimiter' => '<string>', // REQUIRED
                                    'RecordRowDelimiter' => '<string>', // REQUIRED
                                ],
                                'JSONMappingParameters' => [
                                    'RecordRowPath' => '<string>', // REQUIRED
                                ],
                            ],
                            'RecordFormatType' => 'JSON|CSV', // REQUIRED
                        ],
                    ],
                    'KinesisFirehoseInputUpdate' => [
                        'ResourceARNUpdate' => '<string>', // REQUIRED
                    ],
                    'KinesisStreamsInputUpdate' => [
                        'ResourceARNUpdate' => '<string>', // REQUIRED
                    ],
                    'NamePrefixUpdate' => '<string>',
                ],
                // ...
            ],
            'OutputUpdates' => [
                [
                    'DestinationSchemaUpdate' => [
                        'RecordFormatType' => 'JSON|CSV', // REQUIRED
                    ],
                    'KinesisFirehoseOutputUpdate' => [
                        'ResourceARNUpdate' => '<string>', // REQUIRED
                    ],
                    'KinesisStreamsOutputUpdate' => [
                        'ResourceARNUpdate' => '<string>', // REQUIRED
                    ],
                    'LambdaOutputUpdate' => [
                        'ResourceARNUpdate' => '<string>', // REQUIRED
                    ],
                    'NameUpdate' => '<string>',
                    'OutputId' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'ReferenceDataSourceUpdates' => [
                [
                    'ReferenceId' => '<string>', // REQUIRED
                    'ReferenceSchemaUpdate' => [
                        'RecordColumns' => [ // REQUIRED
                            [
                                'Mapping' => '<string>',
                                'Name' => '<string>', // REQUIRED
                                'SqlType' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'RecordEncoding' => '<string>',
                        'RecordFormat' => [ // REQUIRED
                            'MappingParameters' => [
                                'CSVMappingParameters' => [
                                    'RecordColumnDelimiter' => '<string>', // REQUIRED
                                    'RecordRowDelimiter' => '<string>', // REQUIRED
                                ],
                                'JSONMappingParameters' => [
                                    'RecordRowPath' => '<string>', // REQUIRED
                                ],
                            ],
                            'RecordFormatType' => 'JSON|CSV', // REQUIRED
                        ],
                    ],
                    'S3ReferenceDataSourceUpdate' => [
                        'BucketARNUpdate' => '<string>',
                        'FileKeyUpdate' => '<string>',
                    ],
                    'TableNameUpdate' => '<string>',
                ],
                // ...
            ],
        ],
        'VpcConfigurationUpdates' => [
            [
                'SecurityGroupIdUpdates' => ['<string>', ...],
                'SubnetIdUpdates' => ['<string>', ...],
                'VpcConfigurationId' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ZeppelinApplicationConfigurationUpdate' => [
            'CatalogConfigurationUpdate' => [
                'GlueDataCatalogConfigurationUpdate' => [ // REQUIRED
                    'DatabaseARNUpdate' => '<string>', // REQUIRED
                ],
            ],
            'CustomArtifactsConfigurationUpdate' => [
                [
                    'ArtifactType' => 'UDF|DEPENDENCY_JAR', // REQUIRED
                    'MavenReference' => [
                        'ArtifactId' => '<string>', // REQUIRED
                        'GroupId' => '<string>', // REQUIRED
                        'Version' => '<string>', // REQUIRED
                    ],
                    'S3ContentLocation' => [
                        'BucketARN' => '<string>', // REQUIRED
                        'FileKey' => '<string>', // REQUIRED
                        'ObjectVersion' => '<string>',
                    ],
                ],
                // ...
            ],
            'DeployAsApplicationConfigurationUpdate' => [
                'S3ContentLocationUpdate' => [
                    'BasePathUpdate' => '<string>',
                    'BucketARNUpdate' => '<string>',
                ],
            ],
            'MonitoringConfigurationUpdate' => [
                'LogLevelUpdate' => 'INFO|WARN|ERROR|DEBUG', // REQUIRED
            ],
        ],
    ],
    'ApplicationName' => '<string>', // REQUIRED
    'CloudWatchLoggingOptionUpdates' => [
        [
            'CloudWatchLoggingOptionId' => '<string>', // REQUIRED
            'LogStreamARNUpdate' => '<string>',
        ],
        // ...
    ],
    'ConditionalToken' => '<string>',
    'CurrentApplicationVersionId' => <integer>,
    'RunConfigurationUpdate' => [
        'ApplicationRestoreConfiguration' => [
            'ApplicationRestoreType' => 'SKIP_RESTORE_FROM_SNAPSHOT|RESTORE_FROM_LATEST_SNAPSHOT|RESTORE_FROM_CUSTOM_SNAPSHOT', // REQUIRED
            'SnapshotName' => '<string>',
        ],
        'FlinkRunConfiguration' => [
            'AllowNonRestoredState' => true || false,
        ],
    ],
    'ServiceExecutionRoleUpdate' => '<string>',
]);

Parameter Details

Members

ApplicationConfigurationUpdate

Type: ApplicationConfigurationUpdate structure

Describes application configuration updates.

ApplicationName

Required: Yes
Type: string

The name of the application to update.

CloudWatchLoggingOptionUpdates

Type: Array of CloudWatchLoggingOptionUpdate structures

Describes application Amazon CloudWatch logging option updates. You can only update existing CloudWatch logging options with this action. To add a new CloudWatch logging option, use AddApplicationCloudWatchLoggingOption.

ConditionalToken

Type: string

CurrentApplicationVersionId

Type: long (int|float)

The current application version ID. You must provide the CurrentApplicationVersionId or the ConditionalToken.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

RunConfigurationUpdate

Type: RunConfigurationUpdate structure

Describes updates to the application's starting parameters.

ServiceExecutionRoleUpdate

Type: string

Describes updates to the service execution role.

Result Syntax

[
    'ApplicationDetail' => [
        'ApplicationARN' => '<string>',
        'ApplicationConfigurationDescription' => [
            'ApplicationCodeConfigurationDescription' => [
                'CodeContentDescription' => [
                    'CodeMD5' => '<string>',
                    'CodeSize' => <integer>,
                    'S3ApplicationCodeLocationDescription' => [
                        'BucketARN' => '<string>',
                        'FileKey' => '<string>',
                        'ObjectVersion' => '<string>',
                    ],
                    'TextContent' => '<string>',
                ],
                'CodeContentType' => 'PLAINTEXT|ZIPFILE',
            ],
            'ApplicationSnapshotConfigurationDescription' => [
                'SnapshotsEnabled' => true || false,
            ],
            'EnvironmentPropertyDescriptions' => [
                'PropertyGroupDescriptions' => [
                    [
                        'PropertyGroupId' => '<string>',
                        'PropertyMap' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'FlinkApplicationConfigurationDescription' => [
                'CheckpointConfigurationDescription' => [
                    'CheckpointInterval' => <integer>,
                    'CheckpointingEnabled' => true || false,
                    'ConfigurationType' => 'DEFAULT|CUSTOM',
                    'MinPauseBetweenCheckpoints' => <integer>,
                ],
                'JobPlanDescription' => '<string>',
                'MonitoringConfigurationDescription' => [
                    'ConfigurationType' => 'DEFAULT|CUSTOM',
                    'LogLevel' => 'INFO|WARN|ERROR|DEBUG',
                    'MetricsLevel' => 'APPLICATION|TASK|OPERATOR|PARALLELISM',
                ],
                'ParallelismConfigurationDescription' => [
                    'AutoScalingEnabled' => true || false,
                    'ConfigurationType' => 'DEFAULT|CUSTOM',
                    'CurrentParallelism' => <integer>,
                    'Parallelism' => <integer>,
                    'ParallelismPerKPU' => <integer>,
                ],
            ],
            'RunConfigurationDescription' => [
                'ApplicationRestoreConfigurationDescription' => [
                    'ApplicationRestoreType' => 'SKIP_RESTORE_FROM_SNAPSHOT|RESTORE_FROM_LATEST_SNAPSHOT|RESTORE_FROM_CUSTOM_SNAPSHOT',
                    'SnapshotName' => '<string>',
                ],
                'FlinkRunConfigurationDescription' => [
                    'AllowNonRestoredState' => true || false,
                ],
            ],
            'SqlApplicationConfigurationDescription' => [
                'InputDescriptions' => [
                    [
                        'InAppStreamNames' => ['<string>', ...],
                        'InputId' => '<string>',
                        'InputParallelism' => [
                            'Count' => <integer>,
                        ],
                        'InputProcessingConfigurationDescription' => [
                            'InputLambdaProcessorDescription' => [
                                'ResourceARN' => '<string>',
                                'RoleARN' => '<string>',
                            ],
                        ],
                        'InputSchema' => [
                            'RecordColumns' => [
                                [
                                    'Mapping' => '<string>',
                                    'Name' => '<string>',
                                    'SqlType' => '<string>',
                                ],
                                // ...
                            ],
                            'RecordEncoding' => '<string>',
                            'RecordFormat' => [
                                'MappingParameters' => [
                                    'CSVMappingParameters' => [
                                        'RecordColumnDelimiter' => '<string>',
                                        'RecordRowDelimiter' => '<string>',
                                    ],
                                    'JSONMappingParameters' => [
                                        'RecordRowPath' => '<string>',
                                    ],
                                ],
                                'RecordFormatType' => 'JSON|CSV',
                            ],
                        ],
                        'InputStartingPositionConfiguration' => [
                            'InputStartingPosition' => 'NOW|TRIM_HORIZON|LAST_STOPPED_POINT',
                        ],
                        'KinesisFirehoseInputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'KinesisStreamsInputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'NamePrefix' => '<string>',
                    ],
                    // ...
                ],
                'OutputDescriptions' => [
                    [
                        'DestinationSchema' => [
                            'RecordFormatType' => 'JSON|CSV',
                        ],
                        'KinesisFirehoseOutputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'KinesisStreamsOutputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'LambdaOutputDescription' => [
                            'ResourceARN' => '<string>',
                            'RoleARN' => '<string>',
                        ],
                        'Name' => '<string>',
                        'OutputId' => '<string>',
                    ],
                    // ...
                ],
                'ReferenceDataSourceDescriptions' => [
                    [
                        'ReferenceId' => '<string>',
                        'ReferenceSchema' => [
                            'RecordColumns' => [
                                [
                                    'Mapping' => '<string>',
                                    'Name' => '<string>',
                                    'SqlType' => '<string>',
                                ],
                                // ...
                            ],
                            'RecordEncoding' => '<string>',
                            'RecordFormat' => [
                                'MappingParameters' => [
                                    'CSVMappingParameters' => [
                                        'RecordColumnDelimiter' => '<string>',
                                        'RecordRowDelimiter' => '<string>',
                                    ],
                                    'JSONMappingParameters' => [
                                        'RecordRowPath' => '<string>',
                                    ],
                                ],
                                'RecordFormatType' => 'JSON|CSV',
                            ],
                        ],
                        'S3ReferenceDataSourceDescription' => [
                            'BucketARN' => '<string>',
                            'FileKey' => '<string>',
                            'ReferenceRoleARN' => '<string>',
                        ],
                        'TableName' => '<string>',
                    ],
                    // ...
                ],
            ],
            'VpcConfigurationDescriptions' => [
                [
                    'SecurityGroupIds' => ['<string>', ...],
                    'SubnetIds' => ['<string>', ...],
                    'VpcConfigurationId' => '<string>',
                    'VpcId' => '<string>',
                ],
                // ...
            ],
            'ZeppelinApplicationConfigurationDescription' => [
                'CatalogConfigurationDescription' => [
                    'GlueDataCatalogConfigurationDescription' => [
                        'DatabaseARN' => '<string>',
                    ],
                ],
                'CustomArtifactsConfigurationDescription' => [
                    [
                        'ArtifactType' => 'UDF|DEPENDENCY_JAR',
                        'MavenReferenceDescription' => [
                            'ArtifactId' => '<string>',
                            'GroupId' => '<string>',
                            'Version' => '<string>',
                        ],
                        'S3ContentLocationDescription' => [
                            'BucketARN' => '<string>',
                            'FileKey' => '<string>',
                            'ObjectVersion' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'DeployAsApplicationConfigurationDescription' => [
                    'S3ContentLocationDescription' => [
                        'BasePath' => '<string>',
                        'BucketARN' => '<string>',
                    ],
                ],
                'MonitoringConfigurationDescription' => [
                    'LogLevel' => 'INFO|WARN|ERROR|DEBUG',
                ],
            ],
        ],
        'ApplicationDescription' => '<string>',
        'ApplicationMaintenanceConfigurationDescription' => [
            'ApplicationMaintenanceWindowEndTime' => '<string>',
            'ApplicationMaintenanceWindowStartTime' => '<string>',
        ],
        'ApplicationMode' => 'STREAMING|INTERACTIVE',
        'ApplicationName' => '<string>',
        'ApplicationStatus' => 'DELETING|STARTING|STOPPING|READY|RUNNING|UPDATING|AUTOSCALING|FORCE_STOPPING|ROLLING_BACK|MAINTENANCE|ROLLED_BACK',
        'ApplicationVersionId' => <integer>,
        'ApplicationVersionRolledBackFrom' => <integer>,
        'ApplicationVersionRolledBackTo' => <integer>,
        'ApplicationVersionUpdatedFrom' => <integer>,
        'CloudWatchLoggingOptionDescriptions' => [
            [
                'CloudWatchLoggingOptionId' => '<string>',
                'LogStreamARN' => '<string>',
                'RoleARN' => '<string>',
            ],
            // ...
        ],
        'ConditionalToken' => '<string>',
        'CreateTimestamp' => <DateTime>,
        'LastUpdateTimestamp' => <DateTime>,
        'RuntimeEnvironment' => 'SQL-1_0|FLINK-1_6|FLINK-1_8|ZEPPELIN-FLINK-1_0|FLINK-1_11|FLINK-1_13|ZEPPELIN-FLINK-2_0|FLINK-1_15',
        'ServiceExecutionRole' => '<string>',
    ],
]

Result Details

Members

ApplicationDetail

Required: Yes
Type: ApplicationDetail structure

Describes application updates.

Errors

CodeValidationException:
The user-provided application code (query) is not valid. This can be a simple syntax error.
ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
InvalidArgumentException:
The specified input parameter value is not valid.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
InvalidRequestException:
The request JSON is not valid for the operation.
InvalidApplicationConfigurationException:
The user-provided application configuration is not valid.
LimitExceededException:
The number of allowed resources has been exceeded.

UpdateApplicationMaintenanceConfiguration

$result = $client->updateApplicationMaintenanceConfiguration([/* ... */]);
$promise = $client->updateApplicationMaintenanceConfigurationAsync([/* ... */]);

Updates the maintenance configuration of the Kinesis Data Analytics application.

You can invoke this operation on an application that is in one of the two following states: READY or RUNNING. If you invoke it when the application is in a state other than these two states, it throws a ResourceInUseException. The service makes use of the updated configuration the next time it schedules maintenance for the application. If you invoke this operation after the service schedules maintenance, the service will apply the configuration update the next time it schedules maintenance for the application. This means that you might not see the maintenance configuration update applied to the maintenance process that follows a successful invocation of this operation, but to the following maintenance process instead.

To see the current maintenance configuration of your application, invoke the DescribeApplication operation.

For information about application maintenance, see Kinesis Data Analytics for Apache Flink Maintenance.

This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink.

Parameter Syntax

$result = $client->updateApplicationMaintenanceConfiguration([
    'ApplicationMaintenanceConfigurationUpdate' => [ // REQUIRED
        'ApplicationMaintenanceWindowStartTimeUpdate' => '<string>', // REQUIRED
    ],
    'ApplicationName' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplicationMaintenanceConfigurationUpdate

Required: Yes
Type: ApplicationMaintenanceConfigurationUpdate structure

Describes the application maintenance configuration update.

ApplicationName

Required: Yes
Type: string

The name of the application for which you want to update the maintenance configuration.

Result Syntax

[
    'ApplicationARN' => '<string>',
    'ApplicationMaintenanceConfigurationDescription' => [
        'ApplicationMaintenanceWindowEndTime' => '<string>',
        'ApplicationMaintenanceWindowStartTime' => '<string>',
    ],
]

Result Details

Members

ApplicationARN

Type: string

The Amazon Resource Name (ARN) of the application.

ApplicationMaintenanceConfigurationDescription

Type: ApplicationMaintenanceConfigurationDescription structure

The application maintenance configuration description after the update.

Errors

ResourceNotFoundException:
Specified application can't be found.
ResourceInUseException:
The application is not available for this operation.
InvalidArgumentException:
The specified input parameter value is not valid.
ConcurrentModificationException:
Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

Shapes

ApplicationCodeConfiguration

Description

Describes code configuration for an application.

Members

CodeContent

Type: CodeContent structure

The location and type of the application code.

CodeContentType

Required: Yes
Type: string

Specifies whether the code content is in text or zip format.

ApplicationCodeConfigurationDescription

Description

Describes code configuration for an application.

Members

CodeContentDescription

Type: CodeContentDescription structure

Describes details about the location and format of the application code.

CodeContentType

Required: Yes
Type: string

Specifies whether the code content is in text or zip format.

ApplicationCodeConfigurationUpdate

Description

Describes code configuration updates for an application. This is supported for a Flink-based Kinesis Data Analytics application or a SQL-based Kinesis Data Analytics application.

Members

CodeContentTypeUpdate

Type: string

Describes updates to the code content type.

CodeContentUpdate

Type: CodeContentUpdate structure

Describes updates to the code content of an application.

ApplicationConfiguration

Description

Specifies the creation parameters for a Kinesis Data Analytics application.

Members

ApplicationCodeConfiguration

Type: ApplicationCodeConfiguration structure

The code location and type parameters for a Flink-based Kinesis Data Analytics application.

ApplicationSnapshotConfiguration

Type: ApplicationSnapshotConfiguration structure

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

EnvironmentProperties

Type: EnvironmentProperties structure

Describes execution properties for a Flink-based Kinesis Data Analytics application.

FlinkApplicationConfiguration

Type: FlinkApplicationConfiguration structure

The creation and update parameters for a Flink-based Kinesis Data Analytics application.

SqlApplicationConfiguration

Type: SqlApplicationConfiguration structure

The creation and update parameters for a SQL-based Kinesis Data Analytics application.

VpcConfigurations

Type: Array of VpcConfiguration structures

The array of descriptions of VPC configurations available to the application.

ZeppelinApplicationConfiguration

Type: ZeppelinApplicationConfiguration structure

The configuration parameters for a Kinesis Data Analytics Studio notebook.

ApplicationConfigurationDescription

Description

Describes details about the application code and starting parameters for a Kinesis Data Analytics application.

Members

ApplicationCodeConfigurationDescription

Type: ApplicationCodeConfigurationDescription structure

The details about the application code for a Flink-based Kinesis Data Analytics application.

ApplicationSnapshotConfigurationDescription

Type: ApplicationSnapshotConfigurationDescription structure

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

EnvironmentPropertyDescriptions

Type: EnvironmentPropertyDescriptions structure

Describes execution properties for a Flink-based Kinesis Data Analytics application.

FlinkApplicationConfigurationDescription

Type: FlinkApplicationConfigurationDescription structure

The details about a Flink-based Kinesis Data Analytics application.

RunConfigurationDescription

Type: RunConfigurationDescription structure

The details about the starting properties for a Kinesis Data Analytics application.

SqlApplicationConfigurationDescription

Type: SqlApplicationConfigurationDescription structure

The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.

VpcConfigurationDescriptions

Type: Array of VpcConfigurationDescription structures

The array of descriptions of VPC configurations available to the application.

ZeppelinApplicationConfigurationDescription

Type: ZeppelinApplicationConfigurationDescription structure

The configuration parameters for a Kinesis Data Analytics Studio notebook.

ApplicationConfigurationUpdate

Description

Describes updates to an application's configuration.

Members

ApplicationCodeConfigurationUpdate

Type: ApplicationCodeConfigurationUpdate structure

Describes updates to an application's code configuration.

ApplicationSnapshotConfigurationUpdate

Type: ApplicationSnapshotConfigurationUpdate structure

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

EnvironmentPropertyUpdates

Type: EnvironmentPropertyUpdates structure

Describes updates to the environment properties for a Flink-based Kinesis Data Analytics application.

FlinkApplicationConfigurationUpdate

Type: FlinkApplicationConfigurationUpdate structure

Describes updates to a Flink-based Kinesis Data Analytics application's configuration.

SqlApplicationConfigurationUpdate

Type: SqlApplicationConfigurationUpdate structure

Describes updates to a SQL-based Kinesis Data Analytics application's configuration.

VpcConfigurationUpdates

Type: Array of VpcConfigurationUpdate structures

Updates to the array of descriptions of VPC configurations available to the application.

ZeppelinApplicationConfigurationUpdate

Type: ZeppelinApplicationConfigurationUpdate structure

Updates to the configuration of a Kinesis Data Analytics Studio notebook.

ApplicationDetail

Description

Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.

Members

ApplicationARN

Required: Yes
Type: string

The ARN of the application.

ApplicationConfigurationDescription

Type: ApplicationConfigurationDescription structure

Describes details about the application code and starting parameters for a Kinesis Data Analytics application.

ApplicationDescription

Type: string

The description of the application.

ApplicationMaintenanceConfigurationDescription

Type: ApplicationMaintenanceConfigurationDescription structure

The details of the maintenance configuration for the application.

ApplicationMode

Type: string

To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.

ApplicationName

Required: Yes
Type: string

The name of the application.

ApplicationStatus

Required: Yes
Type: string

The status of the application.

ApplicationVersionId

Required: Yes
Type: long (int|float)

Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

ApplicationVersionRolledBackFrom

Type: long (int|float)

If you reverted the application using RollbackApplication, the application version when RollbackApplication was called.

ApplicationVersionRolledBackTo

Type: long (int|float)

The version to which you want to roll back the application.

ApplicationVersionUpdatedFrom

Type: long (int|float)

The previous application version before the latest application update. RollbackApplication reverts the application to this version.

CloudWatchLoggingOptionDescriptions

Type: Array of CloudWatchLoggingOptionDescription structures

Describes the application Amazon CloudWatch logging options.

ConditionalToken

Type: string

A value you use to implement strong concurrency for application updates.

CreateTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The current timestamp when the application was created.

LastUpdateTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The current timestamp when the application was last updated.

RuntimeEnvironment

Required: Yes
Type: string

The runtime environment for the application.

ServiceExecutionRole

Type: string

Specifies the IAM role that the application uses to access external resources.

ApplicationMaintenanceConfigurationDescription

Description

The details of the maintenance configuration for the application.

Members

ApplicationMaintenanceWindowEndTime

Required: Yes
Type: string

The end time for the maintenance window.

ApplicationMaintenanceWindowStartTime

Required: Yes
Type: string

The start time for the maintenance window.

ApplicationMaintenanceConfigurationUpdate

Description

Describes the updated maintenance configuration for the application.

Members

ApplicationMaintenanceWindowStartTimeUpdate

Required: Yes
Type: string

The updated start time for the maintenance window.

ApplicationRestoreConfiguration

Description

Specifies the method and snapshot to use when restarting an application using previously saved application state.

Members

ApplicationRestoreType

Required: Yes
Type: string

Specifies how the application should be restored.

SnapshotName

Type: string

The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.

ApplicationSnapshotConfiguration

Description

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

Members

SnapshotsEnabled

Required: Yes
Type: boolean

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

ApplicationSnapshotConfigurationDescription

Description

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

Members

SnapshotsEnabled

Required: Yes
Type: boolean

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

ApplicationSnapshotConfigurationUpdate

Description

Describes updates to whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

Members

SnapshotsEnabledUpdate

Required: Yes
Type: boolean

Describes updates to whether snapshots are enabled for an application.

ApplicationSummary

Description

Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.

Members

ApplicationARN

Required: Yes
Type: string

The ARN of the application.

ApplicationMode

Type: string

For a Kinesis Data Analytics for Apache Flink application, the mode is STREAMING. For a Kinesis Data Analytics Studio notebook, it is INTERACTIVE.

ApplicationName

Required: Yes
Type: string

The name of the application.

ApplicationStatus

Required: Yes
Type: string

The status of the application.

ApplicationVersionId

Required: Yes
Type: long (int|float)

Provides the current application version.

RuntimeEnvironment

Required: Yes
Type: string

The runtime environment for the application.

ApplicationVersionSummary

Description

The summary of the application version.

Members

ApplicationStatus

Required: Yes
Type: string

The status of the application.

ApplicationVersionId

Required: Yes
Type: long (int|float)

The ID of the application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

CSVMappingParameters

Description

For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the '\n' as the row delimiter and a comma (",") as the column delimiter:

"name1", "address1"

"name2", "address2"

Members

RecordColumnDelimiter

Required: Yes
Type: string

The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

RecordRowDelimiter

Required: Yes
Type: string

The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

CatalogConfiguration

Description

The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.

Members

GlueDataCatalogConfiguration

Required: Yes
Type: GlueDataCatalogConfiguration structure

The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Kinesis Data Analytics Studio notebook.

CatalogConfigurationDescription

Description

Members

GlueDataCatalogConfigurationDescription

Required: Yes
Type: GlueDataCatalogConfigurationDescription structure

The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.

CatalogConfigurationUpdate

Description

Updates to the configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.

Members

GlueDataCatalogConfigurationUpdate

Required: Yes
Type: GlueDataCatalogConfigurationUpdate structure

Updates to the configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.

CheckpointConfiguration

Description

Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.

Members

CheckpointInterval

Type: long (int|float)

Describes the interval in milliseconds between checkpoint operations.

If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.

CheckpointingEnabled

Type: boolean

Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.

If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.

ConfigurationType

Required: Yes
Type: string

Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.

If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:

CheckpointingEnabled: true
CheckpointInterval: 60000
MinPauseBetweenCheckpoints: 5000

MinPauseBetweenCheckpoints

Type: long (int|float)

Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.

If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.

CheckpointConfigurationDescription

Description

Describes checkpointing parameters for a Flink-based Kinesis Data Analytics application.

Members

CheckpointInterval

Type: long (int|float)

Describes the interval in milliseconds between checkpoint operations.

CheckpointingEnabled

Type: boolean

Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.

ConfigurationType

Type: string

Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics.

If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:

CheckpointingEnabled: true
CheckpointInterval: 60000
MinPauseBetweenCheckpoints: 5000

MinPauseBetweenCheckpoints

Type: long (int|float)

Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.

If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.

CheckpointConfigurationUpdate

Description

Describes updates to the checkpointing parameters for a Flink-based Kinesis Data Analytics application.

Members

CheckpointIntervalUpdate

Type: long (int|float)

Describes updates to the interval in milliseconds between checkpoint operations.

CheckpointingEnabledUpdate

Type: boolean

Describes updates to whether checkpointing is enabled for an application.

ConfigurationTypeUpdate

Type: string

Describes updates to whether the application uses the default checkpointing behavior of Kinesis Data Analytics. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.

If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:

CheckpointingEnabled: true
CheckpointInterval: 60000
MinPauseBetweenCheckpoints: 5000

MinPauseBetweenCheckpointsUpdate

Type: long (int|float)

Describes updates to the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.

If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.

CloudWatchLoggingOption

Description

Provides a description of Amazon CloudWatch logging options, including the log stream Amazon Resource Name (ARN).

Members

LogStreamARN

Required: Yes
Type: string

The ARN of the CloudWatch log to receive application messages.

CloudWatchLoggingOptionDescription

Description

Describes the Amazon CloudWatch logging option.

Members

CloudWatchLoggingOptionId

Type: string

The ID of the CloudWatch logging option description.

LogStreamARN

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.

RoleARN

Type: string

The IAM ARN of the role to use to send application messages.

Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.

CloudWatchLoggingOptionUpdate

Description

Describes the Amazon CloudWatch logging option updates.

Members

CloudWatchLoggingOptionId

Required: Yes
Type: string

The ID of the CloudWatch logging option to update

LogStreamARNUpdate

Type: string

The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.

CodeContent

Description

Specifies either the application code, or the location of the application code, for a Flink-based Kinesis Data Analytics application.

Members

S3ContentLocation

Type: S3ContentLocation structure

Information about the Amazon S3 bucket that contains the application code.

TextContent

Type: string

The text-format code for a Flink-based Kinesis Data Analytics application.

ZipFileContent

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The zip-format code for a Flink-based Kinesis Data Analytics application.

CodeContentDescription

Description

Describes details about the code of a Kinesis Data Analytics application.

Members

CodeMD5

Type: string

The checksum that can be used to validate zip-format code.

CodeSize

Type: long (int|float)

The size in bytes of the application code. Can be used to validate zip-format code.

S3ApplicationCodeLocationDescription

Type: S3ApplicationCodeLocationDescription structure

The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.

TextContent

Type: string

The text-format code

CodeContentUpdate

Description

Describes an update to the code of an application. Not supported for Apache Zeppelin.

Members

S3ContentLocationUpdate

Type: S3ContentLocationUpdate structure

Describes an update to the location of code for an application.

TextContentUpdate

Type: string

Describes an update to the text code for an application.

ZipFileContentUpdate

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Required: Yes
Type: string

UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.

MavenReference

Type: MavenReference structure

The parameters required to fully specify a Maven reference.

S3ContentLocation

Type: S3ContentLocation structure

For a Kinesis Data Analytics application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.

CustomArtifactConfigurationDescription

Description

Specifies a dependency JAR or a JAR of user-defined functions.

Members

ArtifactType

Type: string

UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.

MavenReferenceDescription

Type: MavenReference structure

The parameters that are required to specify a Maven dependency.

S3ContentLocationDescription

Type: S3ContentLocation structure

DeployAsApplicationConfiguration

Description

The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.

Members

S3ContentLocation

Required: Yes
Type: S3ContentBaseLocation structure

The description of an Amazon S3 object that contains the Amazon Data Analytics application, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.

DeployAsApplicationConfigurationDescription

Description

The configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.

Members

S3ContentLocationDescription

Required: Yes
Type: S3ContentBaseLocationDescription structure

The location that holds the data required to specify an Amazon Data Analytics application.

DeployAsApplicationConfigurationUpdate

Description

Updates to the configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.

Members

S3ContentLocationUpdate

Type: S3ContentBaseLocationUpdate structure

Updates to the location that holds the data required to specify an Amazon Data Analytics application.

DestinationSchema

Description

Describes the data format when records are written to the destination in a SQL-based Kinesis Data Analytics application.

Members

RecordFormatType

Required: Yes
Type: string

Specifies the format of the records on the output stream.

EnvironmentProperties

Description

Describes execution properties for a Flink-based Kinesis Data Analytics application.

Members

PropertyGroups

Required: Yes
Type: Array of PropertyGroup structures

Describes the execution property groups.

EnvironmentPropertyDescriptions

Description

Describes the execution properties for an Apache Flink runtime.

Members

PropertyGroupDescriptions

Type: Array of PropertyGroup structures

Describes the execution property groups.

EnvironmentPropertyUpdates

Description

Describes updates to the execution property groups for a Flink-based Kinesis Data Analytics application or a Studio notebook.

Members

PropertyGroups

Required: Yes
Type: Array of PropertyGroup structures

Describes updates to the execution property groups.

FlinkApplicationConfiguration

Description

Describes configuration parameters for a Flink-based Kinesis Data Analytics application or a Studio notebook.

Members

CheckpointConfiguration

Type: CheckpointConfiguration structure

MonitoringConfiguration

Type: MonitoringConfiguration structure

Describes configuration parameters for Amazon CloudWatch logging for an application.

ParallelismConfiguration

Type: ParallelismConfiguration structure

Describes parameters for how an application executes multiple tasks simultaneously.

FlinkApplicationConfigurationDescription

Description

Describes configuration parameters for a Flink-based Kinesis Data Analytics application.

Members

CheckpointConfigurationDescription

Type: CheckpointConfigurationDescription structure

Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.

JobPlanDescription

Type: string

The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.

MonitoringConfigurationDescription

Type: MonitoringConfigurationDescription structure

Describes configuration parameters for Amazon CloudWatch logging for an application.

ParallelismConfigurationDescription

Type: ParallelismConfigurationDescription structure

Describes parameters for how an application executes multiple tasks simultaneously.

FlinkApplicationConfigurationUpdate

Description

Describes updates to the configuration parameters for a Flink-based Kinesis Data Analytics application.

Members

CheckpointConfigurationUpdate

Type: CheckpointConfigurationUpdate structure

Describes updates to an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.

MonitoringConfigurationUpdate

Type: MonitoringConfigurationUpdate structure

Describes updates to the configuration parameters for Amazon CloudWatch logging for an application.

ParallelismConfigurationUpdate

Type: ParallelismConfigurationUpdate structure

Describes updates to the parameters for how an application executes multiple tasks simultaneously.

FlinkRunConfiguration

Description

Describes the starting parameters for a Flink-based Kinesis Data Analytics application.

Members

AllowNonRestoredState

Type: boolean

Type: InputParallelism structure

Describes the number of in-application streams to create.

InputProcessingConfiguration

Type: InputProcessingConfiguration structure

The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor.

InputSchema

Required: Yes
Type: SourceSchema structure

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

Also used to describe the format of the reference data source.

KinesisFirehoseInput

Type: KinesisFirehoseInput structure

If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN.

KinesisStreamsInput

Type: KinesisStreamsInput structure

If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN).

NamePrefix

Required: Yes
Type: string

The name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on.

InputDescription

Description

Describes the application input configuration for a SQL-based Kinesis Data Analytics application.

Members

InAppStreamNames

Type: Array of strings

Returns the in-application stream names that are mapped to the stream source.

InputId

Type: string

The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.

InputParallelism

Type: InputParallelism structure

Describes the configured parallelism (number of in-application streams mapped to the streaming source).

InputProcessingConfigurationDescription

Type: InputProcessingConfigurationDescription structure

The description of the preprocessor that executes on records in this input before the application's code is run.

InputSchema

Type: SourceSchema structure

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

InputStartingPositionConfiguration

Type: InputStartingPositionConfiguration structure

The point at which the application is configured to read from the input stream.

KinesisFirehoseInputDescription

Type: KinesisFirehoseInputDescription structure

If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.

KinesisStreamsInputDescription

Type: KinesisStreamsInputDescription structure

If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).

NamePrefix

Type: string

The in-application name prefix.

InputLambdaProcessor

Description

An object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is used to preprocess records in the stream in a SQL-based Kinesis Data Analytics application.

Members

ResourceARN

Required: Yes
Type: string

The ARN of the Amazon Lambda function that operates on records in the stream.

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda

InputLambdaProcessorDescription

Description

For a SQL-based Kinesis Data Analytics application, an object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is used to preprocess records in the stream.

Members

ResourceARN

Required: Yes
Type: string

The ARN of the Amazon Lambda function that is used to preprocess the records in the stream.

RoleARN

Type: string

Type: Array of RecordColumn structures

A list of RecordColumn objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream.

RecordEncodingUpdate

Type: string

Specifies the encoding of the records in the streaming source; for example, UTF-8.

RecordFormatUpdate

Type: RecordFormat structure

Specifies the format of the records on the streaming source.

InputStartingPositionConfiguration

Description

Describes the point at which the application reads from the streaming source.

Members

InputStartingPosition

Type: string

The starting position on the stream.

NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued.
TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.
LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.

InputUpdate

Description

For a SQL-based Kinesis Data Analytics application, describes updates to a specific input configuration (identified by the InputId of an application).

Members

InputId

Required: Yes
Type: string

The input ID of the application input to be updated.

InputParallelismUpdate

Type: InputParallelismUpdate structure

Describes the parallelism updates (the number of in-application streams Kinesis Data Analytics creates for the specific streaming source).

InputProcessingConfigurationUpdate

Type: InputProcessingConfigurationUpdate structure

Describes updates to an InputProcessingConfiguration.

InputSchemaUpdate

Type: InputSchemaUpdate structure

Describes the data format on the streaming source, and how record elements on the streaming source map to columns of the in-application stream that is created.

KinesisFirehoseInputUpdate

Type: KinesisFirehoseInputUpdate structure

If a Kinesis Data Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN.

KinesisStreamsInputUpdate

Type: KinesisStreamsInputUpdate structure

If a Kinesis data stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN).

NamePrefixUpdate

Type: string

Required: Yes
Type: string

The path to the top-level parent that contains the records.

KinesisFirehoseInput

Description

For a SQL-based Kinesis Data Analytics application, identifies a Kinesis Data Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN).

Members

ResourceARN

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the delivery stream.

KinesisFirehoseInputDescription

Description

Describes the Amazon Kinesis Data Firehose delivery stream that is configured as the streaming source in the application input configuration.

Members

ResourceARN

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the delivery stream.

RoleARN

Type: string

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the delivery stream.

RoleARN

Type: string

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Kinesis data stream.

RoleARN

Type: string

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Kinesis data stream.

RoleARN

Type: string

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the destination Lambda function.

RoleARN

Type: string

The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.

Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.

LambdaOutputUpdate

Description

When you update an SQL-based Kinesis Data Analytics application's output configuration using the UpdateApplication operation, provides information about an Amazon Lambda function that is configured as the destination.

Members

ResourceARNUpdate

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the destination Amazon Lambda function.

LimitExceededException

Description

The number of allowed resources has been exceeded.

Members

Message

Type: string

MappingParameters

Description

When you configure a SQL-based Kinesis Data Analytics application's input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

Members

CSVMappingParameters

Type: CSVMappingParameters structure

Provides additional mapping information when the record format uses delimiters (for example, CSV).

JSONMappingParameters

Type: JSONMappingParameters structure

Provides additional mapping information when JSON is the record format on the streaming source.

MavenReference

Description

The information required to specify a Maven reference. You can use Maven references to specify dependency JAR files.

Members

ArtifactId

Required: Yes
Type: string

The artifact ID of the Maven reference.

GroupId

Required: Yes
Type: string

The group ID of the Maven reference.

Version

Required: Yes
Type: string

The version of the Maven reference.

MonitoringConfiguration

Description

Describes configuration parameters for Amazon CloudWatch logging for an application. For more information about CloudWatch logging, see Monitoring.

Members

ConfigurationType

Required: Yes
Type: string

Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.

LogLevel

Type: string

Describes the verbosity of the CloudWatch Logs for an application.

MetricsLevel

Type: string

Describes the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs.

MonitoringConfigurationDescription

Description

Describes configuration parameters for CloudWatch logging for an application.

Members

ConfigurationType

Type: string

Describes whether to use the default CloudWatch logging configuration for an application.

LogLevel

Type: string

Describes the verbosity of the CloudWatch Logs for an application.

MetricsLevel

Type: string

Describes the granularity of the CloudWatch Logs for an application.

MonitoringConfigurationUpdate

Description

Describes updates to configuration parameters for Amazon CloudWatch logging for an application.

Members

ConfigurationTypeUpdate

Type: string

Describes updates to whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.

LogLevelUpdate

Type: string

Describes updates to the verbosity of the CloudWatch Logs for an application.

MetricsLevelUpdate

Type: string

Describes updates to the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs.

Output

Description

Describes a SQL-based Kinesis Data Analytics application's output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.

Members

DestinationSchema

Required: Yes
Type: DestinationSchema structure

Describes the data format when records are written to the destination.

KinesisFirehoseOutput

Type: KinesisFirehoseOutput structure

Identifies a Kinesis Data Firehose delivery stream as the destination.

KinesisStreamsOutput

Type: KinesisStreamsOutput structure

Identifies a Kinesis data stream as the destination.

LambdaOutput

Type: LambdaOutput structure

Identifies an Amazon Lambda function as the destination.

Name

Required: Yes
Type: string

The name of the in-application stream.

OutputDescription

Description

For a SQL-based Kinesis Data Analytics application, describes the application output configuration, which includes the in-application stream name and the destination where the stream data is written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.

Members

DestinationSchema

Type: DestinationSchema structure

The data format used for writing data to the destination.

KinesisFirehoseOutputDescription

Type: KinesisFirehoseOutputDescription structure

Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.

KinesisStreamsOutputDescription

Type: KinesisStreamsOutputDescription structure

Describes the Kinesis data stream that is configured as the destination where output is written.

LambdaOutputDescription

Type: LambdaOutputDescription structure

Describes the Lambda function that is configured as the destination where output is written.

Name

Type: string

The name of the in-application stream that is configured as output.

OutputId

Type: string

A unique identifier for the output configuration.

OutputUpdate

Description

For a SQL-based Kinesis Data Analytics application, describes updates to the output configuration identified by the OutputId.

Members

DestinationSchemaUpdate

Type: DestinationSchema structure

Describes the data format when records are written to the destination.

KinesisFirehoseOutputUpdate

Type: KinesisFirehoseOutputUpdate structure

Describes a Kinesis Data Firehose delivery stream as the destination for the output.

KinesisStreamsOutputUpdate

Type: KinesisStreamsOutputUpdate structure

Describes a Kinesis data stream as the destination for the output.

LambdaOutputUpdate

Type: LambdaOutputUpdate structure

Describes an Amazon Lambda function as the destination for the output.

NameUpdate

Type: string

If you want to specify a different in-application stream for this output configuration, use this field to specify the new in-application stream name.

OutputId

Required: Yes
Type: string

Identifies the specific output configuration that you want to update.

ParallelismConfiguration

Description

Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution in the Apache Flink Documentation.

Members

AutoScalingEnabled

Type: boolean

Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

ConfigurationType

Required: Yes
Type: string

Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.

Parallelism

Type: int

Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics increases the CurrentParallelism value in response to application load. The service can increase the CurrentParallelism value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

ParallelismPerKPU

Type: int

Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing.

ParallelismConfigurationDescription

Description

Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously.

Members

AutoScalingEnabled

Type: boolean

Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

ConfigurationType

Type: string

Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.

CurrentParallelism

Type: int

Describes the current number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

Parallelism

Type: int

Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

ParallelismPerKPU

Type: int

Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application.

ParallelismConfigurationUpdate

Description

Describes updates to parameters for how an application executes multiple tasks simultaneously.

Members

AutoScalingEnabledUpdate

Type: boolean

Describes updates to whether the Kinesis Data Analytics service can increase the parallelism of a Flink-based Kinesis Data Analytics application in response to increased throughput.

ConfigurationTypeUpdate

Type: string

Describes updates to whether the application uses the default parallelism for the Kinesis Data Analytics service, or if a custom parallelism is used. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.

ParallelismPerKPUUpdate

Type: int

Describes updates to the number of parallel tasks an application can perform per Kinesis Processing Unit (KPU) used by the application.

ParallelismUpdate

Type: int

Describes updates to the initial number of parallel tasks an application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service will reduce CurrentParallelism down to the Parallelism setting.

PropertyGroup

Description

Property key-value pairs passed into an application.

Members

PropertyGroupId

Required: Yes
Type: string

Describes the key of an application execution property key-value pair.

PropertyMap

Required: Yes
Type: Associative array of custom strings keys (PropertyKey) to strings

Describes the value of an application execution property key-value pair.

RecordColumn

Description

For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.

Also used to describe the format of the reference data source.

Members

Mapping

Type: string

A reference to the data element in the streaming input or the reference data source.

Name

Required: Yes
Type: string

The name of the column that is created in the in-application input stream or reference table.

SqlType

Required: Yes
Type: string

The type of column created in the in-application input stream or reference table.

RecordFormat

Description

For a SQL-based Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream.

Members

MappingParameters

Type: MappingParameters structure

When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

RecordFormatType

Required: Yes
Type: string

The type of record format.

ReferenceDataSource

Description

For a SQL-based Kinesis Data Analytics application, describes the reference data source by providing the source information (Amazon S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.

Members

ReferenceSchema

Required: Yes
Type: SourceSchema structure

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

S3ReferenceDataSource

Type: S3ReferenceDataSource structure

Identifies the S3 bucket and object that contains the reference data. A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

TableName

Required: Yes
Type: string

The name of the in-application table to create.

ReferenceDataSourceDescription

Description

For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.

Members

ReferenceId

Required: Yes
Type: string

The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.

ReferenceSchema

Type: SourceSchema structure

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

S3ReferenceDataSourceDescription

Required: Yes
Type: S3ReferenceDataSourceDescription structure

Provides the Amazon S3 bucket name, the object key name that contains the reference data.

TableName

Required: Yes
Type: string

The in-application table name created by the specific reference data source configuration.

ReferenceDataSourceUpdate

Description

When you update a reference data source configuration for a SQL-based Kinesis Data Analytics application, this object provides all the updated values (such as the source bucket name and object key name), the in-application table name that is created, and updated mapping information that maps the data in the Amazon S3 object to the in-application reference table that is created.

Members

ReferenceId

Required: Yes
Type: string

The ID of the reference data source that is being updated. You can use the DescribeApplication operation to get this value.

ReferenceSchemaUpdate

Type: SourceSchema structure

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

S3ReferenceDataSourceUpdate

Type: S3ReferenceDataSourceUpdate structure

Describes the S3 bucket name, object key name, and IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.

TableNameUpdate

Type: string

Type: ApplicationRestoreConfiguration structure

Describes the restore behavior of a restarting application.

FlinkRunConfiguration

Type: FlinkRunConfiguration structure

Describes the starting parameters for a Flink-based Kinesis Data Analytics application.

SqlRunConfigurations

Type: Array of SqlRunConfiguration structures

Describes the starting parameters for a SQL-based Kinesis Data Analytics application application.

RunConfigurationDescription

Description

Describes the starting properties for a Kinesis Data Analytics application.

Members

ApplicationRestoreConfigurationDescription

Type: ApplicationRestoreConfiguration structure

Describes the restore behavior of a restarting application.

FlinkRunConfigurationDescription

Type: FlinkRunConfiguration structure

Describes the starting parameters for a Flink-based Kinesis Data Analytics application.

RunConfigurationUpdate

Description

Describes the updates to the starting parameters for a Kinesis Data Analytics application.

Members

ApplicationRestoreConfiguration

Type: ApplicationRestoreConfiguration structure

Describes updates to the restore behavior of a restarting application.

FlinkRunConfiguration

Type: FlinkRunConfiguration structure

Describes the starting parameters for a Flink-based Kinesis Data Analytics application.

S3ApplicationCodeLocationDescription

Description

Describes the location of an application's code stored in an S3 bucket.

Members

BucketARN

Required: Yes
Type: string

The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

FileKey

Required: Yes
Type: string

The file key for the object containing the application code.

ObjectVersion

Type: string

The version of the object containing the application code.

S3Configuration

Description

For a SQL-based Kinesis Data Analytics application, provides a description of an Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 bucket and the name of the Amazon S3 object that contains the data.

Members

BucketARN

Required: Yes
Type: string

The ARN of the S3 bucket that contains the data.

FileKey

Required: Yes
Type: string

The name of the object that contains the data.

S3ContentBaseLocation

Description

The S3 bucket that holds the application information.

Members

BasePath

Type: string

The base path for the S3 bucket.

BucketARN

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the S3 bucket.

S3ContentBaseLocationDescription

Description

The description of the S3 base location that holds the application.

Members

BasePath

Type: string

The base path for the S3 bucket.

BucketARN

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the S3 bucket.

S3ContentBaseLocationUpdate

Description

The information required to update the S3 base location that holds the application.

Members

BasePathUpdate

Type: string

The updated S3 bucket path.

BucketARNUpdate

Type: string

The updated Amazon Resource Name (ARN) of the S3 bucket.

S3ContentLocation

Description

Members

BucketARN

Required: Yes
Type: string

The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

FileKey

Required: Yes
Type: string

The file key for the object containing the application code.

ObjectVersion

Type: string

The version of the object containing the application code.

S3ContentLocationUpdate

Description

Describes an update for the Amazon S3 code content location for an application.

Members

BucketARNUpdate

Type: string

The new Amazon Resource Name (ARN) for the S3 bucket containing the application code.

FileKeyUpdate

Type: string

The new file key for the object containing the application code.

ObjectVersionUpdate

Type: string

The new version of the object containing the application code.

S3ReferenceDataSource

Description

For a SQL-based Kinesis Data Analytics application, identifies the Amazon S3 bucket and object that contains the reference data.

A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

Members

BucketARN

Type: string

The Amazon Resource Name (ARN) of the S3 bucket.

FileKey

Type: string

The object key name containing the reference data.

S3ReferenceDataSourceDescription

Description

For a SQL-based Kinesis Data Analytics application, provides the bucket name and object key name that stores the reference data.

Members

BucketARN

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the S3 bucket.

FileKey

Required: Yes
Type: string

Amazon S3 object key name.

ReferenceRoleARN

Type: string

The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.

Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.

S3ReferenceDataSourceUpdate

Description

For a SQL-based Kinesis Data Analytics application, describes the Amazon S3 bucket name and object key name for an in-application reference table.

Members

BucketARNUpdate

Type: string

The Amazon Resource Name (ARN) of the S3 bucket.

FileKeyUpdate

Type: string

The object key name.

ServiceUnavailableException

Description

The service cannot complete the request.

Members

Message

Type: string

SnapshotDetails

Description

Provides details about a snapshot of application state.

Members

ApplicationVersionId

Required: Yes
Type: long (int|float)

The current application version ID when the snapshot was created.

SnapshotCreationTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the application snapshot.

SnapshotName

Required: Yes
Type: string

The identifier for the application snapshot.

SnapshotStatus

Required: Yes
Type: string

The status of the application snapshot.

SourceSchema

Description

For a SQL-based Kinesis Data Analytics application, describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

Members

RecordColumns

Required: Yes
Type: Array of RecordColumn structures

A list of RecordColumn objects.

RecordEncoding

Type: string

Specifies the encoding of the records in the streaming source. For example, UTF-8.

RecordFormat

Required: Yes
Type: RecordFormat structure

Specifies the format of the records on the streaming source.

SqlApplicationConfiguration

Description

Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.

Members

Inputs

Type: Array of Input structures

The array of Input objects describing the input streams used by the application.

Outputs

Type: Array of Output structures

The array of Output objects describing the destination streams used by the application.

ReferenceDataSources

Type: Array of ReferenceDataSource structures

The array of ReferenceDataSource objects describing the reference data sources used by the application.

SqlApplicationConfigurationDescription

Description

Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.

Members

InputDescriptions

Type: Array of InputDescription structures

The array of InputDescription objects describing the input streams used by the application.

OutputDescriptions

Type: Array of OutputDescription structures

The array of OutputDescription objects describing the destination streams used by the application.

ReferenceDataSourceDescriptions

Type: Array of ReferenceDataSourceDescription structures

The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.

SqlApplicationConfigurationUpdate

Description

Describes updates to the input streams, destination streams, and reference data sources for a SQL-based Kinesis Data Analytics application.

Members

InputUpdates

Type: Array of InputUpdate structures

The array of InputUpdate objects describing the new input streams used by the application.

OutputUpdates

Type: Array of OutputUpdate structures

The array of OutputUpdate objects describing the new destination streams used by the application.

ReferenceDataSourceUpdates

Type: Array of ReferenceDataSourceUpdate structures

The array of ReferenceDataSourceUpdate objects describing the new reference data sources used by the application.

SqlRunConfiguration

Description

Describes the starting parameters for a SQL-based Kinesis Data Analytics application.

Members

InputId

Required: Yes
Type: string

The input source ID. You can get this ID by calling the DescribeApplication operation.

InputStartingPositionConfiguration

Required: Yes
Type: InputStartingPositionConfiguration structure

The point at which you want the application to start processing records from the streaming source.

Tag

Description

A key-value pair (the value is optional) that you can define and assign to Amazon resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.

Members

Key

Required: Yes
Type: string

The key of the key-value tag.

Value

Type: string

The value of the key-value tag. The value is optional.

TooManyTagsException

Description

Application created with too many tags, or too many tags added to an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.

Members

message

Type: string

UnableToDetectSchemaException

Description

The data format is not valid. Kinesis Data Analytics cannot detect the schema for the given streaming source.

Members

Message

Type: string

ProcessedInputRecords

Type: Array of strings

Stream data that was modified by the processor specified in the InputProcessingConfiguration parameter.

RawInputRecords

Type: Array of strings

Raw stream data that was sampled to infer the schema.

UnsupportedOperationException

Description

The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

Members

Message

Type: string

VpcConfiguration

Description

Describes the parameters of a VPC used by the application.

Members

SecurityGroupIds

Required: Yes
Type: Array of strings

The array of SecurityGroup IDs used by the VPC configuration.

SubnetIds

Required: Yes
Type: Array of strings

The array of Subnet IDs used by the VPC configuration.

VpcConfigurationDescription

Description

Describes the parameters of a VPC used by the application.

Members

SecurityGroupIds

Required: Yes
Type: Array of strings

The array of SecurityGroup IDs used by the VPC configuration.

SubnetIds

Required: Yes
Type: Array of strings

The array of Subnet IDs used by the VPC configuration.

VpcConfigurationId

Required: Yes
Type: string

The ID of the VPC configuration.

VpcId

Required: Yes
Type: string

The ID of the associated VPC.

VpcConfigurationUpdate

Description

Describes updates to the VPC configuration used by the application.

Members

SecurityGroupIdUpdates

Type: Array of strings

Describes updates to the array of SecurityGroup IDs used by the VPC configuration.

SubnetIdUpdates

Type: Array of strings

Describes updates to the array of Subnet IDs used by the VPC configuration.

VpcConfigurationId

Required: Yes
Type: string

Describes an update to the ID of the VPC configuration.

ZeppelinApplicationConfiguration

Description

The configuration of a Kinesis Data Analytics Studio notebook.

Members

CatalogConfiguration

Type: CatalogConfiguration structure

The Amazon Glue Data Catalog that you use in queries in a Kinesis Data Analytics Studio notebook.

CustomArtifactsConfiguration

Type: Array of CustomArtifactConfiguration structures

Custom artifacts are dependency JARs and user-defined functions (UDF).

DeployAsApplicationConfiguration

Type: DeployAsApplicationConfiguration structure

The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.

MonitoringConfiguration

Type: ZeppelinMonitoringConfiguration structure

The monitoring configuration of a Kinesis Data Analytics Studio notebook.

ZeppelinApplicationConfigurationDescription

Description

The configuration of a Kinesis Data Analytics Studio notebook.

Members

CatalogConfigurationDescription

Type: CatalogConfigurationDescription structure

The Amazon Glue Data Catalog that is associated with the Kinesis Data Analytics Studio notebook.

CustomArtifactsConfigurationDescription

Type: Array of CustomArtifactConfigurationDescription structures

Custom artifacts are dependency JARs and user-defined functions (UDF).

DeployAsApplicationConfigurationDescription

Type: DeployAsApplicationConfigurationDescription structure

The parameters required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.

MonitoringConfigurationDescription

Required: Yes
Type: ZeppelinMonitoringConfigurationDescription structure

The monitoring configuration of a Kinesis Data Analytics Studio notebook.

ZeppelinApplicationConfigurationUpdate

Description

Updates to the configuration of Kinesis Data Analytics Studio notebook.

Members

CatalogConfigurationUpdate

Type: CatalogConfigurationUpdate structure

Updates to the configuration of the Amazon Glue Data Catalog that is associated with the Kinesis Data Analytics Studio notebook.

CustomArtifactsConfigurationUpdate

Type: Array of CustomArtifactConfiguration structures

Updates to the customer artifacts. Custom artifacts are dependency JAR files and user-defined functions (UDF).

DeployAsApplicationConfigurationUpdate

Type: DeployAsApplicationConfigurationUpdate structure

Updates to the configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.

MonitoringConfigurationUpdate

Type: ZeppelinMonitoringConfigurationUpdate structure

Updates to the monitoring configuration of a Kinesis Data Analytics Studio notebook.

ZeppelinMonitoringConfiguration

Description

Describes configuration parameters for Amazon CloudWatch logging for a Kinesis Data Analytics Studio notebook. For more information about CloudWatch logging, see Monitoring.

Members

LogLevel

Required: Yes
Type: string

The verbosity of the CloudWatch Logs for an application.

ZeppelinMonitoringConfigurationDescription

Description

The monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.

Members

LogLevel

Type: string

Describes the verbosity of the CloudWatch Logs for an application.

ZeppelinMonitoringConfigurationUpdate

Description

Updates to the monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.

Members

LogLevelUpdate

Required: Yes
Type: string

Updates to the logging level for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Kinesis Analytics 2018-05-23

Operation Summary

Operations

AddApplicationCloudWatchLoggingOption

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AddApplicationInput

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AddApplicationInputProcessingConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AddApplicationOutput

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AddApplicationReferenceDataSource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AddApplicationVpcConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateApplication

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateApplicationPresignedUrl

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateApplicationSnapshot

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors