paws.analytics (version 0.5.0)

kinesisanalyticsv2: Amazon Kinesis Analytics

Description

Amazon Kinesis Data Analytics is a fully managed service that you can use to process and analyze streaming data using Java, 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
)

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.

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.

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_optionAdds an Amazon CloudWatch log stream to monitor application configuration errors
add_application_inputAdds a streaming source to your SQL-based Kinesis Data Analytics application
add_application_input_processing_configurationAdds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application
add_application_outputAdds an external destination to your SQL-based Kinesis Data Analytics application
add_application_reference_data_sourceAdds a reference data source to an existing SQL-based Kinesis Data Analytics application
add_application_vpc_configurationAdds a Virtual Private Cloud (VPC) configuration to the application
create_applicationCreates a Kinesis Data Analytics application
create_application_presigned_urlCreates and returns a URL that you can use to connect to an application's extension
create_application_snapshotCreates a snapshot of the application's state data
delete_applicationDeletes the specified application
delete_application_cloud_watch_logging_optionDeletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application
delete_application_input_processing_configurationDeletes an InputProcessingConfiguration from an input
delete_application_outputDeletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration
delete_application_reference_data_sourceDeletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration
delete_application_snapshotDeletes a snapshot of application state
delete_application_vpc_configurationRemoves a VPC configuration from a Kinesis Data Analytics application
describe_applicationReturns information about a specific Kinesis Data Analytics application
describe_application_snapshotReturns information about a snapshot of application state data
describe_application_versionProvides a detailed description of a specified version of the application
discover_input_schemaInfers 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_applicationsReturns a list of Kinesis Data Analytics applications in your account
list_application_snapshotsLists information about the current application snapshots
list_application_versionsLists all the versions for the specified application, including versions that were rolled back
list_tags_for_resourceRetrieves the list of key-value tags assigned to the application
rollback_applicationReverts the application to the previous running version
start_applicationStarts the specified Kinesis Data Analytics application
stop_applicationStops the application from processing data
tag_resourceAdds one or more key-value tags to a Kinesis Data Analytics application
untag_resourceRemoves one or more tags from a Kinesis Data Analytics application
update_applicationUpdates an existing Kinesis Data Analytics application
update_application_maintenance_configurationUpdates the maintenance configuration of the Kinesis Data Analytics application

Examples

Run this code
if (FALSE) {
svc <- kinesisanalyticsv2()
svc$add_application_cloud_watch_logging_option(
  Foo = 123
)
}

Run the code above in your browser using DataLab