Documentation ¶
Overview ¶
Package kinesisanalytics provides the client and types for making API requests to Kinesis Analytics.
Overview ¶
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
This is the Amazon Kinesis Analytics v1 API Reference. The Amazon Kinesis Analytics Developer Guide provides additional information.
See https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14 for more information on this service.
See kinesisanalytics package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/kinesisanalytics/
Using the Client ¶
To use Kinesis Analytics with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Kinesis Analytics client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/kinesisanalytics/#New
Index ¶
- Constants
- type AddApplicationCloudWatchLoggingOptionInput
- type AddApplicationCloudWatchLoggingOptionOutput
- type AddApplicationCloudWatchLoggingOptionRequest
- type AddApplicationCloudWatchLoggingOptionResponse
- type AddApplicationInputInput
- type AddApplicationInputOutput
- type AddApplicationInputProcessingConfigurationInput
- type AddApplicationInputProcessingConfigurationOutput
- type AddApplicationInputProcessingConfigurationRequest
- type AddApplicationInputProcessingConfigurationResponse
- type AddApplicationInputRequest
- type AddApplicationInputResponse
- type AddApplicationOutputInput
- type AddApplicationOutputOutput
- type AddApplicationOutputRequest
- type AddApplicationOutputResponse
- type AddApplicationReferenceDataSourceInput
- type AddApplicationReferenceDataSourceOutput
- type AddApplicationReferenceDataSourceRequest
- type AddApplicationReferenceDataSourceResponse
- type ApplicationDetail
- type ApplicationStatus
- type ApplicationSummary
- type ApplicationUpdate
- type CSVMappingParameters
- type Client
- func (c *Client) AddApplicationCloudWatchLoggingOptionRequest(input *AddApplicationCloudWatchLoggingOptionInput) AddApplicationCloudWatchLoggingOptionRequest
- func (c *Client) AddApplicationInputProcessingConfigurationRequest(input *AddApplicationInputProcessingConfigurationInput) AddApplicationInputProcessingConfigurationRequest
- func (c *Client) AddApplicationInputRequest(input *AddApplicationInputInput) AddApplicationInputRequest
- func (c *Client) AddApplicationOutputRequest(input *AddApplicationOutputInput) AddApplicationOutputRequest
- func (c *Client) AddApplicationReferenceDataSourceRequest(input *AddApplicationReferenceDataSourceInput) AddApplicationReferenceDataSourceRequest
- func (c *Client) CreateApplicationRequest(input *CreateApplicationInput) CreateApplicationRequest
- func (c *Client) DeleteApplicationCloudWatchLoggingOptionRequest(input *DeleteApplicationCloudWatchLoggingOptionInput) DeleteApplicationCloudWatchLoggingOptionRequest
- func (c *Client) DeleteApplicationInputProcessingConfigurationRequest(input *DeleteApplicationInputProcessingConfigurationInput) DeleteApplicationInputProcessingConfigurationRequest
- func (c *Client) DeleteApplicationOutputRequest(input *DeleteApplicationOutputInput) DeleteApplicationOutputRequest
- func (c *Client) DeleteApplicationReferenceDataSourceRequest(input *DeleteApplicationReferenceDataSourceInput) DeleteApplicationReferenceDataSourceRequest
- func (c *Client) DeleteApplicationRequest(input *DeleteApplicationInput) DeleteApplicationRequest
- func (c *Client) DescribeApplicationRequest(input *DescribeApplicationInput) DescribeApplicationRequest
- func (c *Client) DiscoverInputSchemaRequest(input *DiscoverInputSchemaInput) DiscoverInputSchemaRequest
- func (c *Client) ListApplicationsRequest(input *ListApplicationsInput) ListApplicationsRequest
- func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
- func (c *Client) StartApplicationRequest(input *StartApplicationInput) StartApplicationRequest
- func (c *Client) StopApplicationRequest(input *StopApplicationInput) StopApplicationRequest
- func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
- func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
- func (c *Client) UpdateApplicationRequest(input *UpdateApplicationInput) UpdateApplicationRequest
- type CloudWatchLoggingOption
- type CloudWatchLoggingOptionDescription
- type CloudWatchLoggingOptionUpdate
- type CreateApplicationInput
- type CreateApplicationOutput
- type CreateApplicationRequest
- type CreateApplicationResponse
- type DeleteApplicationCloudWatchLoggingOptionInput
- type DeleteApplicationCloudWatchLoggingOptionOutput
- type DeleteApplicationCloudWatchLoggingOptionRequest
- type DeleteApplicationCloudWatchLoggingOptionResponse
- type DeleteApplicationInput
- type DeleteApplicationInputProcessingConfigurationInput
- type DeleteApplicationInputProcessingConfigurationOutput
- type DeleteApplicationInputProcessingConfigurationRequest
- type DeleteApplicationInputProcessingConfigurationResponse
- type DeleteApplicationOutput
- type DeleteApplicationOutputInput
- type DeleteApplicationOutputOutput
- type DeleteApplicationOutputRequest
- type DeleteApplicationOutputResponse
- type DeleteApplicationReferenceDataSourceInput
- type DeleteApplicationReferenceDataSourceOutput
- type DeleteApplicationReferenceDataSourceRequest
- type DeleteApplicationReferenceDataSourceResponse
- type DeleteApplicationRequest
- type DeleteApplicationResponse
- type DescribeApplicationInput
- type DescribeApplicationOutput
- type DescribeApplicationRequest
- type DescribeApplicationResponse
- type DestinationSchema
- type DiscoverInputSchemaInput
- type DiscoverInputSchemaOutput
- type DiscoverInputSchemaRequest
- type DiscoverInputSchemaResponse
- type Input
- type InputConfiguration
- type InputDescription
- type InputLambdaProcessor
- type InputLambdaProcessorDescription
- type InputLambdaProcessorUpdate
- type InputParallelism
- type InputParallelismUpdate
- type InputProcessingConfiguration
- type InputProcessingConfigurationDescription
- type InputProcessingConfigurationUpdate
- type InputSchemaUpdate
- type InputStartingPosition
- type InputStartingPositionConfiguration
- type InputUpdate
- type JSONMappingParameters
- type KinesisFirehoseInput
- type KinesisFirehoseInputDescription
- type KinesisFirehoseInputUpdate
- type KinesisFirehoseOutput
- type KinesisFirehoseOutputDescription
- type KinesisFirehoseOutputUpdate
- type KinesisStreamsInput
- type KinesisStreamsInputDescription
- type KinesisStreamsInputUpdate
- type KinesisStreamsOutput
- type KinesisStreamsOutputDescription
- type KinesisStreamsOutputUpdate
- type LambdaOutput
- type LambdaOutputDescription
- type LambdaOutputUpdate
- type ListApplicationsInput
- type ListApplicationsOutput
- type ListApplicationsRequest
- type ListApplicationsResponse
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTagsForResourceRequest
- type ListTagsForResourceResponse
- type MappingParameters
- type Output
- type OutputDescription
- type OutputUpdate
- type RecordColumn
- type RecordFormat
- type RecordFormatType
- type ReferenceDataSource
- type ReferenceDataSourceDescription
- type ReferenceDataSourceUpdate
- type S3Configuration
- type S3ReferenceDataSource
- type S3ReferenceDataSourceDescription
- type S3ReferenceDataSourceUpdate
- type SourceSchema
- type StartApplicationInput
- type StartApplicationOutput
- type StartApplicationRequest
- type StartApplicationResponse
- type StopApplicationInput
- type StopApplicationOutput
- type StopApplicationRequest
- type StopApplicationResponse
- type Tag
- type TagResourceInput
- type TagResourceOutput
- type TagResourceRequest
- type TagResourceResponse
- type UntagResourceInput
- type UntagResourceOutput
- type UntagResourceRequest
- type UntagResourceResponse
- type UpdateApplicationInput
- type UpdateApplicationOutput
- type UpdateApplicationRequest
- type UpdateApplicationResponse
Constants ¶
const ( ServiceName = "Kinesis Analytics" // Service's name ServiceID = "KinesisAnalytics" // Service's identifier EndpointsID = "kinesisanalytics" // Service's Endpoint identifier )
const ( // ErrCodeCodeValidationException for service response error code // "CodeValidationException". // // User-provided application code (query) is invalid. This can be a simple syntax // error. ErrCodeCodeValidationException = "CodeValidationException" // ErrCodeConcurrentModificationException for service response error code // "ConcurrentModificationException". // // Exception thrown as a result of concurrent modification to an application. // For example, two individuals attempting to edit the same application at the // same time. ErrCodeConcurrentModificationException = "ConcurrentModificationException" // ErrCodeInvalidApplicationConfigurationException for service response error code // "InvalidApplicationConfigurationException". // // User-provided application configuration is not valid. ErrCodeInvalidApplicationConfigurationException = "InvalidApplicationConfigurationException" // ErrCodeInvalidArgumentException for service response error code // "InvalidArgumentException". // // Specified input parameter value is invalid. ErrCodeInvalidArgumentException = "InvalidArgumentException" // ErrCodeLimitExceededException for service response error code // "LimitExceededException". // // Exceeded the number of applications allowed. ErrCodeLimitExceededException = "LimitExceededException" // ErrCodeResourceInUseException for service response error code // "ResourceInUseException". // // Application is not available for this operation. ErrCodeResourceInUseException = "ResourceInUseException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // // Specified application can't be found. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeResourceProvisionedThroughputExceededException for service response error code // "ResourceProvisionedThroughputExceededException". // // Discovery failed to get a record from the streaming source because of the // Amazon Kinesis Streams ProvisionedThroughputExceededException. For more information, // see GetRecords (https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html) // in the Amazon Kinesis Streams API Reference. ErrCodeResourceProvisionedThroughputExceededException = "ResourceProvisionedThroughputExceededException" // "ServiceUnavailableException". // // The service is unavailable. Back off and retry the operation. ErrCodeServiceUnavailableException = "ServiceUnavailableException" // ErrCodeTooManyTagsException for service response error code // "TooManyTagsException". // // Application created with too many tags, or too many tags added to an application. // Note that the maximum number of application tags includes system tags. The // maximum number of user-defined application tags is 50. ErrCodeTooManyTagsException = "TooManyTagsException" // ErrCodeUnableToDetectSchemaException for service response error code // "UnableToDetectSchemaException". // // Data format is not valid. Amazon Kinesis Analytics is not able to detect // schema for the given streaming source. ErrCodeUnableToDetectSchemaException = "UnableToDetectSchemaException" // ErrCodeUnsupportedOperationException for service response error code // "UnsupportedOperationException". // // The request was rejected because a specified parameter is not supported or // a specified resource is not valid for this operation. ErrCodeUnsupportedOperationException = "UnsupportedOperationException" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddApplicationCloudWatchLoggingOptionInput ¶
type AddApplicationCloudWatchLoggingOptionInput struct { // The Kinesis Analytics application name. // // ApplicationName is a required field ApplicationName *string `min:"1" type:"string" required:"true"` // Provides the CloudWatch log stream Amazon Resource Name (ARN) and the IAM // role ARN. Note: To write application messages to CloudWatch, the IAM role // that is used must have the PutLogEvents policy action enabled. // // CloudWatchLoggingOption is a required field CloudWatchLoggingOption *CloudWatchLoggingOption `type:"structure" required:"true"` // The version ID of the Kinesis Analytics application. // // CurrentApplicationVersionId is a required field CurrentApplicationVersionId *int64 `min:"1" type:"long" required:"true"` // contains filtered or unexported fields }
func (AddApplicationCloudWatchLoggingOptionInput) String ¶
func (s AddApplicationCloudWatchLoggingOptionInput) String() string
String returns the string representation
func (*AddApplicationCloudWatchLoggingOptionInput) Validate ¶
func (s *AddApplicationCloudWatchLoggingOptionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddApplicationCloudWatchLoggingOptionOutput ¶
type AddApplicationCloudWatchLoggingOptionOutput struct {
// contains filtered or unexported fields
}
func (AddApplicationCloudWatchLoggingOptionOutput) String ¶
func (s AddApplicationCloudWatchLoggingOptionOutput) String() string
String returns the string representation
type AddApplicationCloudWatchLoggingOptionRequest ¶
type AddApplicationCloudWatchLoggingOptionRequest struct { *aws.Request Input *AddApplicationCloudWatchLoggingOptionInput Copy func(*AddApplicationCloudWatchLoggingOptionInput) AddApplicationCloudWatchLoggingOptionRequest }
AddApplicationCloudWatchLoggingOptionRequest is the request type for the AddApplicationCloudWatchLoggingOption API operation.
func (AddApplicationCloudWatchLoggingOptionRequest) Send ¶
func (r AddApplicationCloudWatchLoggingOptionRequest) Send(ctx context.Context) (*AddApplicationCloudWatchLoggingOptionResponse, error)
Send marshals and sends the AddApplicationCloudWatchLoggingOption API request.
type AddApplicationCloudWatchLoggingOptionResponse ¶ added in v0.9.0
type AddApplicationCloudWatchLoggingOptionResponse struct { *AddApplicationCloudWatchLoggingOptionOutput // contains filtered or unexported fields }
AddApplicationCloudWatchLoggingOptionResponse is the response type for the AddApplicationCloudWatchLoggingOption API operation.
func (*AddApplicationCloudWatchLoggingOptionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *AddApplicationCloudWatchLoggingOptionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the AddApplicationCloudWatchLoggingOption request.
type AddApplicationInputInput ¶
type AddApplicationInputInput struct { // Name of your existing Amazon Kinesis Analytics application to which you want // to add the streaming source. // // ApplicationName is a required field ApplicationName *string `min:"1" type:"string" required:"true"` // Current version of your Amazon Kinesis Analytics application. You can use // the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to find the current application version. // // CurrentApplicationVersionId is a required field CurrentApplicationVersionId *int64 `min:"1" type:"long" required:"true"` // The Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_Input.html) // to add. // // Input is a required field Input *Input `type:"structure" required:"true"` // contains filtered or unexported fields }
func (AddApplicationInputInput) String ¶
func (s AddApplicationInputInput) String() string
String returns the string representation
func (*AddApplicationInputInput) Validate ¶
func (s *AddApplicationInputInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddApplicationInputOutput ¶
type AddApplicationInputOutput struct {
// contains filtered or unexported fields
}
func (AddApplicationInputOutput) String ¶
func (s AddApplicationInputOutput) String() string
String returns the string representation
type AddApplicationInputProcessingConfigurationInput ¶
type AddApplicationInputProcessingConfigurationInput struct { // Name of the application to which you want to add the input processing configuration. // // ApplicationName is a required field ApplicationName *string `min:"1" type:"string" required:"true"` // Version of the application to which you want to add the input processing // configuration. You can use the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to get the current application version. If the version specified // is not the current version, the ConcurrentModificationException is returned. // // CurrentApplicationVersionId is a required field CurrentApplicationVersionId *int64 `min:"1" type:"long" required:"true"` // 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 // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation. // // InputId is a required field InputId *string `min:"1" type:"string" required:"true"` // The InputProcessingConfiguration (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) // to add to the application. // // InputProcessingConfiguration is a required field InputProcessingConfiguration *InputProcessingConfiguration `type:"structure" required:"true"` // contains filtered or unexported fields }
func (AddApplicationInputProcessingConfigurationInput) String ¶
func (s AddApplicationInputProcessingConfigurationInput) String() string
String returns the string representation
func (*AddApplicationInputProcessingConfigurationInput) Validate ¶
func (s *AddApplicationInputProcessingConfigurationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddApplicationInputProcessingConfigurationOutput ¶
type AddApplicationInputProcessingConfigurationOutput struct {
// contains filtered or unexported fields
}
func (AddApplicationInputProcessingConfigurationOutput) String ¶
func (s AddApplicationInputProcessingConfigurationOutput) String() string
String returns the string representation
type AddApplicationInputProcessingConfigurationRequest ¶
type AddApplicationInputProcessingConfigurationRequest struct { *aws.Request Input *AddApplicationInputProcessingConfigurationInput Copy func(*AddApplicationInputProcessingConfigurationInput) AddApplicationInputProcessingConfigurationRequest }
AddApplicationInputProcessingConfigurationRequest is the request type for the AddApplicationInputProcessingConfiguration API operation.
func (AddApplicationInputProcessingConfigurationRequest) Send ¶
func (r AddApplicationInputProcessingConfigurationRequest) Send(ctx context.Context) (*AddApplicationInputProcessingConfigurationResponse, error)
Send marshals and sends the AddApplicationInputProcessingConfiguration API request.
type AddApplicationInputProcessingConfigurationResponse ¶ added in v0.9.0
type AddApplicationInputProcessingConfigurationResponse struct { *AddApplicationInputProcessingConfigurationOutput // contains filtered or unexported fields }
AddApplicationInputProcessingConfigurationResponse is the response type for the AddApplicationInputProcessingConfiguration API operation.
func (*AddApplicationInputProcessingConfigurationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *AddApplicationInputProcessingConfigurationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the AddApplicationInputProcessingConfiguration request.
type AddApplicationInputRequest ¶
type AddApplicationInputRequest struct { *aws.Request Input *AddApplicationInputInput Copy func(*AddApplicationInputInput) AddApplicationInputRequest }
AddApplicationInputRequest is the request type for the AddApplicationInput API operation.
func (AddApplicationInputRequest) Send ¶
func (r AddApplicationInputRequest) Send(ctx context.Context) (*AddApplicationInputResponse, error)
Send marshals and sends the AddApplicationInput API request.
type AddApplicationInputResponse ¶ added in v0.9.0
type AddApplicationInputResponse struct { *AddApplicationInputOutput // contains filtered or unexported fields }
AddApplicationInputResponse is the response type for the AddApplicationInput API operation.
func (*AddApplicationInputResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *AddApplicationInputResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the AddApplicationInput request.
type AddApplicationOutputInput ¶
type AddApplicationOutputInput struct { // Name of the application to which you want to add the output configuration. // // ApplicationName is a required field ApplicationName *string `min:"1" type:"string" required:"true"` // Version of the application to which you want to add the output configuration. // You can use the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to get the current application version. If the version specified // is not the current version, the ConcurrentModificationException is returned. // // CurrentApplicationVersionId is a required field CurrentApplicationVersionId *int64 `min:"1" type:"long" required:"true"` // 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, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, // or an AWS Lambda function), and record the formation to use when writing // to the destination. // // Output is a required field Output *Output `type:"structure" required:"true"` // contains filtered or unexported fields }
func (AddApplicationOutputInput) String ¶
func (s AddApplicationOutputInput) String() string
String returns the string representation
func (*AddApplicationOutputInput) Validate ¶
func (s *AddApplicationOutputInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddApplicationOutputOutput ¶
type AddApplicationOutputOutput struct {
// contains filtered or unexported fields
}
func (AddApplicationOutputOutput) String ¶
func (s AddApplicationOutputOutput) String() string
String returns the string representation
type AddApplicationOutputRequest ¶
type AddApplicationOutputRequest struct { *aws.Request Input *AddApplicationOutputInput Copy func(*AddApplicationOutputInput) AddApplicationOutputRequest }
AddApplicationOutputRequest is the request type for the AddApplicationOutput API operation.
func (AddApplicationOutputRequest) Send ¶
func (r AddApplicationOutputRequest) Send(ctx context.Context) (*AddApplicationOutputResponse, error)
Send marshals and sends the AddApplicationOutput API request.
type AddApplicationOutputResponse ¶ added in v0.9.0
type AddApplicationOutputResponse struct { *AddApplicationOutputOutput // contains filtered or unexported fields }
AddApplicationOutputResponse is the response type for the AddApplicationOutput API operation.
func (*AddApplicationOutputResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *AddApplicationOutputResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the AddApplicationOutput request.
type AddApplicationReferenceDataSourceInput ¶
type AddApplicationReferenceDataSourceInput struct { // Name of an existing application. // // ApplicationName is a required field ApplicationName *string `min:"1" type:"string" required:"true"` // Version of the application for which you are adding the reference data source. // You can use the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to get the current application version. If the version specified // is not the current version, the ConcurrentModificationException is returned. // // CurrentApplicationVersionId is a required field CurrentApplicationVersionId *int64 `min:"1" type:"long" required:"true"` // The reference data source can be an object in your Amazon S3 bucket. Amazon // Kinesis 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. You must also provide an // IAM role with the necessary permissions that Amazon Kinesis Analytics can // assume to read the object from your S3 bucket on your behalf. // // ReferenceDataSource is a required field ReferenceDataSource *ReferenceDataSource `type:"structure" required:"true"` // contains filtered or unexported fields }
func (AddApplicationReferenceDataSourceInput) String ¶
func (s AddApplicationReferenceDataSourceInput) String() string
String returns the string representation
func (*AddApplicationReferenceDataSourceInput) Validate ¶
func (s *AddApplicationReferenceDataSourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddApplicationReferenceDataSourceOutput ¶
type AddApplicationReferenceDataSourceOutput struct {
// contains filtered or unexported fields
}
func (AddApplicationReferenceDataSourceOutput) String ¶
func (s AddApplicationReferenceDataSourceOutput) String() string
String returns the string representation
type AddApplicationReferenceDataSourceRequest ¶
type AddApplicationReferenceDataSourceRequest struct { *aws.Request Input *AddApplicationReferenceDataSourceInput Copy func(*AddApplicationReferenceDataSourceInput) AddApplicationReferenceDataSourceRequest }
AddApplicationReferenceDataSourceRequest is the request type for the AddApplicationReferenceDataSource API operation.
func (AddApplicationReferenceDataSourceRequest) Send ¶
func (r AddApplicationReferenceDataSourceRequest) Send(ctx context.Context) (*AddApplicationReferenceDataSourceResponse, error)
Send marshals and sends the AddApplicationReferenceDataSource API request.
type AddApplicationReferenceDataSourceResponse ¶ added in v0.9.0
type AddApplicationReferenceDataSourceResponse struct { *AddApplicationReferenceDataSourceOutput // contains filtered or unexported fields }
AddApplicationReferenceDataSourceResponse is the response type for the AddApplicationReferenceDataSource API operation.
func (*AddApplicationReferenceDataSourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *AddApplicationReferenceDataSourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the AddApplicationReferenceDataSource request.
type ApplicationDetail ¶
type ApplicationDetail struct { // ARN of the application. // // ApplicationARN is a required field ApplicationARN *string `min:"1" type:"string" required:"true"` // Returns the application code that you provided to perform data analysis on // any of the in-application streams in your application. ApplicationCode *string `type:"string"` // Description of the application. ApplicationDescription *string `type:"string"` // Name of the application. // // ApplicationName is a required field ApplicationName *string `min:"1" type:"string" required:"true"` // Status of the application. // // ApplicationStatus is a required field ApplicationStatus ApplicationStatus `type:"string" required:"true" enum:"true"` // Provides the current application version. // // ApplicationVersionId is a required field ApplicationVersionId *int64 `min:"1" type:"long" required:"true"` // Describes the CloudWatch log streams that are configured to receive application // messages. For more information about using CloudWatch log streams with Amazon // Kinesis Analytics applications, see Working with Amazon CloudWatch Logs (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html). CloudWatchLoggingOptionDescriptions []CloudWatchLoggingOptionDescription `type:"list"` // Time stamp when the application version was created. CreateTimestamp *time.Time `type:"timestamp"` // Describes the application input configuration. For more information, see // Configuring Application Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). InputDescriptions []InputDescription `type:"list"` // Time stamp when the application was last updated. LastUpdateTimestamp *time.Time `type:"timestamp"` // 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 []OutputDescription `type:"list"` // Describes reference data sources configured for the application. For more // information, see Configuring Application Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). ReferenceDataSourceDescriptions []ReferenceDataSourceDescription `type:"list"` // contains filtered or unexported fields }
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Provides a description of the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configuration.
func (ApplicationDetail) String ¶
func (s ApplicationDetail) String() string
String returns the string representation
type ApplicationStatus ¶
type ApplicationStatus string
const ( ApplicationStatusDeleting ApplicationStatus = "DELETING" ApplicationStatusStarting ApplicationStatus = "STARTING" ApplicationStatusStopping ApplicationStatus = "STOPPING" ApplicationStatusReady ApplicationStatus = "READY" ApplicationStatusRunning ApplicationStatus = "RUNNING" ApplicationStatusUpdating ApplicationStatus = "UPDATING" )
Enum values for ApplicationStatus
func (ApplicationStatus) MarshalValue ¶ added in v0.3.0
func (enum ApplicationStatus) MarshalValue() (string, error)
func (ApplicationStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum ApplicationStatus) MarshalValueBuf(b []byte) ([]byte, error)
type ApplicationSummary ¶
type ApplicationSummary struct { // ARN of the application. // // ApplicationARN is a required field ApplicationARN *string `min:"1" type:"string" required:"true"` // Name of the application. // // ApplicationName is a required field ApplicationName *string `min:"1" type:"string" required:"true"` // Status of the application. // // ApplicationStatus is a required field ApplicationStatus ApplicationStatus `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.
func (ApplicationSummary) String ¶
func (s ApplicationSummary) String() string
String returns the string representation
type ApplicationUpdate ¶
type ApplicationUpdate struct { // Describes application code updates. ApplicationCodeUpdate *string `type:"string"` // Describes application CloudWatch logging option updates. CloudWatchLoggingOptionUpdates []CloudWatchLoggingOptionUpdate `type:"list"` // Describes application input configuration updates. InputUpdates []InputUpdate `type:"list"` // Describes application output configuration updates. OutputUpdates []OutputUpdate `type:"list"` // Describes application reference data source updates. ReferenceDataSourceUpdates []ReferenceDataSourceUpdate `type:"list"` // contains filtered or unexported fields }
Describes updates to apply to an existing Amazon Kinesis Analytics application.
func (ApplicationUpdate) String ¶
func (s ApplicationUpdate) String() string
String returns the string representation
func (*ApplicationUpdate) Validate ¶
func (s *ApplicationUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CSVMappingParameters ¶
type CSVMappingParameters struct { // Column delimiter. For example, in a CSV format, a comma (",") is the typical // column delimiter. // // RecordColumnDelimiter is a required field RecordColumnDelimiter *string `min:"1" type:"string" required:"true"` // Row delimiter. For example, in a CSV format, '\n' is the typical row delimiter. // // RecordRowDelimiter is a required field RecordRowDelimiter *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the '\n' as the row delimiter and a comma (",") as the column delimiter:
"name1", "address1"
"name2", "address2"
func (CSVMappingParameters) String ¶
func (s CSVMappingParameters) String() string
String returns the string representation
func (*CSVMappingParameters) Validate ¶
func (s *CSVMappingParameters) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Client ¶ added in v0.9.0
Client provides the API operation methods for making requests to Kinesis Analytics. See this package's package overview docs for details on the service.
The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the client from the provided Config.
Example:
// Create a client from just a config. svc := kinesisanalytics.New(myConfig)
func (*Client) AddApplicationCloudWatchLoggingOptionRequest ¶ added in v0.9.0
func (c *Client) AddApplicationCloudWatchLoggingOptionRequest(input *AddApplicationCloudWatchLoggingOptionInput) AddApplicationCloudWatchLoggingOptionRequest
AddApplicationCloudWatchLoggingOptionRequest returns a request value for making API operation for Amazon Kinesis Analytics.
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html).
// Example sending a request using AddApplicationCloudWatchLoggingOptionRequest. req := client.AddApplicationCloudWatchLoggingOptionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/AddApplicationCloudWatchLoggingOption
func (*Client) AddApplicationInputProcessingConfigurationRequest ¶ added in v0.9.0
func (c *Client) AddApplicationInputProcessingConfigurationRequest(input *AddApplicationInputProcessingConfigurationInput) AddApplicationInputProcessingConfigurationRequest
AddApplicationInputProcessingConfigurationRequest returns a request value for making API operation for Amazon Kinesis Analytics.
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Adds an InputProcessingConfiguration (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) to an application. An input processor preprocesses 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/).
// Example sending a request using AddApplicationInputProcessingConfigurationRequest. req := client.AddApplicationInputProcessingConfigurationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/AddApplicationInputProcessingConfiguration
func (*Client) AddApplicationInputRequest ¶ added in v0.9.0
func (c *Client) AddApplicationInputRequest(input *AddApplicationInputInput) AddApplicationInputRequest
AddApplicationInputRequest returns a request value for making API operation for Amazon Kinesis Analytics.
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Adds a streaming source to your Amazon Kinesis application. For conceptual information, see Configuring Application Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).
You can add a streaming source either 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 (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_CreateApplication.html).
Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation to find the current application version.
This operation requires permissions to perform the kinesisanalytics:AddApplicationInput action.
// Example sending a request using AddApplicationInputRequest. req := client.AddApplicationInputRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/AddApplicationInput
func (*Client) AddApplicationOutputRequest ¶ added in v0.9.0
func (c *Client) AddApplicationOutputRequest(input *AddApplicationOutputInput) AddApplicationOutputRequest
AddApplicationOutputRequest returns a request value for making API operation for Amazon Kinesis Analytics.
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Adds an external destination to your Amazon Kinesis Analytics application.
If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis 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. For more information, see Understanding Application Output (Destination) (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html).
Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation to find the current application version.
For the limits on the number of application inputs and outputs you can configure, see Limits (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html).
This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.
// Example sending a request using AddApplicationOutputRequest. req := client.AddApplicationOutputRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/AddApplicationOutput
func (*Client) AddApplicationReferenceDataSourceRequest ¶ added in v0.9.0
func (c *Client) AddApplicationReferenceDataSourceRequest(input *AddApplicationReferenceDataSourceInput) AddApplicationReferenceDataSourceRequest
AddApplicationReferenceDataSourceRequest returns a request value for making API operation for Amazon Kinesis Analytics.
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Adds a reference data source to an existing application.
Amazon Kinesis 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 Amazon S3 object maps to columns in the resulting in-application table.
For conceptual information, see Configuring Application Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). For the limits on data sources you can add to your application, see Limits (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html).
This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.
// Example sending a request using AddApplicationReferenceDataSourceRequest. req := client.AddApplicationReferenceDataSourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/AddApplicationReferenceDataSource
func (*Client) CreateApplicationRequest ¶ added in v0.9.0
func (c *Client) CreateApplicationRequest(input *CreateApplicationInput) CreateApplicationRequest
CreateApplicationRequest returns a request value for making API operation for Amazon Kinesis Analytics.
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to three destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see How it Works (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works.html).
In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source.
Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps.
In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to three destinations.
To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the kinesisanalytics:CreateApplication action.
For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/getting-started.html).
// Example sending a request using CreateApplicationRequest. req := client.CreateApplicationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/CreateApplication
func (*Client) DeleteApplicationCloudWatchLoggingOptionRequest ¶ added in v0.9.0
func (c *Client) DeleteApplicationCloudWatchLoggingOptionRequest(input *DeleteApplicationCloudWatchLoggingOptionInput) DeleteApplicationCloudWatchLoggingOptionRequest
DeleteApplicationCloudWatchLoggingOptionRequest returns a request value for making API operation for Amazon Kinesis Analytics.
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html).
// Example sending a request using DeleteApplicationCloudWatchLoggingOptionRequest. req := client.DeleteApplicationCloudWatchLoggingOptionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/DeleteApplicationCloudWatchLoggingOption
func (*Client) DeleteApplicationInputProcessingConfigurationRequest ¶ added in v0.9.0
func (c *Client) DeleteApplicationInputProcessingConfigurationRequest(input *DeleteApplicationInputProcessingConfigurationInput) DeleteApplicationInputProcessingConfigurationRequest
DeleteApplicationInputProcessingConfigurationRequest returns a request value for making API operation for Amazon Kinesis Analytics.
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Deletes an InputProcessingConfiguration (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) from an input.
// Example sending a request using DeleteApplicationInputProcessingConfigurationRequest. req := client.DeleteApplicationInputProcessingConfigurationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/DeleteApplicationInputProcessingConfiguration
func (*Client) DeleteApplicationOutputRequest ¶ added in v0.9.0
func (c *Client) DeleteApplicationOutputRequest(input *DeleteApplicationOutputInput) DeleteApplicationOutputRequest
DeleteApplicationOutputRequest returns a request value for making API operation for Amazon Kinesis Analytics.
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Deletes output destination configuration from your application configuration. Amazon Kinesis Analytics will no longer write data from the corresponding in-application stream to the external output destination.
This operation requires permissions to perform the kinesisanalytics:DeleteApplicationOutput action.
// Example sending a request using DeleteApplicationOutputRequest. req := client.DeleteApplicationOutputRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/DeleteApplicationOutput
func (*Client) DeleteApplicationReferenceDataSourceRequest ¶ added in v0.9.0
func (c *Client) DeleteApplicationReferenceDataSourceRequest(input *DeleteApplicationReferenceDataSourceInput) DeleteApplicationReferenceDataSourceRequest
DeleteApplicationReferenceDataSourceRequest returns a request value for making API operation for Amazon Kinesis Analytics.
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Deletes a reference data source configuration from the specified application configuration.
If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html) operation.
This operation requires permissions to perform the kinesisanalytics.DeleteApplicationReferenceDataSource action.
// Example sending a request using DeleteApplicationReferenceDataSourceRequest. req := client.DeleteApplicationReferenceDataSourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/DeleteApplicationReferenceDataSource
func (*Client) DeleteApplicationRequest ¶ added in v0.9.0
func (c *Client) DeleteApplicationRequest(input *DeleteApplicationInput) DeleteApplicationRequest
DeleteApplicationRequest returns a request value for making API operation for Amazon Kinesis Analytics.
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the application, including any application artifacts (such as in-application streams, reference table, and application code).
This operation requires permissions to perform the kinesisanalytics:DeleteApplication action.
// Example sending a request using DeleteApplicationRequest. req := client.DeleteApplicationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/DeleteApplication
func (*Client) DescribeApplicationRequest ¶ added in v0.9.0
func (c *Client) DescribeApplicationRequest(input *DescribeApplicationInput) DescribeApplicationRequest
DescribeApplicationRequest returns a request value for making API operation for Amazon Kinesis Analytics.
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Returns information about a specific Amazon Kinesis Analytics application.
If you want to retrieve a list of all applications in your account, use the ListApplications (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_ListApplications.html) operation.
This operation requires permissions to perform the kinesisanalytics:DescribeApplication action. You can use DescribeApplication to get the current application versionId, which you need to call other operations such as Update.
// Example sending a request using DescribeApplicationRequest. req := client.DescribeApplicationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/DescribeApplication
func (*Client) DiscoverInputSchemaRequest ¶ added in v0.9.0
func (c *Client) DiscoverInputSchemaRequest(input *DiscoverInputSchemaInput) DiscoverInputSchemaRequest
DiscoverInputSchemaRequest returns a request value for making API operation for Amazon Kinesis Analytics.
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream) or 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. For conceptual information, see Configuring Application Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface.
This operation requires permissions to perform the kinesisanalytics:DiscoverInputSchema action.
// Example sending a request using DiscoverInputSchemaRequest. req := client.DiscoverInputSchemaRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/DiscoverInputSchema
func (*Client) ListApplicationsRequest ¶ added in v0.9.0
func (c *Client) ListApplicationsRequest(input *ListApplicationsInput) ListApplicationsRequest
ListApplicationsRequest returns a request value for making API operation for Amazon Kinesis Analytics.
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the HasMoreApplications value as true, you can send another request by adding the ExclusiveStartApplicationName in the request body, and set the value of this to the last application name from the previous response.
If you want detailed information about a specific application, use DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html).
This operation requires permissions to perform the kinesisanalytics:ListApplications action.
// Example sending a request using ListApplicationsRequest. req := client.ListApplicationsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/ListApplications
func (*Client) ListTagsForResourceRequest ¶ added in v0.9.0
func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
ListTagsForResourceRequest returns a request value for making API operation for Amazon Kinesis Analytics.
Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html).
// Example sending a request using ListTagsForResourceRequest. req := client.ListTagsForResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/ListTagsForResource
func (*Client) StartApplicationRequest ¶ added in v0.9.0
func (c *Client) StartApplicationRequest(input *StartApplicationInput) StartApplicationRequest
StartApplicationRequest returns a request value for making API operation for Amazon Kinesis Analytics.
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Starts the specified Amazon Kinesis Analytics application. After creating an application, you must exclusively call this operation to start your application.
After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination.
The application status must be READY for you to start an application. You can get the application status in the console or using the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation.
After you start the application, you can stop the application from processing the input by calling the StopApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_StopApplication.html) operation.
This operation requires permissions to perform the kinesisanalytics:StartApplication action.
// Example sending a request using StartApplicationRequest. req := client.StartApplicationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/StartApplication
func (*Client) StopApplicationRequest ¶ added in v0.9.0
func (c *Client) StopApplicationRequest(input *StopApplicationInput) StopApplicationRequest
StopApplicationRequest returns a request value for making API operation for Amazon Kinesis Analytics.
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops reading data from the input, the application stops processing data, and there is no output written to the destination.
This operation requires permissions to perform the kinesisanalytics:StopApplication action.
// Example sending a request using StopApplicationRequest. req := client.StopApplicationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/StopApplication
func (*Client) TagResourceRequest ¶ added in v0.9.0
func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
TagResourceRequest returns a request value for making API operation for Amazon Kinesis Analytics.
Adds one or more key-value tags to a Kinesis 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/dev/how-tagging.html).
// Example sending a request using TagResourceRequest. req := client.TagResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/TagResource
func (*Client) UntagResourceRequest ¶ added in v0.9.0
func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
UntagResourceRequest returns a request value for making API operation for Amazon Kinesis Analytics.
Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html).
// Example sending a request using UntagResourceRequest. req := client.UntagResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/UntagResource
func (*Client) UpdateApplicationRequest ¶ added in v0.9.0
func (c *Client) UpdateApplicationRequest(input *UpdateApplicationInput) UpdateApplicationRequest
UpdateApplicationRequest returns a request value for making API operation for Amazon Kinesis Analytics.
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation (/kinesisanalytics/latest/apiv2/Welcome.html).
Updates an existing Amazon Kinesis Analytics application. Using this API, you can update application code, input configuration, and output configuration.
Note that Amazon Kinesis Analytics updates the CurrentApplicationVersionId each time you update your application.
This operation requires permission for the kinesisanalytics:UpdateApplication action.
// Example sending a request using UpdateApplicationRequest. req := client.UpdateApplicationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/UpdateApplication
type CloudWatchLoggingOption ¶
type CloudWatchLoggingOption struct { // ARN of the CloudWatch log to receive application messages. // // LogStreamARN is a required field LogStreamARN *string `min:"1" type:"string" required:"true"` // IAM ARN of the role to use to send application messages. Note: To write application // messages to CloudWatch, the IAM role that is used must have the PutLogEvents // policy action enabled. // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Provides a description of CloudWatch logging options, including the log stream Amazon Resource Name (ARN) and the role ARN.
func (CloudWatchLoggingOption) String ¶
func (s CloudWatchLoggingOption) String() string
String returns the string representation
func (*CloudWatchLoggingOption) Validate ¶
func (s *CloudWatchLoggingOption) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CloudWatchLoggingOptionDescription ¶
type CloudWatchLoggingOptionDescription struct { // ID of the CloudWatch logging option description. CloudWatchLoggingOptionId *string `min:"1" type:"string"` // ARN of the CloudWatch log to receive application messages. // // LogStreamARN is a required field LogStreamARN *string `min:"1" type:"string" required:"true"` // IAM ARN of the role to use to send application messages. Note: To write application // messages to CloudWatch, the IAM role used must have the PutLogEvents policy // action enabled. // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Description of the CloudWatch logging option.
func (CloudWatchLoggingOptionDescription) String ¶
func (s CloudWatchLoggingOptionDescription) String() string
String returns the string representation
type CloudWatchLoggingOptionUpdate ¶
type CloudWatchLoggingOptionUpdate struct { // ID of the CloudWatch logging option to update // // CloudWatchLoggingOptionId is a required field CloudWatchLoggingOptionId *string `min:"1" type:"string" required:"true"` // ARN of the CloudWatch log to receive application messages. LogStreamARNUpdate *string `min:"1" type:"string"` // IAM ARN of the role to use to send application messages. Note: To write application // messages to CloudWatch, the IAM role used must have the PutLogEvents policy // action enabled. RoleARNUpdate *string `min:"1" type:"string"` // contains filtered or unexported fields }
Describes CloudWatch logging option updates.
func (CloudWatchLoggingOptionUpdate) String ¶
func (s CloudWatchLoggingOptionUpdate) String() string
String returns the string representation
func (*CloudWatchLoggingOptionUpdate) Validate ¶
func (s *CloudWatchLoggingOptionUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateApplicationInput ¶
type CreateApplicationInput struct { // One or more SQL statements that read input data, transform it, and generate // output. For example, you can write a SQL statement that reads data from one // in-application stream, generates a running average of the number of advertisement // clicks by vendor, and insert resulting rows in another in-application stream // using pumps. For more information about the typical pattern, see Application // Code (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-app-code.html). // // You can provide such series of SQL statements, where output of one statement // can be used as the input for the next statement. You store intermediate results // by creating in-application streams and pumps. // // Note that the application code must create the streams with names specified // in the Outputs. For example, if your Outputs defines output streams named // ExampleOutputStream1 and ExampleOutputStream2, then your application code // must create these streams. ApplicationCode *string `type:"string"` // Summary description of the application. ApplicationDescription *string `type:"string"` // Name of your Amazon Kinesis Analytics application (for example, sample-app). // // ApplicationName is a required field ApplicationName *string `min:"1" type:"string" required:"true"` // Use this parameter to configure a CloudWatch log stream to monitor application // configuration errors. For more information, see Working with Amazon CloudWatch // Logs (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html). CloudWatchLoggingOptions []CloudWatchLoggingOption `type:"list"` // Use this parameter to configure the application input. // // You can configure your application to receive input from a single streaming // source. In this configuration, you map this streaming source to an in-application // stream that is created. Your application code can then query the in-application // stream like a table (you can think of it as a constantly updating table). // // For the streaming source, you provide its Amazon Resource Name (ARN) and // format of data on the stream (for example, JSON, CSV, etc.). You also must // provide an IAM role that Amazon Kinesis Analytics can assume to read this // stream on your behalf. // // To create the in-application stream, you need to specify a schema to transform // your data into a schematized version used in SQL. In the schema, you provide // the necessary mapping of the data elements in the streaming source to record // columns in the in-app stream. Inputs []Input `type:"list"` // You can configure application output to write data from any of the in-application // streams to up to three destinations. // // These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose // delivery streams, AWS Lambda destinations, or any combination of the three. // // In the configuration, you specify the in-application stream name, the destination // stream or Lambda function Amazon Resource Name (ARN), and the format to use // when writing data. You must also provide an IAM role that Amazon Kinesis // Analytics can assume to write to the destination stream or Lambda function // on your behalf. // // In the output configuration, you also provide the output stream or Lambda // function ARN. For stream destinations, you provide the format of data in // the stream (for example, JSON, CSV). You also must provide an IAM role that // Amazon Kinesis Analytics can assume to write to the stream or Lambda function // on your behalf. Outputs []Output `type:"list"` // 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/dev/how-tagging.html). Tags []Tag `min:"1" type:"list"` // contains filtered or unexported fields }
TBD
func (CreateApplicationInput) String ¶
func (s CreateApplicationInput) String() string
String returns the string representation
func (*CreateApplicationInput) Validate ¶
func (s *CreateApplicationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateApplicationOutput ¶
type CreateApplicationOutput struct { // In response to your CreateApplication request, Amazon Kinesis Analytics returns // a response with a summary of the application it created, including the application // Amazon Resource Name (ARN), name, and status. // // ApplicationSummary is a required field ApplicationSummary *ApplicationSummary `type:"structure" required:"true"` // contains filtered or unexported fields }
TBD
func (CreateApplicationOutput) String ¶
func (s CreateApplicationOutput) String() string
String returns the string representation
type CreateApplicationRequest ¶
type CreateApplicationRequest struct { *aws.Request Input *CreateApplicationInput Copy func(*CreateApplicationInput) CreateApplicationRequest }
CreateApplicationRequest is the request type for the CreateApplication API operation.
func (CreateApplicationRequest) Send ¶
func (r CreateApplicationRequest) Send(ctx context.Context) (*CreateApplicationResponse, error)
Send marshals and sends the CreateApplication API request.
type CreateApplicationResponse ¶ added in v0.9.0
type CreateApplicationResponse struct { *CreateApplicationOutput // contains filtered or unexported fields }
CreateApplicationResponse is the response type for the CreateApplication API operation.
func (*CreateApplicationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateApplicationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateApplication request.
type DeleteApplicationCloudWatchLoggingOptionInput ¶
type DeleteApplicationCloudWatchLoggingOptionInput struct { // The Kinesis Analytics application name. // // ApplicationName is a required field ApplicationName *string `min:"1" type:"string" required:"true"` // The CloudWatchLoggingOptionId of the CloudWatch logging option to delete. // You can get the CloudWatchLoggingOptionId by using the DescribeApplication // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation. // // CloudWatchLoggingOptionId is a required field CloudWatchLoggingOptionId *string `min:"1" type:"string" required:"true"` // The version ID of the Kinesis Analytics application. // // CurrentApplicationVersionId is a required field CurrentApplicationVersionId *int64 `min:"1" type:"long" required:"true"` // contains filtered or unexported fields }
func (DeleteApplicationCloudWatchLoggingOptionInput) String ¶
func (s DeleteApplicationCloudWatchLoggingOptionInput) String() string
String returns the string representation
func (*DeleteApplicationCloudWatchLoggingOptionInput) Validate ¶
func (s *DeleteApplicationCloudWatchLoggingOptionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteApplicationCloudWatchLoggingOptionOutput ¶
type DeleteApplicationCloudWatchLoggingOptionOutput struct {
// contains filtered or unexported fields
}
func (DeleteApplicationCloudWatchLoggingOptionOutput) String ¶
func (s DeleteApplicationCloudWatchLoggingOptionOutput) String() string
String returns the string representation
type DeleteApplicationCloudWatchLoggingOptionRequest ¶
type DeleteApplicationCloudWatchLoggingOptionRequest struct { *aws.Request Input *DeleteApplicationCloudWatchLoggingOptionInput Copy func(*DeleteApplicationCloudWatchLoggingOptionInput) DeleteApplicationCloudWatchLoggingOptionRequest }
DeleteApplicationCloudWatchLoggingOptionRequest is the request type for the DeleteApplicationCloudWatchLoggingOption API operation.
func (DeleteApplicationCloudWatchLoggingOptionRequest) Send ¶
func (r DeleteApplicationCloudWatchLoggingOptionRequest) Send(ctx context.Context) (*DeleteApplicationCloudWatchLoggingOptionResponse, error)
Send marshals and sends the DeleteApplicationCloudWatchLoggingOption API request.
type DeleteApplicationCloudWatchLoggingOptionResponse ¶ added in v0.9.0
type DeleteApplicationCloudWatchLoggingOptionResponse struct { *DeleteApplicationCloudWatchLoggingOptionOutput // contains filtered or unexported fields }
DeleteApplicationCloudWatchLoggingOptionResponse is the response type for the DeleteApplicationCloudWatchLoggingOption API operation.
func (*DeleteApplicationCloudWatchLoggingOptionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteApplicationCloudWatchLoggingOptionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteApplicationCloudWatchLoggingOption request.
type DeleteApplicationInput ¶
type DeleteApplicationInput struct { // Name of the Amazon Kinesis Analytics application to delete. // // ApplicationName is a required field ApplicationName *string `min:"1" type:"string" required:"true"` // You can use the DescribeApplication operation to get this value. // // CreateTimestamp is a required field CreateTimestamp *time.Time `type:"timestamp" required:"true"` // contains filtered or unexported fields }
func (DeleteApplicationInput) String ¶
func (s DeleteApplicationInput) String() string
String returns the string representation
func (*DeleteApplicationInput) Validate ¶
func (s *DeleteApplicationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteApplicationInputProcessingConfigurationInput ¶
type DeleteApplicationInputProcessingConfigurationInput struct { // The Kinesis Analytics application name. // // ApplicationName is a required field ApplicationName *string `min:"1" type:"string" required:"true"` // The version ID of the Kinesis Analytics application. // // CurrentApplicationVersionId is a required field CurrentApplicationVersionId *int64 `min:"1" type:"long" required:"true"` // 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 (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation. // // InputId is a required field InputId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteApplicationInputProcessingConfigurationInput) String ¶
func (s DeleteApplicationInputProcessingConfigurationInput) String() string
String returns the string representation
func (*DeleteApplicationInputProcessingConfigurationInput) Validate ¶
func (s *DeleteApplicationInputProcessingConfigurationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteApplicationInputProcessingConfigurationOutput ¶
type DeleteApplicationInputProcessingConfigurationOutput struct {
// contains filtered or unexported fields
}
func (DeleteApplicationInputProcessingConfigurationOutput) String ¶
func (s DeleteApplicationInputProcessingConfigurationOutput) String() string
String returns the string representation
type DeleteApplicationInputProcessingConfigurationRequest ¶
type DeleteApplicationInputProcessingConfigurationRequest struct { *aws.Request Input *DeleteApplicationInputProcessingConfigurationInput Copy func(*DeleteApplicationInputProcessingConfigurationInput) DeleteApplicationInputProcessingConfigurationRequest }
DeleteApplicationInputProcessingConfigurationRequest is the request type for the DeleteApplicationInputProcessingConfiguration API operation.
func (DeleteApplicationInputProcessingConfigurationRequest) Send ¶
func (r DeleteApplicationInputProcessingConfigurationRequest) Send(ctx context.Context) (*DeleteApplicationInputProcessingConfigurationResponse, error)
Send marshals and sends the DeleteApplicationInputProcessingConfiguration API request.
type DeleteApplicationInputProcessingConfigurationResponse ¶ added in v0.9.0
type DeleteApplicationInputProcessingConfigurationResponse struct { *DeleteApplicationInputProcessingConfigurationOutput // contains filtered or unexported fields }
DeleteApplicationInputProcessingConfigurationResponse is the response type for the DeleteApplicationInputProcessingConfiguration API operation.
func (*DeleteApplicationInputProcessingConfigurationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteApplicationInputProcessingConfigurationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteApplicationInputProcessingConfiguration request.
type DeleteApplicationOutput ¶
type DeleteApplicationOutput struct {
// contains filtered or unexported fields
}
func (DeleteApplicationOutput) String ¶
func (s DeleteApplicationOutput) String() string
String returns the string representation
type DeleteApplicationOutputInput ¶
type DeleteApplicationOutputInput struct { // Amazon Kinesis Analytics application name. // // ApplicationName is a required field ApplicationName *string `min:"1" type:"string" required:"true"` // Amazon Kinesis Analytics application version. You can use the DescribeApplication // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to get the current application version. If the version specified // is not the current version, the ConcurrentModificationException is returned. // // CurrentApplicationVersionId is a required field CurrentApplicationVersionId *int64 `min:"1" type:"long" required:"true"` // 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 (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationOutput.html) // 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 (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to get the specific OutputId. // // OutputId is a required field OutputId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteApplicationOutputInput) String ¶
func (s DeleteApplicationOutputInput) String() string
String returns the string representation
func (*DeleteApplicationOutputInput) Validate ¶
func (s *DeleteApplicationOutputInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteApplicationOutputOutput ¶
type DeleteApplicationOutputOutput struct {
// contains filtered or unexported fields
}
func (DeleteApplicationOutputOutput) String ¶
func (s DeleteApplicationOutputOutput) String() string
String returns the string representation
type DeleteApplicationOutputRequest ¶
type DeleteApplicationOutputRequest struct { *aws.Request Input *DeleteApplicationOutputInput Copy func(*DeleteApplicationOutputInput) DeleteApplicationOutputRequest }
DeleteApplicationOutputRequest is the request type for the DeleteApplicationOutput API operation.
func (DeleteApplicationOutputRequest) Send ¶
func (r DeleteApplicationOutputRequest) Send(ctx context.Context) (*DeleteApplicationOutputResponse, error)
Send marshals and sends the DeleteApplicationOutput API request.
type DeleteApplicationOutputResponse ¶ added in v0.9.0
type DeleteApplicationOutputResponse struct { *DeleteApplicationOutputOutput // contains filtered or unexported fields }
DeleteApplicationOutputResponse is the response type for the DeleteApplicationOutput API operation.
func (*DeleteApplicationOutputResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteApplicationOutputResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteApplicationOutput request.
type DeleteApplicationReferenceDataSourceInput ¶
type DeleteApplicationReferenceDataSourceInput struct { // Name of an existing application. // // ApplicationName is a required field ApplicationName *string `min:"1" type:"string" required:"true"` // Version of the application. You can use the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to get the current application version. If the version specified // is not the current version, the ConcurrentModificationException is returned. // // CurrentApplicationVersionId is a required field CurrentApplicationVersionId *int64 `min:"1" type:"long" required:"true"` // ID of the reference data source. When you add a reference data source to // your application using the AddApplicationReferenceDataSource (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html), // Amazon Kinesis Analytics assigns an ID. You can use the DescribeApplication // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to get the reference ID. // // ReferenceId is a required field ReferenceId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteApplicationReferenceDataSourceInput) String ¶
func (s DeleteApplicationReferenceDataSourceInput) String() string
String returns the string representation
func (*DeleteApplicationReferenceDataSourceInput) Validate ¶
func (s *DeleteApplicationReferenceDataSourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteApplicationReferenceDataSourceOutput ¶
type DeleteApplicationReferenceDataSourceOutput struct {
// contains filtered or unexported fields
}
func (DeleteApplicationReferenceDataSourceOutput) String ¶
func (s DeleteApplicationReferenceDataSourceOutput) String() string
String returns the string representation
type DeleteApplicationReferenceDataSourceRequest ¶
type DeleteApplicationReferenceDataSourceRequest struct { *aws.Request Input *DeleteApplicationReferenceDataSourceInput Copy func(*DeleteApplicationReferenceDataSourceInput) DeleteApplicationReferenceDataSourceRequest }
DeleteApplicationReferenceDataSourceRequest is the request type for the DeleteApplicationReferenceDataSource API operation.
func (DeleteApplicationReferenceDataSourceRequest) Send ¶
func (r DeleteApplicationReferenceDataSourceRequest) Send(ctx context.Context) (*DeleteApplicationReferenceDataSourceResponse, error)
Send marshals and sends the DeleteApplicationReferenceDataSource API request.
type DeleteApplicationReferenceDataSourceResponse ¶ added in v0.9.0
type DeleteApplicationReferenceDataSourceResponse struct { *DeleteApplicationReferenceDataSourceOutput // contains filtered or unexported fields }
DeleteApplicationReferenceDataSourceResponse is the response type for the DeleteApplicationReferenceDataSource API operation.
func (*DeleteApplicationReferenceDataSourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteApplicationReferenceDataSourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteApplicationReferenceDataSource request.
type DeleteApplicationRequest ¶
type DeleteApplicationRequest struct { *aws.Request Input *DeleteApplicationInput Copy func(*DeleteApplicationInput) DeleteApplicationRequest }
DeleteApplicationRequest is the request type for the DeleteApplication API operation.
func (DeleteApplicationRequest) Send ¶
func (r DeleteApplicationRequest) Send(ctx context.Context) (*DeleteApplicationResponse, error)
Send marshals and sends the DeleteApplication API request.
type DeleteApplicationResponse ¶ added in v0.9.0
type DeleteApplicationResponse struct { *DeleteApplicationOutput // contains filtered or unexported fields }
DeleteApplicationResponse is the response type for the DeleteApplication API operation.
func (*DeleteApplicationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteApplicationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteApplication request.
type DescribeApplicationInput ¶
type DescribeApplicationInput struct { // Name of the application. // // ApplicationName is a required field ApplicationName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeApplicationInput) String ¶
func (s DescribeApplicationInput) String() string
String returns the string representation
func (*DescribeApplicationInput) Validate ¶
func (s *DescribeApplicationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeApplicationOutput ¶
type DescribeApplicationOutput struct { // Provides a description of the application, such as the application Amazon // Resource Name (ARN), status, latest version, and input and output configuration // details. // // ApplicationDetail is a required field ApplicationDetail *ApplicationDetail `type:"structure" required:"true"` // contains filtered or unexported fields }
func (DescribeApplicationOutput) String ¶
func (s DescribeApplicationOutput) String() string
String returns the string representation
type DescribeApplicationRequest ¶
type DescribeApplicationRequest struct { *aws.Request Input *DescribeApplicationInput Copy func(*DescribeApplicationInput) DescribeApplicationRequest }
DescribeApplicationRequest is the request type for the DescribeApplication API operation.
func (DescribeApplicationRequest) Send ¶
func (r DescribeApplicationRequest) Send(ctx context.Context) (*DescribeApplicationResponse, error)
Send marshals and sends the DescribeApplication API request.
type DescribeApplicationResponse ¶ added in v0.9.0
type DescribeApplicationResponse struct { *DescribeApplicationOutput // contains filtered or unexported fields }
DescribeApplicationResponse is the response type for the DescribeApplication API operation.
func (*DescribeApplicationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeApplicationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeApplication request.
type DestinationSchema ¶
type DestinationSchema struct { // Specifies the format of the records on the output stream. // // RecordFormatType is a required field RecordFormatType RecordFormatType `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Describes the data format when records are written to the destination. For more information, see Configuring Application Output (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html).
func (DestinationSchema) String ¶
func (s DestinationSchema) String() string
String returns the string representation
func (*DestinationSchema) Validate ¶ added in v0.6.0
func (s *DestinationSchema) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DiscoverInputSchemaInput ¶
type DiscoverInputSchemaInput struct { // The InputProcessingConfiguration (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) // to use to preprocess the records before discovering the schema of the records. InputProcessingConfiguration *InputProcessingConfiguration `type:"structure"` // Point at which you want Amazon Kinesis Analytics to start reading records // from the specified streaming source discovery purposes. InputStartingPositionConfiguration *InputStartingPositionConfiguration `type:"structure"` // Amazon Resource Name (ARN) of the streaming source. ResourceARN *string `min:"1" type:"string"` // ARN of the IAM role that Amazon Kinesis Analytics can assume to access the // stream on your behalf. RoleARN *string `min:"1" type:"string"` // Specify this parameter to discover a schema from data in an Amazon S3 object. S3Configuration *S3Configuration `type:"structure"` // contains filtered or unexported fields }
func (DiscoverInputSchemaInput) String ¶
func (s DiscoverInputSchemaInput) String() string
String returns the string representation
func (*DiscoverInputSchemaInput) Validate ¶
func (s *DiscoverInputSchemaInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DiscoverInputSchemaOutput ¶
type DiscoverInputSchemaOutput struct { // 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 *SourceSchema `type:"structure"` // 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 `type:"list"` // Stream data that was modified by the processor specified in the InputProcessingConfiguration // parameter. ProcessedInputRecords []string `type:"list"` // Raw stream data that was sampled to infer the schema. RawInputRecords []string `type:"list"` // contains filtered or unexported fields }
func (DiscoverInputSchemaOutput) String ¶
func (s DiscoverInputSchemaOutput) String() string
String returns the string representation
type DiscoverInputSchemaRequest ¶
type DiscoverInputSchemaRequest struct { *aws.Request Input *DiscoverInputSchemaInput Copy func(*DiscoverInputSchemaInput) DiscoverInputSchemaRequest }
DiscoverInputSchemaRequest is the request type for the DiscoverInputSchema API operation.
func (DiscoverInputSchemaRequest) Send ¶
func (r DiscoverInputSchemaRequest) Send(ctx context.Context) (*DiscoverInputSchemaResponse, error)
Send marshals and sends the DiscoverInputSchema API request.
type DiscoverInputSchemaResponse ¶ added in v0.9.0
type DiscoverInputSchemaResponse struct { *DiscoverInputSchemaOutput // contains filtered or unexported fields }
DiscoverInputSchemaResponse is the response type for the DiscoverInputSchema API operation.
func (*DiscoverInputSchemaResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DiscoverInputSchemaResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DiscoverInputSchema request.
type Input ¶
type Input struct { // Describes the number of in-application streams to create. // // Data from your source is routed to these in-application input streams. // // (see Configuring Application Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). InputParallelism *InputParallelism `type:"structure"` // The InputProcessingConfiguration (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) // for the input. An input processor transforms records as they are received // from the stream, before the application's SQL code executes. Currently, the // only input processing configuration available is InputLambdaProcessor (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html). InputProcessingConfiguration *InputProcessingConfiguration `type:"structure"` // Describes the format of the data in the streaming source, and how each data // element maps to corresponding columns in the in-application stream that is // being created. // // Also used to describe the format of the reference data source. // // InputSchema is a required field InputSchema *SourceSchema `type:"structure" required:"true"` // If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies // the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics // to access the stream on your behalf. // // Note: Either KinesisStreamsInput or KinesisFirehoseInput is required. KinesisFirehoseInput *KinesisFirehoseInput `type:"structure"` // If the streaming source is an Amazon Kinesis stream, identifies the stream's // Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics // to access the stream on your behalf. // // Note: Either KinesisStreamsInput or KinesisFirehoseInput is required. KinesisStreamsInput *KinesisStreamsInput `type:"structure"` // Name prefix to use when creating an in-application stream. Suppose that you // specify a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates // one or more (as per the InputParallelism count you specified) in-application // streams with names "MyInApplicationStream_001," "MyInApplicationStream_002," // and so on. // // NamePrefix is a required field NamePrefix *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
When you configure the application input, you specify the streaming source, the in-application stream name that is created, and the mapping between the two. For more information, see Configuring Application Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).
type InputConfiguration ¶
type InputConfiguration struct { // Input source ID. You can get this ID by calling the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` // Point at which you want the application to start processing records from // the streaming source. // // InputStartingPositionConfiguration is a required field InputStartingPositionConfiguration *InputStartingPositionConfiguration `type:"structure" required:"true"` // contains filtered or unexported fields }
When you start your application, you provide this configuration, which identifies the input source and the point in the input source at which you want the application to start processing records.
func (InputConfiguration) String ¶
func (s InputConfiguration) String() string
String returns the string representation
func (*InputConfiguration) Validate ¶
func (s *InputConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InputDescription ¶
type InputDescription struct { // Returns the in-application stream names that are mapped to the stream source. InAppStreamNames []string `type:"list"` // Input ID associated with the application input. This is the ID that Amazon // Kinesis Analytics assigns to each input configuration you add to your application. InputId *string `min:"1" type:"string"` // Describes the configured parallelism (number of in-application streams mapped // to the streaming source). InputParallelism *InputParallelism `type:"structure"` // The description of the preprocessor that executes on records in this input // before the application's code is run. InputProcessingConfigurationDescription *InputProcessingConfigurationDescription `type:"structure"` // Describes the format of the data in the streaming source, and how each data // element maps to corresponding columns in the in-application stream that is // being created. InputSchema *SourceSchema `type:"structure"` // Point at which the application is configured to read from the input stream. InputStartingPositionConfiguration *InputStartingPositionConfiguration `type:"structure"` // If an Amazon Kinesis Firehose delivery stream is configured as a streaming // source, provides the delivery stream's ARN and an IAM role that enables Amazon // Kinesis Analytics to access the stream on your behalf. KinesisFirehoseInputDescription *KinesisFirehoseInputDescription `type:"structure"` // If an Amazon Kinesis stream is configured as streaming source, provides Amazon // Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables // Amazon Kinesis Analytics to access the stream on your behalf. KinesisStreamsInputDescription *KinesisStreamsInputDescription `type:"structure"` // In-application name prefix. NamePrefix *string `min:"1" type:"string"` // contains filtered or unexported fields }
Describes the application input configuration. For more information, see Configuring Application Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).
func (InputDescription) String ¶
func (s InputDescription) String() string
String returns the string representation
type InputLambdaProcessor ¶
type InputLambdaProcessor struct { // The ARN of the AWS Lambda (https://docs.aws.amazon.com/lambda/) function // that operates on records in the stream. // // To specify an earlier version of the Lambda function than the latest, include // the Lambda function version in the Lambda function ARN. For more information // about Lambda ARNs, see Example ARNs: AWS Lambda (/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) // // ResourceARN is a required field ResourceARN *string `min:"1" type:"string" required:"true"` // The ARN of the IAM role that is used to access the AWS Lambda function. // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
An object that contains the Amazon Resource Name (ARN) of the AWS Lambda (https://docs.aws.amazon.com/lambda/) function that is used to preprocess records in the stream, and the ARN of the IAM role that is used to access the AWS Lambda function.
func (InputLambdaProcessor) String ¶
func (s InputLambdaProcessor) String() string
String returns the string representation
func (*InputLambdaProcessor) Validate ¶
func (s *InputLambdaProcessor) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InputLambdaProcessorDescription ¶
type InputLambdaProcessorDescription struct { // The ARN of the AWS Lambda (https://docs.aws.amazon.com/lambda/) function // that is used to preprocess the records in the stream. ResourceARN *string `min:"1" type:"string"` // The ARN of the IAM role that is used to access the AWS Lambda function. RoleARN *string `min:"1" type:"string"` // contains filtered or unexported fields }
An object that contains the Amazon Resource Name (ARN) of the AWS Lambda (https://docs.aws.amazon.com/lambda/) function that is used to preprocess records in the stream, and the ARN of the IAM role that is used to access the AWS Lambda expression.
func (InputLambdaProcessorDescription) String ¶
func (s InputLambdaProcessorDescription) String() string
String returns the string representation
type InputLambdaProcessorUpdate ¶
type InputLambdaProcessorUpdate struct { // The Amazon Resource Name (ARN) of the new AWS Lambda (https://docs.aws.amazon.com/lambda/) // function that is used to preprocess the records in the stream. // // To specify an earlier version of the Lambda function than the latest, include // the Lambda function version in the Lambda function ARN. For more information // about Lambda ARNs, see Example ARNs: AWS Lambda (/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) ResourceARNUpdate *string `min:"1" type:"string"` // The ARN of the new IAM role that is used to access the AWS Lambda function. RoleARNUpdate *string `min:"1" type:"string"` // contains filtered or unexported fields }
Represents an update to the InputLambdaProcessor (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html) that is used to preprocess the records in the stream.
func (InputLambdaProcessorUpdate) String ¶
func (s InputLambdaProcessorUpdate) String() string
String returns the string representation
func (*InputLambdaProcessorUpdate) Validate ¶
func (s *InputLambdaProcessorUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InputParallelism ¶
type InputParallelism struct { // Number of in-application streams to create. For more information, see Limits // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html). Count *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
Describes the number of in-application streams to create for a given streaming source. For information about parallelism, see Configuring Application Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).
func (InputParallelism) String ¶
func (s InputParallelism) String() string
String returns the string representation
func (*InputParallelism) Validate ¶
func (s *InputParallelism) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InputParallelismUpdate ¶
type InputParallelismUpdate struct { // Number of in-application streams to create for the specified streaming source. CountUpdate *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
Provides updates to the parallelism count.
func (InputParallelismUpdate) String ¶
func (s InputParallelismUpdate) String() string
String returns the string representation
func (*InputParallelismUpdate) Validate ¶
func (s *InputParallelismUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InputProcessingConfiguration ¶
type InputProcessingConfiguration struct { // The InputLambdaProcessor (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html) // that is used to preprocess the records in the stream before being processed // by your application code. // // InputLambdaProcessor is a required field InputLambdaProcessor *InputLambdaProcessor `type:"structure" required:"true"` // contains filtered or unexported fields }
Provides a description of a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is AWS Lambda (https://docs.aws.amazon.com/lambda/).
func (InputProcessingConfiguration) String ¶
func (s InputProcessingConfiguration) String() string
String returns the string representation
func (*InputProcessingConfiguration) Validate ¶
func (s *InputProcessingConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InputProcessingConfigurationDescription ¶
type InputProcessingConfigurationDescription struct { // Provides configuration information about the associated InputLambdaProcessorDescription // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessorDescription.html). InputLambdaProcessorDescription *InputLambdaProcessorDescription `type:"structure"` // contains filtered or unexported fields }
Provides configuration information about an input processor. Currently, the only input processor available is AWS Lambda (https://docs.aws.amazon.com/lambda/).
func (InputProcessingConfigurationDescription) String ¶
func (s InputProcessingConfigurationDescription) String() string
String returns the string representation
type InputProcessingConfigurationUpdate ¶
type InputProcessingConfigurationUpdate struct { // Provides update information for an InputLambdaProcessor (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html). // // InputLambdaProcessorUpdate is a required field InputLambdaProcessorUpdate *InputLambdaProcessorUpdate `type:"structure" required:"true"` // contains filtered or unexported fields }
Describes updates to an InputProcessingConfiguration (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html).
func (InputProcessingConfigurationUpdate) String ¶
func (s InputProcessingConfigurationUpdate) String() string
String returns the string representation
func (*InputProcessingConfigurationUpdate) Validate ¶
func (s *InputProcessingConfigurationUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InputSchemaUpdate ¶
type InputSchemaUpdate struct { // A list of RecordColumn objects. Each object describes the mapping of the // streaming source element to the corresponding column in the in-application // stream. RecordColumnUpdates []RecordColumn `min:"1" type:"list"` // Specifies the encoding of the records in the streaming source. For example, // UTF-8. RecordEncodingUpdate *string `type:"string"` // Specifies the format of the records on the streaming source. RecordFormatUpdate *RecordFormat `type:"structure"` // contains filtered or unexported fields }
Describes updates for the application's input schema.
func (InputSchemaUpdate) String ¶
func (s InputSchemaUpdate) String() string
String returns the string representation
func (*InputSchemaUpdate) Validate ¶
func (s *InputSchemaUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InputStartingPosition ¶
type InputStartingPosition string
const ( InputStartingPositionNow InputStartingPosition = "NOW" InputStartingPositionTrimHorizon InputStartingPosition = "TRIM_HORIZON" InputStartingPositionLastStoppedPoint InputStartingPosition = "LAST_STOPPED_POINT" )
Enum values for InputStartingPosition
func (InputStartingPosition) MarshalValue ¶ added in v0.3.0
func (enum InputStartingPosition) MarshalValue() (string, error)
func (InputStartingPosition) MarshalValueBuf ¶ added in v0.3.0
func (enum InputStartingPosition) MarshalValueBuf(b []byte) ([]byte, error)
type InputStartingPositionConfiguration ¶
type InputStartingPositionConfiguration struct { // The starting position on the stream. // // * NOW - Start reading just after the most recent record in the stream, // start at the request time stamp that the customer issued. // // * TRIM_HORIZON - Start reading at the last untrimmed record in the stream, // which is the oldest record available in the stream. This option is not // available for an Amazon Kinesis Firehose delivery stream. // // * LAST_STOPPED_POINT - Resume reading from where the application last // stopped reading. InputStartingPosition InputStartingPosition `type:"string" enum:"true"` // contains filtered or unexported fields }
Describes the point at which the application reads from the streaming source.
func (InputStartingPositionConfiguration) String ¶
func (s InputStartingPositionConfiguration) String() string
String returns the string representation
type InputUpdate ¶
type InputUpdate struct { // Input ID of the application input to be updated. // // InputId is a required field InputId *string `min:"1" type:"string" required:"true"` // Describes the parallelism updates (the number in-application streams Amazon // Kinesis Analytics creates for the specific streaming source). InputParallelismUpdate *InputParallelismUpdate `type:"structure"` // Describes updates for an input processing configuration. InputProcessingConfigurationUpdate *InputProcessingConfigurationUpdate `type:"structure"` // Describes the data format on the streaming source, and how record elements // on the streaming source map to columns of the in-application stream that // is created. InputSchemaUpdate *InputSchemaUpdate `type:"structure"` // If an Amazon Kinesis Firehose delivery stream is the streaming source to // be updated, provides an updated stream ARN and IAM role ARN. KinesisFirehoseInputUpdate *KinesisFirehoseInputUpdate `type:"structure"` // If an Amazon Kinesis stream is the streaming source to be updated, provides // an updated stream Amazon Resource Name (ARN) and IAM role ARN. KinesisStreamsInputUpdate *KinesisStreamsInputUpdate `type:"structure"` // Name prefix for in-application streams that Amazon Kinesis Analytics creates // for the specific streaming source. NamePrefixUpdate *string `min:"1" type:"string"` // contains filtered or unexported fields }
Describes updates to a specific input configuration (identified by the InputId of an application).
func (InputUpdate) String ¶
func (s InputUpdate) String() string
String returns the string representation
func (*InputUpdate) Validate ¶
func (s *InputUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type JSONMappingParameters ¶
type JSONMappingParameters struct { // Path to the top-level parent that contains the records. // // RecordRowPath is a required field RecordRowPath *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Provides additional mapping information when JSON is the record format on the streaming source.
func (JSONMappingParameters) String ¶
func (s JSONMappingParameters) String() string
String returns the string representation
func (*JSONMappingParameters) Validate ¶
func (s *JSONMappingParameters) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KinesisFirehoseInput ¶
type KinesisFirehoseInput struct { // ARN of the input delivery stream. // // ResourceARN is a required field ResourceARN *string `min:"1" type:"string" required:"true"` // ARN of the IAM role that Amazon Kinesis Analytics can assume to access the // stream on your behalf. You need to make sure that the role has the necessary // permissions to access the stream. // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.
func (KinesisFirehoseInput) String ¶
func (s KinesisFirehoseInput) String() string
String returns the string representation
func (*KinesisFirehoseInput) Validate ¶
func (s *KinesisFirehoseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KinesisFirehoseInputDescription ¶
type KinesisFirehoseInputDescription struct { // Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream. ResourceARN *string `min:"1" type:"string"` // ARN of the IAM role that Amazon Kinesis Analytics assumes to access the stream. RoleARN *string `min:"1" type:"string"` // contains filtered or unexported fields }
Describes the Amazon Kinesis Firehose delivery stream that is configured as the streaming source in the application input configuration.
func (KinesisFirehoseInputDescription) String ¶
func (s KinesisFirehoseInputDescription) String() string
String returns the string representation
type KinesisFirehoseInputUpdate ¶
type KinesisFirehoseInputUpdate struct { // Amazon Resource Name (ARN) of the input Amazon Kinesis Firehose delivery // stream to read. ResourceARNUpdate *string `min:"1" type:"string"` // ARN of the IAM role that Amazon Kinesis Analytics can assume to access the // stream on your behalf. You need to grant the necessary permissions to this // role. RoleARNUpdate *string `min:"1" type:"string"` // contains filtered or unexported fields }
When updating application input configuration, provides information about an Amazon Kinesis Firehose delivery stream as the streaming source.
func (KinesisFirehoseInputUpdate) String ¶
func (s KinesisFirehoseInputUpdate) String() string
String returns the string representation
func (*KinesisFirehoseInputUpdate) Validate ¶
func (s *KinesisFirehoseInputUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KinesisFirehoseOutput ¶
type KinesisFirehoseOutput struct { // ARN of the destination Amazon Kinesis Firehose delivery stream to write to. // // ResourceARN is a required field ResourceARN *string `min:"1" type:"string" required:"true"` // ARN of the IAM role that Amazon Kinesis Analytics can assume to write to // the destination stream on your behalf. You need to grant the necessary permissions // to this role. // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
When configuring application output, identifies an Amazon Kinesis Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to write to the stream on your behalf.
func (KinesisFirehoseOutput) String ¶
func (s KinesisFirehoseOutput) String() string
String returns the string representation
func (*KinesisFirehoseOutput) Validate ¶
func (s *KinesisFirehoseOutput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KinesisFirehoseOutputDescription ¶
type KinesisFirehoseOutputDescription struct { // Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream. ResourceARN *string `min:"1" type:"string"` // ARN of the IAM role that Amazon Kinesis Analytics can assume to access the // stream. RoleARN *string `min:"1" type:"string"` // contains filtered or unexported fields }
For an application output, describes the Amazon Kinesis Firehose delivery stream configured as its destination.
func (KinesisFirehoseOutputDescription) String ¶
func (s KinesisFirehoseOutputDescription) String() string
String returns the string representation
type KinesisFirehoseOutputUpdate ¶
type KinesisFirehoseOutputUpdate struct { // Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream // to write to. ResourceARNUpdate *string `min:"1" type:"string"` // ARN of the IAM role that Amazon Kinesis Analytics can assume to access the // stream on your behalf. You need to grant the necessary permissions to this // role. RoleARNUpdate *string `min:"1" type:"string"` // contains filtered or unexported fields }
When updating an output configuration using the UpdateApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) operation, provides information about an Amazon Kinesis Firehose delivery stream configured as the destination.
func (KinesisFirehoseOutputUpdate) String ¶
func (s KinesisFirehoseOutputUpdate) String() string
String returns the string representation
func (*KinesisFirehoseOutputUpdate) Validate ¶
func (s *KinesisFirehoseOutputUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KinesisStreamsInput ¶
type KinesisStreamsInput struct { // ARN of the input Amazon Kinesis stream to read. // // ResourceARN is a required field ResourceARN *string `min:"1" type:"string" required:"true"` // ARN of the IAM role that Amazon Kinesis Analytics can assume to access the // stream on your behalf. You need to grant the necessary permissions to this // role. // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Identifies an Amazon Kinesis stream as the streaming source. You provide the stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.
func (KinesisStreamsInput) String ¶
func (s KinesisStreamsInput) String() string
String returns the string representation
func (*KinesisStreamsInput) Validate ¶
func (s *KinesisStreamsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KinesisStreamsInputDescription ¶
type KinesisStreamsInputDescription struct { // Amazon Resource Name (ARN) of the Amazon Kinesis stream. ResourceARN *string `min:"1" type:"string"` // ARN of the IAM role that Amazon Kinesis Analytics can assume to access the // stream. RoleARN *string `min:"1" type:"string"` // contains filtered or unexported fields }
Describes the Amazon Kinesis stream that is configured as the streaming source in the application input configuration.
func (KinesisStreamsInputDescription) String ¶
func (s KinesisStreamsInputDescription) String() string
String returns the string representation
type KinesisStreamsInputUpdate ¶
type KinesisStreamsInputUpdate struct { // Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read. ResourceARNUpdate *string `min:"1" type:"string"` // ARN of the IAM role that Amazon Kinesis Analytics can assume to access the // stream on your behalf. You need to grant the necessary permissions to this // role. RoleARNUpdate *string `min:"1" type:"string"` // contains filtered or unexported fields }
When updating application input configuration, provides information about an Amazon Kinesis stream as the streaming source.
func (KinesisStreamsInputUpdate) String ¶
func (s KinesisStreamsInputUpdate) String() string
String returns the string representation
func (*KinesisStreamsInputUpdate) Validate ¶
func (s *KinesisStreamsInputUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KinesisStreamsOutput ¶
type KinesisStreamsOutput struct { // ARN of the destination Amazon Kinesis stream to write to. // // ResourceARN is a required field ResourceARN *string `min:"1" type:"string" required:"true"` // ARN of the IAM role that Amazon Kinesis Analytics can assume to write to // the destination stream on your behalf. You need to grant the necessary permissions // to this role. // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
When configuring application output, identifies an Amazon Kinesis stream as the destination. You provide the stream Amazon Resource Name (ARN) and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the stream on your behalf.
func (KinesisStreamsOutput) String ¶
func (s KinesisStreamsOutput) String() string
String returns the string representation
func (*KinesisStreamsOutput) Validate ¶
func (s *KinesisStreamsOutput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KinesisStreamsOutputDescription ¶
type KinesisStreamsOutputDescription struct { // Amazon Resource Name (ARN) of the Amazon Kinesis stream. ResourceARN *string `min:"1" type:"string"` // ARN of the IAM role that Amazon Kinesis Analytics can assume to access the // stream. RoleARN *string `min:"1" type:"string"` // contains filtered or unexported fields }
For an application output, describes the Amazon Kinesis stream configured as its destination.
func (KinesisStreamsOutputDescription) String ¶
func (s KinesisStreamsOutputDescription) String() string
String returns the string representation
type KinesisStreamsOutputUpdate ¶
type KinesisStreamsOutputUpdate struct { // Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want to // write the output. ResourceARNUpdate *string `min:"1" type:"string"` // ARN of the IAM role that Amazon Kinesis Analytics can assume to access the // stream on your behalf. You need to grant the necessary permissions to this // role. RoleARNUpdate *string `min:"1" type:"string"` // contains filtered or unexported fields }
When updating an output configuration using the UpdateApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) operation, provides information about an Amazon Kinesis stream configured as the destination.
func (KinesisStreamsOutputUpdate) String ¶
func (s KinesisStreamsOutputUpdate) String() string
String returns the string representation
func (*KinesisStreamsOutputUpdate) Validate ¶
func (s *KinesisStreamsOutputUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type LambdaOutput ¶ added in v0.2.0
type LambdaOutput struct { // Amazon Resource Name (ARN) of the destination Lambda function to write to. // // To specify an earlier version of the Lambda function than the latest, include // the Lambda function version in the Lambda function ARN. For more information // about Lambda ARNs, see Example ARNs: AWS Lambda (/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) // // ResourceARN is a required field ResourceARN *string `min:"1" type:"string" required:"true"` // ARN of the IAM role that Amazon Kinesis Analytics can assume to write to // the destination function on your behalf. You need to grant the necessary // permissions to this role. // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
When configuring application output, identifies an AWS Lambda function as the destination. You provide the function Amazon Resource Name (ARN) and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the function on your behalf.
func (LambdaOutput) String ¶ added in v0.2.0
func (s LambdaOutput) String() string
String returns the string representation
func (*LambdaOutput) Validate ¶ added in v0.2.0
func (s *LambdaOutput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type LambdaOutputDescription ¶ added in v0.2.0
type LambdaOutputDescription struct { // Amazon Resource Name (ARN) of the destination Lambda function. ResourceARN *string `min:"1" type:"string"` // ARN of the IAM role that Amazon Kinesis Analytics can assume to write to // the destination function. RoleARN *string `min:"1" type:"string"` // contains filtered or unexported fields }
For an application output, describes the AWS Lambda function configured as its destination.
func (LambdaOutputDescription) String ¶ added in v0.2.0
func (s LambdaOutputDescription) String() string
String returns the string representation
type LambdaOutputUpdate ¶ added in v0.2.0
type LambdaOutputUpdate struct { // Amazon Resource Name (ARN) of the destination Lambda function. // // To specify an earlier version of the Lambda function than the latest, include // the Lambda function version in the Lambda function ARN. For more information // about Lambda ARNs, see Example ARNs: AWS Lambda (/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) ResourceARNUpdate *string `min:"1" type:"string"` // ARN of the IAM role that Amazon Kinesis Analytics can assume to write to // the destination function on your behalf. You need to grant the necessary // permissions to this role. RoleARNUpdate *string `min:"1" type:"string"` // contains filtered or unexported fields }
When updating an output configuration using the UpdateApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) operation, provides information about an AWS Lambda function configured as the destination.
func (LambdaOutputUpdate) String ¶ added in v0.2.0
func (s LambdaOutputUpdate) String() string
String returns the string representation
func (*LambdaOutputUpdate) Validate ¶ added in v0.2.0
func (s *LambdaOutputUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListApplicationsInput ¶
type ListApplicationsInput struct { // Name of the application to start the list with. When using pagination to // retrieve the list, you don't need to specify this parameter in the first // request. However, in subsequent requests, you add the last application name // from the previous response to get the next page of applications. ExclusiveStartApplicationName *string `min:"1" type:"string"` // Maximum number of applications to list. Limit *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
func (ListApplicationsInput) String ¶
func (s ListApplicationsInput) String() string
String returns the string representation
func (*ListApplicationsInput) Validate ¶
func (s *ListApplicationsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListApplicationsOutput ¶
type ListApplicationsOutput struct { // List of ApplicationSummary objects. // // ApplicationSummaries is a required field ApplicationSummaries []ApplicationSummary `type:"list" required:"true"` // Returns true if there are more applications to retrieve. // // HasMoreApplications is a required field HasMoreApplications *bool `type:"boolean" required:"true"` // contains filtered or unexported fields }
func (ListApplicationsOutput) String ¶
func (s ListApplicationsOutput) String() string
String returns the string representation
type ListApplicationsRequest ¶
type ListApplicationsRequest struct { *aws.Request Input *ListApplicationsInput Copy func(*ListApplicationsInput) ListApplicationsRequest }
ListApplicationsRequest is the request type for the ListApplications API operation.
func (ListApplicationsRequest) Send ¶
func (r ListApplicationsRequest) Send(ctx context.Context) (*ListApplicationsResponse, error)
Send marshals and sends the ListApplications API request.
type ListApplicationsResponse ¶ added in v0.9.0
type ListApplicationsResponse struct { *ListApplicationsOutput // contains filtered or unexported fields }
ListApplicationsResponse is the response type for the ListApplications API operation.
func (*ListApplicationsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListApplicationsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListApplications request.
type ListTagsForResourceInput ¶ added in v0.9.0
type ListTagsForResourceInput struct { // The ARN of the application for which to retrieve tags. // // ResourceARN is a required field ResourceARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (ListTagsForResourceInput) String ¶ added in v0.9.0
func (s ListTagsForResourceInput) String() string
String returns the string representation
func (*ListTagsForResourceInput) Validate ¶ added in v0.9.0
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput ¶ added in v0.9.0
type ListTagsForResourceOutput struct { // The key-value tags assigned to the application. Tags []Tag `min:"1" type:"list"` // contains filtered or unexported fields }
func (ListTagsForResourceOutput) String ¶ added in v0.9.0
func (s ListTagsForResourceOutput) String() string
String returns the string representation
type ListTagsForResourceRequest ¶ added in v0.9.0
type ListTagsForResourceRequest struct { *aws.Request Input *ListTagsForResourceInput Copy func(*ListTagsForResourceInput) ListTagsForResourceRequest }
ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.
func (ListTagsForResourceRequest) Send ¶ added in v0.9.0
func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)
Send marshals and sends the ListTagsForResource API request.
type ListTagsForResourceResponse ¶ added in v0.9.0
type ListTagsForResourceResponse struct { *ListTagsForResourceOutput // contains filtered or unexported fields }
ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.
func (*ListTagsForResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListTagsForResource request.
type MappingParameters ¶
type MappingParameters struct { // Provides additional mapping information when the record format uses delimiters // (for example, CSV). CSVMappingParameters *CSVMappingParameters `type:"structure"` // Provides additional mapping information when JSON is the record format on // the streaming source. JSONMappingParameters *JSONMappingParameters `type:"structure"` // contains filtered or unexported fields }
When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
func (MappingParameters) String ¶
func (s MappingParameters) String() string
String returns the string representation
func (*MappingParameters) Validate ¶
func (s *MappingParameters) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Output ¶
type Output struct { // Describes the data format when records are written to the destination. For // more information, see Configuring Application Output (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html). // // DestinationSchema is a required field DestinationSchema *DestinationSchema `type:"structure" required:"true"` // Identifies an Amazon Kinesis Firehose delivery stream as the destination. KinesisFirehoseOutput *KinesisFirehoseOutput `type:"structure"` // Identifies an Amazon Kinesis stream as the destination. KinesisStreamsOutput *KinesisStreamsOutput `type:"structure"` // Identifies an AWS Lambda function as the destination. LambdaOutput *LambdaOutput `type:"structure"` // Name of the in-application stream. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Describes application output configuration in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream.
For limits on how many destinations an application can write and other limitations, see Limits (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html).
type OutputDescription ¶
type OutputDescription struct { // Data format used for writing data to the destination. DestinationSchema *DestinationSchema `type:"structure"` // Describes the Amazon Kinesis Firehose delivery stream configured as the destination // where output is written. KinesisFirehoseOutputDescription *KinesisFirehoseOutputDescription `type:"structure"` // Describes Amazon Kinesis stream configured as the destination where output // is written. KinesisStreamsOutputDescription *KinesisStreamsOutputDescription `type:"structure"` // Describes the AWS Lambda function configured as the destination where output // is written. LambdaOutputDescription *LambdaOutputDescription `type:"structure"` // Name of the in-application stream configured as output. Name *string `min:"1" type:"string"` // A unique identifier for the output configuration. OutputId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Describes the application output configuration, which includes the in-application stream name and the destination where the stream data is written. The destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream.
func (OutputDescription) String ¶
func (s OutputDescription) String() string
String returns the string representation
type OutputUpdate ¶
type OutputUpdate struct { // Describes the data format when records are written to the destination. For // more information, see Configuring Application Output (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html). DestinationSchemaUpdate *DestinationSchema `type:"structure"` // Describes an Amazon Kinesis Firehose delivery stream as the destination for // the output. KinesisFirehoseOutputUpdate *KinesisFirehoseOutputUpdate `type:"structure"` // Describes an Amazon Kinesis stream as the destination for the output. KinesisStreamsOutputUpdate *KinesisStreamsOutputUpdate `type:"structure"` // Describes an AWS Lambda function as the destination for the output. LambdaOutputUpdate *LambdaOutputUpdate `type:"structure"` // If you want to specify a different in-application stream for this output // configuration, use this field to specify the new in-application stream name. NameUpdate *string `min:"1" type:"string"` // Identifies the specific output configuration that you want to update. // // OutputId is a required field OutputId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Describes updates to the output configuration identified by the OutputId.
func (OutputUpdate) String ¶
func (s OutputUpdate) String() string
String returns the string representation
func (*OutputUpdate) Validate ¶
func (s *OutputUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RecordColumn ¶
type RecordColumn struct { // Reference to the data element in the streaming input or the reference data // source. This element is required if the RecordFormatType (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel) // is JSON. Mapping *string `type:"string"` // Name of the column created in the in-application input stream or reference // table. // // Name is a required field Name *string `type:"string" required:"true"` // Type of column created in the in-application input stream or reference table. // // SqlType is a required field SqlType *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
Also used to describe the format of the reference data source.
func (RecordColumn) String ¶
func (s RecordColumn) String() string
String returns the string representation
func (*RecordColumn) Validate ¶
func (s *RecordColumn) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RecordFormat ¶
type RecordFormat struct { // When configuring application input at the time of creating or updating an // application, provides additional mapping information specific to the record // format (such as JSON, CSV, or record fields delimited by some delimiter) // on the streaming source. MappingParameters *MappingParameters `type:"structure"` // The type of record format. // // RecordFormatType is a required field RecordFormatType RecordFormatType `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Describes the record format and relevant mapping information that should be applied to schematize the records on the stream.
func (RecordFormat) String ¶
func (s RecordFormat) String() string
String returns the string representation
func (*RecordFormat) Validate ¶
func (s *RecordFormat) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RecordFormatType ¶
type RecordFormatType string
const ( RecordFormatTypeJson RecordFormatType = "JSON" RecordFormatTypeCsv RecordFormatType = "CSV" )
Enum values for RecordFormatType
func (RecordFormatType) MarshalValue ¶ added in v0.3.0
func (enum RecordFormatType) MarshalValue() (string, error)
func (RecordFormatType) MarshalValueBuf ¶ added in v0.3.0
func (enum RecordFormatType) MarshalValueBuf(b []byte) ([]byte, error)
type ReferenceDataSource ¶
type ReferenceDataSource struct { // Describes the format of the data in the streaming source, and how each data // element maps to corresponding columns created in the in-application stream. // // ReferenceSchema is a required field ReferenceSchema *SourceSchema `type:"structure" required:"true"` // Identifies the S3 bucket and object that contains the reference data. Also // identifies the IAM role Amazon Kinesis Analytics can assume to read this // object on your behalf. An Amazon Kinesis Analytics application loads reference // data only once. If the data changes, you call the UpdateApplication operation // to trigger reloading of data into your application. S3ReferenceDataSource *S3ReferenceDataSource `type:"structure"` // Name of the in-application table to create. // // TableName is a required field TableName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Describes the reference data source by providing the source information (S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.
func (ReferenceDataSource) String ¶
func (s ReferenceDataSource) String() string
String returns the string representation
func (*ReferenceDataSource) Validate ¶
func (s *ReferenceDataSource) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ReferenceDataSourceDescription ¶
type ReferenceDataSourceDescription struct { // ID of the reference data source. This is the ID that Amazon Kinesis Analytics // assigns when you add the reference data source to your application using // the AddApplicationReferenceDataSource (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html) // operation. // // ReferenceId is a required field ReferenceId *string `min:"1" type:"string" required:"true"` // Describes the format of the data in the streaming source, and how each data // element maps to corresponding columns created in the in-application stream. ReferenceSchema *SourceSchema `type:"structure"` // Provides the S3 bucket name, the object key name that contains the reference // data. It also provides the Amazon Resource Name (ARN) of the IAM role that // Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate // the in-application reference table. // // S3ReferenceDataSourceDescription is a required field S3ReferenceDataSourceDescription *S3ReferenceDataSourceDescription `type:"structure" required:"true"` // The in-application table name created by the specific reference data source // configuration. // // TableName is a required field TableName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Describes the reference data source configured for an application.
func (ReferenceDataSourceDescription) String ¶
func (s ReferenceDataSourceDescription) String() string
String returns the string representation
type ReferenceDataSourceUpdate ¶
type ReferenceDataSourceUpdate struct { // ID of the reference data source being updated. You can use the DescribeApplication // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to get this value. // // ReferenceId is a required field ReferenceId *string `min:"1" type:"string" required:"true"` // Describes the format of the data in the streaming source, and how each data // element maps to corresponding columns created in the in-application stream. ReferenceSchemaUpdate *SourceSchema `type:"structure"` // Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis // Analytics can assume to read the Amazon S3 object on your behalf and populate // the in-application reference table. S3ReferenceDataSourceUpdate *S3ReferenceDataSourceUpdate `type:"structure"` // In-application table name that is created by this update. TableNameUpdate *string `min:"1" type:"string"` // contains filtered or unexported fields }
When you update a reference data source configuration for an application, this object provides all the updated values (such as the source bucket name and object key name), the in-application table name that is created, and updated mapping information that maps the data in the Amazon S3 object to the in-application reference table that is created.
func (ReferenceDataSourceUpdate) String ¶
func (s ReferenceDataSourceUpdate) String() string
String returns the string representation
func (*ReferenceDataSourceUpdate) Validate ¶
func (s *ReferenceDataSourceUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type S3Configuration ¶
type S3Configuration struct { // ARN of the S3 bucket that contains the data. // // BucketARN is a required field BucketARN *string `min:"1" type:"string" required:"true"` // The name of the object that contains the data. // // FileKey is a required field FileKey *string `min:"1" type:"string" required:"true"` // IAM ARN of the role used to access the data. // // RoleARN is a required field RoleARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Provides a description of an Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 bucket, the ARN of the IAM role that is used to access the bucket, and the name of the Amazon S3 object that contains the data.
func (S3Configuration) String ¶
func (s S3Configuration) String() string
String returns the string representation
func (*S3Configuration) Validate ¶
func (s *S3Configuration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type S3ReferenceDataSource ¶
type S3ReferenceDataSource struct { // Amazon Resource Name (ARN) of the S3 bucket. // // BucketARN is a required field BucketARN *string `min:"1" type:"string" required:"true"` // Object key name containing reference data. // // FileKey is a required field FileKey *string `min:"1" type:"string" required:"true"` // ARN of the IAM role that the service can assume to read data on your behalf. // This role must have permission for the s3:GetObject action on the object // and trust policy that allows Amazon Kinesis Analytics service principal to // assume this role. // // ReferenceRoleARN is a required field ReferenceRoleARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf.
An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) operation to trigger reloading of data into your application.
func (S3ReferenceDataSource) String ¶
func (s S3ReferenceDataSource) String() string
String returns the string representation
func (*S3ReferenceDataSource) Validate ¶
func (s *S3ReferenceDataSource) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type S3ReferenceDataSourceDescription ¶
type S3ReferenceDataSourceDescription struct { // Amazon Resource Name (ARN) of the S3 bucket. // // BucketARN is a required field BucketARN *string `min:"1" type:"string" required:"true"` // Amazon S3 object key name. // // FileKey is a required field FileKey *string `min:"1" type:"string" required:"true"` // ARN of the IAM role that Amazon Kinesis Analytics can assume to read the // Amazon S3 object on your behalf to populate the in-application reference // table. // // ReferenceRoleARN is a required field ReferenceRoleARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Provides the bucket name and object key name that stores the reference data.
func (S3ReferenceDataSourceDescription) String ¶
func (s S3ReferenceDataSourceDescription) String() string
String returns the string representation
type S3ReferenceDataSourceUpdate ¶
type S3ReferenceDataSourceUpdate struct { // Amazon Resource Name (ARN) of the S3 bucket. BucketARNUpdate *string `min:"1" type:"string"` // Object key name. FileKeyUpdate *string `min:"1" type:"string"` // ARN of the IAM role that Amazon Kinesis Analytics can assume to read the // Amazon S3 object and populate the in-application. ReferenceRoleARNUpdate *string `min:"1" type:"string"` // contains filtered or unexported fields }
Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.
func (S3ReferenceDataSourceUpdate) String ¶
func (s S3ReferenceDataSourceUpdate) String() string
String returns the string representation
func (*S3ReferenceDataSourceUpdate) Validate ¶
func (s *S3ReferenceDataSourceUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SourceSchema ¶
type SourceSchema struct { // A list of RecordColumn objects. // // RecordColumns is a required field RecordColumns []RecordColumn `min:"1" type:"list" required:"true"` // Specifies the encoding of the records in the streaming source. For example, // UTF-8. RecordEncoding *string `type:"string"` // Specifies the format of the records on the streaming source. // // RecordFormat is a required field RecordFormat *RecordFormat `type:"structure" required:"true"` // contains filtered or unexported fields }
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
func (SourceSchema) String ¶
func (s SourceSchema) String() string
String returns the string representation
func (*SourceSchema) Validate ¶
func (s *SourceSchema) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartApplicationInput ¶
type StartApplicationInput struct { // Name of the application. // // ApplicationName is a required field ApplicationName *string `min:"1" type:"string" required:"true"` // Identifies the specific input, by ID, that the application starts consuming. // Amazon Kinesis Analytics starts reading the streaming source associated with // the input. You can also specify where in the streaming source you want Amazon // Kinesis Analytics to start reading. // // InputConfigurations is a required field InputConfigurations []InputConfiguration `type:"list" required:"true"` // contains filtered or unexported fields }
func (StartApplicationInput) String ¶
func (s StartApplicationInput) String() string
String returns the string representation
func (*StartApplicationInput) Validate ¶
func (s *StartApplicationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartApplicationOutput ¶
type StartApplicationOutput struct {
// contains filtered or unexported fields
}
func (StartApplicationOutput) String ¶
func (s StartApplicationOutput) String() string
String returns the string representation
type StartApplicationRequest ¶
type StartApplicationRequest struct { *aws.Request Input *StartApplicationInput Copy func(*StartApplicationInput) StartApplicationRequest }
StartApplicationRequest is the request type for the StartApplication API operation.
func (StartApplicationRequest) Send ¶
func (r StartApplicationRequest) Send(ctx context.Context) (*StartApplicationResponse, error)
Send marshals and sends the StartApplication API request.
type StartApplicationResponse ¶ added in v0.9.0
type StartApplicationResponse struct { *StartApplicationOutput // contains filtered or unexported fields }
StartApplicationResponse is the response type for the StartApplication API operation.
func (*StartApplicationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *StartApplicationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the StartApplication request.
type StopApplicationInput ¶
type StopApplicationInput struct { // Name of the running application to stop. // // ApplicationName is a required field ApplicationName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (StopApplicationInput) String ¶
func (s StopApplicationInput) String() string
String returns the string representation
func (*StopApplicationInput) Validate ¶
func (s *StopApplicationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StopApplicationOutput ¶
type StopApplicationOutput struct {
// contains filtered or unexported fields
}
func (StopApplicationOutput) String ¶
func (s StopApplicationOutput) String() string
String returns the string representation
type StopApplicationRequest ¶
type StopApplicationRequest struct { *aws.Request Input *StopApplicationInput Copy func(*StopApplicationInput) StopApplicationRequest }
StopApplicationRequest is the request type for the StopApplication API operation.
func (StopApplicationRequest) Send ¶
func (r StopApplicationRequest) Send(ctx context.Context) (*StopApplicationResponse, error)
Send marshals and sends the StopApplication API request.
type StopApplicationResponse ¶ added in v0.9.0
type StopApplicationResponse struct { *StopApplicationOutput // contains filtered or unexported fields }
StopApplicationResponse is the response type for the StopApplication API operation.
func (*StopApplicationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *StopApplicationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the StopApplication request.
type Tag ¶ added in v0.9.0
type Tag struct { // The key of the key-value tag. // // Key is a required field Key *string `min:"1" type:"string" required:"true"` // The value of the key-value tag. The value is optional. Value *string `type:"string"` // contains filtered or unexported fields }
A key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. 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/dev/how-tagging.html).
type TagResourceInput ¶ added in v0.9.0
type TagResourceInput struct { // The ARN of the application to assign the tags. // // ResourceARN is a required field ResourceARN *string `min:"1" type:"string" required:"true"` // The key-value tags to assign to the application. // // Tags is a required field Tags []Tag `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
func (TagResourceInput) String ¶ added in v0.9.0
func (s TagResourceInput) String() string
String returns the string representation
func (*TagResourceInput) Validate ¶ added in v0.9.0
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput ¶ added in v0.9.0
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (TagResourceOutput) String ¶ added in v0.9.0
func (s TagResourceOutput) String() string
String returns the string representation
type TagResourceRequest ¶ added in v0.9.0
type TagResourceRequest struct { *aws.Request Input *TagResourceInput Copy func(*TagResourceInput) TagResourceRequest }
TagResourceRequest is the request type for the TagResource API operation.
func (TagResourceRequest) Send ¶ added in v0.9.0
func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)
Send marshals and sends the TagResource API request.
type TagResourceResponse ¶ added in v0.9.0
type TagResourceResponse struct { *TagResourceOutput // contains filtered or unexported fields }
TagResourceResponse is the response type for the TagResource API operation.
func (*TagResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the TagResource request.
type UntagResourceInput ¶ added in v0.9.0
type UntagResourceInput struct { // The ARN of the Kinesis Analytics application from which to remove the tags. // // ResourceARN is a required field ResourceARN *string `min:"1" type:"string" required:"true"` // A list of keys of tags to remove from the specified application. // // TagKeys is a required field TagKeys []string `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
func (UntagResourceInput) String ¶ added in v0.9.0
func (s UntagResourceInput) String() string
String returns the string representation
func (*UntagResourceInput) Validate ¶ added in v0.9.0
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput ¶ added in v0.9.0
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
func (UntagResourceOutput) String ¶ added in v0.9.0
func (s UntagResourceOutput) String() string
String returns the string representation
type UntagResourceRequest ¶ added in v0.9.0
type UntagResourceRequest struct { *aws.Request Input *UntagResourceInput Copy func(*UntagResourceInput) UntagResourceRequest }
UntagResourceRequest is the request type for the UntagResource API operation.
func (UntagResourceRequest) Send ¶ added in v0.9.0
func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)
Send marshals and sends the UntagResource API request.
type UntagResourceResponse ¶ added in v0.9.0
type UntagResourceResponse struct { *UntagResourceOutput // contains filtered or unexported fields }
UntagResourceResponse is the response type for the UntagResource API operation.
func (*UntagResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UntagResource request.
type UpdateApplicationInput ¶
type UpdateApplicationInput struct { // Name of the Amazon Kinesis Analytics application to update. // // ApplicationName is a required field ApplicationName *string `min:"1" type:"string" required:"true"` // Describes application updates. // // ApplicationUpdate is a required field ApplicationUpdate *ApplicationUpdate `type:"structure" required:"true"` // The current application version ID. You can use the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to get this value. // // CurrentApplicationVersionId is a required field CurrentApplicationVersionId *int64 `min:"1" type:"long" required:"true"` // contains filtered or unexported fields }
func (UpdateApplicationInput) String ¶
func (s UpdateApplicationInput) String() string
String returns the string representation
func (*UpdateApplicationInput) Validate ¶
func (s *UpdateApplicationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateApplicationOutput ¶
type UpdateApplicationOutput struct {
// contains filtered or unexported fields
}
func (UpdateApplicationOutput) String ¶
func (s UpdateApplicationOutput) String() string
String returns the string representation
type UpdateApplicationRequest ¶
type UpdateApplicationRequest struct { *aws.Request Input *UpdateApplicationInput Copy func(*UpdateApplicationInput) UpdateApplicationRequest }
UpdateApplicationRequest is the request type for the UpdateApplication API operation.
func (UpdateApplicationRequest) Send ¶
func (r UpdateApplicationRequest) Send(ctx context.Context) (*UpdateApplicationResponse, error)
Send marshals and sends the UpdateApplication API request.
type UpdateApplicationResponse ¶ added in v0.9.0
type UpdateApplicationResponse struct { *UpdateApplicationOutput // contains filtered or unexported fields }
UpdateApplicationResponse is the response type for the UpdateApplication API operation.
func (*UpdateApplicationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateApplicationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateApplication request.
Source Files ¶
- api_client.go
- api_doc.go
- api_enums.go
- api_errors.go
- api_op_AddApplicationCloudWatchLoggingOption.go
- api_op_AddApplicationInput.go
- api_op_AddApplicationInputProcessingConfiguration.go
- api_op_AddApplicationOutput.go
- api_op_AddApplicationReferenceDataSource.go
- api_op_CreateApplication.go
- api_op_DeleteApplication.go
- api_op_DeleteApplicationCloudWatchLoggingOption.go
- api_op_DeleteApplicationInputProcessingConfiguration.go
- api_op_DeleteApplicationOutput.go
- api_op_DeleteApplicationReferenceDataSource.go
- api_op_DescribeApplication.go
- api_op_DiscoverInputSchema.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
- api_types.go
Directories ¶
Path | Synopsis |
---|---|
Package kinesisanalyticsiface provides an interface to enable mocking the Amazon Kinesis Analytics service client for testing your code.
|
Package kinesisanalyticsiface provides an interface to enable mocking the Amazon Kinesis Analytics service client for testing your code. |