Class: Aws::KinesisAnalyticsV2::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::KinesisAnalyticsV2::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb
Overview
An API client for KinesisAnalyticsV2. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::KinesisAnalyticsV2::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_application_cloud_watch_logging_option(params = {}) ⇒ Types::AddApplicationCloudWatchLoggingOptionResponse
Adds an Amazon CloudWatch log stream to monitor application configuration errors.
-
#add_application_input(params = {}) ⇒ Types::AddApplicationInputResponse
Adds a streaming source to your SQL-based Kinesis Data Analytics application.
-
#add_application_input_processing_configuration(params = {}) ⇒ Types::AddApplicationInputProcessingConfigurationResponse
Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application.
-
#add_application_output(params = {}) ⇒ Types::AddApplicationOutputResponse
Adds an external destination to your SQL-based Kinesis Data Analytics application.
-
#add_application_reference_data_source(params = {}) ⇒ Types::AddApplicationReferenceDataSourceResponse
Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.
-
#add_application_vpc_configuration(params = {}) ⇒ Types::AddApplicationVpcConfigurationResponse
Adds a Virtual Private Cloud (VPC) configuration to the application.
-
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates a Managed Service for Apache Flink application.
-
#create_application_presigned_url(params = {}) ⇒ Types::CreateApplicationPresignedUrlResponse
Creates and returns a URL that you can use to connect to an application's extension.
-
#create_application_snapshot(params = {}) ⇒ Struct
Creates a snapshot of the application's state data.
-
#delete_application(params = {}) ⇒ Struct
Deletes the specified application.
-
#delete_application_cloud_watch_logging_option(params = {}) ⇒ Types::DeleteApplicationCloudWatchLoggingOptionResponse
Deletes an Amazon CloudWatch log stream from an SQL-based Kinesis Data Analytics application.
-
#delete_application_input_processing_configuration(params = {}) ⇒ Types::DeleteApplicationInputProcessingConfigurationResponse
Deletes an InputProcessingConfiguration from an input.
-
#delete_application_output(params = {}) ⇒ Types::DeleteApplicationOutputResponse
Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration.
-
#delete_application_reference_data_source(params = {}) ⇒ Types::DeleteApplicationReferenceDataSourceResponse
Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration.
-
#delete_application_snapshot(params = {}) ⇒ Struct
Deletes a snapshot of application state.
-
#delete_application_vpc_configuration(params = {}) ⇒ Types::DeleteApplicationVpcConfigurationResponse
Removes a VPC configuration from a Managed Service for Apache Flink application.
-
#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse
Returns information about a specific Managed Service for Apache Flink application.
-
#describe_application_operation(params = {}) ⇒ Types::DescribeApplicationOperationResponse
Returns information about a specific operation performed on a Managed Service for Apache Flink application.
-
#describe_application_snapshot(params = {}) ⇒ Types::DescribeApplicationSnapshotResponse
Returns information about a snapshot of application state data.
-
#describe_application_version(params = {}) ⇒ Types::DescribeApplicationVersionResponse
Provides a detailed description of a specified version of the application.
-
#discover_input_schema(params = {}) ⇒ Types::DiscoverInputSchemaResponse
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(params = {}) ⇒ Types::ListApplicationOperationsResponse
Lists information about operations performed on a Managed Service for Apache Flink application.
-
#list_application_snapshots(params = {}) ⇒ Types::ListApplicationSnapshotsResponse
Lists information about the current application snapshots.
-
#list_application_versions(params = {}) ⇒ Types::ListApplicationVersionsResponse
Lists all the versions for the specified application, including versions that were rolled back.
-
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Returns a list of Managed Service for Apache Flink applications in your account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the list of key-value tags assigned to the application.
-
#rollback_application(params = {}) ⇒ Types::RollbackApplicationResponse
Reverts the application to the previous running version.
-
#start_application(params = {}) ⇒ Types::StartApplicationResponse
Starts the specified Managed Service for Apache Flink application.
-
#stop_application(params = {}) ⇒ Types::StopApplicationResponse
Stops the application from processing data.
-
#tag_resource(params = {}) ⇒ Struct
Adds one or more key-value tags to a Managed Service for Apache Flink application.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from a Managed Service for Apache Flink application.
-
#update_application(params = {}) ⇒ Types::UpdateApplicationResponse
Updates an existing Managed Service for Apache Flink application.
-
#update_application_maintenance_configuration(params = {}) ⇒ Types::UpdateApplicationMaintenanceConfigurationResponse
Updates the maintenance configuration of the Managed Service for Apache Flink application.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
Parameters:
- options (Hash)
Options Hash (options):
-
:plugins
(Array<Seahorse::Client::Plugin>)
— default:
[]]
—
A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.
-
:credentials
(required, Aws::CredentialProvider)
—
Your AWS credentials. This can be an instance of any one of the following classes:
Aws::Credentials
- Used for configuring static, non-refreshing credentials.Aws::SharedCredentials
- Used for loading static credentials from a shared file, such as~/.aws/config
.Aws::AssumeRoleCredentials
- Used when you need to assume a role.Aws::AssumeRoleWebIdentityCredentials
- Used when you need to assume a role after providing credentials via the web.Aws::SSOCredentials
- Used for loading credentials from AWS SSO using an access token generated fromaws login
.Aws::ProcessCredentials
- Used for loading credentials from a process that outputs to stdout.Aws::InstanceProfileCredentials
- Used for loading credentials from an EC2 IMDS on an EC2 instance.Aws::ECSCredentials
- Used for loading credentials from instances running in ECS.Aws::CognitoIdentityCredentials
- Used for loading credentials from the Cognito Identity service.
When
:credentials
are not configured directly, the following locations will be searched for credentials:Aws.config[:credentials]
- The
:access_key_id
,:secret_access_key
, and:session_token
options. - ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
~/.aws/credentials
~/.aws/config
- EC2/ECS IMDS instance profile - When used by default, the timeouts
are very aggressive. Construct and pass an instance of
Aws::InstanceProfileCredentails
orAws::ECSCredentials
to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
-
:region
(required, String)
—
The AWS region to connect to. The configured
:region
is used to determine the service:endpoint
. When not passed, a default:region
is searched for in the following locations:Aws.config[:region]
ENV['AWS_REGION']
ENV['AMAZON_REGION']
ENV['AWS_DEFAULT_REGION']
~/.aws/credentials
~/.aws/config
- :access_key_id (String)
-
:active_endpoint_cache
(Boolean)
— default:
false
—
When set to
true
, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults tofalse
. -
:adaptive_retry_wait_to_fill
(Boolean)
— default:
true
—
Used only in
adaptive
retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise aRetryCapacityNotAvailableError
and will not retry instead of sleeping. -
:client_side_monitoring
(Boolean)
— default:
false
—
When
true
, client-side metrics will be collected for all API requests from this client. -
:client_side_monitoring_client_id
(String)
— default:
""
—
Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.
-
:client_side_monitoring_host
(String)
— default:
"127.0.0.1"
—
Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.
-
:client_side_monitoring_port
(Integer)
— default:
31000
—
Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.
-
:client_side_monitoring_publisher
(Aws::ClientSideMonitoring::Publisher)
— default:
Aws::ClientSideMonitoring::Publisher
—
Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.
-
:convert_params
(Boolean)
— default:
true
—
When
true
, an attempt is made to coerce request parameters into the required types. -
:correct_clock_skew
(Boolean)
— default:
true
—
Used only in
standard
and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. -
:defaults_mode
(String)
— default:
"legacy"
—
See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.
-
:disable_host_prefix_injection
(Boolean)
— default:
false
—
Set to true to disable SDK automatically adding host prefix to default service endpoint when available.
-
:disable_request_compression
(Boolean)
— default:
false
—
When set to 'true' the request body will not be compressed for supported operations.
-
:endpoint
(String, URI::HTTPS, URI::HTTP)
—
Normally you should not configure the
:endpoint
option directly. This is normally constructed from the:region
option. Configuring:endpoint
is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:'http://example.com' 'https://example.com' 'http://example.com:123'
-
:endpoint_cache_max_entries
(Integer)
— default:
1000
—
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.
-
:endpoint_cache_max_threads
(Integer)
— default:
10
—
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
-
:endpoint_cache_poll_interval
(Integer)
— default:
60
—
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.
-
:endpoint_discovery
(Boolean)
— default:
false
—
When set to
true
, endpoint discovery will be enabled for operations when available. -
:ignore_configured_endpoint_urls
(Boolean)
—
Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.
-
:log_formatter
(Aws::Log::Formatter)
— default:
Aws::Log::Formatter.default
—
The log formatter.
-
:log_level
(Symbol)
— default:
:info
—
The log level to send messages to the
:logger
at. -
:logger
(Logger)
—
The Logger instance to send log messages to. If this option is not set, logging will be disabled.
-
:max_attempts
(Integer)
— default:
3
—
An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in
standard
andadaptive
retry modes. -
:profile
(String)
— default:
"default"
—
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.
-
:request_min_compression_size_bytes
(Integer)
— default:
10240
—
The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.
-
:retry_backoff
(Proc)
—
A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the
legacy
retry mode. -
:retry_base_delay
(Float)
— default:
0.3
—
The base delay in seconds used by the default backoff function. This option is only used in the
legacy
retry mode. -
:retry_jitter
(Symbol)
— default:
:none
—
A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the
legacy
retry mode.@see https://www.awsarchitectureblog.com/2015/03/backoff.html
-
: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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the
legacy
retry mode. -
:retry_max_delay
(Integer)
— default:
0
—
The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the
legacy
retry mode. -
:retry_mode
(String)
— default:
"legacy"
—
Specifies which retry algorithm to use. Values are:
legacy
- The pre-existing retry behavior. This is default value if no retry mode is provided.standard
- A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.adaptive
- An experimental retry mode that includes all the functionality ofstandard
mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.
-
:sdk_ua_app_id
(String)
—
A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
- :secret_access_key (String)
- :session_token (String)
-
:sigv4a_signing_region_set
(Array)
—
A list of regions that should be signed with SigV4a signing. When not passed, a default
:sigv4a_signing_region_set
is searched for in the following locations:Aws.config[:sigv4a_signing_region_set]
ENV['AWS_SIGV4A_SIGNING_REGION_SET']
~/.aws/config
-
:simple_json
(Boolean)
— default:
false
—
Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.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.
-
: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.
-
:telemetry_provider
(Aws::Telemetry::TelemetryProviderBase)
— default:
Aws::Telemetry::NoOpTelemetryProvider
—
Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses
NoOpTelemetryProvider
which will not record or emit any telemetry data. The SDK supports the following telemetry providers:- OpenTelemetry (OTel) - To use the OTel provider, install and require the
opentelemetry-sdk
gem and then, pass in an instance of aAws::Telemetry::OTelProvider
for telemetry provider.
- OpenTelemetry (OTel) - To use the OTel provider, install and require the
-
:token_provider
(Aws::TokenProvider)
—
A Bearer Token Provider. This can be an instance of any one of the following classes:
Aws::StaticTokenProvider
- Used for configuring static, non-refreshing tokens.Aws::SSOTokenProvider
- Used for loading tokens from AWS SSO using an access token generated fromaws login
.
When
:token_provider
is not configured directly, theAws::TokenProviderChain
will be used to search for tokens configured for your profile in shared configuration files. -
:use_dualstack_endpoint
(Boolean)
—
When set to
true
, dualstack enabled endpoints (with.aws
TLD) will be used if available. -
:use_fips_endpoint
(Boolean)
—
When set to
true
, fips compatible endpoints will be used if available. When afips
region is used, the region is normalized and this config is set totrue
. -
:validate_params
(Boolean)
— default:
true
—
When
true
, request parameters are validated before sending the request. -
:endpoint_provider
(Aws::KinesisAnalyticsV2::EndpointProvider)
—
The endpoint provider used to resolve endpoints. Any object that responds to
#resolve_endpoint(parameters)
whereparameters
is a Struct similar toAws::KinesisAnalyticsV2::EndpointParameters
-
:http_continue_timeout
(Float)
— default:
1
—
The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to
nil
which disables this behaviour. This value can safely be set per request on the session. -
:http_idle_timeout
(Float)
— default:
5
—
The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.
-
:http_open_timeout
(Float)
— default:
15
—
The default number of seconds to wait for response data. This value can safely be set per-request on the session.
-
:http_proxy
(URI::HTTP, String)
—
A proxy to send requests through. Formatted like 'http://proxy.com:123'.
-
:http_read_timeout
(Float)
— default:
60
—
The default number of seconds to wait for response data. This value can safely be set per-request on the session.
-
:http_wire_trace
(Boolean)
— default:
false
—
When
true
, HTTP debug output will be sent to the:logger
. -
:on_chunk_received
(Proc)
—
When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a
content-length
). -
:on_chunk_sent
(Proc)
—
When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.
-
:raise_response_errors
(Boolean)
— default:
true
—
When
true
, response errors are raised. -
:ssl_ca_bundle
(String)
—
Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass
:ssl_ca_bundle
or:ssl_ca_directory
the the system default will be used if available. -
:ssl_ca_directory
(String)
—
Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass
:ssl_ca_bundle
or:ssl_ca_directory
the the system default will be used if available. -
:ssl_ca_store
(String)
—
Sets the X509::Store to verify peer certificate.
-
:ssl_timeout
(Float)
—
Sets the SSL timeout in seconds
-
:ssl_verify_peer
(Boolean)
— default:
true
—
When
true
, SSL peer certificates are verified when establishing a connection.
441 442 443 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 441 def initialize(*args) super end |
Instance Method Details
#add_application_cloud_watch_logging_option(params = {}) ⇒ Types::AddApplicationCloudWatchLoggingOptionResponse
Adds an Amazon CloudWatch log stream to monitor application configuration errors.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.add_application_cloud_watch_logging_option({
application_name: "ApplicationName", # required
current_application_version_id: 1,
cloud_watch_logging_option: { # required
log_stream_arn: "LogStreamARN", # required
},
conditional_token: "ConditionalToken",
})
Response structure
Response structure
resp.application_arn #=> String
resp.application_version_id #=> Integer
resp.cloud_watch_logging_option_descriptions #=> Array
resp.cloud_watch_logging_option_descriptions[0].cloud_watch_logging_option_id #=> String
resp.cloud_watch_logging_option_descriptions[0].log_stream_arn #=> String
resp.cloud_watch_logging_option_descriptions[0].role_arn #=> String
resp.operation_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The Kinesis Data Analytics application name.
-
:current_application_version_id
(Integer)
—
The version ID of the SQL-based Kinesis Data Analytics application. You must provide the
CurrentApplicationVersionId
or theConditionalToken
.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use theConditionalToken
parameter instead ofCurrentApplicationVersionId
. -
:cloud_watch_logging_option
(required, Types::CloudWatchLoggingOption)
—
Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN).
-
:conditional_token
(String)
—
A value you use to implement strong concurrency for application updates. You must provide the
CurrentApplicationVersionId
or theConditionalToken
. You get the application's currentConditionalToken
using DescribeApplication. For better concurrency support, use theConditionalToken
parameter instead ofCurrentApplicationVersionId
.
Returns:
-
(Types::AddApplicationCloudWatchLoggingOptionResponse)
—
Returns a response object which responds to the following methods:
- #application_arn => String
- #application_version_id => Integer
- #cloud_watch_logging_option_descriptions => Array<Types::CloudWatchLoggingOptionDescription>
- #operation_id => String
See Also:
503 504 505 506 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 503 def add_application_cloud_watch_logging_option(params = {}, options = {}) req = build_request(:add_application_cloud_watch_logging_option, params) req.send_request(options) end |
#add_application_input(params = {}) ⇒ Types::AddApplicationInputResponse
Adds a streaming source to your SQL-based Kinesis Data Analytics application.
You can add a streaming source 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.
Examples:
Request syntax with placeholder values
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
},
},
kinesis_streams_input: {
resource_arn: "ResourceARN", # required
},
kinesis_firehose_input: {
resource_arn: "ResourceARN", # 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
},
],
},
},
})
Response structure
Response structure
resp.application_arn #=> String
resp.application_version_id #=> Integer
resp.input_descriptions #=> Array
resp.input_descriptions[0].input_id #=> String
resp.input_descriptions[0].name_prefix #=> String
resp.input_descriptions[0].in_app_stream_names #=> Array
resp.input_descriptions[0].in_app_stream_names[0] #=> String
resp.input_descriptions[0].input_processing_configuration_description.input_lambda_processor_description.resource_arn #=> String
resp.input_descriptions[0].input_processing_configuration_description.input_lambda_processor_description.role_arn #=> String
resp.input_descriptions[0].kinesis_streams_input_description.resource_arn #=> String
resp.input_descriptions[0].kinesis_streams_input_description.role_arn #=> String
resp.input_descriptions[0].kinesis_firehose_input_description.resource_arn #=> String
resp.input_descriptions[0].kinesis_firehose_input_description.role_arn #=> String
resp.input_descriptions[0].input_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
resp.input_descriptions[0].input_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
resp.input_descriptions[0].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
resp.input_descriptions[0].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
resp.input_descriptions[0].input_schema.record_encoding #=> String
resp.input_descriptions[0].input_schema.record_columns #=> Array
resp.input_descriptions[0].input_schema.record_columns[0].name #=> String
resp.input_descriptions[0].input_schema.record_columns[0].mapping #=> String
resp.input_descriptions[0].input_schema.record_columns[0].sql_type #=> String
resp.input_descriptions[0].input_parallelism.count #=> Integer
resp.input_descriptions[0].input_starting_position_configuration.input_starting_position #=> String, one of "NOW", "TRIM_HORIZON", "LAST_STOPPED_POINT"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of your existing application to which you want to add the streaming source.
-
:current_application_version_id
(required, Integer)
—
The current version of your application. You must provide the
ApplicationVersionID
or theConditionalToken
.You can use the DescribeApplication operation to find the current application version. -
:input
(required, Types::Input)
—
The Input to add.
Returns:
-
(Types::AddApplicationInputResponse)
—
Returns a response object which responds to the following methods:
- #application_arn => String
- #application_version_id => Integer
- #input_descriptions => Array<Types::InputDescription>
See Also:
615 616 617 618 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 615 def add_application_input(params = {}, options = {}) req = build_request(:add_application_input, params) req.send_request(options) end |
#add_application_input_processing_configuration(params = {}) ⇒ Types::AddApplicationInputProcessingConfigurationResponse
Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only input processor available is Amazon Lambda.
Examples:
Request syntax with placeholder values
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
},
},
})
Response structure
Response structure
resp.application_arn #=> String
resp.application_version_id #=> Integer
resp.input_id #=> String
resp.input_processing_configuration_description.input_lambda_processor_description.resource_arn #=> String
resp.input_processing_configuration_description.input_lambda_processor_description.role_arn #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of the application to which you want to add the input processing configuration.
-
:current_application_version_id
(required, Integer)
—
The 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 add the input processing configuration to. 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:
-
(Types::AddApplicationInputProcessingConfigurationResponse)
—
Returns a response object which responds to the following methods:
- #application_arn => String
- #application_version_id => Integer
- #input_id => String
- #input_processing_configuration_description => Types::InputProcessingConfigurationDescription
See Also:
680 681 682 683 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 680 def add_application_input_processing_configuration(params = {}, options = {}) req = build_request(:add_application_input_processing_configuration, params) req.send_request(options) end |
#add_application_output(params = {}) ⇒ Types::AddApplicationOutputResponse
Adds an external destination to your SQL-based Kinesis Data Analytics application.
If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon 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.
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.
Examples:
Request syntax with placeholder values
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
},
kinesis_firehose_output: {
resource_arn: "ResourceARN", # required
},
lambda_output: {
resource_arn: "ResourceARN", # required
},
destination_schema: { # required
record_format_type: "JSON", # required, accepts JSON, CSV
},
},
})
Response structure
Response structure
resp.application_arn #=> String
resp.application_version_id #=> Integer
resp.output_descriptions #=> Array
resp.output_descriptions[0].output_id #=> String
resp.output_descriptions[0].name #=> String
resp.output_descriptions[0].kinesis_streams_output_description.resource_arn #=> String
resp.output_descriptions[0].kinesis_streams_output_description.role_arn #=> String
resp.output_descriptions[0].kinesis_firehose_output_description.resource_arn #=> String
resp.output_descriptions[0].kinesis_firehose_output_description.role_arn #=> String
resp.output_descriptions[0].lambda_output_description.resource_arn #=> String
resp.output_descriptions[0].lambda_output_description.role_arn #=> String
resp.output_descriptions[0].destination_schema.record_format_type #=> String, one of "JSON", "CSV"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of the application to which you want to add the output configuration.
-
:current_application_version_id
(required, Integer)
—
The 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, 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, a Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda function), and record the formation to use when writing to the destination.
Returns:
-
(Types::AddApplicationOutputResponse)
—
Returns a response object which responds to the following methods:
- #application_arn => String
- #application_version_id => Integer
- #output_descriptions => Array<Types::OutputDescription>
See Also:
770 771 772 773 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 770 def add_application_output(params = {}, options = {}) req = build_request(:add_application_output, params) req.send_request(options) end |
#add_application_reference_data_source(params = {}) ⇒ Types::AddApplicationReferenceDataSourceResponse
Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.
Kinesis Data 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 an Amazon S3 object maps to columns in the resulting in-application table.
Examples:
Request syntax with placeholder values
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",
file_key: "FileKey",
},
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
},
],
},
},
})
Response structure
Response structure
resp.application_arn #=> String
resp.application_version_id #=> Integer
resp.reference_data_source_descriptions #=> Array
resp.reference_data_source_descriptions[0].reference_id #=> String
resp.reference_data_source_descriptions[0].table_name #=> String
resp.reference_data_source_descriptions[0].s3_reference_data_source_description.bucket_arn #=> String
resp.reference_data_source_descriptions[0].s3_reference_data_source_description.file_key #=> String
resp.reference_data_source_descriptions[0].s3_reference_data_source_description.reference_role_arn #=> String
resp.reference_data_source_descriptions[0].reference_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
resp.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
resp.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
resp.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
resp.reference_data_source_descriptions[0].reference_schema.record_encoding #=> String
resp.reference_data_source_descriptions[0].reference_schema.record_columns #=> Array
resp.reference_data_source_descriptions[0].reference_schema.record_columns[0].name #=> String
resp.reference_data_source_descriptions[0].reference_schema.record_columns[0].mapping #=> String
resp.reference_data_source_descriptions[0].reference_schema.record_columns[0].sql_type #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of an existing application.
-
:current_application_version_id
(required, Integer)
—
The 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. Kinesis Data 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.
Returns:
-
(Types::AddApplicationReferenceDataSourceResponse)
—
Returns a response object which responds to the following methods:
- #application_arn => String
- #application_version_id => Integer
- #reference_data_source_descriptions => Array<Types::ReferenceDataSourceDescription>
See Also:
866 867 868 869 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 866 def add_application_reference_data_source(params = {}, options = {}) req = build_request(:add_application_reference_data_source, params) req.send_request(options) end |
#add_application_vpc_configuration(params = {}) ⇒ Types::AddApplicationVpcConfigurationResponse
Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely.
Note the following about VPC configurations for Managed Service for Apache Flink applications:
VPC configurations are not supported for SQL applications.
When a VPC is added to a Managed Service for Apache Flink application, the application can no longer be accessed from the Internet directly. To enable Internet access to the application, add an Internet gateway to your VPC.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.add_application_vpc_configuration({
application_name: "ApplicationName", # required
current_application_version_id: 1,
vpc_configuration: { # required
subnet_ids: ["SubnetId"], # required
security_group_ids: ["SecurityGroupId"], # required
},
conditional_token: "ConditionalToken",
})
Response structure
Response structure
resp.application_arn #=> String
resp.application_version_id #=> Integer
resp.vpc_configuration_description.vpc_configuration_id #=> String
resp.vpc_configuration_description.vpc_id #=> String
resp.vpc_configuration_description.subnet_ids #=> Array
resp.vpc_configuration_description.subnet_ids[0] #=> String
resp.vpc_configuration_description.security_group_ids #=> Array
resp.vpc_configuration_description.security_group_ids[0] #=> String
resp.operation_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of an existing application.
-
:current_application_version_id
(Integer)
—
The version of the application to which you want to add the VPC configuration. You must provide the
CurrentApplicationVersionId
or theConditionalToken
. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, theConcurrentModificationException
is returned. For better concurrency support, use theConditionalToken
parameter instead ofCurrentApplicationVersionId
. -
:vpc_configuration
(required, Types::VpcConfiguration)
—
Description of the VPC to add to the application.
-
:conditional_token
(String)
—
A value you use to implement strong concurrency for application updates. You must provide the
ApplicationVersionID
or theConditionalToken
. You get the application's currentConditionalToken
using DescribeApplication. For better concurrency support, use theConditionalToken
parameter instead ofCurrentApplicationVersionId
.
Returns:
-
(Types::AddApplicationVpcConfigurationResponse)
—
Returns a response object which responds to the following methods:
- #application_arn => String
- #application_version_id => Integer
- #vpc_configuration_description => Types::VpcConfigurationDescription
- #operation_id => String
See Also:
942 943 944 945 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 942 def add_application_vpc_configuration(params = {}, options = {}) req = build_request(:add_application_vpc_configuration, params) req.send_request(options) end |
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates a Managed Service for Apache Flink application. For information about creating a Managed Service for Apache Flink application, see Creating an Application.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_application({
application_name: "ApplicationName", # required
application_description: "ApplicationDescription",
runtime_environment: "SQL-1_0", # required, accepts SQL-1_0, FLINK-1_6, FLINK-1_8, ZEPPELIN-FLINK-1_0, FLINK-1_11, FLINK-1_13, ZEPPELIN-FLINK-2_0, FLINK-1_15, ZEPPELIN-FLINK-3_0, FLINK-1_18, FLINK-1_19, FLINK-1_20
service_execution_role: "RoleARN", # required
application_configuration: {
sql_application_configuration: {
inputs: [
{
name_prefix: "InAppStreamName", # required
input_processing_configuration: {
input_lambda_processor: { # required
resource_arn: "ResourceARN", # required
},
},
kinesis_streams_input: {
resource_arn: "ResourceARN", # required
},
kinesis_firehose_input: {
resource_arn: "ResourceARN", # 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
},
kinesis_firehose_output: {
resource_arn: "ResourceARN", # required
},
lambda_output: {
resource_arn: "ResourceARN", # required
},
destination_schema: { # required
record_format_type: "JSON", # required, accepts JSON, CSV
},
},
],
reference_data_sources: [
{
table_name: "InAppTableName", # required
s3_reference_data_source: {
bucket_arn: "BucketARN",
file_key: "FileKey",
},
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
},
],
},
},
],
},
flink_application_configuration: {
checkpoint_configuration: {
configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM
checkpointing_enabled: false,
checkpoint_interval: 1,
min_pause_between_checkpoints: 1,
},
monitoring_configuration: {
configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM
metrics_level: "APPLICATION", # accepts APPLICATION, TASK, OPERATOR, PARALLELISM
log_level: "INFO", # accepts INFO, WARN, ERROR, DEBUG
},
parallelism_configuration: {
configuration_type: "DEFAULT", # required, accepts DEFAULT, CUSTOM
parallelism: 1,
parallelism_per_kpu: 1,
auto_scaling_enabled: false,
},
},
environment_properties: {
property_groups: [ # required
{
property_group_id: "Id", # required
property_map: { # required
"PropertyKey" => "PropertyValue",
},
},
],
},
application_code_configuration: {
code_content: {
text_content: "TextContent",
zip_file_content: "data",
s3_content_location: {
bucket_arn: "BucketARN", # required
file_key: "FileKey", # required
object_version: "ObjectVersion",
},
},
code_content_type: "PLAINTEXT", # required, accepts PLAINTEXT, ZIPFILE
},
application_snapshot_configuration: {
snapshots_enabled: false, # required
},
application_system_rollback_configuration: {
rollback_enabled: false, # required
},
vpc_configurations: [
{
subnet_ids: ["SubnetId"], # required
security_group_ids: ["SecurityGroupId"], # required
},
],
zeppelin_application_configuration: {
monitoring_configuration: {
log_level: "INFO", # required, accepts INFO, WARN, ERROR, DEBUG
},
catalog_configuration: {
glue_data_catalog_configuration: { # required
database_arn: "DatabaseARN", # required
},
},
deploy_as_application_configuration: {
s3_content_location: { # required
bucket_arn: "BucketARN", # required
base_path: "BasePath",
},
},
custom_artifacts_configuration: [
{
artifact_type: "UDF", # required, accepts UDF, DEPENDENCY_JAR
s3_content_location: {
bucket_arn: "BucketARN", # required
file_key: "FileKey", # required
object_version: "ObjectVersion",
},
maven_reference: {
group_id: "MavenGroupId", # required
artifact_id: "MavenArtifactId", # required
version: "MavenVersion", # required
},
},
],
},
},
cloud_watch_logging_options: [
{
log_stream_arn: "LogStreamARN", # required
},
],
tags: [
{
key: "TagKey", # required
value: "TagValue",
},
],
application_mode: "STREAMING", # accepts STREAMING, INTERACTIVE
})
Response structure
Response structure
resp.application_detail.application_arn #=> String
resp.application_detail.application_description #=> String
resp.application_detail.application_name #=> String
resp.application_detail.runtime_environment #=> String, one of "SQL-1_0", "FLINK-1_6", "FLINK-1_8", "ZEPPELIN-FLINK-1_0", "FLINK-1_11", "FLINK-1_13", "ZEPPELIN-FLINK-2_0", "FLINK-1_15", "ZEPPELIN-FLINK-3_0", "FLINK-1_18", "FLINK-1_19", "FLINK-1_20"
resp.application_detail.service_execution_role #=> String
resp.application_detail.application_status #=> String, one of "DELETING", "STARTING", "STOPPING", "READY", "RUNNING", "UPDATING", "AUTOSCALING", "FORCE_STOPPING", "ROLLING_BACK", "MAINTENANCE", "ROLLED_BACK"
resp.application_detail.application_version_id #=> Integer
resp.application_detail.create_timestamp #=> Time
resp.application_detail.last_update_timestamp #=> Time
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_id #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].name_prefix #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].in_app_stream_names #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].in_app_stream_names[0] #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_processing_configuration_description.input_lambda_processor_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_processing_configuration_description.input_lambda_processor_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_streams_input_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_streams_input_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_firehose_input_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_firehose_input_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_encoding #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns[0].name #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns[0].mapping #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns[0].sql_type #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_parallelism.count #=> Integer
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_starting_position_configuration.input_starting_position #=> String, one of "NOW", "TRIM_HORIZON", "LAST_STOPPED_POINT"
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].output_id #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].name #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_streams_output_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_streams_output_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_firehose_output_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_firehose_output_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].lambda_output_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].lambda_output_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].destination_schema.record_format_type #=> String, one of "JSON", "CSV"
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_id #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].table_name #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].s3_reference_data_source_description.bucket_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].s3_reference_data_source_description.file_key #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].s3_reference_data_source_description.reference_role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_encoding #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns[0].name #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns[0].mapping #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns[0].sql_type #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_type #=> String, one of "PLAINTEXT", "ZIPFILE"
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.text_content #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.code_md5 #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.code_size #=> Integer
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description.bucket_arn #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description.file_key #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description.object_version #=> String
resp.application_detail.application_configuration_description.run_configuration_description.application_restore_configuration_description.application_restore_type #=> String, one of "SKIP_RESTORE_FROM_SNAPSHOT", "RESTORE_FROM_LATEST_SNAPSHOT", "RESTORE_FROM_CUSTOM_SNAPSHOT"
resp.application_detail.application_configuration_description.run_configuration_description.application_restore_configuration_description.snapshot_name #=> String
resp.application_detail.application_configuration_description.run_configuration_description.flink_run_configuration_description.allow_non_restored_state #=> Boolean
resp.application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.configuration_type #=> String, one of "DEFAULT", "CUSTOM"
resp.application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.checkpointing_enabled #=> Boolean
resp.application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.checkpoint_interval #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.min_pause_between_checkpoints #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description.configuration_type #=> String, one of "DEFAULT", "CUSTOM"
resp.application_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description.metrics_level #=> String, one of "APPLICATION", "TASK", "OPERATOR", "PARALLELISM"
resp.application_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description.log_level #=> String, one of "INFO", "WARN", "ERROR", "DEBUG"
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.configuration_type #=> String, one of "DEFAULT", "CUSTOM"
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.parallelism #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.parallelism_per_kpu #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.current_parallelism #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.auto_scaling_enabled #=> Boolean
resp.application_detail.application_configuration_description.flink_application_configuration_description.job_plan_description #=> String
resp.application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions #=> Array
resp.application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions[0].property_group_id #=> String
resp.application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions[0].property_map #=> Hash
resp.application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions[0].property_map["PropertyKey"] #=> String
resp.application_detail.application_configuration_description.application_snapshot_configuration_description.snapshots_enabled #=> Boolean
resp.application_detail.application_configuration_description.application_system_rollback_configuration_description.rollback_enabled #=> Boolean
resp.application_detail.application_configuration_description.vpc_configuration_descriptions #=> Array
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].vpc_configuration_id #=> String
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].vpc_id #=> String
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].subnet_ids #=> Array
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].subnet_ids[0] #=> String
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].security_group_ids #=> Array
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].security_group_ids[0] #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.monitoring_configuration_description.log_level #=> String, one of "INFO", "WARN", "ERROR", "DEBUG"
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.catalog_configuration_description.glue_data_catalog_configuration_description.database_arn #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.deploy_as_application_configuration_description.s3_content_location_description.bucket_arn #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.deploy_as_application_configuration_description.s3_content_location_description.base_path #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description #=> Array
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].artifact_type #=> String, one of "UDF", "DEPENDENCY_JAR"
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].s3_content_location_description.bucket_arn #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].s3_content_location_description.file_key #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].s3_content_location_description.object_version #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].maven_reference_description.group_id #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].maven_reference_description.artifact_id #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].maven_reference_description.version #=> 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_maintenance_configuration_description.application_maintenance_window_start_time #=> String
resp.application_detail.application_maintenance_configuration_description.application_maintenance_window_end_time #=> String
resp.application_detail.application_version_updated_from #=> Integer
resp.application_detail.application_version_rolled_back_from #=> Integer
resp.application_detail.application_version_create_timestamp #=> Time
resp.application_detail.conditional_token #=> String
resp.application_detail.application_version_rolled_back_to #=> Integer
resp.application_detail.application_mode #=> String, one of "STREAMING", "INTERACTIVE"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of your application (for example,
sample-app
). -
:application_description
(String)
—
A summary description of the application.
-
:runtime_environment
(required, String)
—
The runtime environment for the application.
-
:service_execution_role
(required, String)
—
The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.
-
:application_configuration
(Types::ApplicationConfiguration)
—
Use this parameter to configure the application.
-
:cloud_watch_logging_options
(Array<Types::CloudWatchLoggingOption>)
—
Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.
-
:tags
(Array<Types::Tag>)
—
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.
-
:application_mode
(String)
—
Use the
STREAMING
mode to create a Managed Service for Apache Flink application. To create a Managed Service for Apache Flink Studio notebook, use theINTERACTIVE
mode.
Returns:
-
(Types::CreateApplicationResponse)
—
Returns a response object which responds to the following methods:
- #application_detail => Types::ApplicationDetail
See Also:
1317 1318 1319 1320 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 1317 def create_application(params = {}, options = {}) req = build_request(:create_application, params) req.send_request(options) end |
#create_application_presigned_url(params = {}) ⇒ Types::CreateApplicationPresignedUrlResponse
Creates and returns a URL that you can use to connect to an application's extension.
The IAM role or user used to call this API defines the permissions to access the extension. After the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request that attempts to connect to the extension.
You control the amount of time that the URL will be valid using the
SessionExpirationDurationInSeconds
parameter. If you do not provide
this parameter, the returned URL is valid for twelve hours.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_application_presigned_url({
application_name: "ApplicationName", # required
url_type: "FLINK_DASHBOARD_URL", # required, accepts FLINK_DASHBOARD_URL, ZEPPELIN_UI_URL
session_expiration_duration_in_seconds: 1,
})
Response structure
Response structure
resp.authorized_url #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of the application.
-
:url_type
(required, String)
—
The type of the extension for which to create and return a URL. Currently, the only valid extension URL type is
FLINK_DASHBOARD_URL
. -
:session_expiration_duration_in_seconds
(Integer)
—
The duration in seconds for which the returned URL will be valid.
Returns:
-
(Types::CreateApplicationPresignedUrlResponse)
—
Returns a response object which responds to the following methods:
- #authorized_url => String
See Also:
1372 1373 1374 1375 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 1372 def create_application_presigned_url(params = {}, options = {}) req = build_request(:create_application_presigned_url, params) req.send_request(options) end |
#create_application_snapshot(params = {}) ⇒ Struct
Creates a snapshot of the application's state data.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_application_snapshot({
application_name: "ApplicationName", # required
snapshot_name: "SnapshotName", # required
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of an existing application
-
:snapshot_name
(required, String)
—
An identifier for the application snapshot.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
1398 1399 1400 1401 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 1398 def create_application_snapshot(params = {}, options = {}) req = build_request(:create_application_snapshot, params) req.send_request(options) end |
#delete_application(params = {}) ⇒ Struct
Deletes the specified application. Managed Service for Apache Flink halts application execution and deletes the application.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_application({
application_name: "ApplicationName", # required
create_timestamp: Time.now, # required
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of the application to delete.
-
:create_timestamp
(required, Time, DateTime, Date, Integer, String)
—
Use the
DescribeApplication
operation to get this value.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
1425 1426 1427 1428 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 1425 def delete_application(params = {}, options = {}) req = build_request(:delete_application, params) req.send_request(options) end |
#delete_application_cloud_watch_logging_option(params = {}) ⇒ Types::DeleteApplicationCloudWatchLoggingOptionResponse
Deletes an Amazon CloudWatch log stream from an SQL-based Kinesis Data Analytics application.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_application_cloud_watch_logging_option({
application_name: "ApplicationName", # required
current_application_version_id: 1,
cloud_watch_logging_option_id: "Id", # required
conditional_token: "ConditionalToken",
})
Response structure
Response structure
resp.application_arn #=> String
resp.application_version_id #=> Integer
resp.cloud_watch_logging_option_descriptions #=> Array
resp.cloud_watch_logging_option_descriptions[0].cloud_watch_logging_option_id #=> String
resp.cloud_watch_logging_option_descriptions[0].log_stream_arn #=> String
resp.cloud_watch_logging_option_descriptions[0].role_arn #=> String
resp.operation_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The application name.
-
:current_application_version_id
(Integer)
—
The version ID of the application. You must provide the
CurrentApplicationVersionId
or theConditionalToken
. You can retrieve the application version ID using DescribeApplication. For better concurrency support, use theConditionalToken
parameter instead ofCurrentApplicationVersionId
. -
:cloud_watch_logging_option_id
(required, String)
—
The
CloudWatchLoggingOptionId
of the Amazon CloudWatch logging option to delete. You can get theCloudWatchLoggingOptionId
by using the DescribeApplication operation. -
:conditional_token
(String)
—
A value you use to implement strong concurrency for application updates. You must provide the
CurrentApplicationVersionId
or theConditionalToken
. You get the application's currentConditionalToken
using DescribeApplication. For better concurrency support, use theConditionalToken
parameter instead ofCurrentApplicationVersionId
.
Returns:
-
(Types::DeleteApplicationCloudWatchLoggingOptionResponse)
—
Returns a response object which responds to the following methods:
- #application_arn => String
- #application_version_id => Integer
- #cloud_watch_logging_option_descriptions => Array<Types::CloudWatchLoggingOptionDescription>
- #operation_id => String
See Also:
1486 1487 1488 1489 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 1486 def delete_application_cloud_watch_logging_option(params = {}, options = {}) req = build_request(:delete_application_cloud_watch_logging_option, params) req.send_request(options) end |
#delete_application_input_processing_configuration(params = {}) ⇒ Types::DeleteApplicationInputProcessingConfigurationResponse
Deletes an InputProcessingConfiguration from an input.
Examples:
Request syntax with placeholder values
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
})
Response structure
Response structure
resp.application_arn #=> String
resp.application_version_id #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of the application.
-
:current_application_version_id
(required, Integer)
—
The 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. -
:input_id
(required, 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.
Returns:
-
(Types::DeleteApplicationInputProcessingConfigurationResponse)
—
Returns a response object which responds to the following methods:
- #application_arn => String
- #application_version_id => Integer
See Also:
1529 1530 1531 1532 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 1529 def delete_application_input_processing_configuration(params = {}, options = {}) req = build_request(:delete_application_input_processing_configuration, params) req.send_request(options) end |
#delete_application_output(params = {}) ⇒ Types::DeleteApplicationOutputResponse
Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_application_output({
application_name: "ApplicationName", # required
current_application_version_id: 1, # required
output_id: "Id", # required
})
Response structure
Response structure
resp.application_arn #=> String
resp.application_version_id #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The application name.
-
:current_application_version_id
(required, Integer)
—
The 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:
-
(Types::DeleteApplicationOutputResponse)
—
Returns a response object which responds to the following methods:
- #application_arn => String
- #application_version_id => Integer
See Also:
1578 1579 1580 1581 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 1578 def delete_application_output(params = {}, options = {}) req = build_request(:delete_application_output, params) req.send_request(options) end |
#delete_application_reference_data_source(params = {}) ⇒ Types::DeleteApplicationReferenceDataSourceResponse
Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration.
If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.
Examples:
Request syntax with placeholder values
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
})
Response structure
Response structure
resp.application_arn #=> String
resp.application_version_id #=> Integer
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of an existing application.
-
:current_application_version_id
(required, Integer)
—
The current 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. -
:reference_id
(required, String)
—
The ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Kinesis Data Analytics assigns an ID. You can use the DescribeApplication operation to get the reference ID.
Returns:
-
(Types::DeleteApplicationReferenceDataSourceResponse)
—
Returns a response object which responds to the following methods:
- #application_arn => String
- #application_version_id => Integer
See Also:
1628 1629 1630 1631 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 1628 def delete_application_reference_data_source(params = {}, options = {}) req = build_request(:delete_application_reference_data_source, params) req.send_request(options) end |
#delete_application_snapshot(params = {}) ⇒ Struct
Deletes a snapshot of application state.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_application_snapshot({
application_name: "ApplicationName", # required
snapshot_name: "SnapshotName", # required
snapshot_creation_timestamp: Time.now, # required
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of an existing application.
-
:snapshot_name
(required, String)
—
The identifier for the snapshot delete.
-
:snapshot_creation_timestamp
(required, Time, DateTime, Date, Integer, String)
—
The creation timestamp of the application snapshot to delete. You can retrieve this value using or .
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
1659 1660 1661 1662 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 1659 def delete_application_snapshot(params = {}, options = {}) req = build_request(:delete_application_snapshot, params) req.send_request(options) end |
#delete_application_vpc_configuration(params = {}) ⇒ Types::DeleteApplicationVpcConfigurationResponse
Removes a VPC configuration from a Managed Service for Apache Flink application.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_application_vpc_configuration({
application_name: "ApplicationName", # required
current_application_version_id: 1,
vpc_configuration_id: "Id", # required
conditional_token: "ConditionalToken",
})
Response structure
Response structure
resp.application_arn #=> String
resp.application_version_id #=> Integer
resp.operation_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of an existing application.
-
:current_application_version_id
(Integer)
—
The current application version ID. You must provide the
CurrentApplicationVersionId
or theConditionalToken
. You can retrieve the application version ID using DescribeApplication. For better concurrency support, use theConditionalToken
parameter instead ofCurrentApplicationVersionId
. -
:vpc_configuration_id
(required, String)
—
The ID of the VPC configuration to delete.
-
:conditional_token
(String)
—
A value you use to implement strong concurrency for application updates. You must provide the
CurrentApplicationVersionId
or theConditionalToken
. You get the application's currentConditionalToken
using DescribeApplication. For better concurrency support, use theConditionalToken
parameter instead ofCurrentApplicationVersionId
.
Returns:
-
(Types::DeleteApplicationVpcConfigurationResponse)
—
Returns a response object which responds to the following methods:
- #application_arn => String
- #application_version_id => Integer
- #operation_id => String
See Also:
1713 1714 1715 1716 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 1713 def delete_application_vpc_configuration(params = {}, options = {}) req = build_request(:delete_application_vpc_configuration, params) req.send_request(options) end |
#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse
Returns information about a specific Managed Service for Apache Flink application.
If you want to retrieve a list of all applications in your account, use the ListApplications operation.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.describe_application({
application_name: "ApplicationName", # required
include_additional_details: false,
})
Response structure
Response structure
resp.application_detail.application_arn #=> String
resp.application_detail.application_description #=> String
resp.application_detail.application_name #=> String
resp.application_detail.runtime_environment #=> String, one of "SQL-1_0", "FLINK-1_6", "FLINK-1_8", "ZEPPELIN-FLINK-1_0", "FLINK-1_11", "FLINK-1_13", "ZEPPELIN-FLINK-2_0", "FLINK-1_15", "ZEPPELIN-FLINK-3_0", "FLINK-1_18", "FLINK-1_19", "FLINK-1_20"
resp.application_detail.service_execution_role #=> String
resp.application_detail.application_status #=> String, one of "DELETING", "STARTING", "STOPPING", "READY", "RUNNING", "UPDATING", "AUTOSCALING", "FORCE_STOPPING", "ROLLING_BACK", "MAINTENANCE", "ROLLED_BACK"
resp.application_detail.application_version_id #=> Integer
resp.application_detail.create_timestamp #=> Time
resp.application_detail.last_update_timestamp #=> Time
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_id #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].name_prefix #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].in_app_stream_names #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].in_app_stream_names[0] #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_processing_configuration_description.input_lambda_processor_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_processing_configuration_description.input_lambda_processor_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_streams_input_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_streams_input_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_firehose_input_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_firehose_input_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_encoding #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns[0].name #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns[0].mapping #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns[0].sql_type #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_parallelism.count #=> Integer
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_starting_position_configuration.input_starting_position #=> String, one of "NOW", "TRIM_HORIZON", "LAST_STOPPED_POINT"
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].output_id #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].name #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_streams_output_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_streams_output_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_firehose_output_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_firehose_output_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].lambda_output_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].lambda_output_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].destination_schema.record_format_type #=> String, one of "JSON", "CSV"
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_id #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].table_name #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].s3_reference_data_source_description.bucket_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].s3_reference_data_source_description.file_key #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].s3_reference_data_source_description.reference_role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_encoding #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns[0].name #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns[0].mapping #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns[0].sql_type #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_type #=> String, one of "PLAINTEXT", "ZIPFILE"
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.text_content #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.code_md5 #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.code_size #=> Integer
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description.bucket_arn #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description.file_key #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description.object_version #=> String
resp.application_detail.application_configuration_description.run_configuration_description.application_restore_configuration_description.application_restore_type #=> String, one of "SKIP_RESTORE_FROM_SNAPSHOT", "RESTORE_FROM_LATEST_SNAPSHOT", "RESTORE_FROM_CUSTOM_SNAPSHOT"
resp.application_detail.application_configuration_description.run_configuration_description.application_restore_configuration_description.snapshot_name #=> String
resp.application_detail.application_configuration_description.run_configuration_description.flink_run_configuration_description.allow_non_restored_state #=> Boolean
resp.application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.configuration_type #=> String, one of "DEFAULT", "CUSTOM"
resp.application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.checkpointing_enabled #=> Boolean
resp.application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.checkpoint_interval #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.min_pause_between_checkpoints #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description.configuration_type #=> String, one of "DEFAULT", "CUSTOM"
resp.application_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description.metrics_level #=> String, one of "APPLICATION", "TASK", "OPERATOR", "PARALLELISM"
resp.application_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description.log_level #=> String, one of "INFO", "WARN", "ERROR", "DEBUG"
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.configuration_type #=> String, one of "DEFAULT", "CUSTOM"
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.parallelism #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.parallelism_per_kpu #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.current_parallelism #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.auto_scaling_enabled #=> Boolean
resp.application_detail.application_configuration_description.flink_application_configuration_description.job_plan_description #=> String
resp.application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions #=> Array
resp.application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions[0].property_group_id #=> String
resp.application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions[0].property_map #=> Hash
resp.application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions[0].property_map["PropertyKey"] #=> String
resp.application_detail.application_configuration_description.application_snapshot_configuration_description.snapshots_enabled #=> Boolean
resp.application_detail.application_configuration_description.application_system_rollback_configuration_description.rollback_enabled #=> Boolean
resp.application_detail.application_configuration_description.vpc_configuration_descriptions #=> Array
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].vpc_configuration_id #=> String
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].vpc_id #=> String
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].subnet_ids #=> Array
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].subnet_ids[0] #=> String
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].security_group_ids #=> Array
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].security_group_ids[0] #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.monitoring_configuration_description.log_level #=> String, one of "INFO", "WARN", "ERROR", "DEBUG"
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.catalog_configuration_description.glue_data_catalog_configuration_description.database_arn #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.deploy_as_application_configuration_description.s3_content_location_description.bucket_arn #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.deploy_as_application_configuration_description.s3_content_location_description.base_path #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description #=> Array
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].artifact_type #=> String, one of "UDF", "DEPENDENCY_JAR"
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].s3_content_location_description.bucket_arn #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].s3_content_location_description.file_key #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].s3_content_location_description.object_version #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].maven_reference_description.group_id #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].maven_reference_description.artifact_id #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].maven_reference_description.version #=> 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_maintenance_configuration_description.application_maintenance_window_start_time #=> String
resp.application_detail.application_maintenance_configuration_description.application_maintenance_window_end_time #=> String
resp.application_detail.application_version_updated_from #=> Integer
resp.application_detail.application_version_rolled_back_from #=> Integer
resp.application_detail.application_version_create_timestamp #=> Time
resp.application_detail.conditional_token #=> String
resp.application_detail.application_version_rolled_back_to #=> Integer
resp.application_detail.application_mode #=> String, one of "STREAMING", "INTERACTIVE"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of the application.
-
:include_additional_details
(Boolean)
—
Displays verbose information about a Managed Service for Apache Flink application, including the application's job plan.
Returns:
-
(Types::DescribeApplicationResponse)
—
Returns a response object which responds to the following methods:
- #application_detail => Types::ApplicationDetail
See Also:
1865 1866 1867 1868 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 1865 def describe_application(params = {}, options = {}) req = build_request(:describe_application, params) req.send_request(options) end |
#describe_application_operation(params = {}) ⇒ Types::DescribeApplicationOperationResponse
Returns information about a specific operation performed on a Managed Service for Apache Flink application
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.describe_application_operation({
application_name: "ApplicationName", # required
operation_id: "OperationId", # required
})
Response structure
Response structure
resp.application_operation_info_details.operation #=> String
resp.application_operation_info_details.start_time #=> Time
resp.application_operation_info_details.end_time #=> Time
resp.application_operation_info_details.operation_status #=> String, one of "IN_PROGRESS", "CANCELLED", "SUCCESSFUL", "FAILED"
resp.application_operation_info_details.application_version_change_details.application_version_updated_from #=> Integer
resp.application_operation_info_details.application_version_change_details.application_version_updated_to #=> Integer
resp.application_operation_info_details.operation_failure_details.rollback_operation_id #=> String
resp.application_operation_info_details.operation_failure_details.error_info.error_string #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of the application
-
:operation_id
(required, String)
—
Identifier of the Operation
Returns:
-
(Types::DescribeApplicationOperationResponse)
—
Returns a response object which responds to the following methods:
- #application_operation_info_details => Types::ApplicationOperationInfoDetails
See Also:
1905 1906 1907 1908 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 1905 def describe_application_operation(params = {}, options = {}) req = build_request(:describe_application_operation, params) req.send_request(options) end |
#describe_application_snapshot(params = {}) ⇒ Types::DescribeApplicationSnapshotResponse
Returns information about a snapshot of application state data.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.describe_application_snapshot({
application_name: "ApplicationName", # required
snapshot_name: "SnapshotName", # required
})
Response structure
Response structure
resp.snapshot_details.snapshot_name #=> String
resp.snapshot_details.snapshot_status #=> String, one of "CREATING", "READY", "DELETING", "FAILED"
resp.snapshot_details.application_version_id #=> Integer
resp.snapshot_details.snapshot_creation_timestamp #=> Time
resp.snapshot_details.runtime_environment #=> String, one of "SQL-1_0", "FLINK-1_6", "FLINK-1_8", "ZEPPELIN-FLINK-1_0", "FLINK-1_11", "FLINK-1_13", "ZEPPELIN-FLINK-2_0", "FLINK-1_15", "ZEPPELIN-FLINK-3_0", "FLINK-1_18", "FLINK-1_19", "FLINK-1_20"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of an existing application.
-
:snapshot_name
(required, String)
—
The identifier of an application snapshot. You can retrieve this value using .
Returns:
-
(Types::DescribeApplicationSnapshotResponse)
—
Returns a response object which responds to the following methods:
- #snapshot_details => Types::SnapshotDetails
See Also:
1942 1943 1944 1945 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 1942 def describe_application_snapshot(params = {}, options = {}) req = build_request(:describe_application_snapshot, params) req.send_request(options) end |
#describe_application_version(params = {}) ⇒ Types::DescribeApplicationVersionResponse
Provides a detailed description of a specified version of the application. To see a list of all the versions of an application, invoke the ListApplicationVersions operation.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.describe_application_version({
application_name: "ApplicationName", # required
application_version_id: 1, # required
})
Response structure
Response structure
resp.application_version_detail.application_arn #=> String
resp.application_version_detail.application_description #=> String
resp.application_version_detail.application_name #=> String
resp.application_version_detail.runtime_environment #=> String, one of "SQL-1_0", "FLINK-1_6", "FLINK-1_8", "ZEPPELIN-FLINK-1_0", "FLINK-1_11", "FLINK-1_13", "ZEPPELIN-FLINK-2_0", "FLINK-1_15", "ZEPPELIN-FLINK-3_0", "FLINK-1_18", "FLINK-1_19", "FLINK-1_20"
resp.application_version_detail.service_execution_role #=> String
resp.application_version_detail.application_status #=> String, one of "DELETING", "STARTING", "STOPPING", "READY", "RUNNING", "UPDATING", "AUTOSCALING", "FORCE_STOPPING", "ROLLING_BACK", "MAINTENANCE", "ROLLED_BACK"
resp.application_version_detail.application_version_id #=> Integer
resp.application_version_detail.create_timestamp #=> Time
resp.application_version_detail.last_update_timestamp #=> Time
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions #=> Array
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_id #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].name_prefix #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].in_app_stream_names #=> Array
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].in_app_stream_names[0] #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_processing_configuration_description.input_lambda_processor_description.resource_arn #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_processing_configuration_description.input_lambda_processor_description.role_arn #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_streams_input_description.resource_arn #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_streams_input_description.role_arn #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_firehose_input_description.resource_arn #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_firehose_input_description.role_arn #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_encoding #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns #=> Array
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns[0].name #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns[0].mapping #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns[0].sql_type #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_parallelism.count #=> Integer
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_starting_position_configuration.input_starting_position #=> String, one of "NOW", "TRIM_HORIZON", "LAST_STOPPED_POINT"
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.output_descriptions #=> Array
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].output_id #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].name #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_streams_output_description.resource_arn #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_streams_output_description.role_arn #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_firehose_output_description.resource_arn #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_firehose_output_description.role_arn #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].lambda_output_description.resource_arn #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].lambda_output_description.role_arn #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].destination_schema.record_format_type #=> String, one of "JSON", "CSV"
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions #=> Array
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_id #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].table_name #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].s3_reference_data_source_description.bucket_arn #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].s3_reference_data_source_description.file_key #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].s3_reference_data_source_description.reference_role_arn #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_encoding #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns #=> Array
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns[0].name #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns[0].mapping #=> String
resp.application_version_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns[0].sql_type #=> String
resp.application_version_detail.application_configuration_description.application_code_configuration_description.code_content_type #=> String, one of "PLAINTEXT", "ZIPFILE"
resp.application_version_detail.application_configuration_description.application_code_configuration_description.code_content_description.text_content #=> String
resp.application_version_detail.application_configuration_description.application_code_configuration_description.code_content_description.code_md5 #=> String
resp.application_version_detail.application_configuration_description.application_code_configuration_description.code_content_description.code_size #=> Integer
resp.application_version_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description.bucket_arn #=> String
resp.application_version_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description.file_key #=> String
resp.application_version_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description.object_version #=> String
resp.application_version_detail.application_configuration_description.run_configuration_description.application_restore_configuration_description.application_restore_type #=> String, one of "SKIP_RESTORE_FROM_SNAPSHOT", "RESTORE_FROM_LATEST_SNAPSHOT", "RESTORE_FROM_CUSTOM_SNAPSHOT"
resp.application_version_detail.application_configuration_description.run_configuration_description.application_restore_configuration_description.snapshot_name #=> String
resp.application_version_detail.application_configuration_description.run_configuration_description.flink_run_configuration_description.allow_non_restored_state #=> Boolean
resp.application_version_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.configuration_type #=> String, one of "DEFAULT", "CUSTOM"
resp.application_version_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.checkpointing_enabled #=> Boolean
resp.application_version_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.checkpoint_interval #=> Integer
resp.application_version_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.min_pause_between_checkpoints #=> Integer
resp.application_version_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description.configuration_type #=> String, one of "DEFAULT", "CUSTOM"
resp.application_version_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description.metrics_level #=> String, one of "APPLICATION", "TASK", "OPERATOR", "PARALLELISM"
resp.application_version_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description.log_level #=> String, one of "INFO", "WARN", "ERROR", "DEBUG"
resp.application_version_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.configuration_type #=> String, one of "DEFAULT", "CUSTOM"
resp.application_version_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.parallelism #=> Integer
resp.application_version_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.parallelism_per_kpu #=> Integer
resp.application_version_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.current_parallelism #=> Integer
resp.application_version_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.auto_scaling_enabled #=> Boolean
resp.application_version_detail.application_configuration_description.flink_application_configuration_description.job_plan_description #=> String
resp.application_version_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions #=> Array
resp.application_version_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions[0].property_group_id #=> String
resp.application_version_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions[0].property_map #=> Hash
resp.application_version_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions[0].property_map["PropertyKey"] #=> String
resp.application_version_detail.application_configuration_description.application_snapshot_configuration_description.snapshots_enabled #=> Boolean
resp.application_version_detail.application_configuration_description.application_system_rollback_configuration_description.rollback_enabled #=> Boolean
resp.application_version_detail.application_configuration_description.vpc_configuration_descriptions #=> Array
resp.application_version_detail.application_configuration_description.vpc_configuration_descriptions[0].vpc_configuration_id #=> String
resp.application_version_detail.application_configuration_description.vpc_configuration_descriptions[0].vpc_id #=> String
resp.application_version_detail.application_configuration_description.vpc_configuration_descriptions[0].subnet_ids #=> Array
resp.application_version_detail.application_configuration_description.vpc_configuration_descriptions[0].subnet_ids[0] #=> String
resp.application_version_detail.application_configuration_description.vpc_configuration_descriptions[0].security_group_ids #=> Array
resp.application_version_detail.application_configuration_description.vpc_configuration_descriptions[0].security_group_ids[0] #=> String
resp.application_version_detail.application_configuration_description.zeppelin_application_configuration_description.monitoring_configuration_description.log_level #=> String, one of "INFO", "WARN", "ERROR", "DEBUG"
resp.application_version_detail.application_configuration_description.zeppelin_application_configuration_description.catalog_configuration_description.glue_data_catalog_configuration_description.database_arn #=> String
resp.application_version_detail.application_configuration_description.zeppelin_application_configuration_description.deploy_as_application_configuration_description.s3_content_location_description.bucket_arn #=> String
resp.application_version_detail.application_configuration_description.zeppelin_application_configuration_description.deploy_as_application_configuration_description.s3_content_location_description.base_path #=> String
resp.application_version_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description #=> Array
resp.application_version_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].artifact_type #=> String, one of "UDF", "DEPENDENCY_JAR"
resp.application_version_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].s3_content_location_description.bucket_arn #=> String
resp.application_version_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].s3_content_location_description.file_key #=> String
resp.application_version_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].s3_content_location_description.object_version #=> String
resp.application_version_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].maven_reference_description.group_id #=> String
resp.application_version_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].maven_reference_description.artifact_id #=> String
resp.application_version_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].maven_reference_description.version #=> String
resp.application_version_detail.cloud_watch_logging_option_descriptions #=> Array
resp.application_version_detail.cloud_watch_logging_option_descriptions[0].cloud_watch_logging_option_id #=> String
resp.application_version_detail.cloud_watch_logging_option_descriptions[0].log_stream_arn #=> String
resp.application_version_detail.cloud_watch_logging_option_descriptions[0].role_arn #=> String
resp.application_version_detail.application_maintenance_configuration_description.application_maintenance_window_start_time #=> String
resp.application_version_detail.application_maintenance_configuration_description.application_maintenance_window_end_time #=> String
resp.application_version_detail.application_version_updated_from #=> Integer
resp.application_version_detail.application_version_rolled_back_from #=> Integer
resp.application_version_detail.application_version_create_timestamp #=> Time
resp.application_version_detail.conditional_token #=> String
resp.application_version_detail.application_version_rolled_back_to #=> Integer
resp.application_version_detail.application_mode #=> String, one of "STREAMING", "INTERACTIVE"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of the application for which you want to get the version description.
-
:application_version_id
(required, Integer)
—
The ID of the application version for which you want to get the description.
Returns:
-
(Types::DescribeApplicationVersionResponse)
—
Returns a response object which responds to the following methods:
- #application_version_detail => Types::ApplicationDetail
See Also:
2097 2098 2099 2100 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 2097 def describe_application_version(params = {}, options = {}) req = build_request(:describe_application_version, params) req.send_request(options) end |
#discover_input_schema(params = {}) ⇒ Types::DiscoverInputSchemaResponse
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. 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. When you create an application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show it in the console user interface.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.discover_input_schema({
resource_arn: "ResourceARN",
service_execution_role: "RoleARN", # required
input_starting_position_configuration: {
input_starting_position: "NOW", # accepts NOW, TRIM_HORIZON, LAST_STOPPED_POINT
},
s3_configuration: {
bucket_arn: "BucketARN", # required
file_key: "FileKey", # required
},
input_processing_configuration: {
input_lambda_processor: { # required
resource_arn: "ResourceARN", # required
},
},
})
Response structure
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
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:resource_arn
(String)
—
The Amazon Resource Name (ARN) of the streaming source.
-
:service_execution_role
(required, String)
—
The ARN of the role that is used to access the streaming source.
-
:input_starting_position_configuration
(Types::InputStartingPositionConfiguration)
—
The point at which you want Kinesis Data Analytics to start reading records from the specified streaming source for discovery purposes.
-
:s3_configuration
(Types::S3Configuration)
—
Specify this parameter to discover a schema from data in an Amazon S3 object.
-
:input_processing_configuration
(Types::InputProcessingConfiguration)
—
The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.
Returns:
-
(Types::DiscoverInputSchemaResponse)
—
Returns a response object which responds to the following methods:
- #input_schema => Types::SourceSchema
- #parsed_input_records => Array<Array<String>>
- #processed_input_records => Array<String>
- #raw_input_records => Array<String>
See Also:
2180 2181 2182 2183 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 2180 def discover_input_schema(params = {}, options = {}) req = build_request(:discover_input_schema, params) req.send_request(options) end |
#list_application_operations(params = {}) ⇒ Types::ListApplicationOperationsResponse
Lists information about operations performed on a Managed Service for Apache Flink application
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_application_operations({
application_name: "ApplicationName", # required
limit: 1,
next_token: "NextToken",
operation: "Operation",
operation_status: "IN_PROGRESS", # accepts IN_PROGRESS, CANCELLED, SUCCESSFUL, FAILED
})
Response structure
Response structure
resp.application_operation_info_list #=> Array
resp.application_operation_info_list[0].operation #=> String
resp.application_operation_info_list[0].operation_id #=> String
resp.application_operation_info_list[0].start_time #=> Time
resp.application_operation_info_list[0].end_time #=> Time
resp.application_operation_info_list[0].operation_status #=> String, one of "IN_PROGRESS", "CANCELLED", "SUCCESSFUL", "FAILED"
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of the application
-
:limit
(Integer)
—
Limit on the number of records returned in the response
-
:next_token
(String)
—
If a previous command returned a pagination token, pass it into this value to retrieve the next set of results
-
:operation
(String)
—
Type of operation performed on an application
-
:operation_status
(String)
—
Status of the operation performed on an application
Returns:
-
(Types::ListApplicationOperationsResponse)
—
Returns a response object which responds to the following methods:
- #application_operation_info_list => Array<Types::ApplicationOperationInfo>
- #next_token => String
See Also:
2235 2236 2237 2238 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 2235 def list_application_operations(params = {}, options = {}) req = build_request(:list_application_operations, params) req.send_request(options) end |
#list_application_snapshots(params = {}) ⇒ Types::ListApplicationSnapshotsResponse
Lists information about the current application snapshots.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_application_snapshots({
application_name: "ApplicationName", # required
limit: 1,
next_token: "NextToken",
})
Response structure
Response structure
resp.snapshot_summaries #=> Array
resp.snapshot_summaries[0].snapshot_name #=> String
resp.snapshot_summaries[0].snapshot_status #=> String, one of "CREATING", "READY", "DELETING", "FAILED"
resp.snapshot_summaries[0].application_version_id #=> Integer
resp.snapshot_summaries[0].snapshot_creation_timestamp #=> Time
resp.snapshot_summaries[0].runtime_environment #=> String, one of "SQL-1_0", "FLINK-1_6", "FLINK-1_8", "ZEPPELIN-FLINK-1_0", "FLINK-1_11", "FLINK-1_13", "ZEPPELIN-FLINK-2_0", "FLINK-1_15", "ZEPPELIN-FLINK-3_0", "FLINK-1_18", "FLINK-1_19", "FLINK-1_20"
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of an existing application.
-
:limit
(Integer)
—
The maximum number of application snapshots to list.
-
:next_token
(String)
—
Use this parameter if you receive a
NextToken
response in a previous request that indicates that there is more output available. Set it to the value of the previous call'sNextToken
response to indicate where the output should continue from.
Returns:
-
(Types::ListApplicationSnapshotsResponse)
—
Returns a response object which responds to the following methods:
- #snapshot_summaries => Array<Types::SnapshotDetails>
- #next_token => String
See Also:
2283 2284 2285 2286 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 2283 def list_application_snapshots(params = {}, options = {}) req = build_request(:list_application_snapshots, params) req.send_request(options) end |
#list_application_versions(params = {}) ⇒ Types::ListApplicationVersionsResponse
Lists all the versions for the specified application, including versions that were rolled back. The response also includes a summary of the configuration associated with each version.
To get the complete description of a specific application version, invoke the DescribeApplicationVersion operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_application_versions({
application_name: "ApplicationName", # required
limit: 1,
next_token: "NextToken",
})
Response structure
Response structure
resp.application_version_summaries #=> Array
resp.application_version_summaries[0].application_version_id #=> Integer
resp.application_version_summaries[0].application_status #=> String, one of "DELETING", "STARTING", "STOPPING", "READY", "RUNNING", "UPDATING", "AUTOSCALING", "FORCE_STOPPING", "ROLLING_BACK", "MAINTENANCE", "ROLLED_BACK"
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of the application for which you want to list all versions.
-
:limit
(Integer)
—
The maximum number of versions to list in this invocation of the operation.
-
:next_token
(String)
—
If a previous invocation of this operation returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.
Returns:
-
(Types::ListApplicationVersionsResponse)
—
Returns a response object which responds to the following methods:
- #application_version_summaries => Array<Types::ApplicationVersionSummary>
- #next_token => String
See Also:
2342 2343 2344 2345 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 2342 def list_application_versions(params = {}, options = {}) req = build_request(:list_application_versions, params) req.send_request(options) end |
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Returns a list of Managed Service for Apache Flink applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status.
If you want detailed information about a specific application, use DescribeApplication.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_applications({
limit: 1,
next_token: "ApplicationName",
})
Response structure
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", "AUTOSCALING", "FORCE_STOPPING", "ROLLING_BACK", "MAINTENANCE", "ROLLED_BACK"
resp.application_summaries[0].application_version_id #=> Integer
resp.application_summaries[0].runtime_environment #=> String, one of "SQL-1_0", "FLINK-1_6", "FLINK-1_8", "ZEPPELIN-FLINK-1_0", "FLINK-1_11", "FLINK-1_13", "ZEPPELIN-FLINK-2_0", "FLINK-1_15", "ZEPPELIN-FLINK-3_0", "FLINK-1_18", "FLINK-1_19", "FLINK-1_20"
resp.application_summaries[0].application_mode #=> String, one of "STREAMING", "INTERACTIVE"
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:limit
(Integer)
—
The maximum number of applications to list.
-
:next_token
(String)
—
If a previous command returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.
Returns:
-
(Types::ListApplicationsResponse)
—
Returns a response object which responds to the following methods:
- #application_summaries => Array<Types::ApplicationSummary>
- #next_token => String
See Also:
2396 2397 2398 2399 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 2396 def list_applications(params = {}, options = {}) req = build_request(:list_applications, params) req.send_request(options) end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_tags_for_resource({
resource_arn: "KinesisAnalyticsARN", # required
})
Response structure
Response structure
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:resource_arn
(required, String)
—
The ARN of the application for which to retrieve tags.
Returns:
See Also:
2431 2432 2433 2434 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 2431 def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end |
#rollback_application(params = {}) ⇒ Types::RollbackApplicationResponse
Reverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status or in the running status.
You can roll back an application only if it is in the UPDATING
,
AUTOSCALING
, or RUNNING
statuses.
When you rollback an application, it loads state data from the last successful snapshot. If the application has no snapshots, Managed Service for Apache Flink rejects the rollback request.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.rollback_application({
application_name: "ApplicationName", # required
current_application_version_id: 1, # required
})
Response structure
Response structure
resp.application_detail.application_arn #=> String
resp.application_detail.application_description #=> String
resp.application_detail.application_name #=> String
resp.application_detail.runtime_environment #=> String, one of "SQL-1_0", "FLINK-1_6", "FLINK-1_8", "ZEPPELIN-FLINK-1_0", "FLINK-1_11", "FLINK-1_13", "ZEPPELIN-FLINK-2_0", "FLINK-1_15", "ZEPPELIN-FLINK-3_0", "FLINK-1_18", "FLINK-1_19", "FLINK-1_20"
resp.application_detail.service_execution_role #=> String
resp.application_detail.application_status #=> String, one of "DELETING", "STARTING", "STOPPING", "READY", "RUNNING", "UPDATING", "AUTOSCALING", "FORCE_STOPPING", "ROLLING_BACK", "MAINTENANCE", "ROLLED_BACK"
resp.application_detail.application_version_id #=> Integer
resp.application_detail.create_timestamp #=> Time
resp.application_detail.last_update_timestamp #=> Time
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_id #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].name_prefix #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].in_app_stream_names #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].in_app_stream_names[0] #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_processing_configuration_description.input_lambda_processor_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_processing_configuration_description.input_lambda_processor_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_streams_input_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_streams_input_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_firehose_input_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_firehose_input_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_encoding #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns[0].name #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns[0].mapping #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns[0].sql_type #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_parallelism.count #=> Integer
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_starting_position_configuration.input_starting_position #=> String, one of "NOW", "TRIM_HORIZON", "LAST_STOPPED_POINT"
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].output_id #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].name #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_streams_output_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_streams_output_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_firehose_output_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_firehose_output_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].lambda_output_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].lambda_output_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].destination_schema.record_format_type #=> String, one of "JSON", "CSV"
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_id #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].table_name #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].s3_reference_data_source_description.bucket_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].s3_reference_data_source_description.file_key #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].s3_reference_data_source_description.reference_role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_encoding #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns[0].name #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns[0].mapping #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns[0].sql_type #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_type #=> String, one of "PLAINTEXT", "ZIPFILE"
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.text_content #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.code_md5 #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.code_size #=> Integer
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description.bucket_arn #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description.file_key #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description.object_version #=> String
resp.application_detail.application_configuration_description.run_configuration_description.application_restore_configuration_description.application_restore_type #=> String, one of "SKIP_RESTORE_FROM_SNAPSHOT", "RESTORE_FROM_LATEST_SNAPSHOT", "RESTORE_FROM_CUSTOM_SNAPSHOT"
resp.application_detail.application_configuration_description.run_configuration_description.application_restore_configuration_description.snapshot_name #=> String
resp.application_detail.application_configuration_description.run_configuration_description.flink_run_configuration_description.allow_non_restored_state #=> Boolean
resp.application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.configuration_type #=> String, one of "DEFAULT", "CUSTOM"
resp.application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.checkpointing_enabled #=> Boolean
resp.application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.checkpoint_interval #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.min_pause_between_checkpoints #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description.configuration_type #=> String, one of "DEFAULT", "CUSTOM"
resp.application_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description.metrics_level #=> String, one of "APPLICATION", "TASK", "OPERATOR", "PARALLELISM"
resp.application_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description.log_level #=> String, one of "INFO", "WARN", "ERROR", "DEBUG"
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.configuration_type #=> String, one of "DEFAULT", "CUSTOM"
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.parallelism #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.parallelism_per_kpu #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.current_parallelism #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.auto_scaling_enabled #=> Boolean
resp.application_detail.application_configuration_description.flink_application_configuration_description.job_plan_description #=> String
resp.application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions #=> Array
resp.application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions[0].property_group_id #=> String
resp.application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions[0].property_map #=> Hash
resp.application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions[0].property_map["PropertyKey"] #=> String
resp.application_detail.application_configuration_description.application_snapshot_configuration_description.snapshots_enabled #=> Boolean
resp.application_detail.application_configuration_description.application_system_rollback_configuration_description.rollback_enabled #=> Boolean
resp.application_detail.application_configuration_description.vpc_configuration_descriptions #=> Array
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].vpc_configuration_id #=> String
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].vpc_id #=> String
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].subnet_ids #=> Array
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].subnet_ids[0] #=> String
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].security_group_ids #=> Array
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].security_group_ids[0] #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.monitoring_configuration_description.log_level #=> String, one of "INFO", "WARN", "ERROR", "DEBUG"
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.catalog_configuration_description.glue_data_catalog_configuration_description.database_arn #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.deploy_as_application_configuration_description.s3_content_location_description.bucket_arn #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.deploy_as_application_configuration_description.s3_content_location_description.base_path #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description #=> Array
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].artifact_type #=> String, one of "UDF", "DEPENDENCY_JAR"
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].s3_content_location_description.bucket_arn #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].s3_content_location_description.file_key #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].s3_content_location_description.object_version #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].maven_reference_description.group_id #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].maven_reference_description.artifact_id #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].maven_reference_description.version #=> 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_maintenance_configuration_description.application_maintenance_window_start_time #=> String
resp.application_detail.application_maintenance_configuration_description.application_maintenance_window_end_time #=> String
resp.application_detail.application_version_updated_from #=> Integer
resp.application_detail.application_version_rolled_back_from #=> Integer
resp.application_detail.application_version_create_timestamp #=> Time
resp.application_detail.conditional_token #=> String
resp.application_detail.application_version_rolled_back_to #=> Integer
resp.application_detail.application_mode #=> String, one of "STREAMING", "INTERACTIVE"
resp.operation_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of the application.
-
:current_application_version_id
(required, Integer)
—
The current application version ID. You can retrieve the application version ID using DescribeApplication.
Returns:
-
(Types::RollbackApplicationResponse)
—
Returns a response object which responds to the following methods:
- #application_detail => Types::ApplicationDetail
- #operation_id => String
See Also:
2590 2591 2592 2593 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 2590 def rollback_application(params = {}, options = {}) req = build_request(:rollback_application, params) req.send_request(options) end |
#start_application(params = {}) ⇒ Types::StartApplicationResponse
Starts the specified Managed Service for Apache Flink application. After creating an application, you must exclusively call this operation to start your application.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.start_application({
application_name: "ApplicationName", # required
run_configuration: {
flink_run_configuration: {
allow_non_restored_state: false,
},
sql_run_configurations: [
{
input_id: "Id", # required
input_starting_position_configuration: { # required
input_starting_position: "NOW", # accepts NOW, TRIM_HORIZON, LAST_STOPPED_POINT
},
},
],
application_restore_configuration: {
application_restore_type: "SKIP_RESTORE_FROM_SNAPSHOT", # required, accepts SKIP_RESTORE_FROM_SNAPSHOT, RESTORE_FROM_LATEST_SNAPSHOT, RESTORE_FROM_CUSTOM_SNAPSHOT
snapshot_name: "SnapshotName",
},
},
})
Response structure
Response structure
resp.operation_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of the application.
-
:run_configuration
(Types::RunConfiguration)
—
Identifies the run configuration (start parameters) of a Managed Service for Apache Flink application.
Returns:
-
(Types::StartApplicationResponse)
—
Returns a response object which responds to the following methods:
- #operation_id => String
See Also:
2641 2642 2643 2644 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 2641 def start_application(params = {}, options = {}) req = build_request(:start_application, params) req.send_request(options) end |
#stop_application(params = {}) ⇒ Types::StopApplicationResponse
Stops the application from processing data. You can stop an
application only if it is in the running status, unless you set the
Force
parameter to true
.
You can use the DescribeApplication operation to find the application status.
Managed Service for Apache Flink takes a snapshot when the application
is stopped, unless Force
is set to true
.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.stop_application({
application_name: "ApplicationName", # required
force: false,
})
Response structure
Response structure
resp.operation_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of the running application to stop.
-
:force
(Boolean)
—
Set to
true
to force the application to stop. If you setForce
totrue
, Managed Service for Apache Flink stops the application without taking a snapshot.Force-stopping your application may lead to data loss or duplication. To prevent data loss or duplicate processing of data during application restarts, we recommend you to take frequent snapshots of your application. You can only force stop a Managed Service for Apache Flink application. You can't force stop a SQL-based Kinesis Data Analytics application.
The application must be in the
STARTING
,UPDATING
,STOPPING
,AUTOSCALING
, orRUNNING
status.
Returns:
-
(Types::StopApplicationResponse)
—
Returns a response object which responds to the following methods:
- #operation_id => String
See Also:
2697 2698 2699 2700 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 2697 def stop_application(params = {}, options = {}) req = build_request(:stop_application, params) req.send_request(options) end |
#tag_resource(params = {}) ⇒ Struct
Adds one or more key-value tags to a Managed Service for Apache Flink 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.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.tag_resource({
resource_arn: "KinesisAnalyticsARN", # required
tags: [ # required
{
key: "TagKey", # required
value: "TagValue",
},
],
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:resource_arn
(required, String)
—
The ARN of the application to assign the tags.
-
:tags
(required, Array<Types::Tag>)
—
The key-value tags to assign to the application.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
2735 2736 2737 2738 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 2735 def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from a Managed Service for Apache Flink application. For more information, see Using Tagging.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.untag_resource({
resource_arn: "KinesisAnalyticsARN", # required
tag_keys: ["TagKey"], # required
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:resource_arn
(required, String)
—
The ARN of the Managed Service for Apache Flink application from which to remove the tags.
-
:tag_keys
(required, Array<String>)
—
A list of keys of tags to remove from the specified application.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
2767 2768 2769 2770 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 2767 def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end |
#update_application(params = {}) ⇒ Types::UpdateApplicationResponse
Updates an existing Managed Service for Apache Flink application. Using this operation, you can update application code, input configuration, and output configuration.
Managed Service for Apache Flink updates the ApplicationVersionId
each time you update your application.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_application({
application_name: "ApplicationName", # required
current_application_version_id: 1,
application_configuration_update: {
sql_application_configuration_update: {
input_updates: [
{
input_id: "Id", # required
name_prefix_update: "InAppStreamName",
input_processing_configuration_update: {
input_lambda_processor_update: { # required
resource_arn_update: "ResourceARN", # required
},
},
kinesis_streams_input_update: {
resource_arn_update: "ResourceARN", # required
},
kinesis_firehose_input_update: {
resource_arn_update: "ResourceARN", # required
},
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, # required
},
},
],
output_updates: [
{
output_id: "Id", # required
name_update: "InAppStreamName",
kinesis_streams_output_update: {
resource_arn_update: "ResourceARN", # required
},
kinesis_firehose_output_update: {
resource_arn_update: "ResourceARN", # required
},
lambda_output_update: {
resource_arn_update: "ResourceARN", # required
},
destination_schema_update: {
record_format_type: "JSON", # required, 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_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
},
],
},
},
],
},
application_code_configuration_update: {
code_content_type_update: "PLAINTEXT", # accepts PLAINTEXT, ZIPFILE
code_content_update: {
text_content_update: "TextContent",
zip_file_content_update: "data",
s3_content_location_update: {
bucket_arn_update: "BucketARN",
file_key_update: "FileKey",
object_version_update: "ObjectVersion",
},
},
},
flink_application_configuration_update: {
checkpoint_configuration_update: {
configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM
checkpointing_enabled_update: false,
checkpoint_interval_update: 1,
min_pause_between_checkpoints_update: 1,
},
monitoring_configuration_update: {
configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM
metrics_level_update: "APPLICATION", # accepts APPLICATION, TASK, OPERATOR, PARALLELISM
log_level_update: "INFO", # accepts INFO, WARN, ERROR, DEBUG
},
parallelism_configuration_update: {
configuration_type_update: "DEFAULT", # accepts DEFAULT, CUSTOM
parallelism_update: 1,
parallelism_per_kpu_update: 1,
auto_scaling_enabled_update: false,
},
},
environment_property_updates: {
property_groups: [ # required
{
property_group_id: "Id", # required
property_map: { # required
"PropertyKey" => "PropertyValue",
},
},
],
},
application_snapshot_configuration_update: {
snapshots_enabled_update: false, # required
},
application_system_rollback_configuration_update: {
rollback_enabled_update: false, # required
},
vpc_configuration_updates: [
{
vpc_configuration_id: "Id", # required
subnet_id_updates: ["SubnetId"],
security_group_id_updates: ["SecurityGroupId"],
},
],
zeppelin_application_configuration_update: {
monitoring_configuration_update: {
log_level_update: "INFO", # required, accepts INFO, WARN, ERROR, DEBUG
},
catalog_configuration_update: {
glue_data_catalog_configuration_update: { # required
database_arn_update: "DatabaseARN", # required
},
},
deploy_as_application_configuration_update: {
s3_content_location_update: {
bucket_arn_update: "BucketARN",
base_path_update: "BasePath",
},
},
custom_artifacts_configuration_update: [
{
artifact_type: "UDF", # required, accepts UDF, DEPENDENCY_JAR
s3_content_location: {
bucket_arn: "BucketARN", # required
file_key: "FileKey", # required
object_version: "ObjectVersion",
},
maven_reference: {
group_id: "MavenGroupId", # required
artifact_id: "MavenArtifactId", # required
version: "MavenVersion", # required
},
},
],
},
},
service_execution_role_update: "RoleARN",
run_configuration_update: {
flink_run_configuration: {
allow_non_restored_state: false,
},
application_restore_configuration: {
application_restore_type: "SKIP_RESTORE_FROM_SNAPSHOT", # required, accepts SKIP_RESTORE_FROM_SNAPSHOT, RESTORE_FROM_LATEST_SNAPSHOT, RESTORE_FROM_CUSTOM_SNAPSHOT
snapshot_name: "SnapshotName",
},
},
cloud_watch_logging_option_updates: [
{
cloud_watch_logging_option_id: "Id", # required
log_stream_arn_update: "LogStreamARN",
},
],
conditional_token: "ConditionalToken",
runtime_environment_update: "SQL-1_0", # accepts SQL-1_0, FLINK-1_6, FLINK-1_8, ZEPPELIN-FLINK-1_0, FLINK-1_11, FLINK-1_13, ZEPPELIN-FLINK-2_0, FLINK-1_15, ZEPPELIN-FLINK-3_0, FLINK-1_18, FLINK-1_19, FLINK-1_20
})
Response structure
Response structure
resp.application_detail.application_arn #=> String
resp.application_detail.application_description #=> String
resp.application_detail.application_name #=> String
resp.application_detail.runtime_environment #=> String, one of "SQL-1_0", "FLINK-1_6", "FLINK-1_8", "ZEPPELIN-FLINK-1_0", "FLINK-1_11", "FLINK-1_13", "ZEPPELIN-FLINK-2_0", "FLINK-1_15", "ZEPPELIN-FLINK-3_0", "FLINK-1_18", "FLINK-1_19", "FLINK-1_20"
resp.application_detail.service_execution_role #=> String
resp.application_detail.application_status #=> String, one of "DELETING", "STARTING", "STOPPING", "READY", "RUNNING", "UPDATING", "AUTOSCALING", "FORCE_STOPPING", "ROLLING_BACK", "MAINTENANCE", "ROLLED_BACK"
resp.application_detail.application_version_id #=> Integer
resp.application_detail.create_timestamp #=> Time
resp.application_detail.last_update_timestamp #=> Time
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_id #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].name_prefix #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].in_app_stream_names #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].in_app_stream_names[0] #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_processing_configuration_description.input_lambda_processor_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_processing_configuration_description.input_lambda_processor_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_streams_input_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_streams_input_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_firehose_input_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].kinesis_firehose_input_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_encoding #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns[0].name #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns[0].mapping #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_schema.record_columns[0].sql_type #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_parallelism.count #=> Integer
resp.application_detail.application_configuration_description.sql_application_configuration_description.input_descriptions[0].input_starting_position_configuration.input_starting_position #=> String, one of "NOW", "TRIM_HORIZON", "LAST_STOPPED_POINT"
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].output_id #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].name #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_streams_output_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_streams_output_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_firehose_output_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].kinesis_firehose_output_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].lambda_output_description.resource_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].lambda_output_description.role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.output_descriptions[0].destination_schema.record_format_type #=> String, one of "JSON", "CSV"
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_id #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].table_name #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].s3_reference_data_source_description.bucket_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].s3_reference_data_source_description.file_key #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].s3_reference_data_source_description.reference_role_arn #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.record_format_type #=> String, one of "JSON", "CSV"
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.json_mapping_parameters.record_row_path #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_row_delimiter #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_format.mapping_parameters.csv_mapping_parameters.record_column_delimiter #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_encoding #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns #=> Array
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns[0].name #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns[0].mapping #=> String
resp.application_detail.application_configuration_description.sql_application_configuration_description.reference_data_source_descriptions[0].reference_schema.record_columns[0].sql_type #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_type #=> String, one of "PLAINTEXT", "ZIPFILE"
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.text_content #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.code_md5 #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.code_size #=> Integer
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description.bucket_arn #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description.file_key #=> String
resp.application_detail.application_configuration_description.application_code_configuration_description.code_content_description.s3_application_code_location_description.object_version #=> String
resp.application_detail.application_configuration_description.run_configuration_description.application_restore_configuration_description.application_restore_type #=> String, one of "SKIP_RESTORE_FROM_SNAPSHOT", "RESTORE_FROM_LATEST_SNAPSHOT", "RESTORE_FROM_CUSTOM_SNAPSHOT"
resp.application_detail.application_configuration_description.run_configuration_description.application_restore_configuration_description.snapshot_name #=> String
resp.application_detail.application_configuration_description.run_configuration_description.flink_run_configuration_description.allow_non_restored_state #=> Boolean
resp.application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.configuration_type #=> String, one of "DEFAULT", "CUSTOM"
resp.application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.checkpointing_enabled #=> Boolean
resp.application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.checkpoint_interval #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.checkpoint_configuration_description.min_pause_between_checkpoints #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description.configuration_type #=> String, one of "DEFAULT", "CUSTOM"
resp.application_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description.metrics_level #=> String, one of "APPLICATION", "TASK", "OPERATOR", "PARALLELISM"
resp.application_detail.application_configuration_description.flink_application_configuration_description.monitoring_configuration_description.log_level #=> String, one of "INFO", "WARN", "ERROR", "DEBUG"
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.configuration_type #=> String, one of "DEFAULT", "CUSTOM"
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.parallelism #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.parallelism_per_kpu #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.current_parallelism #=> Integer
resp.application_detail.application_configuration_description.flink_application_configuration_description.parallelism_configuration_description.auto_scaling_enabled #=> Boolean
resp.application_detail.application_configuration_description.flink_application_configuration_description.job_plan_description #=> String
resp.application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions #=> Array
resp.application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions[0].property_group_id #=> String
resp.application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions[0].property_map #=> Hash
resp.application_detail.application_configuration_description.environment_property_descriptions.property_group_descriptions[0].property_map["PropertyKey"] #=> String
resp.application_detail.application_configuration_description.application_snapshot_configuration_description.snapshots_enabled #=> Boolean
resp.application_detail.application_configuration_description.application_system_rollback_configuration_description.rollback_enabled #=> Boolean
resp.application_detail.application_configuration_description.vpc_configuration_descriptions #=> Array
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].vpc_configuration_id #=> String
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].vpc_id #=> String
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].subnet_ids #=> Array
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].subnet_ids[0] #=> String
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].security_group_ids #=> Array
resp.application_detail.application_configuration_description.vpc_configuration_descriptions[0].security_group_ids[0] #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.monitoring_configuration_description.log_level #=> String, one of "INFO", "WARN", "ERROR", "DEBUG"
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.catalog_configuration_description.glue_data_catalog_configuration_description.database_arn #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.deploy_as_application_configuration_description.s3_content_location_description.bucket_arn #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.deploy_as_application_configuration_description.s3_content_location_description.base_path #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description #=> Array
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].artifact_type #=> String, one of "UDF", "DEPENDENCY_JAR"
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].s3_content_location_description.bucket_arn #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].s3_content_location_description.file_key #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].s3_content_location_description.object_version #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].maven_reference_description.group_id #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].maven_reference_description.artifact_id #=> String
resp.application_detail.application_configuration_description.zeppelin_application_configuration_description.custom_artifacts_configuration_description[0].maven_reference_description.version #=> 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_maintenance_configuration_description.application_maintenance_window_start_time #=> String
resp.application_detail.application_maintenance_configuration_description.application_maintenance_window_end_time #=> String
resp.application_detail.application_version_updated_from #=> Integer
resp.application_detail.application_version_rolled_back_from #=> Integer
resp.application_detail.application_version_create_timestamp #=> Time
resp.application_detail.conditional_token #=> String
resp.application_detail.application_version_rolled_back_to #=> Integer
resp.application_detail.application_mode #=> String, one of "STREAMING", "INTERACTIVE"
resp.operation_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of the application to update.
-
:current_application_version_id
(Integer)
—
The current application version ID. You must provide the
CurrentApplicationVersionId
or theConditionalToken
.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use theConditionalToken
parameter instead ofCurrentApplicationVersionId
. -
:application_configuration_update
(Types::ApplicationConfigurationUpdate)
—
Describes application configuration updates.
-
:service_execution_role_update
(String)
—
Describes updates to the service execution role.
-
:run_configuration_update
(Types::RunConfigurationUpdate)
—
Describes updates to the application's starting parameters.
-
:cloud_watch_logging_option_updates
(Array<Types::CloudWatchLoggingOptionUpdate>)
—
Describes application Amazon CloudWatch logging option updates. You can only update existing CloudWatch logging options with this action. To add a new CloudWatch logging option, use AddApplicationCloudWatchLoggingOption.
-
:conditional_token
(String)
—
A value you use to implement strong concurrency for application updates. You must provide the
CurrentApplicationVersionId
or theConditionalToken
. You get the application's currentConditionalToken
using DescribeApplication. For better concurrency support, use theConditionalToken
parameter instead ofCurrentApplicationVersionId
. -
:runtime_environment_update
(String)
—
Updates the Managed Service for Apache Flink runtime environment used to run your code. To avoid issues you must:
Ensure your new jar and dependencies are compatible with the new runtime selected.
Ensure your new code's state is compatible with the snapshot from which your application will start
Returns:
-
(Types::UpdateApplicationResponse)
—
Returns a response object which responds to the following methods:
- #application_detail => Types::ApplicationDetail
- #operation_id => String
See Also:
3157 3158 3159 3160 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 3157 def update_application(params = {}, options = {}) req = build_request(:update_application, params) req.send_request(options) end |
#update_application_maintenance_configuration(params = {}) ⇒ Types::UpdateApplicationMaintenanceConfigurationResponse
Updates the maintenance configuration of the Managed Service for Apache Flink application.
You can invoke this operation on an application that is in one of the
two following states: READY
or RUNNING
. If you invoke it when the
application is in a state other than these two states, it throws a
ResourceInUseException
. The service makes use of the updated
configuration the next time it schedules maintenance for the
application. If you invoke this operation after the service schedules
maintenance, the service will apply the configuration update the next
time it schedules maintenance for the application. This means that you
might not see the maintenance configuration update applied to the
maintenance process that follows a successful invocation of this
operation, but to the following maintenance process instead.
To see the current maintenance configuration of your application, invoke the DescribeApplication operation.
For information about application maintenance, see Managed Service for Apache Flink for Apache Flink Maintenance.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_application_maintenance_configuration({
application_name: "ApplicationName", # required
application_maintenance_configuration_update: { # required
application_maintenance_window_start_time_update: "ApplicationMaintenanceWindowStartTime", # required
},
})
Response structure
Response structure
resp.application_arn #=> String
resp.application_maintenance_configuration_description.application_maintenance_window_start_time #=> String
resp.application_maintenance_configuration_description.application_maintenance_window_end_time #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:application_name
(required, String)
—
The name of the application for which you want to update the maintenance configuration.
-
:application_maintenance_configuration_update
(required, Types::ApplicationMaintenanceConfigurationUpdate)
—
Describes the application maintenance configuration update.
Returns:
-
(Types::UpdateApplicationMaintenanceConfigurationResponse)
—
Returns a response object which responds to the following methods:
- #application_arn => String
- #application_maintenance_configuration_description => Types::ApplicationMaintenanceConfigurationDescription
See Also:
3222 3223 3224 3225 |
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/client.rb', line 3222 def update_application_maintenance_configuration(params = {}, options = {}) req = build_request(:update_application_maintenance_configuration, params) req.send_request(options) end |