kinesisanalyticsv2: Amazon Kinesis Analytics

In paws: Amazon Web Services Software Development Kit

Amazon Kinesis Analytics

Description

Amazon Managed Service for Apache Flink was previously known as Amazon Kinesis Data Analytics for Apache Flink.

Amazon Managed Service for Apache Flink is a fully managed service that you can use to process and analyze streaming data using Java, Python, SQL, or Scala. The service enables you to quickly author and run Java, SQL, or Scala code against streaming sources to perform time series analytics, feed real-time dashboards, and create real-time metrics.

Usage

kinesisanalyticsv2(
  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 <- kinesisanalyticsv2(
  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

add_application_cloud_watch_logging_option	Adds an Amazon CloudWatch log stream to monitor application configuration errors
add_application_input	Adds a streaming source to your SQL-based Kinesis Data Analytics application
add_application_input_processing_configuration	Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application
add_application_output	Adds an external destination to your SQL-based Kinesis Data Analytics application
add_application_reference_data_source	Adds a reference data source to an existing SQL-based Kinesis Data Analytics application
add_application_vpc_configuration	Adds a Virtual Private Cloud (VPC) configuration to the application
create_application	Creates a Managed Service for Apache Flink application
create_application_presigned_url	Creates and returns a URL that you can use to connect to an application's extension
create_application_snapshot	Creates a snapshot of the application's state data
delete_application	Deletes the specified application
delete_application_cloud_watch_logging_option	Deletes an Amazon CloudWatch log stream from an SQL-based Kinesis Data Analytics application
delete_application_input_processing_configuration	Deletes an InputProcessingConfiguration from an input
delete_application_output	Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration
delete_application_reference_data_source	Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration
delete_application_snapshot	Deletes a snapshot of application state
delete_application_vpc_configuration	Removes a VPC configuration from a Managed Service for Apache Flink application
describe_application	Returns information about a specific Managed Service for Apache Flink application
describe_application_operation	Returns information about a specific operation performed on a Managed Service for Apache Flink application
describe_application_snapshot	Returns information about a snapshot of application state data
describe_application_version	Provides a detailed description of a specified version of the application
discover_input_schema	Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object
list_application_operations	Lists information about operations performed on a Managed Service for Apache Flink application
list_applications	Returns a list of Managed Service for Apache Flink applications in your account
list_application_snapshots	Lists information about the current application snapshots
list_application_versions	Lists all the versions for the specified application, including versions that were rolled back
list_tags_for_resource	Retrieves the list of key-value tags assigned to the application
rollback_application	Reverts the application to the previous running version
start_application	Starts the specified Managed Service for Apache Flink application
stop_application	Stops the application from processing data
tag_resource	Adds one or more key-value tags to a Managed Service for Apache Flink application
untag_resource	Removes one or more tags from a Managed Service for Apache Flink application
update_application	Updates an existing Managed Service for Apache Flink application
update_application_maintenance_configuration	Updates the maintenance configuration of the Managed Service for Apache Flink application

Examples

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

## End(Not run)

paws documentation built on Sept. 17, 2024, 5:07 p.m.