Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- InvalidApplicationConfigurationException
- ResourceProvisionedThroughputExceededException
- UnsupportedOperationException
- InvalidArgumentException
- TooManyTagsException
- CodeValidationException
- ConcurrentModificationException
- ServiceUnavailableException
- UnableToDetectSchemaException
- ResourceNotFoundException
- LimitExceededException
- ResourceInUseException
- Waiters
- Operations
- AddApplicationOutput
- DiscoverInputSchema
- DescribeApplication
- StartApplication
- ListTagsForResource
- DeleteApplicationReferenceDataSource
- DeleteApplication
- UpdateApplication
- DeleteApplicationCloudWatchLoggingOption
- AddApplicationInputProcessingConfiguration
- CreateApplication
- DeleteApplicationOutput
- StopApplication
- AddApplicationReferenceDataSource
- AddApplicationInput
- TagResource
- AddApplicationCloudWatchLoggingOption
- ListApplications
- UntagResource
- DeleteApplicationInputProcessingConfiguration
- Types
- ApplicationStatus
- InputStartingPosition
- RecordFormatType
- ApplicationDetail
- ApplicationSummary
- ApplicationUpdate
- CSVMappingParameters
- CloudWatchLoggingOption
- CloudWatchLoggingOptionDescription
- CloudWatchLoggingOptionUpdate
- DestinationSchema
- Input
- InputConfiguration
- InputDescription
- InputLambdaProcessor
- InputLambdaProcessorDescription
- InputLambdaProcessorUpdate
- InputParallelism
- InputParallelismUpdate
- InputProcessingConfiguration
- InputProcessingConfigurationDescription
- InputProcessingConfigurationUpdate
- InputSchemaUpdate
- InputStartingPositionConfiguration
- InputUpdate
- JSONMappingParameters
- KinesisFirehoseInput
- KinesisFirehoseInputDescription
- KinesisFirehoseInputUpdate
- KinesisFirehoseOutput
- KinesisFirehoseOutputDescription
- KinesisFirehoseOutputUpdate
- KinesisStreamsInput
- KinesisStreamsInputDescription
- KinesisStreamsInputUpdate
- KinesisStreamsOutput
- KinesisStreamsOutputDescription
- KinesisStreamsOutputUpdate
- LambdaOutput
- LambdaOutputDescription
- LambdaOutputUpdate
- MappingParameters
- Output
- OutputDescription
- OutputUpdate
- RecordColumn
- RecordFormat
- ReferenceDataSource
- ReferenceDataSourceDescription
- ReferenceDataSourceUpdate
- S3Configuration
- S3ReferenceDataSource
- S3ReferenceDataSourceDescription
- S3ReferenceDataSourceUpdate
- SourceSchema
- Tag
Derived from API version 2015-08-14
of the AWS service descriptions, licensed under Apache 2.0.
Amazon Kinesis Analytics is the easiest way to process streaming data in real time with standard SQL without having to learn new programming languages or processing frameworks. Amazon Kinesis Analytics enables you to create and run SQL queries on streaming data so that you can gain actionable insights and respond to your business and customer needs promptly. Amazon Kinesis Analytics takes care of everything required to run your queries continuously and scales automatically to match the volume and throughput rate of your incoming data. With Amazon Kinesis Analytics, you only pay for the resources your queries consume. There is no minimum fee or setup cost.
Synopsis
- defaultService :: Service
- _InvalidApplicationConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError
- _CodeValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnableToDetectSchemaException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- data AddApplicationOutput = AddApplicationOutput' Text Natural Output
- newAddApplicationOutput :: Text -> Natural -> Output -> AddApplicationOutput
- data AddApplicationOutputResponse = AddApplicationOutputResponse' Int
- newAddApplicationOutputResponse :: Int -> AddApplicationOutputResponse
- data DiscoverInputSchema = DiscoverInputSchema' (Maybe InputStartingPositionConfiguration) (Maybe InputProcessingConfiguration) (Maybe S3Configuration) (Maybe Text) (Maybe Text)
- newDiscoverInputSchema :: DiscoverInputSchema
- data DiscoverInputSchemaResponse = DiscoverInputSchemaResponse' (Maybe [Text]) (Maybe SourceSchema) (Maybe [Text]) (Maybe [[Text]]) Int
- newDiscoverInputSchemaResponse :: Int -> DiscoverInputSchemaResponse
- data DescribeApplication = DescribeApplication' Text
- newDescribeApplication :: Text -> DescribeApplication
- data DescribeApplicationResponse = DescribeApplicationResponse' Int ApplicationDetail
- newDescribeApplicationResponse :: Int -> ApplicationDetail -> DescribeApplicationResponse
- data StartApplication = StartApplication' Text [InputConfiguration]
- newStartApplication :: Text -> StartApplication
- data StartApplicationResponse = StartApplicationResponse' Int
- newStartApplicationResponse :: Int -> StartApplicationResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (NonEmpty Tag)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data DeleteApplicationReferenceDataSource = DeleteApplicationReferenceDataSource' Text Natural Text
- newDeleteApplicationReferenceDataSource :: Text -> Natural -> Text -> DeleteApplicationReferenceDataSource
- data DeleteApplicationReferenceDataSourceResponse = DeleteApplicationReferenceDataSourceResponse' Int
- newDeleteApplicationReferenceDataSourceResponse :: Int -> DeleteApplicationReferenceDataSourceResponse
- data DeleteApplication = DeleteApplication' Text POSIX
- newDeleteApplication :: Text -> UTCTime -> DeleteApplication
- data DeleteApplicationResponse = DeleteApplicationResponse' Int
- newDeleteApplicationResponse :: Int -> DeleteApplicationResponse
- data UpdateApplication = UpdateApplication' Text Natural ApplicationUpdate
- newUpdateApplication :: Text -> Natural -> ApplicationUpdate -> UpdateApplication
- data UpdateApplicationResponse = UpdateApplicationResponse' Int
- newUpdateApplicationResponse :: Int -> UpdateApplicationResponse
- data DeleteApplicationCloudWatchLoggingOption = DeleteApplicationCloudWatchLoggingOption' Text Natural Text
- newDeleteApplicationCloudWatchLoggingOption :: Text -> Natural -> Text -> DeleteApplicationCloudWatchLoggingOption
- data DeleteApplicationCloudWatchLoggingOptionResponse = DeleteApplicationCloudWatchLoggingOptionResponse' Int
- newDeleteApplicationCloudWatchLoggingOptionResponse :: Int -> DeleteApplicationCloudWatchLoggingOptionResponse
- data AddApplicationInputProcessingConfiguration = AddApplicationInputProcessingConfiguration' Text Natural Text InputProcessingConfiguration
- newAddApplicationInputProcessingConfiguration :: Text -> Natural -> Text -> InputProcessingConfiguration -> AddApplicationInputProcessingConfiguration
- data AddApplicationInputProcessingConfigurationResponse = AddApplicationInputProcessingConfigurationResponse' Int
- newAddApplicationInputProcessingConfigurationResponse :: Int -> AddApplicationInputProcessingConfigurationResponse
- data CreateApplication = CreateApplication' (Maybe Text) (Maybe [Input]) (Maybe [CloudWatchLoggingOption]) (Maybe [Output]) (Maybe Text) (Maybe (NonEmpty Tag)) Text
- newCreateApplication :: Text -> CreateApplication
- data CreateApplicationResponse = CreateApplicationResponse' Int ApplicationSummary
- newCreateApplicationResponse :: Int -> ApplicationSummary -> CreateApplicationResponse
- data DeleteApplicationOutput = DeleteApplicationOutput' Text Natural Text
- newDeleteApplicationOutput :: Text -> Natural -> Text -> DeleteApplicationOutput
- data DeleteApplicationOutputResponse = DeleteApplicationOutputResponse' Int
- newDeleteApplicationOutputResponse :: Int -> DeleteApplicationOutputResponse
- data StopApplication = StopApplication' Text
- newStopApplication :: Text -> StopApplication
- data StopApplicationResponse = StopApplicationResponse' Int
- newStopApplicationResponse :: Int -> StopApplicationResponse
- data AddApplicationReferenceDataSource = AddApplicationReferenceDataSource' Text Natural ReferenceDataSource
- newAddApplicationReferenceDataSource :: Text -> Natural -> ReferenceDataSource -> AddApplicationReferenceDataSource
- data AddApplicationReferenceDataSourceResponse = AddApplicationReferenceDataSourceResponse' Int
- newAddApplicationReferenceDataSourceResponse :: Int -> AddApplicationReferenceDataSourceResponse
- data AddApplicationInput = AddApplicationInput' Text Natural Input
- newAddApplicationInput :: Text -> Natural -> Input -> AddApplicationInput
- data AddApplicationInputResponse = AddApplicationInputResponse' Int
- newAddApplicationInputResponse :: Int -> AddApplicationInputResponse
- data TagResource = TagResource' Text (NonEmpty Tag)
- newTagResource :: Text -> NonEmpty Tag -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data AddApplicationCloudWatchLoggingOption = AddApplicationCloudWatchLoggingOption' Text Natural CloudWatchLoggingOption
- newAddApplicationCloudWatchLoggingOption :: Text -> Natural -> CloudWatchLoggingOption -> AddApplicationCloudWatchLoggingOption
- data AddApplicationCloudWatchLoggingOptionResponse = AddApplicationCloudWatchLoggingOptionResponse' Int
- newAddApplicationCloudWatchLoggingOptionResponse :: Int -> AddApplicationCloudWatchLoggingOptionResponse
- data ListApplications = ListApplications' (Maybe Natural) (Maybe Text)
- newListApplications :: ListApplications
- data ListApplicationsResponse = ListApplicationsResponse' Int [ApplicationSummary] Bool
- newListApplicationsResponse :: Int -> Bool -> ListApplicationsResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data DeleteApplicationInputProcessingConfiguration = DeleteApplicationInputProcessingConfiguration' Text Natural Text
- newDeleteApplicationInputProcessingConfiguration :: Text -> Natural -> Text -> DeleteApplicationInputProcessingConfiguration
- data DeleteApplicationInputProcessingConfigurationResponse = DeleteApplicationInputProcessingConfigurationResponse' Int
- newDeleteApplicationInputProcessingConfigurationResponse :: Int -> DeleteApplicationInputProcessingConfigurationResponse
- newtype ApplicationStatus where
- ApplicationStatus' { }
- pattern ApplicationStatus_DELETING :: ApplicationStatus
- pattern ApplicationStatus_READY :: ApplicationStatus
- pattern ApplicationStatus_RUNNING :: ApplicationStatus
- pattern ApplicationStatus_STARTING :: ApplicationStatus
- pattern ApplicationStatus_STOPPING :: ApplicationStatus
- pattern ApplicationStatus_UPDATING :: ApplicationStatus
- newtype InputStartingPosition where
- newtype RecordFormatType where
- RecordFormatType' { }
- pattern RecordFormatType_CSV :: RecordFormatType
- pattern RecordFormatType_JSON :: RecordFormatType
- data ApplicationDetail = ApplicationDetail' (Maybe Text) (Maybe [OutputDescription]) (Maybe [CloudWatchLoggingOptionDescription]) (Maybe [ReferenceDataSourceDescription]) (Maybe [InputDescription]) (Maybe Text) (Maybe POSIX) (Maybe POSIX) Text Text ApplicationStatus Natural
- newApplicationDetail :: Text -> Text -> ApplicationStatus -> Natural -> ApplicationDetail
- data ApplicationSummary = ApplicationSummary' Text Text ApplicationStatus
- newApplicationSummary :: Text -> Text -> ApplicationStatus -> ApplicationSummary
- data ApplicationUpdate = ApplicationUpdate' (Maybe [ReferenceDataSourceUpdate]) (Maybe [InputUpdate]) (Maybe [CloudWatchLoggingOptionUpdate]) (Maybe [OutputUpdate]) (Maybe Text)
- newApplicationUpdate :: ApplicationUpdate
- data CSVMappingParameters = CSVMappingParameters' Text Text
- newCSVMappingParameters :: Text -> Text -> CSVMappingParameters
- data CloudWatchLoggingOption = CloudWatchLoggingOption' Text Text
- newCloudWatchLoggingOption :: Text -> Text -> CloudWatchLoggingOption
- data CloudWatchLoggingOptionDescription = CloudWatchLoggingOptionDescription' (Maybe Text) Text Text
- newCloudWatchLoggingOptionDescription :: Text -> Text -> CloudWatchLoggingOptionDescription
- data CloudWatchLoggingOptionUpdate = CloudWatchLoggingOptionUpdate' (Maybe Text) (Maybe Text) Text
- newCloudWatchLoggingOptionUpdate :: Text -> CloudWatchLoggingOptionUpdate
- data DestinationSchema = DestinationSchema' RecordFormatType
- newDestinationSchema :: RecordFormatType -> DestinationSchema
- data Input = Input' (Maybe InputParallelism) (Maybe InputProcessingConfiguration) (Maybe KinesisStreamsInput) (Maybe KinesisFirehoseInput) Text SourceSchema
- newInput :: Text -> SourceSchema -> Input
- data InputConfiguration = InputConfiguration' Text InputStartingPositionConfiguration
- newInputConfiguration :: Text -> InputStartingPositionConfiguration -> InputConfiguration
- data InputDescription = InputDescription' (Maybe InputStartingPositionConfiguration) (Maybe InputParallelism) (Maybe Text) (Maybe [Text]) (Maybe KinesisFirehoseInputDescription) (Maybe SourceSchema) (Maybe KinesisStreamsInputDescription) (Maybe Text) (Maybe InputProcessingConfigurationDescription)
- newInputDescription :: InputDescription
- data InputLambdaProcessor = InputLambdaProcessor' Text Text
- newInputLambdaProcessor :: Text -> Text -> InputLambdaProcessor
- data InputLambdaProcessorDescription = InputLambdaProcessorDescription' (Maybe Text) (Maybe Text)
- newInputLambdaProcessorDescription :: InputLambdaProcessorDescription
- data InputLambdaProcessorUpdate = InputLambdaProcessorUpdate' (Maybe Text) (Maybe Text)
- newInputLambdaProcessorUpdate :: InputLambdaProcessorUpdate
- data InputParallelism = InputParallelism' (Maybe Natural)
- newInputParallelism :: InputParallelism
- data InputParallelismUpdate = InputParallelismUpdate' (Maybe Natural)
- newInputParallelismUpdate :: InputParallelismUpdate
- data InputProcessingConfiguration = InputProcessingConfiguration' InputLambdaProcessor
- newInputProcessingConfiguration :: InputLambdaProcessor -> InputProcessingConfiguration
- data InputProcessingConfigurationDescription = InputProcessingConfigurationDescription' (Maybe InputLambdaProcessorDescription)
- newInputProcessingConfigurationDescription :: InputProcessingConfigurationDescription
- data InputProcessingConfigurationUpdate = InputProcessingConfigurationUpdate' InputLambdaProcessorUpdate
- newInputProcessingConfigurationUpdate :: InputLambdaProcessorUpdate -> InputProcessingConfigurationUpdate
- data InputSchemaUpdate = InputSchemaUpdate' (Maybe RecordFormat) (Maybe Text) (Maybe (NonEmpty RecordColumn))
- newInputSchemaUpdate :: InputSchemaUpdate
- data InputStartingPositionConfiguration = InputStartingPositionConfiguration' (Maybe InputStartingPosition)
- newInputStartingPositionConfiguration :: InputStartingPositionConfiguration
- data InputUpdate = InputUpdate' (Maybe InputProcessingConfigurationUpdate) (Maybe KinesisStreamsInputUpdate) (Maybe InputParallelismUpdate) (Maybe Text) (Maybe InputSchemaUpdate) (Maybe KinesisFirehoseInputUpdate) Text
- newInputUpdate :: Text -> InputUpdate
- data JSONMappingParameters = JSONMappingParameters' Text
- newJSONMappingParameters :: Text -> JSONMappingParameters
- data KinesisFirehoseInput = KinesisFirehoseInput' Text Text
- newKinesisFirehoseInput :: Text -> Text -> KinesisFirehoseInput
- data KinesisFirehoseInputDescription = KinesisFirehoseInputDescription' (Maybe Text) (Maybe Text)
- newKinesisFirehoseInputDescription :: KinesisFirehoseInputDescription
- data KinesisFirehoseInputUpdate = KinesisFirehoseInputUpdate' (Maybe Text) (Maybe Text)
- newKinesisFirehoseInputUpdate :: KinesisFirehoseInputUpdate
- data KinesisFirehoseOutput = KinesisFirehoseOutput' Text Text
- newKinesisFirehoseOutput :: Text -> Text -> KinesisFirehoseOutput
- data KinesisFirehoseOutputDescription = KinesisFirehoseOutputDescription' (Maybe Text) (Maybe Text)
- newKinesisFirehoseOutputDescription :: KinesisFirehoseOutputDescription
- data KinesisFirehoseOutputUpdate = KinesisFirehoseOutputUpdate' (Maybe Text) (Maybe Text)
- newKinesisFirehoseOutputUpdate :: KinesisFirehoseOutputUpdate
- data KinesisStreamsInput = KinesisStreamsInput' Text Text
- newKinesisStreamsInput :: Text -> Text -> KinesisStreamsInput
- data KinesisStreamsInputDescription = KinesisStreamsInputDescription' (Maybe Text) (Maybe Text)
- newKinesisStreamsInputDescription :: KinesisStreamsInputDescription
- data KinesisStreamsInputUpdate = KinesisStreamsInputUpdate' (Maybe Text) (Maybe Text)
- newKinesisStreamsInputUpdate :: KinesisStreamsInputUpdate
- data KinesisStreamsOutput = KinesisStreamsOutput' Text Text
- newKinesisStreamsOutput :: Text -> Text -> KinesisStreamsOutput
- data KinesisStreamsOutputDescription = KinesisStreamsOutputDescription' (Maybe Text) (Maybe Text)
- newKinesisStreamsOutputDescription :: KinesisStreamsOutputDescription
- data KinesisStreamsOutputUpdate = KinesisStreamsOutputUpdate' (Maybe Text) (Maybe Text)
- newKinesisStreamsOutputUpdate :: KinesisStreamsOutputUpdate
- data LambdaOutput = LambdaOutput' Text Text
- newLambdaOutput :: Text -> Text -> LambdaOutput
- data LambdaOutputDescription = LambdaOutputDescription' (Maybe Text) (Maybe Text)
- newLambdaOutputDescription :: LambdaOutputDescription
- data LambdaOutputUpdate = LambdaOutputUpdate' (Maybe Text) (Maybe Text)
- newLambdaOutputUpdate :: LambdaOutputUpdate
- data MappingParameters = MappingParameters' (Maybe CSVMappingParameters) (Maybe JSONMappingParameters)
- newMappingParameters :: MappingParameters
- data Output = Output' (Maybe LambdaOutput) (Maybe KinesisStreamsOutput) (Maybe KinesisFirehoseOutput) Text DestinationSchema
- newOutput :: Text -> DestinationSchema -> Output
- data OutputDescription = OutputDescription' (Maybe Text) (Maybe DestinationSchema) (Maybe KinesisFirehoseOutputDescription) (Maybe KinesisStreamsOutputDescription) (Maybe Text) (Maybe LambdaOutputDescription)
- newOutputDescription :: OutputDescription
- data OutputUpdate = OutputUpdate' (Maybe KinesisStreamsOutputUpdate) (Maybe DestinationSchema) (Maybe KinesisFirehoseOutputUpdate) (Maybe Text) (Maybe LambdaOutputUpdate) Text
- newOutputUpdate :: Text -> OutputUpdate
- data RecordColumn = RecordColumn' (Maybe Text) Text Text
- newRecordColumn :: Text -> Text -> RecordColumn
- data RecordFormat = RecordFormat' (Maybe MappingParameters) RecordFormatType
- newRecordFormat :: RecordFormatType -> RecordFormat
- data ReferenceDataSource = ReferenceDataSource' (Maybe S3ReferenceDataSource) Text SourceSchema
- newReferenceDataSource :: Text -> SourceSchema -> ReferenceDataSource
- data ReferenceDataSourceDescription = ReferenceDataSourceDescription' (Maybe SourceSchema) Text Text S3ReferenceDataSourceDescription
- newReferenceDataSourceDescription :: Text -> Text -> S3ReferenceDataSourceDescription -> ReferenceDataSourceDescription
- data ReferenceDataSourceUpdate = ReferenceDataSourceUpdate' (Maybe Text) (Maybe S3ReferenceDataSourceUpdate) (Maybe SourceSchema) Text
- newReferenceDataSourceUpdate :: Text -> ReferenceDataSourceUpdate
- data S3Configuration = S3Configuration' Text Text Text
- newS3Configuration :: Text -> Text -> Text -> S3Configuration
- data S3ReferenceDataSource = S3ReferenceDataSource' Text Text Text
- newS3ReferenceDataSource :: Text -> Text -> Text -> S3ReferenceDataSource
- data S3ReferenceDataSourceDescription = S3ReferenceDataSourceDescription' Text Text Text
- newS3ReferenceDataSourceDescription :: Text -> Text -> Text -> S3ReferenceDataSourceDescription
- data S3ReferenceDataSourceUpdate = S3ReferenceDataSourceUpdate' (Maybe Text) (Maybe Text) (Maybe Text)
- newS3ReferenceDataSourceUpdate :: S3ReferenceDataSourceUpdate
- data SourceSchema = SourceSchema' (Maybe Text) RecordFormat (NonEmpty RecordColumn)
- newSourceSchema :: RecordFormat -> NonEmpty RecordColumn -> SourceSchema
- data Tag = Tag' (Maybe Text) Text
- newTag :: Text -> Tag
Service Configuration
defaultService :: Service Source #
API version 2015-08-14
of the Amazon Kinesis Analytics SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by KinesisAnalytics
.
InvalidApplicationConfigurationException
_InvalidApplicationConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
User-provided application configuration is not valid.
ResourceProvisionedThroughputExceededException
_ResourceProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Discovery failed to get a record from the streaming source because of the Amazon Kinesis Streams ProvisionedThroughputExceededException. For more information, see GetRecords in the Amazon Kinesis Streams API Reference.
UnsupportedOperationException
_UnsupportedOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
InvalidArgumentException
_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Specified input parameter value is invalid.
TooManyTagsException
_TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
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.
CodeValidationException
_CodeValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
User-provided application code (query) is invalid. This can be a simple syntax error.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
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.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service is unavailable. Back off and retry the operation.
UnableToDetectSchemaException
_UnableToDetectSchemaException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Data format is not valid. Amazon Kinesis Analytics is not able to detect schema for the given streaming source.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Specified application can't be found.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exceeded the number of applications allowed.
ResourceInUseException
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Application is not available for this operation.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AddApplicationOutput
data AddApplicationOutput Source #
See: newAddApplicationOutput
smart constructor.
Instances
newAddApplicationOutput Source #
:: Text | |
-> Natural | |
-> Output | |
-> AddApplicationOutput |
Create a value of AddApplicationOutput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationName:AddApplicationOutput'
, addApplicationOutput_applicationName
- Name of the application to which you want to add the output
configuration.
$sel:currentApplicationVersionId:AddApplicationOutput'
, addApplicationOutput_currentApplicationVersionId
- Version of the application to which you want to add the output
configuration. You can use the
DescribeApplication
operation to get the current application version. If the version
specified is not the current version, the
ConcurrentModificationException
is returned.
$sel:output:AddApplicationOutput'
, addApplicationOutput_output
- An array of objects, each describing one output configuration. In the
output configuration, you specify the name of an in-application stream,
a destination (that is, 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.
data AddApplicationOutputResponse Source #
See: newAddApplicationOutputResponse
smart constructor.
Instances
newAddApplicationOutputResponse Source #
Create a value of AddApplicationOutputResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AddApplicationOutputResponse'
, addApplicationOutputResponse_httpStatus
- The response's http status code.
DiscoverInputSchema
data DiscoverInputSchema Source #
See: newDiscoverInputSchema
smart constructor.
DiscoverInputSchema' (Maybe InputStartingPositionConfiguration) (Maybe InputProcessingConfiguration) (Maybe S3Configuration) (Maybe Text) (Maybe Text) |
Instances
newDiscoverInputSchema :: DiscoverInputSchema Source #
Create a value of DiscoverInputSchema
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inputStartingPositionConfiguration:DiscoverInputSchema'
, discoverInputSchema_inputStartingPositionConfiguration
- Point at which you want Amazon Kinesis Analytics to start reading
records from the specified streaming source discovery purposes.
$sel:inputProcessingConfiguration:DiscoverInputSchema'
, discoverInputSchema_inputProcessingConfiguration
- The
InputProcessingConfiguration
to use to preprocess the records before discovering the schema of the
records.
$sel:s3Configuration:DiscoverInputSchema'
, discoverInputSchema_s3Configuration
- Specify this parameter to discover a schema from data in an Amazon S3
object.
$sel:resourceARN:DiscoverInputSchema'
, discoverInputSchema_resourceARN
- Amazon Resource Name (ARN) of the streaming source.
$sel:roleARN:DiscoverInputSchema'
, discoverInputSchema_roleARN
- ARN of the IAM role that Amazon Kinesis Analytics can assume to access
the stream on your behalf.
data DiscoverInputSchemaResponse Source #
See: newDiscoverInputSchemaResponse
smart constructor.
DiscoverInputSchemaResponse' (Maybe [Text]) (Maybe SourceSchema) (Maybe [Text]) (Maybe [[Text]]) Int |
Instances
newDiscoverInputSchemaResponse Source #
Create a value of DiscoverInputSchemaResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rawInputRecords:DiscoverInputSchemaResponse'
, discoverInputSchemaResponse_rawInputRecords
- Raw stream data that was sampled to infer the schema.
$sel:inputSchema:DiscoverInputSchemaResponse'
, discoverInputSchemaResponse_inputSchema
- 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.
$sel:processedInputRecords:DiscoverInputSchemaResponse'
, discoverInputSchemaResponse_processedInputRecords
- Stream data that was modified by the processor specified in the
InputProcessingConfiguration
parameter.
$sel:parsedInputRecords:DiscoverInputSchemaResponse'
, discoverInputSchemaResponse_parsedInputRecords
- An array of elements, where each element corresponds to a row in a
stream record (a stream record can have more than one row).
$sel:httpStatus:DiscoverInputSchemaResponse'
, discoverInputSchemaResponse_httpStatus
- The response's http status code.
DescribeApplication
data DescribeApplication Source #
See: newDescribeApplication
smart constructor.
Instances
newDescribeApplication Source #
Create a value of DescribeApplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationName:DescribeApplication'
, describeApplication_applicationName
- Name of the application.
data DescribeApplicationResponse Source #
See: newDescribeApplicationResponse
smart constructor.
Instances
newDescribeApplicationResponse Source #
Create a value of DescribeApplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeApplicationResponse'
, describeApplicationResponse_httpStatus
- The response's http status code.
$sel:applicationDetail:DescribeApplicationResponse'
, describeApplicationResponse_applicationDetail
- Provides a description of the application, such as the application
Amazon Resource Name (ARN), status, latest version, and input and output
configuration details.
StartApplication
data StartApplication Source #
See: newStartApplication
smart constructor.
Instances
Create a value of StartApplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationName:StartApplication'
, startApplication_applicationName
- Name of the application.
$sel:inputConfigurations:StartApplication'
, startApplication_inputConfigurations
- 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.
data StartApplicationResponse Source #
See: newStartApplicationResponse
smart constructor.
Instances
newStartApplicationResponse Source #
Create a value of StartApplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StartApplicationResponse'
, startApplicationResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:ListTagsForResource'
, listTagsForResource_resourceARN
- The ARN of the application for which to retrieve tags.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- The key-value tags assigned to the application.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
DeleteApplicationReferenceDataSource
data DeleteApplicationReferenceDataSource Source #
See: newDeleteApplicationReferenceDataSource
smart constructor.
Instances
newDeleteApplicationReferenceDataSource Source #
:: Text | |
-> Natural |
|
-> Text | |
-> DeleteApplicationReferenceDataSource |
Create a value of DeleteApplicationReferenceDataSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationName:DeleteApplicationReferenceDataSource'
, deleteApplicationReferenceDataSource_applicationName
- Name of an existing application.
$sel:currentApplicationVersionId:DeleteApplicationReferenceDataSource'
, deleteApplicationReferenceDataSource_currentApplicationVersionId
- Version of the application. You can use the
DescribeApplication
operation to get the current application version. If the version
specified is not the current version, the
ConcurrentModificationException
is returned.
$sel:referenceId:DeleteApplicationReferenceDataSource'
, deleteApplicationReferenceDataSource_referenceId
- ID of the reference data source. When you add a reference data source to
your application using the
AddApplicationReferenceDataSource,
Amazon Kinesis Analytics assigns an ID. You can use the
DescribeApplication
operation to get the reference ID.
data DeleteApplicationReferenceDataSourceResponse Source #
See: newDeleteApplicationReferenceDataSourceResponse
smart constructor.
Instances
Eq DeleteApplicationReferenceDataSourceResponse Source # | |
Read DeleteApplicationReferenceDataSourceResponse Source # | |
Show DeleteApplicationReferenceDataSourceResponse Source # | |
Generic DeleteApplicationReferenceDataSourceResponse Source # | |
NFData DeleteApplicationReferenceDataSourceResponse Source # | |
type Rep DeleteApplicationReferenceDataSourceResponse Source # | |
Defined in Amazonka.KinesisAnalytics.DeleteApplicationReferenceDataSource type Rep DeleteApplicationReferenceDataSourceResponse = D1 ('MetaData "DeleteApplicationReferenceDataSourceResponse" "Amazonka.KinesisAnalytics.DeleteApplicationReferenceDataSource" "libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics" 'False) (C1 ('MetaCons "DeleteApplicationReferenceDataSourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeleteApplicationReferenceDataSourceResponse Source #
:: Int |
|
-> DeleteApplicationReferenceDataSourceResponse |
Create a value of DeleteApplicationReferenceDataSourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteApplicationReferenceDataSourceResponse'
, deleteApplicationReferenceDataSourceResponse_httpStatus
- The response's http status code.
DeleteApplication
data DeleteApplication Source #
See: newDeleteApplication
smart constructor.
Instances
:: Text | |
-> UTCTime | |
-> DeleteApplication |
Create a value of DeleteApplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationName:DeleteApplication'
, deleteApplication_applicationName
- Name of the Amazon Kinesis Analytics application to delete.
$sel:createTimestamp:DeleteApplication'
, deleteApplication_createTimestamp
- You can use the DescribeApplication
operation to get this value.
data DeleteApplicationResponse Source #
See: newDeleteApplicationResponse
smart constructor.
Instances
newDeleteApplicationResponse Source #
Create a value of DeleteApplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteApplicationResponse'
, deleteApplicationResponse_httpStatus
- The response's http status code.
UpdateApplication
data UpdateApplication Source #
See: newUpdateApplication
smart constructor.
Instances
:: Text | |
-> Natural | |
-> ApplicationUpdate | |
-> UpdateApplication |
Create a value of UpdateApplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationName:UpdateApplication'
, updateApplication_applicationName
- Name of the Amazon Kinesis Analytics application to update.
$sel:currentApplicationVersionId:UpdateApplication'
, updateApplication_currentApplicationVersionId
- The current application version ID. You can use the
DescribeApplication
operation to get this value.
$sel:applicationUpdate:UpdateApplication'
, updateApplication_applicationUpdate
- Describes application updates.
data UpdateApplicationResponse Source #
See: newUpdateApplicationResponse
smart constructor.
Instances
newUpdateApplicationResponse Source #
Create a value of UpdateApplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateApplicationResponse'
, updateApplicationResponse_httpStatus
- The response's http status code.
DeleteApplicationCloudWatchLoggingOption
data DeleteApplicationCloudWatchLoggingOption Source #
See: newDeleteApplicationCloudWatchLoggingOption
smart constructor.
Instances
newDeleteApplicationCloudWatchLoggingOption Source #
Create a value of DeleteApplicationCloudWatchLoggingOption
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationName:DeleteApplicationCloudWatchLoggingOption'
, deleteApplicationCloudWatchLoggingOption_applicationName
- The Kinesis Analytics application name.
$sel:currentApplicationVersionId:DeleteApplicationCloudWatchLoggingOption'
, deleteApplicationCloudWatchLoggingOption_currentApplicationVersionId
- The version ID of the Kinesis Analytics application.
$sel:cloudWatchLoggingOptionId:DeleteApplicationCloudWatchLoggingOption'
, deleteApplicationCloudWatchLoggingOption_cloudWatchLoggingOptionId
- The CloudWatchLoggingOptionId
of the CloudWatch logging option to
delete. You can get the CloudWatchLoggingOptionId
by using the
DescribeApplication
operation.
data DeleteApplicationCloudWatchLoggingOptionResponse Source #
See: newDeleteApplicationCloudWatchLoggingOptionResponse
smart constructor.
Instances
Eq DeleteApplicationCloudWatchLoggingOptionResponse Source # | |
Read DeleteApplicationCloudWatchLoggingOptionResponse Source # | |
Show DeleteApplicationCloudWatchLoggingOptionResponse Source # | |
Generic DeleteApplicationCloudWatchLoggingOptionResponse Source # | |
NFData DeleteApplicationCloudWatchLoggingOptionResponse Source # | |
type Rep DeleteApplicationCloudWatchLoggingOptionResponse Source # | |
Defined in Amazonka.KinesisAnalytics.DeleteApplicationCloudWatchLoggingOption type Rep DeleteApplicationCloudWatchLoggingOptionResponse = D1 ('MetaData "DeleteApplicationCloudWatchLoggingOptionResponse" "Amazonka.KinesisAnalytics.DeleteApplicationCloudWatchLoggingOption" "libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics" 'False) (C1 ('MetaCons "DeleteApplicationCloudWatchLoggingOptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeleteApplicationCloudWatchLoggingOptionResponse Source #
:: Int |
|
-> DeleteApplicationCloudWatchLoggingOptionResponse |
Create a value of DeleteApplicationCloudWatchLoggingOptionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteApplicationCloudWatchLoggingOptionResponse'
, deleteApplicationCloudWatchLoggingOptionResponse_httpStatus
- The response's http status code.
AddApplicationInputProcessingConfiguration
data AddApplicationInputProcessingConfiguration Source #
See: newAddApplicationInputProcessingConfiguration
smart constructor.
Instances
newAddApplicationInputProcessingConfiguration Source #
Create a value of AddApplicationInputProcessingConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationName:AddApplicationInputProcessingConfiguration'
, addApplicationInputProcessingConfiguration_applicationName
- Name of the application to which you want to add the input processing
configuration.
$sel:currentApplicationVersionId:AddApplicationInputProcessingConfiguration'
, addApplicationInputProcessingConfiguration_currentApplicationVersionId
- Version of the application to which you want to add the input processing
configuration. You can use the
DescribeApplication
operation to get the current application version. If the version
specified is not the current version, the
ConcurrentModificationException
is returned.
$sel:inputId:AddApplicationInputProcessingConfiguration'
, addApplicationInputProcessingConfiguration_inputId
- The ID of the input configuration to add the input processing
configuration to. You can get a list of the input IDs for an application
using the
DescribeApplication
operation.
$sel:inputProcessingConfiguration:AddApplicationInputProcessingConfiguration'
, addApplicationInputProcessingConfiguration_inputProcessingConfiguration
- The
InputProcessingConfiguration
to add to the application.
data AddApplicationInputProcessingConfigurationResponse Source #
See: newAddApplicationInputProcessingConfigurationResponse
smart constructor.
Instances
newAddApplicationInputProcessingConfigurationResponse Source #
:: Int |
|
-> AddApplicationInputProcessingConfigurationResponse |
Create a value of AddApplicationInputProcessingConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AddApplicationInputProcessingConfigurationResponse'
, addApplicationInputProcessingConfigurationResponse_httpStatus
- The response's http status code.
CreateApplication
data CreateApplication Source #
TBD
See: newCreateApplication
smart constructor.
CreateApplication' (Maybe Text) (Maybe [Input]) (Maybe [CloudWatchLoggingOption]) (Maybe [Output]) (Maybe Text) (Maybe (NonEmpty Tag)) Text |
Instances
Create a value of CreateApplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationDescription:CreateApplication'
, createApplication_applicationDescription
- Summary description of the application.
$sel:inputs:CreateApplication'
, createApplication_inputs
- 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.
$sel:cloudWatchLoggingOptions:CreateApplication'
, createApplication_cloudWatchLoggingOptions
- Use this parameter to configure a CloudWatch log stream to monitor
application configuration errors. For more information, see
Working with Amazon CloudWatch Logs.
$sel:outputs:CreateApplication'
, createApplication_outputs
- 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.
$sel:applicationCode:CreateApplication'
, createApplication_applicationCode
- 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.
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.
$sel:tags:CreateApplication'
, createApplication_tags
- 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.
$sel:applicationName:CreateApplication'
, createApplication_applicationName
- Name of your Amazon Kinesis Analytics application (for example,
sample-app
).
data CreateApplicationResponse Source #
TBD
See: newCreateApplicationResponse
smart constructor.
Instances
newCreateApplicationResponse Source #
Create a value of CreateApplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateApplicationResponse'
, createApplicationResponse_httpStatus
- The response's http status code.
$sel:applicationSummary:CreateApplicationResponse'
, createApplicationResponse_applicationSummary
- 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.
DeleteApplicationOutput
data DeleteApplicationOutput Source #
See: newDeleteApplicationOutput
smart constructor.
Instances
newDeleteApplicationOutput Source #
:: Text | |
-> Natural | |
-> Text | |
-> DeleteApplicationOutput |
Create a value of DeleteApplicationOutput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationName:DeleteApplicationOutput'
, deleteApplicationOutput_applicationName
- Amazon Kinesis Analytics application name.
$sel:currentApplicationVersionId:DeleteApplicationOutput'
, deleteApplicationOutput_currentApplicationVersionId
- Amazon Kinesis Analytics application version. You can use the
DescribeApplication
operation to get the current application version. If the version
specified is not the current version, the
ConcurrentModificationException
is returned.
$sel:outputId:DeleteApplicationOutput'
, deleteApplicationOutput_outputId
- The ID of the configuration to delete. Each output configuration that is
added to the application, either when the application is created or
later using the
AddApplicationOutput
operation, has a unique ID. You need to provide the ID to uniquely
identify the output configuration that you want to delete from the
application configuration. You can use the
DescribeApplication
operation to get the specific OutputId
.
data DeleteApplicationOutputResponse Source #
See: newDeleteApplicationOutputResponse
smart constructor.
Instances
Eq DeleteApplicationOutputResponse Source # | |
Read DeleteApplicationOutputResponse Source # | |
Show DeleteApplicationOutputResponse Source # | |
Generic DeleteApplicationOutputResponse Source # | |
NFData DeleteApplicationOutputResponse Source # | |
Defined in Amazonka.KinesisAnalytics.DeleteApplicationOutput rnf :: DeleteApplicationOutputResponse -> () # | |
type Rep DeleteApplicationOutputResponse Source # | |
Defined in Amazonka.KinesisAnalytics.DeleteApplicationOutput type Rep DeleteApplicationOutputResponse = D1 ('MetaData "DeleteApplicationOutputResponse" "Amazonka.KinesisAnalytics.DeleteApplicationOutput" "libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics" 'False) (C1 ('MetaCons "DeleteApplicationOutputResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeleteApplicationOutputResponse Source #
Create a value of DeleteApplicationOutputResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteApplicationOutputResponse'
, deleteApplicationOutputResponse_httpStatus
- The response's http status code.
StopApplication
data StopApplication Source #
See: newStopApplication
smart constructor.
Instances
Create a value of StopApplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationName:StopApplication'
, stopApplication_applicationName
- Name of the running application to stop.
data StopApplicationResponse Source #
See: newStopApplicationResponse
smart constructor.
Instances
newStopApplicationResponse Source #
Create a value of StopApplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StopApplicationResponse'
, stopApplicationResponse_httpStatus
- The response's http status code.
AddApplicationReferenceDataSource
data AddApplicationReferenceDataSource Source #
See: newAddApplicationReferenceDataSource
smart constructor.
Instances
newAddApplicationReferenceDataSource Source #
:: Text | |
-> Natural |
|
-> ReferenceDataSource | |
-> AddApplicationReferenceDataSource |
Create a value of AddApplicationReferenceDataSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationName:AddApplicationReferenceDataSource'
, addApplicationReferenceDataSource_applicationName
- Name of an existing application.
$sel:currentApplicationVersionId:AddApplicationReferenceDataSource'
, addApplicationReferenceDataSource_currentApplicationVersionId
- Version of the application for which you are adding the reference data
source. You can use the
DescribeApplication
operation to get the current application version. If the version
specified is not the current version, the
ConcurrentModificationException
is returned.
$sel:referenceDataSource:AddApplicationReferenceDataSource'
, addApplicationReferenceDataSource_referenceDataSource
- 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.
data AddApplicationReferenceDataSourceResponse Source #
See: newAddApplicationReferenceDataSourceResponse
smart constructor.
Instances
Eq AddApplicationReferenceDataSourceResponse Source # | |
Read AddApplicationReferenceDataSourceResponse Source # | |
Show AddApplicationReferenceDataSourceResponse Source # | |
Generic AddApplicationReferenceDataSourceResponse Source # | |
NFData AddApplicationReferenceDataSourceResponse Source # | |
type Rep AddApplicationReferenceDataSourceResponse Source # | |
Defined in Amazonka.KinesisAnalytics.AddApplicationReferenceDataSource type Rep AddApplicationReferenceDataSourceResponse = D1 ('MetaData "AddApplicationReferenceDataSourceResponse" "Amazonka.KinesisAnalytics.AddApplicationReferenceDataSource" "libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics" 'False) (C1 ('MetaCons "AddApplicationReferenceDataSourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newAddApplicationReferenceDataSourceResponse Source #
Create a value of AddApplicationReferenceDataSourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AddApplicationReferenceDataSourceResponse'
, addApplicationReferenceDataSourceResponse_httpStatus
- The response's http status code.
AddApplicationInput
data AddApplicationInput Source #
See: newAddApplicationInput
smart constructor.
Instances
newAddApplicationInput Source #
:: Text | |
-> Natural | |
-> Input | |
-> AddApplicationInput |
Create a value of AddApplicationInput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationName:AddApplicationInput'
, addApplicationInput_applicationName
- Name of your existing Amazon Kinesis Analytics application to which you
want to add the streaming source.
$sel:currentApplicationVersionId:AddApplicationInput'
, addApplicationInput_currentApplicationVersionId
- Current version of your Amazon Kinesis Analytics application. You can
use the
DescribeApplication
operation to find the current application version.
$sel:input:AddApplicationInput'
, addApplicationInput_input
- The
Input
to add.
data AddApplicationInputResponse Source #
See: newAddApplicationInputResponse
smart constructor.
Instances
newAddApplicationInputResponse Source #
Create a value of AddApplicationInputResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AddApplicationInputResponse'
, addApplicationInputResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:TagResource'
, tagResource_resourceARN
- The ARN of the application to assign the tags.
$sel:tags:TagResource'
, tagResource_tags
- The key-value tags to assign to the application.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
AddApplicationCloudWatchLoggingOption
data AddApplicationCloudWatchLoggingOption Source #
See: newAddApplicationCloudWatchLoggingOption
smart constructor.
Instances
newAddApplicationCloudWatchLoggingOption Source #
Create a value of AddApplicationCloudWatchLoggingOption
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationName:AddApplicationCloudWatchLoggingOption'
, addApplicationCloudWatchLoggingOption_applicationName
- The Kinesis Analytics application name.
$sel:currentApplicationVersionId:AddApplicationCloudWatchLoggingOption'
, addApplicationCloudWatchLoggingOption_currentApplicationVersionId
- The version ID of the Kinesis Analytics application.
$sel:cloudWatchLoggingOption:AddApplicationCloudWatchLoggingOption'
, addApplicationCloudWatchLoggingOption_cloudWatchLoggingOption
- 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.
data AddApplicationCloudWatchLoggingOptionResponse Source #
See: newAddApplicationCloudWatchLoggingOptionResponse
smart constructor.
Instances
Eq AddApplicationCloudWatchLoggingOptionResponse Source # | |
Read AddApplicationCloudWatchLoggingOptionResponse Source # | |
Show AddApplicationCloudWatchLoggingOptionResponse Source # | |
Generic AddApplicationCloudWatchLoggingOptionResponse Source # | |
NFData AddApplicationCloudWatchLoggingOptionResponse Source # | |
type Rep AddApplicationCloudWatchLoggingOptionResponse Source # | |
Defined in Amazonka.KinesisAnalytics.AddApplicationCloudWatchLoggingOption type Rep AddApplicationCloudWatchLoggingOptionResponse = D1 ('MetaData "AddApplicationCloudWatchLoggingOptionResponse" "Amazonka.KinesisAnalytics.AddApplicationCloudWatchLoggingOption" "libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics" 'False) (C1 ('MetaCons "AddApplicationCloudWatchLoggingOptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newAddApplicationCloudWatchLoggingOptionResponse Source #
:: Int |
|
-> AddApplicationCloudWatchLoggingOptionResponse |
Create a value of AddApplicationCloudWatchLoggingOptionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AddApplicationCloudWatchLoggingOptionResponse'
, addApplicationCloudWatchLoggingOptionResponse_httpStatus
- The response's http status code.
ListApplications
data ListApplications Source #
See: newListApplications
smart constructor.
Instances
newListApplications :: ListApplications Source #
Create a value of ListApplications
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:limit:ListApplications'
, listApplications_limit
- Maximum number of applications to list.
$sel:exclusiveStartApplicationName:ListApplications'
, listApplications_exclusiveStartApplicationName
- 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.
data ListApplicationsResponse Source #
See: newListApplicationsResponse
smart constructor.
Instances
newListApplicationsResponse Source #
:: Int | |
-> Bool | |
-> ListApplicationsResponse |
Create a value of ListApplicationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ListApplicationsResponse'
, listApplicationsResponse_httpStatus
- The response's http status code.
$sel:applicationSummaries:ListApplicationsResponse'
, listApplicationsResponse_applicationSummaries
- List of ApplicationSummary
objects.
$sel:hasMoreApplications:ListApplicationsResponse'
, listApplicationsResponse_hasMoreApplications
- Returns true if there are more applications to retrieve.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:UntagResource'
, untagResource_resourceARN
- The ARN of the Kinesis Analytics application from which to remove the
tags.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- A list of keys of tags to remove from the specified application.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
DeleteApplicationInputProcessingConfiguration
data DeleteApplicationInputProcessingConfiguration Source #
See: newDeleteApplicationInputProcessingConfiguration
smart constructor.
Instances
newDeleteApplicationInputProcessingConfiguration Source #
Create a value of DeleteApplicationInputProcessingConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationName:DeleteApplicationInputProcessingConfiguration'
, deleteApplicationInputProcessingConfiguration_applicationName
- The Kinesis Analytics application name.
$sel:currentApplicationVersionId:DeleteApplicationInputProcessingConfiguration'
, deleteApplicationInputProcessingConfiguration_currentApplicationVersionId
- The version ID of the Kinesis Analytics application.
$sel:inputId:DeleteApplicationInputProcessingConfiguration'
, deleteApplicationInputProcessingConfiguration_inputId
- The ID of the input configuration from which to delete the input
processing configuration. You can get a list of the input IDs for an
application by using the
DescribeApplication
operation.
data DeleteApplicationInputProcessingConfigurationResponse Source #
See: newDeleteApplicationInputProcessingConfigurationResponse
smart constructor.
Instances
newDeleteApplicationInputProcessingConfigurationResponse Source #
:: Int |
|
-> DeleteApplicationInputProcessingConfigurationResponse |
Create a value of DeleteApplicationInputProcessingConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteApplicationInputProcessingConfigurationResponse'
, deleteApplicationInputProcessingConfigurationResponse_httpStatus
- The response's http status code.
Types
ApplicationStatus
newtype ApplicationStatus Source #
pattern ApplicationStatus_DELETING :: ApplicationStatus | |
pattern ApplicationStatus_READY :: ApplicationStatus | |
pattern ApplicationStatus_RUNNING :: ApplicationStatus | |
pattern ApplicationStatus_STARTING :: ApplicationStatus | |
pattern ApplicationStatus_STOPPING :: ApplicationStatus | |
pattern ApplicationStatus_UPDATING :: ApplicationStatus |
Instances
InputStartingPosition
newtype InputStartingPosition Source #
Instances
RecordFormatType
newtype RecordFormatType Source #
pattern RecordFormatType_CSV :: RecordFormatType | |
pattern RecordFormatType_JSON :: RecordFormatType |
Instances
ApplicationDetail
data ApplicationDetail Source #
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.
Provides a description of the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configuration.
See: newApplicationDetail
smart constructor.
Instances
:: Text | |
-> Text | |
-> ApplicationStatus | |
-> Natural | |
-> ApplicationDetail |
Create a value of ApplicationDetail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationDescription:ApplicationDetail'
, applicationDetail_applicationDescription
- Description of the application.
$sel:outputDescriptions:ApplicationDetail'
, applicationDetail_outputDescriptions
- Describes the application output configuration. For more information,
see
Configuring Application Output.
$sel:cloudWatchLoggingOptionDescriptions:ApplicationDetail'
, applicationDetail_cloudWatchLoggingOptionDescriptions
- 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.
$sel:referenceDataSourceDescriptions:ApplicationDetail'
, applicationDetail_referenceDataSourceDescriptions
- Describes reference data sources configured for the application. For
more information, see
Configuring Application Input.
$sel:inputDescriptions:ApplicationDetail'
, applicationDetail_inputDescriptions
- Describes the application input configuration. For more information, see
Configuring Application Input.
$sel:applicationCode:ApplicationDetail'
, applicationDetail_applicationCode
- Returns the application code that you provided to perform data analysis
on any of the in-application streams in your application.
$sel:createTimestamp:ApplicationDetail'
, applicationDetail_createTimestamp
- Time stamp when the application version was created.
$sel:lastUpdateTimestamp:ApplicationDetail'
, applicationDetail_lastUpdateTimestamp
- Time stamp when the application was last updated.
$sel:applicationName:ApplicationDetail'
, applicationDetail_applicationName
- Name of the application.
$sel:applicationARN:ApplicationDetail'
, applicationDetail_applicationARN
- ARN of the application.
$sel:applicationStatus:ApplicationDetail'
, applicationDetail_applicationStatus
- Status of the application.
$sel:applicationVersionId:ApplicationDetail'
, applicationDetail_applicationVersionId
- Provides the current application version.
ApplicationSummary
data ApplicationSummary Source #
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.
Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.
See: newApplicationSummary
smart constructor.
Instances
newApplicationSummary Source #
:: Text | |
-> Text | |
-> ApplicationStatus | |
-> ApplicationSummary |
Create a value of ApplicationSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationName:ApplicationSummary'
, applicationSummary_applicationName
- Name of the application.
$sel:applicationARN:ApplicationSummary'
, applicationSummary_applicationARN
- ARN of the application.
$sel:applicationStatus:ApplicationSummary'
, applicationSummary_applicationStatus
- Status of the application.
ApplicationUpdate
data ApplicationUpdate Source #
Describes updates to apply to an existing Amazon Kinesis Analytics application.
See: newApplicationUpdate
smart constructor.
ApplicationUpdate' (Maybe [ReferenceDataSourceUpdate]) (Maybe [InputUpdate]) (Maybe [CloudWatchLoggingOptionUpdate]) (Maybe [OutputUpdate]) (Maybe Text) |
Instances
newApplicationUpdate :: ApplicationUpdate Source #
Create a value of ApplicationUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:referenceDataSourceUpdates:ApplicationUpdate'
, applicationUpdate_referenceDataSourceUpdates
- Describes application reference data source updates.
$sel:inputUpdates:ApplicationUpdate'
, applicationUpdate_inputUpdates
- Describes application input configuration updates.
$sel:cloudWatchLoggingOptionUpdates:ApplicationUpdate'
, applicationUpdate_cloudWatchLoggingOptionUpdates
- Describes application CloudWatch logging option updates.
$sel:outputUpdates:ApplicationUpdate'
, applicationUpdate_outputUpdates
- Describes application output configuration updates.
$sel:applicationCodeUpdate:ApplicationUpdate'
, applicationUpdate_applicationCodeUpdate
- Describes application code updates.
CSVMappingParameters
data CSVMappingParameters Source #
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"
See: newCSVMappingParameters
smart constructor.
Instances
newCSVMappingParameters Source #
:: Text | |
-> Text | |
-> CSVMappingParameters |
Create a value of CSVMappingParameters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recordRowDelimiter:CSVMappingParameters'
, cSVMappingParameters_recordRowDelimiter
- Row delimiter. For example, in a CSV format, '\n' is the typical
row delimiter.
$sel:recordColumnDelimiter:CSVMappingParameters'
, cSVMappingParameters_recordColumnDelimiter
- Column delimiter. For example, in a CSV format, a comma (",") is the
typical column delimiter.
CloudWatchLoggingOption
data CloudWatchLoggingOption Source #
Provides a description of CloudWatch logging options, including the log stream Amazon Resource Name (ARN) and the role ARN.
See: newCloudWatchLoggingOption
smart constructor.
Instances
newCloudWatchLoggingOption Source #
:: Text | |
-> Text | |
-> CloudWatchLoggingOption |
Create a value of CloudWatchLoggingOption
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logStreamARN:CloudWatchLoggingOption'
, cloudWatchLoggingOption_logStreamARN
- ARN of the CloudWatch log to receive application messages.
$sel:roleARN:CloudWatchLoggingOption'
, cloudWatchLoggingOption_roleARN
- 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.
CloudWatchLoggingOptionDescription
data CloudWatchLoggingOptionDescription Source #
Description of the CloudWatch logging option.
See: newCloudWatchLoggingOptionDescription
smart constructor.
Instances
newCloudWatchLoggingOptionDescription Source #
Create a value of CloudWatchLoggingOptionDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cloudWatchLoggingOptionId:CloudWatchLoggingOptionDescription'
, cloudWatchLoggingOptionDescription_cloudWatchLoggingOptionId
- ID of the CloudWatch logging option description.
$sel:logStreamARN:CloudWatchLoggingOptionDescription'
, cloudWatchLoggingOptionDescription_logStreamARN
- ARN of the CloudWatch log to receive application messages.
$sel:roleARN:CloudWatchLoggingOptionDescription'
, cloudWatchLoggingOptionDescription_roleARN
- 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.
CloudWatchLoggingOptionUpdate
data CloudWatchLoggingOptionUpdate Source #
Describes CloudWatch logging option updates.
See: newCloudWatchLoggingOptionUpdate
smart constructor.
Instances
newCloudWatchLoggingOptionUpdate Source #
:: Text |
|
-> CloudWatchLoggingOptionUpdate |
Create a value of CloudWatchLoggingOptionUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:roleARNUpdate:CloudWatchLoggingOptionUpdate'
, cloudWatchLoggingOptionUpdate_roleARNUpdate
- 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.
$sel:logStreamARNUpdate:CloudWatchLoggingOptionUpdate'
, cloudWatchLoggingOptionUpdate_logStreamARNUpdate
- ARN of the CloudWatch log to receive application messages.
$sel:cloudWatchLoggingOptionId:CloudWatchLoggingOptionUpdate'
, cloudWatchLoggingOptionUpdate_cloudWatchLoggingOptionId
- ID of the CloudWatch logging option to update
DestinationSchema
data DestinationSchema Source #
Describes the data format when records are written to the destination. For more information, see Configuring Application Output.
See: newDestinationSchema
smart constructor.
Instances
Create a value of DestinationSchema
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recordFormatType:DestinationSchema'
, destinationSchema_recordFormatType
- Specifies the format of the records on the output stream.
Input
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.
See: newInput
smart constructor.
Input' (Maybe InputParallelism) (Maybe InputProcessingConfiguration) (Maybe KinesisStreamsInput) (Maybe KinesisFirehoseInput) Text SourceSchema |
Instances
Create a value of Input
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inputParallelism:Input'
, input_inputParallelism
- 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.
$sel:inputProcessingConfiguration:Input'
, input_inputProcessingConfiguration
- The
InputProcessingConfiguration
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.
$sel:kinesisStreamsInput:Input'
, input_kinesisStreamsInput
- 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.
$sel:kinesisFirehoseInput:Input'
, input_kinesisFirehoseInput
- 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.
$sel:namePrefix:Input'
, input_namePrefix
- 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.
$sel:inputSchema:Input'
, input_inputSchema
- 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.
InputConfiguration
data InputConfiguration Source #
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.
See: newInputConfiguration
smart constructor.
Instances
newInputConfiguration Source #
Create a value of InputConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:InputConfiguration'
, inputConfiguration_id
- Input source ID. You can get this ID by calling the
DescribeApplication
operation.
$sel:inputStartingPositionConfiguration:InputConfiguration'
, inputConfiguration_inputStartingPositionConfiguration
- Point at which you want the application to start processing records from
the streaming source.
InputDescription
data InputDescription Source #
Describes the application input configuration. For more information, see Configuring Application Input.
See: newInputDescription
smart constructor.
Instances
newInputDescription :: InputDescription Source #
Create a value of InputDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inputStartingPositionConfiguration:InputDescription'
, inputDescription_inputStartingPositionConfiguration
- Point at which the application is configured to read from the input
stream.
$sel:inputParallelism:InputDescription'
, inputDescription_inputParallelism
- Describes the configured parallelism (number of in-application streams
mapped to the streaming source).
$sel:inputId:InputDescription'
, inputDescription_inputId
- 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.
$sel:inAppStreamNames:InputDescription'
, inputDescription_inAppStreamNames
- Returns the in-application stream names that are mapped to the stream
source.
$sel:kinesisFirehoseInputDescription:InputDescription'
, inputDescription_kinesisFirehoseInputDescription
- 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.
$sel:inputSchema:InputDescription'
, inputDescription_inputSchema
- 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.
$sel:kinesisStreamsInputDescription:InputDescription'
, inputDescription_kinesisStreamsInputDescription
- 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.
$sel:namePrefix:InputDescription'
, inputDescription_namePrefix
- In-application name prefix.
$sel:inputProcessingConfigurationDescription:InputDescription'
, inputDescription_inputProcessingConfigurationDescription
- The description of the preprocessor that executes on records in this
input before the application's code is run.
InputLambdaProcessor
data InputLambdaProcessor Source #
An object that contains the Amazon Resource Name (ARN) of the AWS 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.
See: newInputLambdaProcessor
smart constructor.
Instances
newInputLambdaProcessor Source #
:: Text | |
-> Text | |
-> InputLambdaProcessor |
Create a value of InputLambdaProcessor
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:InputLambdaProcessor'
, inputLambdaProcessor_resourceARN
- The ARN of the AWS 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
$sel:roleARN:InputLambdaProcessor'
, inputLambdaProcessor_roleARN
- The ARN of the IAM role that is used to access the AWS Lambda function.
InputLambdaProcessorDescription
data InputLambdaProcessorDescription Source #
An object that contains the Amazon Resource Name (ARN) of the AWS 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.
See: newInputLambdaProcessorDescription
smart constructor.
Instances
Eq InputLambdaProcessorDescription Source # | |
Read InputLambdaProcessorDescription Source # | |
Show InputLambdaProcessorDescription Source # | |
Generic InputLambdaProcessorDescription Source # | |
NFData InputLambdaProcessorDescription Source # | |
Hashable InputLambdaProcessorDescription Source # | |
FromJSON InputLambdaProcessorDescription Source # | |
type Rep InputLambdaProcessorDescription Source # | |
Defined in Amazonka.KinesisAnalytics.Types.InputLambdaProcessorDescription type Rep InputLambdaProcessorDescription = D1 ('MetaData "InputLambdaProcessorDescription" "Amazonka.KinesisAnalytics.Types.InputLambdaProcessorDescription" "libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics" 'False) (C1 ('MetaCons "InputLambdaProcessorDescription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newInputLambdaProcessorDescription :: InputLambdaProcessorDescription Source #
Create a value of InputLambdaProcessorDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:InputLambdaProcessorDescription'
, inputLambdaProcessorDescription_resourceARN
- The ARN of the AWS Lambda function
that is used to preprocess the records in the stream.
$sel:roleARN:InputLambdaProcessorDescription'
, inputLambdaProcessorDescription_roleARN
- The ARN of the IAM role that is used to access the AWS Lambda function.
InputLambdaProcessorUpdate
data InputLambdaProcessorUpdate Source #
Represents an update to the InputLambdaProcessor that is used to preprocess the records in the stream.
See: newInputLambdaProcessorUpdate
smart constructor.
Instances
newInputLambdaProcessorUpdate :: InputLambdaProcessorUpdate Source #
Create a value of InputLambdaProcessorUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:roleARNUpdate:InputLambdaProcessorUpdate'
, inputLambdaProcessorUpdate_roleARNUpdate
- The ARN of the new IAM role that is used to access the AWS Lambda
function.
$sel:resourceARNUpdate:InputLambdaProcessorUpdate'
, inputLambdaProcessorUpdate_resourceARNUpdate
- The Amazon Resource Name (ARN) of the new
AWS 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
InputParallelism
data InputParallelism Source #
Describes the number of in-application streams to create for a given streaming source. For information about parallelism, see Configuring Application Input.
See: newInputParallelism
smart constructor.
Instances
newInputParallelism :: InputParallelism Source #
Create a value of InputParallelism
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:count:InputParallelism'
, inputParallelism_count
- Number of in-application streams to create. For more information, see
Limits.
InputParallelismUpdate
data InputParallelismUpdate Source #
Provides updates to the parallelism count.
See: newInputParallelismUpdate
smart constructor.
Instances
newInputParallelismUpdate :: InputParallelismUpdate Source #
Create a value of InputParallelismUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:countUpdate:InputParallelismUpdate'
, inputParallelismUpdate_countUpdate
- Number of in-application streams to create for the specified streaming
source.
InputProcessingConfiguration
data InputProcessingConfiguration Source #
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.
See: newInputProcessingConfiguration
smart constructor.
Instances
Eq InputProcessingConfiguration Source # | |
Read InputProcessingConfiguration Source # | |
Show InputProcessingConfiguration Source # | |
Generic InputProcessingConfiguration Source # | |
NFData InputProcessingConfiguration Source # | |
Defined in Amazonka.KinesisAnalytics.Types.InputProcessingConfiguration rnf :: InputProcessingConfiguration -> () # | |
Hashable InputProcessingConfiguration Source # | |
ToJSON InputProcessingConfiguration Source # | |
type Rep InputProcessingConfiguration Source # | |
Defined in Amazonka.KinesisAnalytics.Types.InputProcessingConfiguration type Rep InputProcessingConfiguration = D1 ('MetaData "InputProcessingConfiguration" "Amazonka.KinesisAnalytics.Types.InputProcessingConfiguration" "libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics" 'False) (C1 ('MetaCons "InputProcessingConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "inputLambdaProcessor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputLambdaProcessor))) |
newInputProcessingConfiguration Source #
Create a value of InputProcessingConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inputLambdaProcessor:InputProcessingConfiguration'
, inputProcessingConfiguration_inputLambdaProcessor
- The
InputLambdaProcessor
that is used to preprocess the records in the stream before being
processed by your application code.
InputProcessingConfigurationDescription
data InputProcessingConfigurationDescription Source #
Provides configuration information about an input processor. Currently, the only input processor available is AWS Lambda.
See: newInputProcessingConfigurationDescription
smart constructor.
Instances
newInputProcessingConfigurationDescription :: InputProcessingConfigurationDescription Source #
Create a value of InputProcessingConfigurationDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inputLambdaProcessorDescription:InputProcessingConfigurationDescription'
, inputProcessingConfigurationDescription_inputLambdaProcessorDescription
- Provides configuration information about the associated
InputLambdaProcessorDescription.
InputProcessingConfigurationUpdate
data InputProcessingConfigurationUpdate Source #
Describes updates to an InputProcessingConfiguration.
See: newInputProcessingConfigurationUpdate
smart constructor.
Instances
Eq InputProcessingConfigurationUpdate Source # | |
Read InputProcessingConfigurationUpdate Source # | |
Show InputProcessingConfigurationUpdate Source # | |
Generic InputProcessingConfigurationUpdate Source # | |
NFData InputProcessingConfigurationUpdate Source # | |
Hashable InputProcessingConfigurationUpdate Source # | |
ToJSON InputProcessingConfigurationUpdate Source # | |
type Rep InputProcessingConfigurationUpdate Source # | |
Defined in Amazonka.KinesisAnalytics.Types.InputProcessingConfigurationUpdate type Rep InputProcessingConfigurationUpdate = D1 ('MetaData "InputProcessingConfigurationUpdate" "Amazonka.KinesisAnalytics.Types.InputProcessingConfigurationUpdate" "libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics" 'False) (C1 ('MetaCons "InputProcessingConfigurationUpdate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "inputLambdaProcessorUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputLambdaProcessorUpdate))) |
newInputProcessingConfigurationUpdate Source #
:: InputLambdaProcessorUpdate |
|
-> InputProcessingConfigurationUpdate |
Create a value of InputProcessingConfigurationUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inputLambdaProcessorUpdate:InputProcessingConfigurationUpdate'
, inputProcessingConfigurationUpdate_inputLambdaProcessorUpdate
- Provides update information for an
InputLambdaProcessor.
InputSchemaUpdate
data InputSchemaUpdate Source #
Describes updates for the application's input schema.
See: newInputSchemaUpdate
smart constructor.
Instances
newInputSchemaUpdate :: InputSchemaUpdate Source #
Create a value of InputSchemaUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recordFormatUpdate:InputSchemaUpdate'
, inputSchemaUpdate_recordFormatUpdate
- Specifies the format of the records on the streaming source.
$sel:recordEncodingUpdate:InputSchemaUpdate'
, inputSchemaUpdate_recordEncodingUpdate
- Specifies the encoding of the records in the streaming source. For
example, UTF-8.
$sel:recordColumnUpdates:InputSchemaUpdate'
, inputSchemaUpdate_recordColumnUpdates
- A list of RecordColumn
objects. Each object describes the mapping of
the streaming source element to the corresponding column in the
in-application stream.
InputStartingPositionConfiguration
data InputStartingPositionConfiguration Source #
Describes the point at which the application reads from the streaming source.
See: newInputStartingPositionConfiguration
smart constructor.
Instances
Eq InputStartingPositionConfiguration Source # | |
Read InputStartingPositionConfiguration Source # | |
Show InputStartingPositionConfiguration Source # | |
Generic InputStartingPositionConfiguration Source # | |
NFData InputStartingPositionConfiguration Source # | |
Hashable InputStartingPositionConfiguration Source # | |
ToJSON InputStartingPositionConfiguration Source # | |
FromJSON InputStartingPositionConfiguration Source # | |
type Rep InputStartingPositionConfiguration Source # | |
Defined in Amazonka.KinesisAnalytics.Types.InputStartingPositionConfiguration type Rep InputStartingPositionConfiguration = D1 ('MetaData "InputStartingPositionConfiguration" "Amazonka.KinesisAnalytics.Types.InputStartingPositionConfiguration" "libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics" 'False) (C1 ('MetaCons "InputStartingPositionConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "inputStartingPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputStartingPosition)))) |
newInputStartingPositionConfiguration :: InputStartingPositionConfiguration Source #
Create a value of InputStartingPositionConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inputStartingPosition:InputStartingPositionConfiguration'
, inputStartingPositionConfiguration_inputStartingPosition
- 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.
InputUpdate
data InputUpdate Source #
Describes updates to a specific input configuration (identified by the
InputId
of an application).
See: newInputUpdate
smart constructor.
InputUpdate' (Maybe InputProcessingConfigurationUpdate) (Maybe KinesisStreamsInputUpdate) (Maybe InputParallelismUpdate) (Maybe Text) (Maybe InputSchemaUpdate) (Maybe KinesisFirehoseInputUpdate) Text |
Instances
Create a value of InputUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inputProcessingConfigurationUpdate:InputUpdate'
, inputUpdate_inputProcessingConfigurationUpdate
- Describes updates for an input processing configuration.
$sel:kinesisStreamsInputUpdate:InputUpdate'
, inputUpdate_kinesisStreamsInputUpdate
- If an Amazon Kinesis stream is the streaming source to be updated,
provides an updated stream Amazon Resource Name (ARN) and IAM role ARN.
$sel:inputParallelismUpdate:InputUpdate'
, inputUpdate_inputParallelismUpdate
- Describes the parallelism updates (the number in-application streams
Amazon Kinesis Analytics creates for the specific streaming source).
$sel:namePrefixUpdate:InputUpdate'
, inputUpdate_namePrefixUpdate
- Name prefix for in-application streams that Amazon Kinesis Analytics
creates for the specific streaming source.
$sel:inputSchemaUpdate:InputUpdate'
, inputUpdate_inputSchemaUpdate
- 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.
$sel:kinesisFirehoseInputUpdate:InputUpdate'
, inputUpdate_kinesisFirehoseInputUpdate
- If an Amazon Kinesis Firehose delivery stream is the streaming source to
be updated, provides an updated stream ARN and IAM role ARN.
$sel:inputId:InputUpdate'
, inputUpdate_inputId
- Input ID of the application input to be updated.
JSONMappingParameters
data JSONMappingParameters Source #
Provides additional mapping information when JSON is the record format on the streaming source.
See: newJSONMappingParameters
smart constructor.
Instances
newJSONMappingParameters Source #
Create a value of JSONMappingParameters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recordRowPath:JSONMappingParameters'
, jSONMappingParameters_recordRowPath
- Path to the top-level parent that contains the records.
KinesisFirehoseInput
data KinesisFirehoseInput Source #
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.
See: newKinesisFirehoseInput
smart constructor.
Instances
newKinesisFirehoseInput Source #
:: Text | |
-> Text | |
-> KinesisFirehoseInput |
Create a value of KinesisFirehoseInput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:KinesisFirehoseInput'
, kinesisFirehoseInput_resourceARN
- ARN of the input delivery stream.
$sel:roleARN:KinesisFirehoseInput'
, kinesisFirehoseInput_roleARN
- 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.
KinesisFirehoseInputDescription
data KinesisFirehoseInputDescription Source #
Describes the Amazon Kinesis Firehose delivery stream that is configured as the streaming source in the application input configuration.
See: newKinesisFirehoseInputDescription
smart constructor.
Instances
Eq KinesisFirehoseInputDescription Source # | |
Read KinesisFirehoseInputDescription Source # | |
Show KinesisFirehoseInputDescription Source # | |
Generic KinesisFirehoseInputDescription Source # | |
NFData KinesisFirehoseInputDescription Source # | |
Hashable KinesisFirehoseInputDescription Source # | |
FromJSON KinesisFirehoseInputDescription Source # | |
type Rep KinesisFirehoseInputDescription Source # | |
Defined in Amazonka.KinesisAnalytics.Types.KinesisFirehoseInputDescription type Rep KinesisFirehoseInputDescription = D1 ('MetaData "KinesisFirehoseInputDescription" "Amazonka.KinesisAnalytics.Types.KinesisFirehoseInputDescription" "libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics" 'False) (C1 ('MetaCons "KinesisFirehoseInputDescription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newKinesisFirehoseInputDescription :: KinesisFirehoseInputDescription Source #
Create a value of KinesisFirehoseInputDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:KinesisFirehoseInputDescription'
, kinesisFirehoseInputDescription_resourceARN
- Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery
stream.
$sel:roleARN:KinesisFirehoseInputDescription'
, kinesisFirehoseInputDescription_roleARN
- ARN of the IAM role that Amazon Kinesis Analytics assumes to access the
stream.
KinesisFirehoseInputUpdate
data KinesisFirehoseInputUpdate Source #
When updating application input configuration, provides information about an Amazon Kinesis Firehose delivery stream as the streaming source.
See: newKinesisFirehoseInputUpdate
smart constructor.
Instances
newKinesisFirehoseInputUpdate :: KinesisFirehoseInputUpdate Source #
Create a value of KinesisFirehoseInputUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:roleARNUpdate:KinesisFirehoseInputUpdate'
, kinesisFirehoseInputUpdate_roleARNUpdate
- 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.
$sel:resourceARNUpdate:KinesisFirehoseInputUpdate'
, kinesisFirehoseInputUpdate_resourceARNUpdate
- Amazon Resource Name (ARN) of the input Amazon Kinesis Firehose delivery
stream to read.
KinesisFirehoseOutput
data KinesisFirehoseOutput Source #
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.
See: newKinesisFirehoseOutput
smart constructor.
Instances
newKinesisFirehoseOutput Source #
:: Text | |
-> Text | |
-> KinesisFirehoseOutput |
Create a value of KinesisFirehoseOutput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:KinesisFirehoseOutput'
, kinesisFirehoseOutput_resourceARN
- ARN of the destination Amazon Kinesis Firehose delivery stream to write
to.
$sel:roleARN:KinesisFirehoseOutput'
, kinesisFirehoseOutput_roleARN
- 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.
KinesisFirehoseOutputDescription
data KinesisFirehoseOutputDescription Source #
For an application output, describes the Amazon Kinesis Firehose delivery stream configured as its destination.
See: newKinesisFirehoseOutputDescription
smart constructor.
Instances
newKinesisFirehoseOutputDescription :: KinesisFirehoseOutputDescription Source #
Create a value of KinesisFirehoseOutputDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:KinesisFirehoseOutputDescription'
, kinesisFirehoseOutputDescription_resourceARN
- Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery
stream.
$sel:roleARN:KinesisFirehoseOutputDescription'
, kinesisFirehoseOutputDescription_roleARN
- ARN of the IAM role that Amazon Kinesis Analytics can assume to access
the stream.
KinesisFirehoseOutputUpdate
data KinesisFirehoseOutputUpdate Source #
When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis Firehose delivery stream configured as the destination.
See: newKinesisFirehoseOutputUpdate
smart constructor.
Instances
newKinesisFirehoseOutputUpdate :: KinesisFirehoseOutputUpdate Source #
Create a value of KinesisFirehoseOutputUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:roleARNUpdate:KinesisFirehoseOutputUpdate'
, kinesisFirehoseOutputUpdate_roleARNUpdate
- 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.
$sel:resourceARNUpdate:KinesisFirehoseOutputUpdate'
, kinesisFirehoseOutputUpdate_resourceARNUpdate
- Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery
stream to write to.
KinesisStreamsInput
data KinesisStreamsInput Source #
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.
See: newKinesisStreamsInput
smart constructor.
Instances
newKinesisStreamsInput Source #
:: Text | |
-> Text | |
-> KinesisStreamsInput |
Create a value of KinesisStreamsInput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:KinesisStreamsInput'
, kinesisStreamsInput_resourceARN
- ARN of the input Amazon Kinesis stream to read.
$sel:roleARN:KinesisStreamsInput'
, kinesisStreamsInput_roleARN
- 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.
KinesisStreamsInputDescription
data KinesisStreamsInputDescription Source #
Describes the Amazon Kinesis stream that is configured as the streaming source in the application input configuration.
See: newKinesisStreamsInputDescription
smart constructor.
Instances
Eq KinesisStreamsInputDescription Source # | |
Read KinesisStreamsInputDescription Source # | |
Show KinesisStreamsInputDescription Source # | |
Generic KinesisStreamsInputDescription Source # | |
NFData KinesisStreamsInputDescription Source # | |
Hashable KinesisStreamsInputDescription Source # | |
FromJSON KinesisStreamsInputDescription Source # | |
type Rep KinesisStreamsInputDescription Source # | |
Defined in Amazonka.KinesisAnalytics.Types.KinesisStreamsInputDescription type Rep KinesisStreamsInputDescription = D1 ('MetaData "KinesisStreamsInputDescription" "Amazonka.KinesisAnalytics.Types.KinesisStreamsInputDescription" "libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics" 'False) (C1 ('MetaCons "KinesisStreamsInputDescription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newKinesisStreamsInputDescription :: KinesisStreamsInputDescription Source #
Create a value of KinesisStreamsInputDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:KinesisStreamsInputDescription'
, kinesisStreamsInputDescription_resourceARN
- Amazon Resource Name (ARN) of the Amazon Kinesis stream.
$sel:roleARN:KinesisStreamsInputDescription'
, kinesisStreamsInputDescription_roleARN
- ARN of the IAM role that Amazon Kinesis Analytics can assume to access
the stream.
KinesisStreamsInputUpdate
data KinesisStreamsInputUpdate Source #
When updating application input configuration, provides information about an Amazon Kinesis stream as the streaming source.
See: newKinesisStreamsInputUpdate
smart constructor.
Instances
newKinesisStreamsInputUpdate :: KinesisStreamsInputUpdate Source #
Create a value of KinesisStreamsInputUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:roleARNUpdate:KinesisStreamsInputUpdate'
, kinesisStreamsInputUpdate_roleARNUpdate
- 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.
$sel:resourceARNUpdate:KinesisStreamsInputUpdate'
, kinesisStreamsInputUpdate_resourceARNUpdate
- Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read.
KinesisStreamsOutput
data KinesisStreamsOutput Source #
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.
See: newKinesisStreamsOutput
smart constructor.
Instances
newKinesisStreamsOutput Source #
:: Text | |
-> Text | |
-> KinesisStreamsOutput |
Create a value of KinesisStreamsOutput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:KinesisStreamsOutput'
, kinesisStreamsOutput_resourceARN
- ARN of the destination Amazon Kinesis stream to write to.
$sel:roleARN:KinesisStreamsOutput'
, kinesisStreamsOutput_roleARN
- 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.
KinesisStreamsOutputDescription
data KinesisStreamsOutputDescription Source #
For an application output, describes the Amazon Kinesis stream configured as its destination.
See: newKinesisStreamsOutputDescription
smart constructor.
Instances
Eq KinesisStreamsOutputDescription Source # | |
Read KinesisStreamsOutputDescription Source # | |
Show KinesisStreamsOutputDescription Source # | |
Generic KinesisStreamsOutputDescription Source # | |
NFData KinesisStreamsOutputDescription Source # | |
Hashable KinesisStreamsOutputDescription Source # | |
FromJSON KinesisStreamsOutputDescription Source # | |
type Rep KinesisStreamsOutputDescription Source # | |
Defined in Amazonka.KinesisAnalytics.Types.KinesisStreamsOutputDescription type Rep KinesisStreamsOutputDescription = D1 ('MetaData "KinesisStreamsOutputDescription" "Amazonka.KinesisAnalytics.Types.KinesisStreamsOutputDescription" "libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics" 'False) (C1 ('MetaCons "KinesisStreamsOutputDescription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newKinesisStreamsOutputDescription :: KinesisStreamsOutputDescription Source #
Create a value of KinesisStreamsOutputDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:KinesisStreamsOutputDescription'
, kinesisStreamsOutputDescription_resourceARN
- Amazon Resource Name (ARN) of the Amazon Kinesis stream.
$sel:roleARN:KinesisStreamsOutputDescription'
, kinesisStreamsOutputDescription_roleARN
- ARN of the IAM role that Amazon Kinesis Analytics can assume to access
the stream.
KinesisStreamsOutputUpdate
data KinesisStreamsOutputUpdate Source #
When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis stream configured as the destination.
See: newKinesisStreamsOutputUpdate
smart constructor.
Instances
newKinesisStreamsOutputUpdate :: KinesisStreamsOutputUpdate Source #
Create a value of KinesisStreamsOutputUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:roleARNUpdate:KinesisStreamsOutputUpdate'
, kinesisStreamsOutputUpdate_roleARNUpdate
- 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.
$sel:resourceARNUpdate:KinesisStreamsOutputUpdate'
, kinesisStreamsOutputUpdate_resourceARNUpdate
- Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want
to write the output.
LambdaOutput
data LambdaOutput Source #
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.
See: newLambdaOutput
smart constructor.
Instances
Create a value of LambdaOutput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:LambdaOutput'
, lambdaOutput_resourceARN
- 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
$sel:roleARN:LambdaOutput'
, lambdaOutput_roleARN
- 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.
LambdaOutputDescription
data LambdaOutputDescription Source #
For an application output, describes the AWS Lambda function configured as its destination.
See: newLambdaOutputDescription
smart constructor.
Instances
newLambdaOutputDescription :: LambdaOutputDescription Source #
Create a value of LambdaOutputDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:LambdaOutputDescription'
, lambdaOutputDescription_resourceARN
- Amazon Resource Name (ARN) of the destination Lambda function.
$sel:roleARN:LambdaOutputDescription'
, lambdaOutputDescription_roleARN
- ARN of the IAM role that Amazon Kinesis Analytics can assume to write to
the destination function.
LambdaOutputUpdate
data LambdaOutputUpdate Source #
When updating an output configuration using the UpdateApplication operation, provides information about an AWS Lambda function configured as the destination.
See: newLambdaOutputUpdate
smart constructor.
Instances
newLambdaOutputUpdate :: LambdaOutputUpdate Source #
Create a value of LambdaOutputUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:roleARNUpdate:LambdaOutputUpdate'
, lambdaOutputUpdate_roleARNUpdate
- 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.
$sel:resourceARNUpdate:LambdaOutputUpdate'
, lambdaOutputUpdate_resourceARNUpdate
- 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
MappingParameters
data MappingParameters Source #
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.
See: newMappingParameters
smart constructor.
Instances
newMappingParameters :: MappingParameters Source #
Create a value of MappingParameters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cSVMappingParameters:MappingParameters'
, mappingParameters_cSVMappingParameters
- Provides additional mapping information when the record format uses
delimiters (for example, CSV).
$sel:jSONMappingParameters:MappingParameters'
, mappingParameters_jSONMappingParameters
- Provides additional mapping information when JSON is the record format
on the streaming source.
Output
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.
See: newOutput
smart constructor.
Output' (Maybe LambdaOutput) (Maybe KinesisStreamsOutput) (Maybe KinesisFirehoseOutput) Text DestinationSchema |
Instances
Create a value of Output
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lambdaOutput:Output'
, output_lambdaOutput
- Identifies an AWS Lambda function as the destination.
$sel:kinesisStreamsOutput:Output'
, output_kinesisStreamsOutput
- Identifies an Amazon Kinesis stream as the destination.
$sel:kinesisFirehoseOutput:Output'
, output_kinesisFirehoseOutput
- Identifies an Amazon Kinesis Firehose delivery stream as the
destination.
$sel:name:Output'
, output_name
- Name of the in-application stream.
$sel:destinationSchema:Output'
, output_destinationSchema
- Describes the data format when records are written to the destination.
For more information, see
Configuring Application Output.
OutputDescription
data OutputDescription Source #
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.
See: newOutputDescription
smart constructor.
OutputDescription' (Maybe Text) (Maybe DestinationSchema) (Maybe KinesisFirehoseOutputDescription) (Maybe KinesisStreamsOutputDescription) (Maybe Text) (Maybe LambdaOutputDescription) |
Instances
newOutputDescription :: OutputDescription Source #
Create a value of OutputDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:outputId:OutputDescription'
, outputDescription_outputId
- A unique identifier for the output configuration.
$sel:destinationSchema:OutputDescription'
, outputDescription_destinationSchema
- Data format used for writing data to the destination.
$sel:kinesisFirehoseOutputDescription:OutputDescription'
, outputDescription_kinesisFirehoseOutputDescription
- Describes the Amazon Kinesis Firehose delivery stream configured as the
destination where output is written.
$sel:kinesisStreamsOutputDescription:OutputDescription'
, outputDescription_kinesisStreamsOutputDescription
- Describes Amazon Kinesis stream configured as the destination where
output is written.
$sel:name:OutputDescription'
, outputDescription_name
- Name of the in-application stream configured as output.
$sel:lambdaOutputDescription:OutputDescription'
, outputDescription_lambdaOutputDescription
- Describes the AWS Lambda function configured as the destination where
output is written.
OutputUpdate
data OutputUpdate Source #
Describes updates to the output configuration identified by the
OutputId
.
See: newOutputUpdate
smart constructor.
OutputUpdate' (Maybe KinesisStreamsOutputUpdate) (Maybe DestinationSchema) (Maybe KinesisFirehoseOutputUpdate) (Maybe Text) (Maybe LambdaOutputUpdate) Text |
Instances
Create a value of OutputUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kinesisStreamsOutputUpdate:OutputUpdate'
, outputUpdate_kinesisStreamsOutputUpdate
- Describes an Amazon Kinesis stream as the destination for the output.
$sel:destinationSchemaUpdate:OutputUpdate'
, outputUpdate_destinationSchemaUpdate
- Describes the data format when records are written to the destination.
For more information, see
Configuring Application Output.
$sel:kinesisFirehoseOutputUpdate:OutputUpdate'
, outputUpdate_kinesisFirehoseOutputUpdate
- Describes an Amazon Kinesis Firehose delivery stream as the destination
for the output.
$sel:nameUpdate:OutputUpdate'
, outputUpdate_nameUpdate
- 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.
$sel:lambdaOutputUpdate:OutputUpdate'
, outputUpdate_lambdaOutputUpdate
- Describes an AWS Lambda function as the destination for the output.
$sel:outputId:OutputUpdate'
, outputUpdate_outputId
- Identifies the specific output configuration that you want to update.
RecordColumn
data RecordColumn Source #
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.
See: newRecordColumn
smart constructor.
Instances
Create a value of RecordColumn
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mapping:RecordColumn'
, recordColumn_mapping
- Reference to the data element in the streaming input or the reference
data source. This element is required if the
RecordFormatType
is JSON
.
$sel:name:RecordColumn'
, recordColumn_name
- Name of the column created in the in-application input stream or
reference table.
$sel:sqlType:RecordColumn'
, recordColumn_sqlType
- Type of column created in the in-application input stream or reference
table.
RecordFormat
data RecordFormat Source #
Describes the record format and relevant mapping information that should be applied to schematize the records on the stream.
See: newRecordFormat
smart constructor.
Instances
Create a value of RecordFormat
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mappingParameters:RecordFormat'
, recordFormat_mappingParameters
- 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.
$sel:recordFormatType:RecordFormat'
, recordFormat_recordFormatType
- The type of record format.
ReferenceDataSource
data ReferenceDataSource Source #
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.
See: newReferenceDataSource
smart constructor.
Instances
newReferenceDataSource Source #
:: Text | |
-> SourceSchema | |
-> ReferenceDataSource |
Create a value of ReferenceDataSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3ReferenceDataSource:ReferenceDataSource'
, referenceDataSource_s3ReferenceDataSource
- 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.
$sel:tableName:ReferenceDataSource'
, referenceDataSource_tableName
- Name of the in-application table to create.
$sel:referenceSchema:ReferenceDataSource'
, referenceDataSource_referenceSchema
- 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.
ReferenceDataSourceDescription
data ReferenceDataSourceDescription Source #
Describes the reference data source configured for an application.
See: newReferenceDataSourceDescription
smart constructor.
Instances
newReferenceDataSourceDescription Source #
:: Text | |
-> Text | |
-> S3ReferenceDataSourceDescription |
|
-> ReferenceDataSourceDescription |
Create a value of ReferenceDataSourceDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:referenceSchema:ReferenceDataSourceDescription'
, referenceDataSourceDescription_referenceSchema
- 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.
$sel:referenceId:ReferenceDataSourceDescription'
, referenceDataSourceDescription_referenceId
- 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
operation.
$sel:tableName:ReferenceDataSourceDescription'
, referenceDataSourceDescription_tableName
- The in-application table name created by the specific reference data
source configuration.
$sel:s3ReferenceDataSourceDescription:ReferenceDataSourceDescription'
, referenceDataSourceDescription_s3ReferenceDataSourceDescription
- 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.
ReferenceDataSourceUpdate
data ReferenceDataSourceUpdate Source #
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.
See: newReferenceDataSourceUpdate
smart constructor.
ReferenceDataSourceUpdate' (Maybe Text) (Maybe S3ReferenceDataSourceUpdate) (Maybe SourceSchema) Text |
Instances
newReferenceDataSourceUpdate Source #
Create a value of ReferenceDataSourceUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tableNameUpdate:ReferenceDataSourceUpdate'
, referenceDataSourceUpdate_tableNameUpdate
- In-application table name that is created by this update.
$sel:s3ReferenceDataSourceUpdate:ReferenceDataSourceUpdate'
, referenceDataSourceUpdate_s3ReferenceDataSourceUpdate
- 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.
$sel:referenceSchemaUpdate:ReferenceDataSourceUpdate'
, referenceDataSourceUpdate_referenceSchemaUpdate
- 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.
$sel:referenceId:ReferenceDataSourceUpdate'
, referenceDataSourceUpdate_referenceId
- ID of the reference data source being updated. You can use the
DescribeApplication
operation to get this value.
S3Configuration
data S3Configuration Source #
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.
See: newS3Configuration
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> S3Configuration |
Create a value of S3Configuration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:roleARN:S3Configuration'
, s3Configuration_roleARN
- IAM ARN of the role used to access the data.
$sel:bucketARN:S3Configuration'
, s3Configuration_bucketARN
- ARN of the S3 bucket that contains the data.
$sel:fileKey:S3Configuration'
, s3Configuration_fileKey
- The name of the object that contains the data.
S3ReferenceDataSource
data S3ReferenceDataSource Source #
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.
See: newS3ReferenceDataSource
smart constructor.
Instances
newS3ReferenceDataSource Source #
:: Text | |
-> Text | |
-> Text | |
-> S3ReferenceDataSource |
Create a value of S3ReferenceDataSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucketARN:S3ReferenceDataSource'
, s3ReferenceDataSource_bucketARN
- Amazon Resource Name (ARN) of the S3 bucket.
$sel:fileKey:S3ReferenceDataSource'
, s3ReferenceDataSource_fileKey
- Object key name containing reference data.
$sel:referenceRoleARN:S3ReferenceDataSource'
, s3ReferenceDataSource_referenceRoleARN
- 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.
S3ReferenceDataSourceDescription
data S3ReferenceDataSourceDescription Source #
Provides the bucket name and object key name that stores the reference data.
See: newS3ReferenceDataSourceDescription
smart constructor.
Instances
newS3ReferenceDataSourceDescription Source #
:: Text | |
-> Text | |
-> Text | |
-> S3ReferenceDataSourceDescription |
Create a value of S3ReferenceDataSourceDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucketARN:S3ReferenceDataSourceDescription'
, s3ReferenceDataSourceDescription_bucketARN
- Amazon Resource Name (ARN) of the S3 bucket.
$sel:fileKey:S3ReferenceDataSourceDescription'
, s3ReferenceDataSourceDescription_fileKey
- Amazon S3 object key name.
$sel:referenceRoleARN:S3ReferenceDataSourceDescription'
, s3ReferenceDataSourceDescription_referenceRoleARN
- 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.
S3ReferenceDataSourceUpdate
data S3ReferenceDataSourceUpdate Source #
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.
See: newS3ReferenceDataSourceUpdate
smart constructor.
Instances
newS3ReferenceDataSourceUpdate :: S3ReferenceDataSourceUpdate Source #
Create a value of S3ReferenceDataSourceUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucketARNUpdate:S3ReferenceDataSourceUpdate'
, s3ReferenceDataSourceUpdate_bucketARNUpdate
- Amazon Resource Name (ARN) of the S3 bucket.
$sel:fileKeyUpdate:S3ReferenceDataSourceUpdate'
, s3ReferenceDataSourceUpdate_fileKeyUpdate
- Object key name.
$sel:referenceRoleARNUpdate:S3ReferenceDataSourceUpdate'
, s3ReferenceDataSourceUpdate_referenceRoleARNUpdate
- ARN of the IAM role that Amazon Kinesis Analytics can assume to read the
Amazon S3 object and populate the in-application.
SourceSchema
data SourceSchema Source #
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.
See: newSourceSchema
smart constructor.
Instances
Create a value of SourceSchema
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recordEncoding:SourceSchema'
, sourceSchema_recordEncoding
- Specifies the encoding of the records in the streaming source. For
example, UTF-8.
$sel:recordFormat:SourceSchema'
, sourceSchema_recordFormat
- Specifies the format of the records on the streaming source.
$sel:recordColumns:SourceSchema'
, sourceSchema_recordColumns
- A list of RecordColumn
objects.
Tag
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.
See: newTag
smart constructor.
Instances
Eq Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.KinesisAnalytics.Types.Tag | |
Hashable Tag Source # | |
Defined in Amazonka.KinesisAnalytics.Types.Tag | |
ToJSON Tag Source # | |
Defined in Amazonka.KinesisAnalytics.Types.Tag | |
FromJSON Tag Source # | |
type Rep Tag Source # | |
Defined in Amazonka.KinesisAnalytics.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.KinesisAnalytics.Types.Tag" "libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:Tag'
, tag_value
- The value of the key-value tag. The value is optional.
$sel:key:Tag'
, tag_key
- The key of the key-value tag.