AWS SDK for PHP 3.x (original) (raw)

Specified application can't be found.

Application is not available for this operation.

Specified input parameter value is invalid.

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

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

AddApplicationInput

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

Adds a streaming source to your Amazon Kinesis application. For conceptual information, see Configuring Application Input.

You can add a streaming source either 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.

This operation requires permissions to perform the kinesisanalytics:AddApplicationInput action.

Parameter Syntax

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

Parameter Details

Members

ApplicationName

Required: Yes

Type: string

Name of your existing Amazon Kinesis Analytics application to which you want to add the streaming source.

CurrentApplicationVersionId

Required: Yes

Type: long (int|float)

Current version of your Amazon Kinesis Analytics application. You can use the DescribeApplication operation to find the current application version.

Input

Required: Yes

Type: Input structure

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

Specified application can't be found.

Application is not available for this operation.

Specified input parameter value is invalid.

CodeValidationException:

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

User-provided application code (query) is invalid. This can be a simple syntax error.

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

AddApplicationInputProcessingConfiguration

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

Adds an InputProcessingConfiguration to an application. An input processor preprocesses records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda.

Parameter Syntax

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

Parameter Details

Members

ApplicationName

Required: Yes

Type: string

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

CurrentApplicationVersionId

Required: Yes

Type: long (int|float)

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

Specified application can't be found.

Application is not available for this operation.

Specified input parameter value is invalid.

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

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

AddApplicationOutput

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

Adds an external destination to your Amazon Kinesis Analytics application.

If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS 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. For more information, see Understanding Application Output (Destination).

For the limits on the number of application inputs and outputs you can configure, see Limits.

This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.

Parameter Syntax

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

Parameter Details

Members

ApplicationName

Required: Yes

Type: string

Name of the application to which you want to add the output configuration.

CurrentApplicationVersionId

Required: Yes

Type: long (int|float)

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, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), and record the formation to use when writing to the destination.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

Specified application can't be found.

Application is not available for this operation.

Specified input parameter value is invalid.

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

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

AddApplicationReferenceDataSource

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

Adds a reference data source to an existing application.

Amazon Kinesis 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 Amazon S3 object maps to columns in the resulting in-application table.

For conceptual information, see Configuring Application Input. For the limits on data sources you can add to your application, see Limits.

This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.

Parameter Syntax

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

Parameter Details

Members

ApplicationName

Required: Yes

Type: string

Name of an existing application.

CurrentApplicationVersionId

Required: Yes

Type: long (int|float)

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. Amazon Kinesis 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. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

Specified application can't be found.

Application is not available for this operation.

Specified input parameter value is invalid.

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

CodeValidationException:

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

CreateApplication

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

Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to three destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see How it Works.

In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source.

Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps.

In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to three destinations.

To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the kinesisanalytics:CreateApplication action.

For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started.

Parameter Syntax

result=result = result=client->createApplication([ 'ApplicationCode' => '', 'ApplicationDescription' => '', 'ApplicationName' => '', // REQUIRED 'CloudWatchLoggingOptions' => [ [ 'LogStreamARN' => '', // REQUIRED 'RoleARN' => '', // REQUIRED ], // ... ], 'Inputs' => [ [ 'InputParallelism' => [ 'Count' => , ], 'InputProcessingConfiguration' => [ 'InputLambdaProcessor' => [ // REQUIRED 'ResourceARN' => '', // REQUIRED 'RoleARN' => '', // REQUIRED ], ], 'InputSchema' => [ // REQUIRED 'RecordColumns' => [ // REQUIRED [ 'Mapping' => '', 'Name' => '', // REQUIRED 'SqlType' => '', // REQUIRED ], // ... ], 'RecordEncoding' => '', 'RecordFormat' => [ // REQUIRED 'MappingParameters' => [ 'CSVMappingParameters' => [ 'RecordColumnDelimiter' => '', // REQUIRED 'RecordRowDelimiter' => '', // REQUIRED ], 'JSONMappingParameters' => [ 'RecordRowPath' => '', // REQUIRED ], ], 'RecordFormatType' => 'JSON|CSV', // REQUIRED ], ], 'KinesisFirehoseInput' => [ 'ResourceARN' => '', // REQUIRED 'RoleARN' => '', // REQUIRED ], 'KinesisStreamsInput' => [ 'ResourceARN' => '', // REQUIRED 'RoleARN' => '', // REQUIRED ], 'NamePrefix' => '', // REQUIRED ], // ... ], 'Outputs' => [ [ 'DestinationSchema' => [ // REQUIRED 'RecordFormatType' => 'JSON|CSV', // REQUIRED ], 'KinesisFirehoseOutput' => [ 'ResourceARN' => '', // REQUIRED 'RoleARN' => '', // REQUIRED ], 'KinesisStreamsOutput' => [ 'ResourceARN' => '', // REQUIRED 'RoleARN' => '', // REQUIRED ], 'LambdaOutput' => [ 'ResourceARN' => '', // REQUIRED 'RoleARN' => '', // REQUIRED ], 'Name' => '', // REQUIRED ], // ... ], 'Tags' => [ [ 'Key' => '', // REQUIRED 'Value' => '', ], // ... ], ]);

Parameter Details

Members

ApplicationCode

One or more SQL statements that read input data, transform it, and generate output. For example, you can write a SQL statement that reads data from one in-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more information about the typical pattern, see Application Code.

You can provide such series of SQL statements, where output of one statement can be used as the input for the next statement. You store intermediate results by creating in-application streams and pumps.

Note that the application code must create the streams with names specified in the Outputs. For example, if your Outputs defines output streams named ExampleOutputStream1 and ExampleOutputStream2, then your application code must create these streams.

ApplicationDescription

Summary description of the application.

ApplicationName

Required: Yes

Type: string

Name of your Amazon Kinesis Analytics application (for example, sample-app).

CloudWatchLoggingOptions

Type: Array of CloudWatchLoggingOption structures

Use this parameter to configure a CloudWatch log stream to monitor application configuration errors. For more information, see Working with Amazon CloudWatch Logs.

Inputs

Type: Array of Input structures

Use this parameter to configure the application input.

You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table).

For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc.). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf.

To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.

Outputs

Type: Array of Output structures

You can configure application output to write data from any of the in-application streams to up to three destinations.

These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, AWS Lambda destinations, or any combination of the three.

In the configuration, you specify the in-application stream name, the destination stream or Lambda function Amazon Resource Name (ARN), and the format to use when writing data. You must also provide an IAM role that Amazon Kinesis Analytics can assume to write to the destination stream or Lambda function on your behalf.

In the output configuration, you also provide the output stream or Lambda function ARN. For stream destinations, you provide the format of data in the stream (for example, JSON, CSV). You also must provide an IAM role that Amazon Kinesis Analytics can assume to write to the stream or Lambda function on your behalf.

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

Result Details

Members

ApplicationSummary

Required: Yes

Type: ApplicationSummary structure

In response to your CreateApplication request, Amazon Kinesis Analytics returns a response with a summary of the application it created, including the application Amazon Resource Name (ARN), name, and status.

Errors

User-provided application code (query) is invalid. This can be a simple syntax error.

LimitExceededException:

Application is not available for this operation.

Exceeded the number of applications allowed.

TooManyTagsException:

Specified input parameter value is invalid.

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.

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

DeleteApplication

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

Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the application, including any application artifacts (such as in-application streams, reference table, and application code).

This operation requires permissions to perform the kinesisanalytics:DeleteApplication action.

Parameter Syntax

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

Parameter Details

Members

ApplicationName

Required: Yes

Type: string

Name of the Amazon Kinesis Analytics application to delete.

CreateTimestamp

Required: Yes

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

You can use the DescribeApplication operation to get this value.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

Specified application can't be found.

Application is not available for this operation.

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

DeleteApplicationCloudWatchLoggingOption

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

Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.

Parameter Syntax

result=result = result=client->deleteApplicationCloudWatchLoggingOption([ 'ApplicationName' => '', // REQUIRED 'CloudWatchLoggingOptionId' => '', // REQUIRED 'CurrentApplicationVersionId' => , // REQUIRED ]);

Parameter Details

Members

ApplicationName

Required: Yes

Type: string

The Kinesis Analytics application name.

CloudWatchLoggingOptionId

Required: Yes

Type: string

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

CurrentApplicationVersionId

Required: Yes

Type: long (int|float)

The version ID of the Kinesis Analytics application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

Specified application can't be found.

Application is not available for this operation.

Specified input parameter value is invalid.

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

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

DeleteApplicationInputProcessingConfiguration

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

Deletes an InputProcessingConfiguration from an input.

Parameter Syntax

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

Parameter Details

Members

ApplicationName

Required: Yes

Type: string

The Kinesis Analytics application name.

CurrentApplicationVersionId

Required: Yes

Type: long (int|float)

The version ID of the Kinesis Analytics application.

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

[]

Result Details

The results for this operation are always empty.

Errors

Specified application can't be found.

Application is not available for this operation.

Specified input parameter value is invalid.

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

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

DeleteApplicationOutput

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

Deletes output destination configuration from your application configuration. Amazon Kinesis Analytics will no longer write data from the corresponding in-application stream to the external output destination.

This operation requires permissions to perform the kinesisanalytics:DeleteApplicationOutput action.

Parameter Syntax

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

Parameter Details

Members

ApplicationName

Required: Yes

Type: string

Amazon Kinesis Analytics application name.

CurrentApplicationVersionId

Required: Yes

Type: long (int|float)

Amazon Kinesis Analytics 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.

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

[]

Result Details

The results for this operation are always empty.

Errors

Specified application can't be found.

Application is not available for this operation.

Specified input parameter value is invalid.

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

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

DeleteApplicationReferenceDataSource

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

Deletes a reference data source configuration from the specified application configuration.

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

This operation requires permissions to perform the kinesisanalytics.DeleteApplicationReferenceDataSource action.

Parameter Syntax

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

Parameter Details

Members

ApplicationName

Required: Yes

Type: string

Name of an existing application.

CurrentApplicationVersionId

Required: Yes

Type: long (int|float)

Version of the application. 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

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

Specified application can't be found.

Application is not available for this operation.

Specified input parameter value is invalid.

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

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

DescribeApplication

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

Returns information about a specific Amazon Kinesis Analytics application.

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

This operation requires permissions to perform the kinesisanalytics:DescribeApplication action. You can use DescribeApplication to get the current application versionId, which you need to call other operations such as Update.

Parameter Syntax

result=result = result=client->describeApplication([ 'ApplicationName' => '', // REQUIRED ]);

Parameter Details

Members

ApplicationName

Required: Yes

Type: string

Name of the application.

Result Syntax

[ 'ApplicationDetail' => [ 'ApplicationARN' => '', 'ApplicationCode' => '', 'ApplicationDescription' => '', 'ApplicationName' => '', 'ApplicationStatus' => 'DELETING|STARTING|STOPPING|READY|RUNNING|UPDATING', 'ApplicationVersionId' => , 'CloudWatchLoggingOptionDescriptions' => [ [ 'CloudWatchLoggingOptionId' => '', 'LogStreamARN' => '', 'RoleARN' => '', ], // ... ], 'CreateTimestamp' => , 'InputDescriptions' => [ [ 'InAppStreamNames' => ['', ...], 'InputId' => '', 'InputParallelism' => [ 'Count' => , ], 'InputProcessingConfigurationDescription' => [ 'InputLambdaProcessorDescription' => [ 'ResourceARN' => '', 'RoleARN' => '', ], ], 'InputSchema' => [ 'RecordColumns' => [ [ 'Mapping' => '', 'Name' => '', 'SqlType' => '', ], // ... ], 'RecordEncoding' => '', 'RecordFormat' => [ 'MappingParameters' => [ 'CSVMappingParameters' => [ 'RecordColumnDelimiter' => '', 'RecordRowDelimiter' => '', ], 'JSONMappingParameters' => [ 'RecordRowPath' => '', ], ], 'RecordFormatType' => 'JSON|CSV', ], ], 'InputStartingPositionConfiguration' => [ 'InputStartingPosition' => 'NOW|TRIM_HORIZON|LAST_STOPPED_POINT', ], 'KinesisFirehoseInputDescription' => [ 'ResourceARN' => '', 'RoleARN' => '', ], 'KinesisStreamsInputDescription' => [ 'ResourceARN' => '', 'RoleARN' => '', ], 'NamePrefix' => '', ], // ... ], 'LastUpdateTimestamp' => , 'OutputDescriptions' => [ [ 'DestinationSchema' => [ 'RecordFormatType' => 'JSON|CSV', ], 'KinesisFirehoseOutputDescription' => [ 'ResourceARN' => '', 'RoleARN' => '', ], 'KinesisStreamsOutputDescription' => [ 'ResourceARN' => '', 'RoleARN' => '', ], 'LambdaOutputDescription' => [ 'ResourceARN' => '', 'RoleARN' => '', ], 'Name' => '', 'OutputId' => '', ], // ... ], 'ReferenceDataSourceDescriptions' => [ [ 'ReferenceId' => '', 'ReferenceSchema' => [ 'RecordColumns' => [ [ 'Mapping' => '', 'Name' => '', 'SqlType' => '', ], // ... ], 'RecordEncoding' => '', 'RecordFormat' => [ 'MappingParameters' => [ 'CSVMappingParameters' => [ 'RecordColumnDelimiter' => '', 'RecordRowDelimiter' => '', ], 'JSONMappingParameters' => [ 'RecordRowPath' => '', ], ], 'RecordFormatType' => 'JSON|CSV', ], ], 'S3ReferenceDataSourceDescription' => [ 'BucketARN' => '', 'FileKey' => '', 'ReferenceRoleARN' => '', ], 'TableName' => '', ], // ... ], ], ]

Result Details

Members

ApplicationDetail

Required: Yes

Type: ApplicationDetail structure

Provides a description of the application, such as the application Amazon Resource Name (ARN), status, latest version, and input and output configuration details.

Errors

Specified application can't be found.

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

DiscoverInputSchema

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

Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream) or 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. For conceptual information, see Configuring Application Input. Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface.

This operation requires permissions to perform the kinesisanalytics:DiscoverInputSchema action.

Parameter Syntax

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

Parameter Details

Members

InputProcessingConfiguration

Type: InputProcessingConfiguration structure

InputStartingPositionConfiguration

Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes.

ResourceARN

Amazon Resource Name (ARN) of the streaming source.

RoleARN

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.

S3Configuration

Type: S3Configuration structure

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

Result Syntax

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

Result Details

Members

InputSchema

Type: SourceSchema structure

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

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

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

RawInputRecords

Raw stream data that was sampled to infer the schema.

Errors

UnableToDetectSchemaException:

Specified input parameter value is invalid.

Data format is not valid. Amazon Kinesis Analytics is not able to detect schema for the given streaming source.

ResourceProvisionedThroughputExceededException:

Discovery failed to get a record from the streaming source because of the Amazon Kinesis Streams ProvisionedThroughputExceededException. For more information, see GetRecords in the Amazon Kinesis Streams API Reference.

ServiceUnavailableException:

The service is unavailable. Back off and retry the operation.

ListApplications

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

Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the HasMoreApplications value as true, you can send another request by adding the ExclusiveStartApplicationName in the request body, and set the value of this to the last application name from the previous response.

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

This operation requires permissions to perform the kinesisanalytics:ListApplications action.

Parameter Syntax

result=result = result=client->listApplications([ 'ExclusiveStartApplicationName' => '', 'Limit' => , ]);

Parameter Details

Members

ExclusiveStartApplicationName

Name of the application to start the list with. When using pagination to retrieve the list, you don't need to specify this parameter in the first request. However, in subsequent requests, you add the last application name from the previous response to get the next page of applications.

Limit

Maximum number of applications to list.

Result Syntax

[ 'ApplicationSummaries' => [ [ 'ApplicationARN' => '', 'ApplicationName' => '', 'ApplicationStatus' => 'DELETING|STARTING|STOPPING|READY|RUNNING|UPDATING', ], // ... ], 'HasMoreApplications' => true || false, ]

Result Details

Members

ApplicationSummaries

Required: Yes

Type: Array of ApplicationSummary structures

List of ApplicationSummary objects.

HasMoreApplications

Required: Yes

Type: boolean

Returns true if there are more applications to retrieve.

Errors

There are no errors described for this operation.

ListTagsForResource

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

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

Parameter Syntax

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

Parameter Details

Members

ResourceARN

Required: Yes

Type: string

The ARN of the application for which to retrieve tags.

Result Syntax

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

Result Details

Members

Tags

Type: Array of Tag structures

The key-value tags assigned to the application.

Errors

Specified application can't be found.

Specified input parameter value is invalid.

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

StartApplication

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

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

After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination.

The application status must be READY for you to start an application. You can get the application status in the console or using the DescribeApplication operation.

After you start the application, you can stop the application from processing the input by calling the StopApplication operation.

This operation requires permissions to perform the kinesisanalytics:StartApplication action.

Parameter Syntax

result=result = result=client->startApplication([ 'ApplicationName' => '', // REQUIRED 'InputConfigurations' => [ // REQUIRED [ 'Id' => '', // REQUIRED 'InputStartingPositionConfiguration' => [ // REQUIRED 'InputStartingPosition' => 'NOW|TRIM_HORIZON|LAST_STOPPED_POINT', ], ], // ... ], ]);

Parameter Details

Members

ApplicationName

Required: Yes

Type: string

Name of the application.

InputConfigurations

Required: Yes

Type: Array of InputConfiguration structures

Identifies the specific input, by ID, that the application starts consuming. Amazon Kinesis Analytics starts reading the streaming source associated with the input. You can also specify where in the streaming source you want Amazon Kinesis Analytics to start reading.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

Specified application can't be found.

Application is not available for this operation.

InvalidApplicationConfigurationException:

Specified input parameter value is invalid.

User-provided application configuration is not valid.

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

StopApplication

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

Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops reading data from the input, the application stops processing data, and there is no output written to the destination.

This operation requires permissions to perform the kinesisanalytics:StopApplication action.

Parameter Syntax

result=result = result=client->stopApplication([ 'ApplicationName' => '', // REQUIRED ]);

Parameter Details

Members

ApplicationName

Required: Yes

Type: string

Name of the running application to stop.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

Specified application can't be found.

Application is not available for this operation.

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

TagResource

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

Adds one or more key-value tags to a Kinesis 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=result = result=client->tagResource([ 'ResourceARN' => '', // REQUIRED 'Tags' => [ // REQUIRED [ 'Key' => '', // REQUIRED 'Value' => '', ], // ... ], ]);

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

Specified application can't be found.

TooManyTagsException:

Application is not available for this operation.

Specified input parameter value is invalid.

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

UntagResource

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

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

Parameter Syntax

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

Parameter Details

Members

ResourceARN

Required: Yes

Type: string

The ARN of the Kinesis 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

Specified application can't be found.

TooManyTagsException:

Application is not available for this operation.

Specified input parameter value is invalid.

CodeValidationException:

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

UpdateApplication

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

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

Note that Amazon Kinesis Analytics updates the CurrentApplicationVersionId each time you update your application.

This operation requires permission for the kinesisanalytics:UpdateApplication action.

Parameter Syntax

result=result = result=client->updateApplication([ 'ApplicationName' => '', // REQUIRED 'ApplicationUpdate' => [ // REQUIRED 'ApplicationCodeUpdate' => '', 'CloudWatchLoggingOptionUpdates' => [ [ 'CloudWatchLoggingOptionId' => '', // REQUIRED 'LogStreamARNUpdate' => '', 'RoleARNUpdate' => '', ], // ... ], 'InputUpdates' => [ [ 'InputId' => '', // REQUIRED 'InputParallelismUpdate' => [ 'CountUpdate' => , ], 'InputProcessingConfigurationUpdate' => [ 'InputLambdaProcessorUpdate' => [ // REQUIRED 'ResourceARNUpdate' => '', 'RoleARNUpdate' => '', ], ], 'InputSchemaUpdate' => [ 'RecordColumnUpdates' => [ [ 'Mapping' => '', 'Name' => '', // REQUIRED 'SqlType' => '', // REQUIRED ], // ... ], 'RecordEncodingUpdate' => '', 'RecordFormatUpdate' => [ 'MappingParameters' => [ 'CSVMappingParameters' => [ 'RecordColumnDelimiter' => '', // REQUIRED 'RecordRowDelimiter' => '', // REQUIRED ], 'JSONMappingParameters' => [ 'RecordRowPath' => '', // REQUIRED ], ], 'RecordFormatType' => 'JSON|CSV', // REQUIRED ], ], 'KinesisFirehoseInputUpdate' => [ 'ResourceARNUpdate' => '', 'RoleARNUpdate' => '', ], 'KinesisStreamsInputUpdate' => [ 'ResourceARNUpdate' => '', 'RoleARNUpdate' => '', ], 'NamePrefixUpdate' => '', ], // ... ], 'OutputUpdates' => [ [ 'DestinationSchemaUpdate' => [ 'RecordFormatType' => 'JSON|CSV', // REQUIRED ], 'KinesisFirehoseOutputUpdate' => [ 'ResourceARNUpdate' => '', 'RoleARNUpdate' => '', ], 'KinesisStreamsOutputUpdate' => [ 'ResourceARNUpdate' => '', 'RoleARNUpdate' => '', ], 'LambdaOutputUpdate' => [ 'ResourceARNUpdate' => '', 'RoleARNUpdate' => '', ], 'NameUpdate' => '', 'OutputId' => '', // REQUIRED ], // ... ], 'ReferenceDataSourceUpdates' => [ [ 'ReferenceId' => '', // REQUIRED 'ReferenceSchemaUpdate' => [ 'RecordColumns' => [ // REQUIRED [ 'Mapping' => '', 'Name' => '', // REQUIRED 'SqlType' => '', // REQUIRED ], // ... ], 'RecordEncoding' => '', 'RecordFormat' => [ // REQUIRED 'MappingParameters' => [ 'CSVMappingParameters' => [ 'RecordColumnDelimiter' => '', // REQUIRED 'RecordRowDelimiter' => '', // REQUIRED ], 'JSONMappingParameters' => [ 'RecordRowPath' => '', // REQUIRED ], ], 'RecordFormatType' => 'JSON|CSV', // REQUIRED ], ], 'S3ReferenceDataSourceUpdate' => [ 'BucketARNUpdate' => '', 'FileKeyUpdate' => '', 'ReferenceRoleARNUpdate' => '', ], 'TableNameUpdate' => '', ], // ... ], ], 'CurrentApplicationVersionId' => , // REQUIRED ]);

Parameter Details

Members

ApplicationName

Required: Yes

Type: string

Name of the Amazon Kinesis Analytics application to update.

ApplicationUpdate

Required: Yes

Type: ApplicationUpdate structure

Describes application updates.

CurrentApplicationVersionId

Required: Yes

Type: long (int|float)

The current application version ID. You can use the DescribeApplication operation to get this value.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

User-provided application code (query) is invalid. This can be a simple syntax error.

Specified application can't be found.

Application is not available for this operation.

Specified input parameter value is invalid.

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.