Client

kinesisanalytics

R Documentation

Amazon Kinesis Analytics¶

Description¶

Overview

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

This is the Amazon Kinesis Analytics v1 API Reference. The Amazon Kinesis Analytics Developer Guide provides additional information.

Usage¶

kinesisanalytics(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- kinesisanalytics(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications
add_application_input: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications; This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications
add_application_output: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications
add_application_reference_data_source: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications
create_application: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications
delete_application: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications; This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications; This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications
delete_application_output: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications; This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications
describe_application: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications
discover_input_schema: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications
list_applications: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications
list_tags_for_resource: Retrieves the list of key-value tags assigned to the application
start_application: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications
stop_application: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications
tag_resource: Adds one or more key-value tags to a Kinesis Analytics application
untag_resource: Removes one or more tags from a Kinesis Analytics application
update_application: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications

Examples¶

## Not run: 
svc <- kinesisanalytics()
svc$add_application_cloud_watch_logging_option(
  Foo = 123
)

## End(Not run)