package kinesisanalyticsv2
import "github.com/aws/aws-sdk-go-v2/service/kinesisanalyticsv2"
Package kinesisanalyticsv2 provides the API client, operations, and parameter types for Amazon Kinesis Analytics.
Amazon Kinesis Data Analytics is a fully managed service that you can use to process and analyze streaming data using Java, SQL, or Scala. The service enables you to quickly author and run Java, SQL, or Scala code against streaming sources to perform time series analytics, feed real-time dashboards, and create real-time metrics.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type AddApplicationCloudWatchLoggingOptionInput
- type AddApplicationCloudWatchLoggingOptionOutput
- type AddApplicationInputInput
- type AddApplicationInputOutput
- type AddApplicationInputProcessingConfigurationInput
- type AddApplicationInputProcessingConfigurationOutput
- type AddApplicationOutputInput
- type AddApplicationOutputOutput
- type AddApplicationReferenceDataSourceInput
- type AddApplicationReferenceDataSourceOutput
- type AddApplicationVpcConfigurationInput
- type AddApplicationVpcConfigurationOutput
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) AddApplicationCloudWatchLoggingOption(ctx context.Context, params *AddApplicationCloudWatchLoggingOptionInput, optFns ...func(*Options)) (*AddApplicationCloudWatchLoggingOptionOutput, error)
- func (c *Client) AddApplicationInput(ctx context.Context, params *AddApplicationInputInput, optFns ...func(*Options)) (*AddApplicationInputOutput, error)
- func (c *Client) AddApplicationInputProcessingConfiguration(ctx context.Context, params *AddApplicationInputProcessingConfigurationInput, optFns ...func(*Options)) (*AddApplicationInputProcessingConfigurationOutput, error)
- func (c *Client) AddApplicationOutput(ctx context.Context, params *AddApplicationOutputInput, optFns ...func(*Options)) (*AddApplicationOutputOutput, error)
- func (c *Client) AddApplicationReferenceDataSource(ctx context.Context, params *AddApplicationReferenceDataSourceInput, optFns ...func(*Options)) (*AddApplicationReferenceDataSourceOutput, error)
- func (c *Client) AddApplicationVpcConfiguration(ctx context.Context, params *AddApplicationVpcConfigurationInput, optFns ...func(*Options)) (*AddApplicationVpcConfigurationOutput, error)
- func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error)
- func (c *Client) CreateApplicationPresignedUrl(ctx context.Context, params *CreateApplicationPresignedUrlInput, optFns ...func(*Options)) (*CreateApplicationPresignedUrlOutput, error)
- func (c *Client) CreateApplicationSnapshot(ctx context.Context, params *CreateApplicationSnapshotInput, optFns ...func(*Options)) (*CreateApplicationSnapshotOutput, error)
- func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicationInput, optFns ...func(*Options)) (*DeleteApplicationOutput, error)
- func (c *Client) DeleteApplicationCloudWatchLoggingOption(ctx context.Context, params *DeleteApplicationCloudWatchLoggingOptionInput, optFns ...func(*Options)) (*DeleteApplicationCloudWatchLoggingOptionOutput, error)
- func (c *Client) DeleteApplicationInputProcessingConfiguration(ctx context.Context, params *DeleteApplicationInputProcessingConfigurationInput, optFns ...func(*Options)) (*DeleteApplicationInputProcessingConfigurationOutput, error)
- func (c *Client) DeleteApplicationOutput(ctx context.Context, params *DeleteApplicationOutputInput, optFns ...func(*Options)) (*DeleteApplicationOutputOutput, error)
- func (c *Client) DeleteApplicationReferenceDataSource(ctx context.Context, params *DeleteApplicationReferenceDataSourceInput, optFns ...func(*Options)) (*DeleteApplicationReferenceDataSourceOutput, error)
- func (c *Client) DeleteApplicationSnapshot(ctx context.Context, params *DeleteApplicationSnapshotInput, optFns ...func(*Options)) (*DeleteApplicationSnapshotOutput, error)
- func (c *Client) DeleteApplicationVpcConfiguration(ctx context.Context, params *DeleteApplicationVpcConfigurationInput, optFns ...func(*Options)) (*DeleteApplicationVpcConfigurationOutput, error)
- func (c *Client) DescribeApplication(ctx context.Context, params *DescribeApplicationInput, optFns ...func(*Options)) (*DescribeApplicationOutput, error)
- func (c *Client) DescribeApplicationSnapshot(ctx context.Context, params *DescribeApplicationSnapshotInput, optFns ...func(*Options)) (*DescribeApplicationSnapshotOutput, error)
- func (c *Client) DiscoverInputSchema(ctx context.Context, params *DiscoverInputSchemaInput, optFns ...func(*Options)) (*DiscoverInputSchemaOutput, error)
- func (c *Client) ListApplicationSnapshots(ctx context.Context, params *ListApplicationSnapshotsInput, optFns ...func(*Options)) (*ListApplicationSnapshotsOutput, error)
- func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
- func (c *Client) StartApplication(ctx context.Context, params *StartApplicationInput, optFns ...func(*Options)) (*StartApplicationOutput, error)
- func (c *Client) StopApplication(ctx context.Context, params *StopApplicationInput, optFns ...func(*Options)) (*StopApplicationOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicationInput, optFns ...func(*Options)) (*UpdateApplicationOutput, error)
- type CreateApplicationInput
- type CreateApplicationOutput
- type CreateApplicationPresignedUrlInput
- type CreateApplicationPresignedUrlOutput
- type CreateApplicationSnapshotInput
- type CreateApplicationSnapshotOutput
- type DeleteApplicationCloudWatchLoggingOptionInput
- type DeleteApplicationCloudWatchLoggingOptionOutput
- type DeleteApplicationInput
- type DeleteApplicationInputProcessingConfigurationInput
- type DeleteApplicationInputProcessingConfigurationOutput
- type DeleteApplicationOutput
- type DeleteApplicationOutputInput
- type DeleteApplicationOutputOutput
- type DeleteApplicationReferenceDataSourceInput
- type DeleteApplicationReferenceDataSourceOutput
- type DeleteApplicationSnapshotInput
- type DeleteApplicationSnapshotOutput
- type DeleteApplicationVpcConfigurationInput
- type DeleteApplicationVpcConfigurationOutput
- type DescribeApplicationInput
- type DescribeApplicationOutput
- type DescribeApplicationSnapshotInput
- type DescribeApplicationSnapshotOutput
- type DiscoverInputSchemaInput
- type DiscoverInputSchemaOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type HTTPClient
- type HTTPSignerV4
- type ListApplicationSnapshotsInput
- type ListApplicationSnapshotsOutput
- type ListApplicationsInput
- type ListApplicationsOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type StartApplicationInput
- type StartApplicationOutput
- type StopApplicationInput
- type StopApplicationOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateApplicationInput
- type UpdateApplicationOutput
Constants ¶
const ServiceAPIVersion = "2018-05-23"
const ServiceID = "Kinesis Analytics V2"
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type AddApplicationCloudWatchLoggingOptionInput ¶
type AddApplicationCloudWatchLoggingOptionInput struct { // The Kinesis Data Analytics application name. // // This member is required. ApplicationName *string // Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN). // // This member is required. CloudWatchLoggingOption *types.CloudWatchLoggingOption // The version ID of the Kinesis Data Analytics application. You can retrieve the // application version ID using DescribeApplication. // // This member is required. CurrentApplicationVersionId *int64 }
type AddApplicationCloudWatchLoggingOptionOutput ¶
type AddApplicationCloudWatchLoggingOptionOutput struct { // The application's ARN. ApplicationARN *string // The new version ID of the Kinesis Data Analytics application. Kinesis Data // Analytics updates the ApplicationVersionId each time you change the CloudWatch // logging options. ApplicationVersionId *int64 // The descriptions of the current CloudWatch logging options for the Kinesis Data // Analytics application. CloudWatchLoggingOptionDescriptions []types.CloudWatchLoggingOptionDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type AddApplicationInputInput ¶
type AddApplicationInputInput struct { // The name of your existing application to which you want to add the streaming // source. // // This member is required. ApplicationName *string // The current version of your application. You can use the DescribeApplication // operation to find the current application version. // // This member is required. CurrentApplicationVersionId *int64 // The Input to add. // // This member is required. Input *types.Input }
type AddApplicationInputOutput ¶
type AddApplicationInputOutput struct { // The Amazon Resource Name (ARN) of the application. ApplicationARN *string // Provides the current application version. ApplicationVersionId *int64 // Describes the application input configuration. InputDescriptions []types.InputDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type AddApplicationInputProcessingConfigurationInput ¶
type AddApplicationInputProcessingConfigurationInput struct { // The name of the application to which you want to add the input processing // configuration. // // This member is required. ApplicationName *string // 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. // // This member is required. CurrentApplicationVersionId *int64 // 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. // // This member is required. InputId *string // The InputProcessingConfiguration to add to the application. // // This member is required. InputProcessingConfiguration *types.InputProcessingConfiguration }
type AddApplicationInputProcessingConfigurationOutput ¶
type AddApplicationInputProcessingConfigurationOutput struct { // The Amazon Resource Name (ARN) of the application. ApplicationARN *string // Provides the current application version. ApplicationVersionId *int64 // The input ID that is associated with the application input. This is the ID that // Kinesis Data Analytics assigns to each input configuration that you add to your // application. InputId *string // The description of the preprocessor that executes on records in this input // before the application's code is run. InputProcessingConfigurationDescription *types.InputProcessingConfigurationDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type AddApplicationOutputInput ¶
type AddApplicationOutputInput struct { // The name of the application to which you want to add the output configuration. // // This member is required. ApplicationName *string // 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. // // This member is required. CurrentApplicationVersionId *int64 // 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 // AWS Lambda function), and record the formation to use when writing to the // destination. // // This member is required. Output *types.Output }
type AddApplicationOutputOutput ¶
type AddApplicationOutputOutput struct { // The application Amazon Resource Name (ARN). ApplicationARN *string // The updated application version ID. Kinesis Data Analytics increments this ID // when the application is updated. ApplicationVersionId *int64 // Describes the application output configuration. For more information, see // Configuring Application Output // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html). OutputDescriptions []types.OutputDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type AddApplicationReferenceDataSourceInput ¶
type AddApplicationReferenceDataSourceInput struct { // The name of an existing application. // // This member is required. ApplicationName *string // 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. // // This member is required. CurrentApplicationVersionId *int64 // 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. // // This member is required. ReferenceDataSource *types.ReferenceDataSource }
type AddApplicationReferenceDataSourceOutput ¶
type AddApplicationReferenceDataSourceOutput struct { // The application Amazon Resource Name (ARN). ApplicationARN *string // The updated application version ID. Kinesis Data Analytics increments this ID // when the application is updated. ApplicationVersionId *int64 // Describes reference data sources configured for the application. ReferenceDataSourceDescriptions []types.ReferenceDataSourceDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type AddApplicationVpcConfigurationInput ¶
type AddApplicationVpcConfigurationInput struct { // The name of an existing application. // // This member is required. ApplicationName *string // The version of the application to which you want to add the VPC 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. // // This member is required. CurrentApplicationVersionId *int64 // Description of the VPC to add to the application. // // This member is required. VpcConfiguration *types.VpcConfiguration }
type AddApplicationVpcConfigurationOutput ¶
type AddApplicationVpcConfigurationOutput struct { // The ARN of the application. ApplicationARN *string // Provides the current application version. Kinesis Data Analytics updates the // ApplicationVersionId each time you update the application. ApplicationVersionId *int64 // The parameters of the new VPC configuration. VpcConfigurationDescription *types.VpcConfigurationDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon Kinesis Analytics.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AddApplicationCloudWatchLoggingOption ¶
func (c *Client) AddApplicationCloudWatchLoggingOption(ctx context.Context, params *AddApplicationCloudWatchLoggingOptionInput, optFns ...func(*Options)) (*AddApplicationCloudWatchLoggingOptionOutput, error)
Adds an Amazon CloudWatch log stream to monitor application configuration errors.
func (*Client) AddApplicationInput ¶
func (c *Client) AddApplicationInput(ctx context.Context, params *AddApplicationInputInput, optFns ...func(*Options)) (*AddApplicationInputOutput, error)
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.
func (*Client) AddApplicationInputProcessingConfiguration ¶
func (c *Client) AddApplicationInputProcessingConfiguration(ctx context.Context, params *AddApplicationInputProcessingConfigurationInput, optFns ...func(*Options)) (*AddApplicationInputProcessingConfigurationOutput, error)
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 AWS Lambda (https://docs.aws.amazon.com/lambda/).
func (*Client) AddApplicationOutput ¶
func (c *Client) AddApplicationOutput(ctx context.Context, params *AddApplicationOutputInput, optFns ...func(*Options)) (*AddApplicationOutputOutput, error)
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 AWS 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.
func (*Client) AddApplicationReferenceDataSource ¶
func (c *Client) AddApplicationReferenceDataSource(ctx context.Context, params *AddApplicationReferenceDataSourceInput, optFns ...func(*Options)) (*AddApplicationReferenceDataSourceOutput, error)
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.
func (*Client) AddApplicationVpcConfiguration ¶
func (c *Client) AddApplicationVpcConfiguration(ctx context.Context, params *AddApplicationVpcConfigurationInput, optFns ...func(*Options)) (*AddApplicationVpcConfigurationOutput, error)
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 Kinesis Data Analytics applications:
* VPC configurations are not supported for SQL applications.
* When a VPC is added to a Kinesis Data Analytics 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.
func (*Client) CreateApplication ¶
func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error)
Creates a Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application (https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html).
func (*Client) CreateApplicationPresignedUrl ¶
func (c *Client) CreateApplicationPresignedUrl(ctx context.Context, params *CreateApplicationPresignedUrlInput, optFns ...func(*Options)) (*CreateApplicationPresignedUrlOutput, error)
Creates and returns a URL that you can use to connect to an application's extension. Currently, the only available extension is the Apache Flink dashboard. The IAM role or user used to call this API defines the permissions to access the extension. Once 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. The URL that you get from a call to CreateApplicationPresignedUrl must be used within 3 minutes to be valid. If you first try to use the URL after the 3-minute limit expires, the service returns an HTTP 403 Forbidden error.
func (*Client) CreateApplicationSnapshot ¶
func (c *Client) CreateApplicationSnapshot(ctx context.Context, params *CreateApplicationSnapshotInput, optFns ...func(*Options)) (*CreateApplicationSnapshotOutput, error)
Creates a snapshot of the application's state data.
func (*Client) DeleteApplication ¶
func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicationInput, optFns ...func(*Options)) (*DeleteApplicationOutput, error)
Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application.
func (*Client) DeleteApplicationCloudWatchLoggingOption ¶
func (c *Client) DeleteApplicationCloudWatchLoggingOption(ctx context.Context, params *DeleteApplicationCloudWatchLoggingOptionInput, optFns ...func(*Options)) (*DeleteApplicationCloudWatchLoggingOptionOutput, error)
Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.
func (*Client) DeleteApplicationInputProcessingConfiguration ¶
func (c *Client) DeleteApplicationInputProcessingConfiguration(ctx context.Context, params *DeleteApplicationInputProcessingConfigurationInput, optFns ...func(*Options)) (*DeleteApplicationInputProcessingConfigurationOutput, error)
Deletes an InputProcessingConfiguration from an input.
func (*Client) DeleteApplicationOutput ¶
func (c *Client) DeleteApplicationOutput(ctx context.Context, params *DeleteApplicationOutputInput, optFns ...func(*Options)) (*DeleteApplicationOutputOutput, error)
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.
func (*Client) DeleteApplicationReferenceDataSource ¶
func (c *Client) DeleteApplicationReferenceDataSource(ctx context.Context, params *DeleteApplicationReferenceDataSourceInput, optFns ...func(*Options)) (*DeleteApplicationReferenceDataSourceOutput, error)
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.
func (*Client) DeleteApplicationSnapshot ¶
func (c *Client) DeleteApplicationSnapshot(ctx context.Context, params *DeleteApplicationSnapshotInput, optFns ...func(*Options)) (*DeleteApplicationSnapshotOutput, error)
Deletes a snapshot of application state.
func (*Client) DeleteApplicationVpcConfiguration ¶
func (c *Client) DeleteApplicationVpcConfiguration(ctx context.Context, params *DeleteApplicationVpcConfigurationInput, optFns ...func(*Options)) (*DeleteApplicationVpcConfigurationOutput, error)
Removes a VPC configuration from a Kinesis Data Analytics application.
func (*Client) DescribeApplication ¶
func (c *Client) DescribeApplication(ctx context.Context, params *DescribeApplicationInput, optFns ...func(*Options)) (*DescribeApplicationOutput, error)
Returns information about a specific Kinesis Data Analytics application. If you want to retrieve a list of all applications in your account, use the ListApplications operation.
func (*Client) DescribeApplicationSnapshot ¶
func (c *Client) DescribeApplicationSnapshot(ctx context.Context, params *DescribeApplicationSnapshotInput, optFns ...func(*Options)) (*DescribeApplicationSnapshotOutput, error)
Returns information about a snapshot of application state data.
func (*Client) DiscoverInputSchema ¶
func (c *Client) DiscoverInputSchema(ctx context.Context, params *DiscoverInputSchemaInput, optFns ...func(*Options)) (*DiscoverInputSchemaOutput, error)
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.
func (*Client) ListApplicationSnapshots ¶
func (c *Client) ListApplicationSnapshots(ctx context.Context, params *ListApplicationSnapshotsInput, optFns ...func(*Options)) (*ListApplicationSnapshotsOutput, error)
Lists information about the current application snapshots.
func (*Client) ListApplications ¶
func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error)
Returns a list of Kinesis Data Analytics 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.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging (https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html).
func (*Client) StartApplication ¶
func (c *Client) StartApplication(ctx context.Context, params *StartApplicationInput, optFns ...func(*Options)) (*StartApplicationOutput, error)
Starts the specified Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application.
func (*Client) StopApplication ¶
func (c *Client) StopApplication(ctx context.Context, params *StopApplicationInput, optFns ...func(*Options)) (*StopApplicationOutput, error)
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. Kinesis Data Analytics takes a snapshot when the application is stopped, unless Force is set to true.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Adds one or more key-value tags to a Kinesis Data Analytics 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 (https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html).
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes one or more tags from a Kinesis Data Analytics application. For more information, see Using Tagging (https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html).
func (*Client) UpdateApplication ¶
func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicationInput, optFns ...func(*Options)) (*UpdateApplicationOutput, error)
Updates an existing Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration. Kinesis Data Analytics updates the ApplicationVersionId each time you update your application. You cannot update the RuntimeEnvironment of an existing application. If you need to update an application's RuntimeEnvironment, you must delete the application and create it again.
type CreateApplicationInput ¶
type CreateApplicationInput struct { // The name of your application (for example, sample-app). // // This member is required. ApplicationName *string // The runtime environment for the application (SQL-1.0, FLINK-1_6, or FLINK-1_8). // // This member is required. RuntimeEnvironment types.RuntimeEnvironment // The IAM role used by the application to access Kinesis data streams, Kinesis // Data Firehose delivery streams, Amazon S3 objects, and other external resources. // // This member is required. ServiceExecutionRole *string // Use this parameter to configure the application. ApplicationConfiguration *types.ApplicationConfiguration // A summary description of the application. ApplicationDescription *string // Use this parameter to configure an Amazon CloudWatch log stream to monitor // application configuration errors. CloudWatchLoggingOptions []types.CloudWatchLoggingOption // 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 // (https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html). Tags []types.Tag }
type CreateApplicationOutput ¶
type CreateApplicationOutput struct { // In response to your CreateApplication request, Kinesis Data Analytics returns a // response with details of the application it created. // // This member is required. ApplicationDetail *types.ApplicationDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateApplicationPresignedUrlInput ¶
type CreateApplicationPresignedUrlInput struct { // The name of the application. // // This member is required. ApplicationName *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. // // This member is required. UrlType types.UrlType // The duration in seconds for which the returned URL will be valid. SessionExpirationDurationInSeconds *int64 }
type CreateApplicationPresignedUrlOutput ¶
type CreateApplicationPresignedUrlOutput struct { // The URL of the extension. AuthorizedUrl *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateApplicationSnapshotInput ¶
type CreateApplicationSnapshotInput struct { // The name of an existing application // // This member is required. ApplicationName *string // An identifier for the application snapshot. // // This member is required. SnapshotName *string }
type CreateApplicationSnapshotOutput ¶
type CreateApplicationSnapshotOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteApplicationCloudWatchLoggingOptionInput ¶
type DeleteApplicationCloudWatchLoggingOptionInput struct { // The application name. // // This member is required. ApplicationName *string // The CloudWatchLoggingOptionId of the Amazon CloudWatch logging option to delete. // You can get the CloudWatchLoggingOptionId by using the DescribeApplication // operation. // // This member is required. CloudWatchLoggingOptionId *string // The version ID of the application. You can retrieve the application version ID // using DescribeApplication. // // This member is required. CurrentApplicationVersionId *int64 }
type DeleteApplicationCloudWatchLoggingOptionOutput ¶
type DeleteApplicationCloudWatchLoggingOptionOutput struct { // The application's Amazon Resource Name (ARN). ApplicationARN *string // The version ID of the application. Kinesis Data Analytics updates the // ApplicationVersionId each time you change the CloudWatch logging options. ApplicationVersionId *int64 // The descriptions of the remaining CloudWatch logging options for the // application. CloudWatchLoggingOptionDescriptions []types.CloudWatchLoggingOptionDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteApplicationInput ¶
type DeleteApplicationInput struct { // The name of the application to delete. // // This member is required. ApplicationName *string // Use the DescribeApplication operation to get this value. // // This member is required. CreateTimestamp *time.Time }
type DeleteApplicationInputProcessingConfigurationInput ¶
type DeleteApplicationInputProcessingConfigurationInput struct { // The name of the application. // // This member is required. ApplicationName *string // 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. // // This member is required. CurrentApplicationVersionId *int64 // 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. // // This member is required. InputId *string }
type DeleteApplicationInputProcessingConfigurationOutput ¶
type DeleteApplicationInputProcessingConfigurationOutput struct { // The Amazon Resource Name (ARN) of the application. ApplicationARN *string // The current application version ID. ApplicationVersionId *int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteApplicationOutput ¶
type DeleteApplicationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteApplicationOutputInput ¶
type DeleteApplicationOutputInput struct { // The application name. // // This member is required. ApplicationName *string // 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. // // This member is required. CurrentApplicationVersionId *int64 // 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. // // This member is required. OutputId *string }
type DeleteApplicationOutputOutput ¶
type DeleteApplicationOutputOutput struct { // The application Amazon Resource Name (ARN). ApplicationARN *string // The current application version ID. ApplicationVersionId *int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteApplicationReferenceDataSourceInput ¶
type DeleteApplicationReferenceDataSourceInput struct { // The name of an existing application. // // This member is required. ApplicationName *string // 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. // // This member is required. CurrentApplicationVersionId *int64 // 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. // // This member is required. ReferenceId *string }
type DeleteApplicationReferenceDataSourceOutput ¶
type DeleteApplicationReferenceDataSourceOutput struct { // The application Amazon Resource Name (ARN). ApplicationARN *string // The updated version ID of the application. ApplicationVersionId *int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteApplicationSnapshotInput ¶
type DeleteApplicationSnapshotInput struct { // The name of an existing application. // // This member is required. ApplicationName *string // The creation timestamp of the application snapshot to delete. You can retrieve // this value using or . // // This member is required. SnapshotCreationTimestamp *time.Time // The identifier for the snapshot delete. // // This member is required. SnapshotName *string }
type DeleteApplicationSnapshotOutput ¶
type DeleteApplicationSnapshotOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteApplicationVpcConfigurationInput ¶
type DeleteApplicationVpcConfigurationInput struct { // The name of an existing application. // // This member is required. ApplicationName *string // The current application version ID. You can retrieve the application version ID // using DescribeApplication. // // This member is required. CurrentApplicationVersionId *int64 // The ID of the VPC configuration to delete. // // This member is required. VpcConfigurationId *string }
type DeleteApplicationVpcConfigurationOutput ¶
type DeleteApplicationVpcConfigurationOutput struct { // The ARN of the Kinesis Data Analytics application. ApplicationARN *string // The updated version ID of the application. ApplicationVersionId *int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeApplicationInput ¶
type DescribeApplicationInput struct { // The name of the application. // // This member is required. ApplicationName *string // Displays verbose information about a Kinesis Data Analytics application, // including the application's job plan. IncludeAdditionalDetails *bool }
type DescribeApplicationOutput ¶
type DescribeApplicationOutput struct { // Provides a description of the application, such as the application's Amazon // Resource Name (ARN), status, and latest version. // // This member is required. ApplicationDetail *types.ApplicationDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeApplicationSnapshotInput ¶
type DescribeApplicationSnapshotInput struct { // The name of an existing application. // // This member is required. ApplicationName *string // The identifier of an application snapshot. You can retrieve this value using . // // This member is required. SnapshotName *string }
type DescribeApplicationSnapshotOutput ¶
type DescribeApplicationSnapshotOutput struct { // An object containing information about the application snapshot. // // This member is required. SnapshotDetails *types.SnapshotDetails // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DiscoverInputSchemaInput ¶
type DiscoverInputSchemaInput struct { // The ARN of the role that is used to access the streaming source. // // This member is required. ServiceExecutionRole *string // The InputProcessingConfiguration to use to preprocess the records before // discovering the schema of the records. InputProcessingConfiguration *types.InputProcessingConfiguration // The point at which you want Kinesis Data Analytics to start reading records from // the specified streaming source discovery purposes. InputStartingPositionConfiguration *types.InputStartingPositionConfiguration // The Amazon Resource Name (ARN) of the streaming source. ResourceARN *string // Specify this parameter to discover a schema from data in an Amazon S3 object. S3Configuration *types.S3Configuration }
type DiscoverInputSchemaOutput ¶
type DiscoverInputSchemaOutput struct { // The schema inferred from the streaming source. It identifies the format of the // data in the streaming source and how each data element maps to corresponding // columns in the in-application stream that you can create. InputSchema *types.SourceSchema // An array of elements, where each element corresponds to a row in a stream record // (a stream record can have more than one row). ParsedInputRecords [][]string // The stream data that was modified by the processor specified in the // InputProcessingConfiguration parameter. ProcessedInputRecords []string // The raw stream data that was sampled to infer the schema. RawInputRecords []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error }
type ListApplicationSnapshotsInput ¶
type ListApplicationSnapshotsInput struct { // The name of an existing application. // // This member is required. ApplicationName *string // The maximum number of application snapshots to list. Limit *int32 // 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's NextToken response to indicate where the output should continue // from. NextToken *string }
type ListApplicationSnapshotsOutput ¶
type ListApplicationSnapshotsOutput struct { // The token for the next set of results, or null if there are no additional // results. NextToken *string // A collection of objects containing information about the application snapshots. SnapshotSummaries []types.SnapshotDetails // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListApplicationsInput ¶
type ListApplicationsInput struct { // The maximum number of applications to list. Limit *int32 // 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 AWS Command Line Interface's Pagination Options // (https://docs.aws.amazon.com/cli/latest/userguide/pagination.html). NextToken *string }
type ListApplicationsOutput ¶
type ListApplicationsOutput struct { // A list of ApplicationSummary objects. // // This member is required. ApplicationSummaries []types.ApplicationSummary // The pagination token for the next set of results, or null if there are no // additional results. Pass this token into a subsequent command to retrieve the // next set of items For more information about pagination, see Using the AWS // Command Line Interface's Pagination Options // (https://docs.aws.amazon.com/cli/latest/userguide/pagination.html). NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The ARN of the application for which to retrieve tags. // // This member is required. ResourceARN *string }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // The key-value tags assigned to the application. Tags []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer aws.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type StartApplicationInput ¶
type StartApplicationInput struct { // The name of the application. // // This member is required. ApplicationName *string // Identifies the run configuration (start parameters) of a Kinesis Data Analytics // application. // // This member is required. RunConfiguration *types.RunConfiguration }
type StartApplicationOutput ¶
type StartApplicationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type StopApplicationInput ¶
type StopApplicationInput struct { // The name of the running application to stop. // // This member is required. ApplicationName *string // Set to true to force the application to stop. If you set Force to true, Kinesis // Data Analytics 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 // Flink-based Kinesis Data Analytics application. You can't force stop a SQL-based // Kinesis Data Analytics application. The application must be in the STARTING, // UPDATING, STOPPING, AUTOSCALING, or RUNNING status. Force *bool }
type StopApplicationOutput ¶
type StopApplicationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type TagResourceInput ¶
type TagResourceInput struct { // The ARN of the application to assign the tags. // // This member is required. ResourceARN *string // The key-value tags to assign to the application. // // This member is required. Tags []types.Tag }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UntagResourceInput ¶
type UntagResourceInput struct { // The ARN of the Kinesis Data Analytics application from which to remove the tags. // // This member is required. ResourceARN *string // A list of keys of tags to remove from the specified application. // // This member is required. TagKeys []string }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateApplicationInput ¶
type UpdateApplicationInput struct { // The name of the application to update. // // This member is required. ApplicationName *string // The current application version ID. You can retrieve the application version ID // using DescribeApplication. // // This member is required. CurrentApplicationVersionId *int64 // Describes application configuration updates. ApplicationConfigurationUpdate *types.ApplicationConfigurationUpdate // 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. CloudWatchLoggingOptionUpdates []types.CloudWatchLoggingOptionUpdate // Describes updates to the application's starting parameters. RunConfigurationUpdate *types.RunConfigurationUpdate // Describes updates to the service execution role. ServiceExecutionRoleUpdate *string }
type UpdateApplicationOutput ¶
type UpdateApplicationOutput struct { // Describes application updates. // // This member is required. ApplicationDetail *types.ApplicationDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
api_client.go api_op_AddApplicationCloudWatchLoggingOption.go api_op_AddApplicationInput.go api_op_AddApplicationInputProcessingConfiguration.go api_op_AddApplicationOutput.go api_op_AddApplicationReferenceDataSource.go api_op_AddApplicationVpcConfiguration.go api_op_CreateApplication.go api_op_CreateApplicationPresignedUrl.go api_op_CreateApplicationSnapshot.go api_op_DeleteApplication.go api_op_DeleteApplicationCloudWatchLoggingOption.go api_op_DeleteApplicationInputProcessingConfiguration.go api_op_DeleteApplicationOutput.go api_op_DeleteApplicationReferenceDataSource.go api_op_DeleteApplicationSnapshot.go api_op_DeleteApplicationVpcConfiguration.go api_op_DescribeApplication.go api_op_DescribeApplicationSnapshot.go api_op_DiscoverInputSchema.go api_op_ListApplicationSnapshots.go api_op_ListApplications.go api_op_ListTagsForResource.go api_op_StartApplication.go api_op_StopApplication.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateApplication.go deserializers.go doc.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v1.1.4
- Published
- Apr 2, 2021
- Platform
- js/wasm
- Imports
- 27 packages
- Last checked
- now –
Tools for package owners.