You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::KinesisAnalytics::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for Amazon Kinesis Analytics. To construct a client, you need to configure a :region and :credentials.

kinesisanalytics = Aws::KinesisAnalytics::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::KinesisAnalytics::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::KinesisAnalytics::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#add_application_cloud_watch_logging_option(options = {}) ⇒ Struct

Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.

Examples:

Request syntax with placeholder values


resp = client.add_application_cloud_watch_logging_option({
  application_name: "ApplicationName", # required
  current_application_version_id: 1, # required
  cloud_watch_logging_option: { # required
    log_stream_arn: "LogStreamARN", # required
    role_arn: "RoleARN", # required
  },
})

Options Hash (options):

  • :application_name (required, String)

    The Kinesis Analytics application name.

  • :current_application_version_id (required, Integer)

    The version ID of the Kinesis Analytics application.

  • :cloud_watch_logging_option (required, Types::CloudWatchLoggingOption)

    Provides the CloudWatch log stream Amazon Resource Name (ARN) and the IAM role ARN. Note: To write application messages to CloudWatch, the IAM role that is used must have the PutLogEvents policy action enabled.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#add_application_input(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.add_application_input({
  application_name: "ApplicationName", # required
  current_application_version_id: 1, # required
  input: { # required
    name_prefix: "InAppStreamName", # required
    input_processing_configuration: {
      input_lambda_processor: { # required
        resource_arn: "ResourceARN", # required
        role_arn: "RoleARN", # required
      },
    },
    kinesis_streams_input: {
      resource_arn: "ResourceARN", # required
      role_arn: "RoleARN", # required
    },
    kinesis_firehose_input: {
      resource_arn: "ResourceARN", # required
      role_arn: "RoleARN", # required
    },
    input_parallelism: {
      count: 1,
    },
    input_schema: { # required
      record_format: { # required
        record_format_type: "JSON", # required, accepts JSON, CSV
        mapping_parameters: {
          json_mapping_parameters: {
            record_row_path: "RecordRowPath", # required
          },
          csv_mapping_parameters: {
            record_row_delimiter: "RecordRowDelimiter", # required
            record_column_delimiter: "RecordColumnDelimiter", # required
          },
        },
      },
      record_encoding: "RecordEncoding",
      record_columns: [ # required
        {
          name: "RecordColumnName", # required
          mapping: "RecordColumnMapping",
          sql_type: "RecordColumnSqlType", # required
        },
      ],
    },
  },
})

Options Hash (options):

  • :application_name (required, String)

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

  • :current_application_version_id (required, Integer)

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

  • :input (required, Types::Input)

    The Input to add.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#add_application_input_processing_configuration(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.add_application_input_processing_configuration({
  application_name: "ApplicationName", # required
  current_application_version_id: 1, # required
  input_id: "Id", # required
  input_processing_configuration: { # required
    input_lambda_processor: { # required
      resource_arn: "ResourceARN", # required
      role_arn: "RoleARN", # required
    },
  },
})

Options Hash (options):

  • :application_name (required, String)

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

  • :current_application_version_id (required, Integer)

    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.

  • :input_id (required, String)

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

  • :input_processing_configuration (required, Types::InputProcessingConfiguration)

    The InputProcessingConfiguration to add to the application.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#add_application_output(options = {}) ⇒ Struct

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 or a Firehose delivery stream), 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 conceptual information, see Understanding Application Output (Destination).

Note that 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.

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.

Examples:

Request syntax with placeholder values


resp = client.add_application_output({
  application_name: "ApplicationName", # required
  current_application_version_id: 1, # required
  output: { # required
    name: "InAppStreamName", # required
    kinesis_streams_output: {
      resource_arn: "ResourceARN", # required
      role_arn: "RoleARN", # required
    },
    kinesis_firehose_output: {
      resource_arn: "ResourceARN", # required
      role_arn: "RoleARN", # required
    },
    destination_schema: { # required
      record_format_type: "JSON", # accepts JSON, CSV
    },
  },
})

Options Hash (options):

  • :application_name (required, String)

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

  • :current_application_version_id (required, Integer)

    Version of the application to which you want 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, Types::Output)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#add_application_reference_data_source(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.add_application_reference_data_source({
  application_name: "ApplicationName", # required
  current_application_version_id: 1, # required
  reference_data_source: { # required
    table_name: "InAppTableName", # required
    s3_reference_data_source: {
      bucket_arn: "BucketARN", # required
      file_key: "FileKey", # required
      reference_role_arn: "RoleARN", # required
    },
    reference_schema: { # required
      record_format: { # required
        record_format_type: "JSON", # required, accepts JSON, CSV
        mapping_parameters: {
          json_mapping_parameters: {
            record_row_path: "RecordRowPath", # required
          },
          csv_mapping_parameters: {
            record_row_delimiter: "RecordRowDelimiter", # required
            record_column_delimiter: "RecordColumnDelimiter", # required
          },
        },
      },
      record_encoding: "RecordEncoding",
      record_columns: [ # required
        {
          name: "RecordColumnName", # required
          mapping: "RecordColumnMapping",
          sql_type: "RecordColumnSqlType", # required
        },
      ],
    },
  },
})

Options Hash (options):

  • :application_name (required, String)

    Name of an existing application.

  • :current_application_version_id (required, Integer)

    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.

  • :reference_data_source (required, Types::ReferenceDataSource)

    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.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#create_application(options = {}) ⇒ Types::CreateApplicationResponse

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 five streaming 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 five streaming 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.

Examples:

Request syntax with placeholder values


resp = client.create_application({
  application_name: "ApplicationName", # required
  application_description: "ApplicationDescription",
  inputs: [
    {
      name_prefix: "InAppStreamName", # required
      input_processing_configuration: {
        input_lambda_processor: { # required
          resource_arn: "ResourceARN", # required
          role_arn: "RoleARN", # required
        },
      },
      kinesis_streams_input: {
        resource_arn: "ResourceARN", # required
        role_arn: "RoleARN", # required
      },
      kinesis_firehose_input: {
        resource_arn: "ResourceARN", # required
        role_arn: "RoleARN", # required
      },
      input_parallelism: {
        count: 1,
      },
      input_schema: { # required
        record_format: { # required
          record_format_type: "JSON", # required, accepts JSON, CSV
          mapping_parameters: {
            json_mapping_parameters: {
              record_row_path: "RecordRowPath", # required
            },
            csv_mapping_parameters: {
              record_row_delimiter: "RecordRowDelimiter", # required
              record_column_delimiter: "RecordColumnDelimiter", # required
            },
          },
        },
        record_encoding: "RecordEncoding",
        record_columns: [ # required
          {
            name: "RecordColumnName", # required
            mapping: "RecordColumnMapping",
            sql_type: "RecordColumnSqlType", # required
          },
        ],
      },
    },
  ],
  outputs: [
    {
      name: "InAppStreamName", # required
      kinesis_streams_output: {
        resource_arn: "ResourceARN", # required
        role_arn: "RoleARN", # required
      },
      kinesis_firehose_output: {
        resource_arn: "ResourceARN", # required
        role_arn: "RoleARN", # required
      },
      destination_schema: { # required
        record_format_type: "JSON", # accepts JSON, CSV
      },
    },
  ],
  cloud_watch_logging_options: [
    {
      log_stream_arn: "LogStreamARN", # required
      role_arn: "RoleARN", # required
    },
  ],
  application_code: "ApplicationCode",
})

Response structure


resp.application_summary.application_name #=> String
resp.application_summary.application_arn #=> String
resp.application_summary.application_status #=> String, one of "DELETING", "STARTING", "STOPPING", "READY", "RUNNING", "UPDATING"

Options Hash (options):

  • :application_name (required, String)

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

  • :application_description (String)

    Summary description of the application.

  • :inputs (Array<Types::Input>)

    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 (Array<Types::Output>)

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

    These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, or both.

    In the configuration, you specify the in-application stream name, the destination stream 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 on your behalf.

    In the output configuration, you also provide the output stream Amazon Resource Name (ARN) and 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 this stream on your behalf.

  • :cloud_watch_logging_options (Array<Types::CloudWatchLoggingOption>)

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

  • :application_code (String)

    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 inforamtion 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.

Returns:

See Also:

#delete_application(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_application({
  application_name: "ApplicationName", # required
  create_timestamp: Time.now, # required
})

Options Hash (options):

  • :application_name (required, String)

    Name of the Amazon Kinesis Analytics application to delete.

  • :create_timestamp (required, Time)

    You can use the DescribeApplication operation to get this value.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_application_cloud_watch_logging_option(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_application_cloud_watch_logging_option({
  application_name: "ApplicationName", # required
  current_application_version_id: 1, # required
  cloud_watch_logging_option_id: "Id", # required
})

Options Hash (options):

  • :application_name (required, String)

    The Kinesis Analytics application name.

  • :current_application_version_id (required, Integer)

    The version ID of the Kinesis Analytics application.

  • :cloud_watch_logging_option_id (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_application_input_processing_configuration(options = {}) ⇒ Struct

Deletes an InputProcessingConfiguration from an input.

Examples:

Request syntax with placeholder values


resp = client.delete_application_input_processing_configuration({
  application_name: "ApplicationName", # required
  current_application_version_id: 1, # required
  input_id: "Id", # required
})

Options Hash (options):

  • :application_name (required, String)

    The Kinesis Analytics application name.

  • :current_application_version_id (required, Integer)

    The version ID of the Kinesis Analytics application.

  • :input_id (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_application_output(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_application_output({
  application_name: "ApplicationName", # required
  current_application_version_id: 1, # required
  output_id: "Id", # required
})

Options Hash (options):

  • :application_name (required, String)

    Amazon Kinesis Analytics application name.

  • :current_application_version_id (required, Integer)

    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.

  • :output_id (required, 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.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_application_reference_data_source(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_application_reference_data_source({
  application_name: "ApplicationName", # required
  current_application_version_id: 1, # required
  reference_id: "Id", # required
})

Options Hash (options):

  • :application_name (required, String)

    Name of an existing application.

  • :current_application_version_id (required, Integer)

    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.

  • :reference_id (required, 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.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#describe_application(options = {}) ⇒ Types::DescribeApplicationResponse

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.

Examples:

Request syntax with placeholder values


resp = client.describe_application({
  application_name: "ApplicationName", # required
})

Response structure


resp.application_detail.application_name #=> String
resp.application_detail.application_description #=> String
resp.application_detail.application_arn #=> String
resp.application_detail.application_status #=> String, one of "DELETING", "STARTING", "STOPPING", "READY", "RUNNING", "UPDATING"
resp.application_detail.create_timestamp #=> Time
resp.application_detail.last_update_timestamp #=> Time
resp.application_detail.input_descriptions #=> Array
resp.application_detail.input_descriptions[0].input_id #=> String
resp.application_detail.input_descriptions[0].name_prefix #=> String
resp.application_detail.input_descriptions[0].in_app_stream_names #=> Array
resp.application_detail.input_descriptions[0].in_app_stream_names[0] #=> String
resp.application_detail.input_descriptions[0].input_processing_configuration_description.input_lambda_processor_description.resource_arn #=> String
resp.application_detail.input_descriptions[0].input_processing_configuration_description.input_lambda_processor_description.role_arn #=> String
resp.application_detail.input_descriptions[0].kinesis_streams_input_description.resource_arn #=> String
resp.application_detail.input_descriptions[0].kinesis_streams_input_description.role_arn #=> String
resp.application_detail.input_descriptions[0].kinesis_firehose_input_description.resource_arn #=> String
resp.application_detail.input_descriptions[0].kinesis_firehose_input_description.role_arn #=> String
resp.application_detail.input_descriptions[0].input_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
resp.application_detail.input_descriptions[0].input_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
resp.application_detail.input_descriptions[0].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
resp.application_detail.input_descriptions[0].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
resp.application_detail.input_descriptions[0].input_schema.record_encoding #=> String
resp.application_detail.input_descriptions[0].input_schema.record_columns #=> Array
resp.application_detail.input_descriptions[0].input_schema.record_columns[0].name #=> String
resp.application_detail.input_descriptions[0].input_schema.record_columns[0].mapping #=> String
resp.application_detail.input_descriptions[0].input_schema.record_columns[0].sql_type #=> String
resp.application_detail.input_descriptions[0].input_parallelism.count #=> Integer
resp.application_detail.input_descriptions[0].input_starting_position_configuration.input_starting_position #=> String, one of "NOW", "TRIM_HORIZON", "LAST_STOPPED_POINT"
resp.application_detail.output_descriptions #=> Array
resp.application_detail.output_descriptions[0].output_id #=> String
resp.application_detail.output_descriptions[0].name #=> String
resp.application_detail.output_descriptions[0].kinesis_streams_output_description.resource_arn #=> String
resp.application_detail.output_descriptions[0].kinesis_streams_output_description.role_arn #=> String
resp.application_detail.output_descriptions[0].kinesis_firehose_output_description.resource_arn #=> String
resp.application_detail.output_descriptions[0].kinesis_firehose_output_description.role_arn #=> String
resp.application_detail.output_descriptions[0].destination_schema.record_format_type #=> String, one of "JSON", "CSV"
resp.application_detail.reference_data_source_descriptions #=> Array
resp.application_detail.reference_data_source_descriptions[0].reference_id #=> String
resp.application_detail.reference_data_source_descriptions[0].table_name #=> String
resp.application_detail.reference_data_source_descriptions[0].s3_reference_data_source_description.bucket_arn #=> String
resp.application_detail.reference_data_source_descriptions[0].s3_reference_data_source_description.file_key #=> String
resp.application_detail.reference_data_source_descriptions[0].s3_reference_data_source_description.reference_role_arn #=> String
resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_encoding #=> String
resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_columns #=> Array
resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_columns[0].name #=> String
resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_columns[0].mapping #=> String
resp.application_detail.reference_data_source_descriptions[0].reference_schema.record_columns[0].sql_type #=> String
resp.application_detail.cloud_watch_logging_option_descriptions #=> Array
resp.application_detail.cloud_watch_logging_option_descriptions[0].cloud_watch_logging_option_id #=> String
resp.application_detail.cloud_watch_logging_option_descriptions[0].log_stream_arn #=> String
resp.application_detail.cloud_watch_logging_option_descriptions[0].role_arn #=> String
resp.application_detail.application_code #=> String
resp.application_detail.application_version_id #=> Integer

Options Hash (options):

  • :application_name (required, String)

    Name of the application.

Returns:

See Also:

#discover_input_schema(options = {}) ⇒ Types::DiscoverInputSchemaResponse

Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream). 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.

Examples:

Request syntax with placeholder values


resp = client.discover_input_schema({
  resource_arn: "ResourceARN",
  role_arn: "RoleARN",
  input_starting_position_configuration: {
    input_starting_position: "NOW", # accepts NOW, TRIM_HORIZON, LAST_STOPPED_POINT
  },
  s3_configuration: {
    role_arn: "RoleARN", # required
    bucket_arn: "BucketARN", # required
    file_key: "FileKey", # required
  },
  input_processing_configuration: {
    input_lambda_processor: { # required
      resource_arn: "ResourceARN", # required
      role_arn: "RoleARN", # required
    },
  },
})

Response structure


resp.input_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
resp.input_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
resp.input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
resp.input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
resp.input_schema.record_encoding #=> String
resp.input_schema.record_columns #=> Array
resp.input_schema.record_columns[0].name #=> String
resp.input_schema.record_columns[0].mapping #=> String
resp.input_schema.record_columns[0].sql_type #=> String
resp.parsed_input_records #=> Array
resp.parsed_input_records[0] #=> Array
resp.parsed_input_records[0][0] #=> String
resp.processed_input_records #=> Array
resp.processed_input_records[0] #=> String
resp.raw_input_records #=> Array
resp.raw_input_records[0] #=> String

Options Hash (options):

  • :resource_arn (String)

    Amazon Resource Name (ARN) of the streaming source.

  • :role_arn (String)

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

  • :input_starting_position_configuration (Types::InputStartingPositionConfiguration)

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

  • :s3_configuration (Types::S3Configuration)
  • :input_processing_configuration (Types::InputProcessingConfiguration)

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

Returns:

See Also:

#list_applications(options = {}) ⇒ Types::ListApplicationsResponse

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.

Examples:

Request syntax with placeholder values


resp = client.list_applications({
  limit: 1,
  exclusive_start_application_name: "ApplicationName",
})

Response structure


resp.application_summaries #=> Array
resp.application_summaries[0].application_name #=> String
resp.application_summaries[0].application_arn #=> String
resp.application_summaries[0].application_status #=> String, one of "DELETING", "STARTING", "STOPPING", "READY", "RUNNING", "UPDATING"
resp.has_more_applications #=> true/false

Options Hash (options):

  • :limit (Integer)

    Maximum number of applications to list.

  • :exclusive_start_application_name (String)

    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.

Returns:

See Also:

#start_application(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.start_application({
  application_name: "ApplicationName", # required
  input_configurations: [ # required
    {
      id: "Id", # required
      input_starting_position_configuration: { # required
        input_starting_position: "NOW", # accepts NOW, TRIM_HORIZON, LAST_STOPPED_POINT
      },
    },
  ],
})

Options Hash (options):

  • :application_name (required, String)

    Name of the application.

  • :input_configurations (required, Array<Types::InputConfiguration>)

    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.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#stop_application(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.stop_application({
  application_name: "ApplicationName", # required
})

Options Hash (options):

  • :application_name (required, String)

    Name of the running application to stop.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_application(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.update_application({
  application_name: "ApplicationName", # required
  current_application_version_id: 1, # required
  application_update: { # required
    input_updates: [
      {
        input_id: "Id", # required
        name_prefix_update: "InAppStreamName",
        input_processing_configuration_update: {
          input_lambda_processor_update: { # required
            resource_arn_update: "ResourceARN",
            role_arn_update: "RoleARN",
          },
        },
        kinesis_streams_input_update: {
          resource_arn_update: "ResourceARN",
          role_arn_update: "RoleARN",
        },
        kinesis_firehose_input_update: {
          resource_arn_update: "ResourceARN",
          role_arn_update: "RoleARN",
        },
        input_schema_update: {
          record_format_update: {
            record_format_type: "JSON", # required, accepts JSON, CSV
            mapping_parameters: {
              json_mapping_parameters: {
                record_row_path: "RecordRowPath", # required
              },
              csv_mapping_parameters: {
                record_row_delimiter: "RecordRowDelimiter", # required
                record_column_delimiter: "RecordColumnDelimiter", # required
              },
            },
          },
          record_encoding_update: "RecordEncoding",
          record_column_updates: [
            {
              name: "RecordColumnName", # required
              mapping: "RecordColumnMapping",
              sql_type: "RecordColumnSqlType", # required
            },
          ],
        },
        input_parallelism_update: {
          count_update: 1,
        },
      },
    ],
    application_code_update: "ApplicationCode",
    output_updates: [
      {
        output_id: "Id", # required
        name_update: "InAppStreamName",
        kinesis_streams_output_update: {
          resource_arn_update: "ResourceARN",
          role_arn_update: "RoleARN",
        },
        kinesis_firehose_output_update: {
          resource_arn_update: "ResourceARN",
          role_arn_update: "RoleARN",
        },
        destination_schema_update: {
          record_format_type: "JSON", # accepts JSON, CSV
        },
      },
    ],
    reference_data_source_updates: [
      {
        reference_id: "Id", # required
        table_name_update: "InAppTableName",
        s3_reference_data_source_update: {
          bucket_arn_update: "BucketARN",
          file_key_update: "FileKey",
          reference_role_arn_update: "RoleARN",
        },
        reference_schema_update: {
          record_format: { # required
            record_format_type: "JSON", # required, accepts JSON, CSV
            mapping_parameters: {
              json_mapping_parameters: {
                record_row_path: "RecordRowPath", # required
              },
              csv_mapping_parameters: {
                record_row_delimiter: "RecordRowDelimiter", # required
                record_column_delimiter: "RecordColumnDelimiter", # required
              },
            },
          },
          record_encoding: "RecordEncoding",
          record_columns: [ # required
            {
              name: "RecordColumnName", # required
              mapping: "RecordColumnMapping",
              sql_type: "RecordColumnSqlType", # required
            },
          ],
        },
      },
    ],
    cloud_watch_logging_option_updates: [
      {
        cloud_watch_logging_option_id: "Id", # required
        log_stream_arn_update: "LogStreamARN",
        role_arn_update: "RoleARN",
      },
    ],
  },
})

Options Hash (options):

  • :application_name (required, String)

    Name of the Amazon Kinesis Analytics application to update.

  • :current_application_version_id (required, Integer)

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

  • :application_update (required, Types::ApplicationUpdate)

    Describes application updates.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

  • params (Hash) (defaults to: {})

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.