2026/11/11 - Amazon Kinesis Analytics - 8 new6 updated api methods
Changes This release adds support for Enhanced Snapshots in Amazon Managed Service for Apache Flink, enabling application state to be managed as a standalone resource that customers can export, import, and reuse across applications.
Imports an Apache Flink savepoint from an Amazon S3 location as an enhanced snapshot. Managed Service for Apache Flink assumes the IAM role that you specify in ImportSourceConfiguration to read the savepoint data.
This operation is asynchronous. The response returns the snapshot ARN with the CREATING status. To track the progress of the import, use DescribeSnapshotOperation.
For more information, see Import and export.
See also: AWS API Documentation
Request Syntax
client.import_snapshot(
SnapshotName='string',
ImportSourceConfiguration={
'SourceType': 'S3',
'ImportRoleArn': 'string',
'SourceEncryptionConfiguration': {
'KeyId': 'string',
'KeyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
},
'SourceS3PrefixLocation': {
'BucketARN': 'string',
'KeyPrefix': 'string'
}
},
DestinationEncryptionConfiguration={
'KeyId': 'string',
'KeyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
},
SnapshotDescription='string',
SnapshotFormat='CANONICAL',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the enhanced snapshot. The name must be unique among the snapshots in your account and Region. You can't reuse the name of an existing snapshot, including a snapshot in the FAILED status, until you delete that snapshot. Names that begin with SYSTEMSNAPSHOT are reserved.
dict
[REQUIRED]
Describes the location, IAM role, and encryption configuration of the savepoint data to import.
SourceType (string) -- [REQUIRED]
The type of the source location. The only supported value is S3.
ImportRoleArn (string) -- [REQUIRED]
The ARN of the IAM role that Managed Service for Apache Flink assumes to read the savepoint data from the source location. For information about the permissions that this role requires, see Import and export.
SourceEncryptionConfiguration (dict) --
The encryption configuration of the savepoint data at the source location. If you don't specify this parameter, Managed Service for Apache Flink uses a key of type AWS_OWNED_KEY. If you specify a KMS key, you must specify the key ARN.
KeyId (string) --
The KMS key used for encryption. KeyId is used only when KeyType is CUSTOMER_MANAGED_KEY.
KeyType (string) -- [REQUIRED]
Specifies the type of key used for encryption.
SourceS3PrefixLocation (dict) -- [REQUIRED]
The Amazon S3 bucket and key prefix that contain the savepoint data to import. The bucket must be owned by your account and must be in the same Region as the request.
BucketARN (string) -- [REQUIRED]
The ARN of the Amazon S3 bucket.
KeyPrefix (string) -- [REQUIRED]
The key prefix in the Amazon S3 bucket.
dict
The encryption configuration of the imported snapshot. If you don't specify this parameter, the snapshot is encrypted using a key of type AWS_OWNED_KEY. If you specify a KMS key, you must specify the key ARN.
KeyId (string) --
The KMS key used for encryption. KeyId is used only when KeyType is CUSTOMER_MANAGED_KEY.
KeyType (string) -- [REQUIRED]
Specifies the type of key used for encryption.
string
A summary description of the snapshot.
string
The format of the snapshot being imported.
list
A list of one or more tags to assign to the snapshot. A tag is a key-value pair that identifies a snapshot. For more information, see Using Tagging.
(dict) --
A key-value pair (the value is optional) that you can define and assign to Amazon 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.
Key (string) -- [REQUIRED]
The key of the key-value tag.
Value (string) --
The value of the key-value tag. The value is optional.
dict
Response Syntax
{
'SnapshotArn': 'string',
'SnapshotStatus': 'CREATING'|'READY'|'DELETING'|'FAILED',
'SnapshotOperationId': 'string',
'SnapshotOperationStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'CANCELLED'
}
Response Structure
(dict) --
SnapshotArn (string) --
The ARN of the enhanced snapshot.
SnapshotStatus (string) --
The status of the snapshot. When Managed Service for Apache Flink accepts the request, the status is CREATING.
SnapshotOperationId (string) --
The ID of the snapshot operation. You can use this value with DescribeSnapshotOperation to track the progress of the import.
SnapshotOperationStatus (string) --
The status of the snapshot operation.
Lists the enhanced snapshots in your account. Snapshots are not scoped to an application. To list the snapshots that were created from a specific application, use the SourceApplicationName parameter.
You can specify only one of the following filters in a request: SourceApplicationName, SnapshotInitiator, SnapshotInitiatorOperation, or SnapshotStatus. If you specify more than one filter, InvalidArgumentException is returned.
The results are sorted in descending order of snapshot creation timestamp. To get detailed information about a specific snapshot, use DescribeSnapshot.
See also: AWS API Documentation
Request Syntax
client.list_snapshots(
SourceApplicationName='string',
SnapshotInitiator='USER'|'SYSTEM',
SnapshotInitiatorOperation='CreateSnapshot'|'ImportSnapshot'|'SystemCreateSnapshot',
SnapshotStatus='CREATING'|'READY'|'DELETING'|'FAILED',
Limit=123,
NextToken='string'
)
string
The name of the application.
string
Use this parameter to list only the snapshots with the specified initiator.
string
Use this parameter to list only the snapshots that were created by the specified operation.
string
Use this parameter to list only the snapshots with the specified status.
integer
The maximum number of snapshots to list.
string
A pagination token that can be used in a subsequent request.
dict
Response Syntax
{
'SnapshotInfoList': [
{
'SnapshotName': 'string',
'SnapshotArn': 'string',
'SnapshotStatus': 'CREATING'|'READY'|'DELETING'|'FAILED',
'SnapshotCreationTimestamp': datetime(2015, 1, 1),
'SnapshotInitiator': 'USER'|'SYSTEM',
'SnapshotInitiatorOperation': 'CreateSnapshot'|'ImportSnapshot'|'SystemCreateSnapshot',
'SourceApplicationName': 'string',
'SnapshotFormat': 'CANONICAL'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SnapshotInfoList (list) --
A list of SnapshotInfo objects.
(dict) --
Provides summary information about an enhanced snapshot.
SnapshotName (string) --
The name of the enhanced snapshot.
SnapshotArn (string) --
The ARN of the enhanced snapshot.
SnapshotStatus (string) --
The status of the enhanced snapshot.
SnapshotCreationTimestamp (datetime) --
The timestamp that indicates when the snapshot was created.
SnapshotInitiator (string) --
Indicates who initiated the snapshot. USER indicates a snapshot that you created or imported. SYSTEM indicates a snapshot that Managed Service for Apache Flink created.
SnapshotInitiatorOperation (string) --
The operation that created the snapshot.
SourceApplicationName (string) --
The name of the application.
SnapshotFormat (string) --
The format of the snapshot.
NextToken (string) --
A pagination token that can be used in a subsequent request.
Returns information about an enhanced snapshot. To see a list of the snapshots in your account, use ListSnapshots.
See also: AWS API Documentation
Request Syntax
client.describe_snapshot(
SnapshotName='string'
)
string
[REQUIRED]
The name of the enhanced snapshot. You can retrieve this value using ListSnapshots.
dict
Response Syntax
{
'SnapshotInfoDetails': {
'SnapshotName': 'string',
'SnapshotArn': 'string',
'SnapshotDescription': 'string',
'SnapshotStatus': 'CREATING'|'READY'|'DELETING'|'FAILED',
'SnapshotCreationTimestamp': datetime(2015, 1, 1),
'RuntimeEnvironment': 'SQL-1_0'|'FLINK-1_6'|'FLINK-1_8'|'ZEPPELIN-FLINK-1_0'|'FLINK-1_11'|'FLINK-1_13'|'ZEPPELIN-FLINK-2_0'|'FLINK-1_15'|'ZEPPELIN-FLINK-3_0'|'FLINK-1_18'|'FLINK-1_19'|'FLINK-1_20'|'FLINK-2_2'|'FLINK-2_3',
'SnapshotSizeInBytes': 123,
'SnapshotEncryptionConfigurationDescription': {
'KeyId': 'string',
'KeyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
},
'SnapshotInitiator': 'USER'|'SYSTEM',
'SnapshotInitiatorOperation': 'CreateSnapshot'|'ImportSnapshot'|'SystemCreateSnapshot',
'SnapshotSourceDescription': {
'S3PrefixLocation': {
'BucketARN': 'string',
'KeyPrefix': 'string'
},
'SourceApplicationDescription': {
'ApplicationName': 'string',
'ApplicationCreationTimestamp': datetime(2015, 1, 1),
'ApplicationVersionId': 123
}
},
'SnapshotFormat': 'CANONICAL'
}
}
Response Structure
(dict) --
SnapshotInfoDetails (dict) --
An object containing information about the enhanced snapshot.
SnapshotName (string) --
The name of the enhanced snapshot.
SnapshotArn (string) --
The ARN of the enhanced snapshot.
SnapshotDescription (string) --
The summary description of the snapshot.
SnapshotStatus (string) --
The status of the enhanced snapshot.
SnapshotCreationTimestamp (datetime) --
The timestamp that indicates when the snapshot was created.
RuntimeEnvironment (string) --
The Flink runtime of the application that the snapshot was created from. This field is not present for imported snapshots.
SnapshotSizeInBytes (integer) --
The size of the snapshot, in bytes. The value is 0 until the snapshot status is READY.
SnapshotEncryptionConfigurationDescription (dict) --
Describes the encryption settings of data at rest for the snapshot.
KeyId (string) --
The KMS key used for encryption. KeyId is used only when KeyType is CUSTOMER_MANAGED_KEY.
KeyType (string) --
Specifies the type of key used for encryption.
SnapshotInitiator (string) --
Indicates who initiated the snapshot. USER indicates a snapshot that you created or imported. SYSTEM indicates a snapshot that Managed Service for Apache Flink created.
SnapshotInitiatorOperation (string) --
The operation that created the snapshot.
SnapshotSourceDescription (dict) --
Describes the source of the snapshot.
S3PrefixLocation (dict) --
The Amazon S3 location that the snapshot was imported from. This field is present only if SnapshotInitiatorOperation is ImportSnapshot.
BucketARN (string) --
The ARN of the Amazon S3 bucket.
KeyPrefix (string) --
The key prefix in the Amazon S3 bucket.
SourceApplicationDescription (dict) --
Describes the application that the snapshot was created from. This field is not present for imported snapshots.
ApplicationName (string) --
The name of the application.
ApplicationCreationTimestamp (datetime) --
The timestamp that indicates when the source application was created.
ApplicationVersionId (integer) --
The version ID of the source application when the snapshot was created.
SnapshotFormat (string) --
The format of the snapshot.
Lists the operations that were performed on the specified enhanced snapshot, such as CreateSnapshot, ImportSnapshot, and ExportSnapshot. The response includes a summary of each operation.
You can specify only one of the SnapshotOperation or SnapshotOperationStatus filters in a request. If you specify both, InvalidArgumentException is returned.
To get the complete description of a specific operation, use DescribeSnapshotOperation. Snapshot operations are available for 90 days after they are created.
See also: AWS API Documentation
Request Syntax
client.list_snapshot_operations(
SnapshotName='string',
SnapshotOperation='CreateSnapshot'|'DeleteSnapshot'|'ImportSnapshot'|'ExportSnapshot'|'SystemCreateSnapshot',
SnapshotOperationStatus='IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'CANCELLED',
Limit=123,
NextToken='string'
)
string
[REQUIRED]
The name of the enhanced snapshot.
string
Use this parameter to list only the operations of the specified type.
string
Use this parameter to list only the operations with the specified status.
integer
The maximum number of snapshot operations to list.
string
A pagination token that can be used in a subsequent request.
dict
Response Syntax
{
'SnapshotOperationInfoList': [
{
'SnapshotOperationId': 'string',
'SnapshotOperation': 'CreateSnapshot'|'DeleteSnapshot'|'ImportSnapshot'|'ExportSnapshot'|'SystemCreateSnapshot',
'SnapshotOperationStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'CANCELLED',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SnapshotOperationInfoList (list) --
A list of SnapshotOperationInfo objects.
(dict) --
Provides summary information about an operation that was performed on an enhanced snapshot.
SnapshotOperationId (string) --
The ID of the snapshot operation.
SnapshotOperation (string) --
The type of operation that was performed on the snapshot.
SnapshotOperationStatus (string) --
The status of the snapshot operation.
StartTime (datetime) --
The timestamp that indicates when the operation was created.
EndTime (datetime) --
The timestamp that indicates when the operation finished. This field is present only after the operation completes.
NextToken (string) --
A pagination token that can be used in a subsequent request.
Provides a detailed description of a specified operation that was performed on an enhanced snapshot. To see a list of the operations of a snapshot, use ListSnapshotOperations.
Snapshot operations are available for 90 days after they are created.
See also: AWS API Documentation
Request Syntax
client.describe_snapshot_operation(
SnapshotName='string',
SnapshotOperationId='string'
)
string
[REQUIRED]
The name of the enhanced snapshot.
string
[REQUIRED]
The ID of the snapshot operation. You can retrieve this value using ListSnapshotOperations.
dict
Response Syntax
{
'SnapshotOperationInfoDetails': {
'SnapshotOperationId': 'string',
'SnapshotOperation': 'CreateSnapshot'|'DeleteSnapshot'|'ImportSnapshot'|'ExportSnapshot'|'SystemCreateSnapshot',
'SnapshotOperationStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'CANCELLED',
'SnapshotArn': 'string',
'SourceEncryptionConfigurationDescription': {
'KeyId': 'string',
'KeyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
},
'DestinationEncryptionConfigurationDescription': {
'KeyId': 'string',
'KeyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
},
'SnapshotSourceLocationDescription': {
'LocationType': 'S3',
'S3PrefixLocation': {
'BucketARN': 'string',
'KeyPrefix': 'string',
'ExportedPrefix': 'string'
}
},
'SnapshotDestinationLocationDescription': {
'LocationType': 'S3',
'S3PrefixLocation': {
'BucketARN': 'string',
'KeyPrefix': 'string',
'ExportedPrefix': 'string'
}
},
'ApplicationOperationDescription': {
'ApplicationOperationId': 'string',
'ApplicationName': 'string'
},
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'SnapshotOperationFailureDetails': {
'ErrorInfo': {
'ErrorCode': 'string',
'ErrorString': 'string'
}
}
}
}
Response Structure
(dict) --
SnapshotOperationInfoDetails (dict) --
An object containing information about the snapshot operation.
SnapshotOperationId (string) --
The ID of the snapshot operation.
SnapshotOperation (string) --
The type of operation that was performed on the snapshot.
SnapshotOperationStatus (string) --
The status of the snapshot operation.
SnapshotArn (string) --
The ARN of the enhanced snapshot.
SourceEncryptionConfigurationDescription (dict) --
Describes the encryption configuration of the source data. This field is present only for ImportSnapshot operation.
KeyId (string) --
The KMS key used for encryption.
KeyType (string) --
Specifies the type of key used for encryption.
DestinationEncryptionConfigurationDescription (dict) --
Describes the encryption configuration of the destination data. This field is present only for ImportSnapshot and ExportSnapshot operations.
KeyId (string) --
The KMS key used for encryption.
KeyType (string) --
Specifies the type of key used for encryption.
SnapshotSourceLocationDescription (dict) --
Describes the location that the snapshot data was read from. This field is present only for ImportSnapshot operations.
LocationType (string) --
The type of the location. The only supported value is S3.
S3PrefixLocation (dict) --
Describes the Amazon S3 bucket and key prefix of the location.
BucketARN (string) --
The ARN of the Amazon S3 bucket.
KeyPrefix (string) --
The key prefix in the Amazon S3 bucket that you specified in the request.
ExportedPrefix (string) --
The full key prefix that the exported snapshot data was written to. This value includes the unique prefix that Managed Service for Apache Flink appends to KeyPrefix. This field is present only after an ExportSnapshot operation completes successfully.
SnapshotDestinationLocationDescription (dict) --
Describes the location that the snapshot data was written to. This field is present only for ExportSnapshot operations, after the operation completes.
LocationType (string) --
The type of the location. The only supported value is S3.
S3PrefixLocation (dict) --
Describes the Amazon S3 bucket and key prefix of the location.
BucketARN (string) --
The ARN of the Amazon S3 bucket.
KeyPrefix (string) --
The key prefix in the Amazon S3 bucket that you specified in the request.
ExportedPrefix (string) --
The full key prefix that the exported snapshot data was written to. This value includes the unique prefix that Managed Service for Apache Flink appends to KeyPrefix. This field is present only after an ExportSnapshot operation completes successfully.
ApplicationOperationDescription (dict) --
Describes the application operation that initiated the snapshot operation. This field is present only for SystemCreateSnapshot operations.
ApplicationOperationId (string) --
The operation ID of the request.
ApplicationName (string) --
The name of the application.
StartTime (datetime) --
The timestamp that indicates when the operation was created.
EndTime (datetime) --
The timestamp that indicates when the operation finished. This field is present only after the operation completes.
SnapshotOperationFailureDetails (dict) --
Provides a description of the operation failure. This field is present only if SnapshotOperationStatus is FAILED.
ErrorInfo (dict) --
A description of the error that caused the snapshot operation to fail.
ErrorCode (string) --
The error code that identifies the cause of the failure.
ErrorString (string) --
An error message that is returned when an operation fails.
Deletes an enhanced snapshot. Snapshots are not scoped to an application, so you can delete a snapshot independently of the application that it was created from.
This operation is asynchronous. The response returns the snapshot ARN with the DELETING status. To track the progress of the operation, use DescribeSnapshotOperation.
You can delete a snapshot in the READY or FAILED status. If a snapshot operation, such as an export, uses the snapshot, Managed Service for Apache Flink waits for that operation to finish before it deletes the snapshot. For a snapshot in any other status, ResourceInUseException is returned.
See also: AWS API Documentation
Request Syntax
client.delete_snapshot(
SnapshotName='string',
SnapshotCreationTimestamp=datetime(2015, 1, 1)
)
string
[REQUIRED]
The name of the enhanced snapshot to delete.
datetime
[REQUIRED]
The creation timestamp of the enhanced snapshot to delete. Use the DescribeSnapshot operation to get this value.
dict
Response Syntax
{
'SnapshotArn': 'string',
'SnapshotStatus': 'CREATING'|'READY'|'DELETING'|'FAILED',
'SnapshotOperationId': 'string',
'SnapshotOperationStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'CANCELLED'
}
Response Structure
(dict) --
SnapshotArn (string) --
The ARN of the enhanced snapshot.
SnapshotStatus (string) --
The status of the snapshot. When Managed Service for Apache Flink accepts the request, the status is DELETING. If a snapshot operation, such as an export, uses the snapshot, the status stays DELETING until that operation finishes and Managed Service for Apache Flink deletes the snapshot.
SnapshotOperationId (string) --
The ID of the snapshot operation. You can use this value with DescribeSnapshotOperation to track the progress of the operation.
SnapshotOperationStatus (string) --
The status of the snapshot operation.
Exports the data of an enhanced snapshot to an Amazon S3 location. Managed Service for Apache Flink assumes the IAM role that you specify in ExportDestinationConfiguration to write the snapshot data. The snapshot must be in the READY status.
This operation is asynchronous. To track the progress of the export, use DescribeSnapshotOperation.
A snapshot can have only one export in progress at a time. If an export of the snapshot is already in progress, LimitExceededException is returned.
For more information, see Import and export.
See also: AWS API Documentation
Request Syntax
client.export_snapshot(
SnapshotName='string',
ExportDestinationConfiguration={
'DestinationType': 'S3',
'ExportRoleArn': 'string',
'DestinationEncryptionConfiguration': {
'KeyId': 'string',
'KeyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
},
'DestinationS3PrefixLocation': {
'BucketARN': 'string',
'KeyPrefix': 'string'
}
}
)
string
[REQUIRED]
The name of the enhanced snapshot to export.
dict
[REQUIRED]
Describes the location, IAM role, and encryption configuration of the export destination.
DestinationType (string) -- [REQUIRED]
The type of the destination location. The only supported value is S3.
ExportRoleArn (string) -- [REQUIRED]
The ARN of the IAM role that Managed Service for Apache Flink assumes to write the snapshot data to the destination location. For information about the permissions that this role requires, see Import and export.
DestinationEncryptionConfiguration (dict) --
The encryption configuration of the exported snapshot data. If you don't specify this parameter, Managed Service for Apache Flink uses a key of type AWS_OWNED_KEY. If you specify a KMS key, you must specify the key ARN.
KeyId (string) --
The KMS key used for encryption. KeyId is used only when KeyType is CUSTOMER_MANAGED_KEY.
KeyType (string) -- [REQUIRED]
Specifies the type of key used for encryption.
DestinationS3PrefixLocation (dict) -- [REQUIRED]
The Amazon S3 bucket and key prefix to export the snapshot data to. Managed Service for Apache Flink writes the data under a unique prefix that it appends to the key prefix that you specify. After the export completes, use DescribeSnapshotOperation to get the full prefix. The bucket must be owned by your account and must be in the same Region as the request.
BucketARN (string) -- [REQUIRED]
The ARN of the Amazon S3 bucket.
KeyPrefix (string) -- [REQUIRED]
The key prefix in the Amazon S3 bucket.
dict
Response Syntax
{
'SnapshotOperationId': 'string',
'SnapshotOperationStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'CANCELLED'
}
Response Structure
(dict) --
SnapshotOperationId (string) --
The ID of the snapshot operation. You can use this value with DescribeSnapshotOperation to track the progress of the export.
SnapshotOperationStatus (string) --
The status of the snapshot operation.
Creates an enhanced snapshot of the state data of a running Managed Service for Apache Flink application. The application must be in the RUNNING status, use Apache Flink version 1.20 or later, and use the ENHANCED_SNAPSHOTS snapshot mode.
This operation is asynchronous. The response returns the snapshot ARN with the CREATING status. To check the status of the snapshot, use DescribeSnapshot. To track the progress of the operation, use DescribeSnapshotOperation.
An application can have only one CreateSnapshot operation in progress at a time. For information about limits, see Managed Service for Apache Flink Quotas. For more information about snapshots, see Enhanced Snapshots.
See also: AWS API Documentation
Request Syntax
client.create_snapshot(
ApplicationName='string',
SnapshotName='string',
SnapshotDescription='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the application.
string
[REQUIRED]
The name of the enhanced snapshot. The name must be unique among the snapshots in your account and Region. You can't reuse the name of an existing snapshot, including a snapshot in the FAILED status, until you delete that snapshot. Names that begin with SYSTEMSNAPSHOT are reserved.
string
A summary description of the snapshot.
list
A list of one or more tags to assign to the snapshot. A tag is a key-value pair that identifies a snapshot. For more information, see Using Tagging.
(dict) --
A key-value pair (the value is optional) that you can define and assign to Amazon 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.
Key (string) -- [REQUIRED]
The key of the key-value tag.
Value (string) --
The value of the key-value tag. The value is optional.
dict
Response Syntax
{
'SnapshotArn': 'string',
'SnapshotStatus': 'CREATING'|'READY'|'DELETING'|'FAILED',
'SnapshotOperationId': 'string',
'SnapshotOperationStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'CANCELLED'
}
Response Structure
(dict) --
SnapshotArn (string) --
The ARN of the enhanced snapshot.
SnapshotStatus (string) --
The status of the snapshot. When Managed Service for Apache Flink accepts the request, the status is CREATING.
SnapshotOperationId (string) --
The ID of the snapshot operation. You can use this value with DescribeSnapshotOperation to track the progress of the operation.
SnapshotOperationStatus (string) --
The status of the snapshot operation.
{'ApplicationConfiguration': {'ApplicationSnapshotConfiguration': {'SnapshotMode': 'APPLICATION_SNAPSHOTS_LEGACY '
'| '
'ENHANCED_SNAPSHOTS'}}}
Response {'ApplicationDetail': {'ApplicationConfigurationDescription': {'ApplicationSnapshotConfigurationDescription': {'SnapshotMode': 'APPLICATION_SNAPSHOTS_LEGACY '
'| '
'ENHANCED_SNAPSHOTS'},
'RunConfigurationDescription': {'ApplicationRestoreConfigurationDescription': {'SnapshotArn': 'string'}}}}}
Creates a Managed Service for Apache Flink application. For information about creating a Managed Service for Apache Flink application, see Creating an Application.
See also: AWS API Documentation
Request Syntax
client.create_application(
ApplicationName='string',
ApplicationDescription='string',
RuntimeEnvironment='SQL-1_0'|'FLINK-1_6'|'FLINK-1_8'|'ZEPPELIN-FLINK-1_0'|'FLINK-1_11'|'FLINK-1_13'|'ZEPPELIN-FLINK-2_0'|'FLINK-1_15'|'ZEPPELIN-FLINK-3_0'|'FLINK-1_18'|'FLINK-1_19'|'FLINK-1_20'|'FLINK-2_2'|'FLINK-2_3',
ServiceExecutionRole='string',
ApplicationConfiguration={
'SqlApplicationConfiguration': {
'Inputs': [
{
'NamePrefix': 'string',
'InputProcessingConfiguration': {
'InputLambdaProcessor': {
'ResourceARN': 'string'
}
},
'KinesisStreamsInput': {
'ResourceARN': 'string'
},
'KinesisFirehoseInput': {
'ResourceARN': 'string'
},
'InputParallelism': {
'Count': 123
},
'InputSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
}
},
],
'Outputs': [
{
'Name': 'string',
'KinesisStreamsOutput': {
'ResourceARN': 'string'
},
'KinesisFirehoseOutput': {
'ResourceARN': 'string'
},
'LambdaOutput': {
'ResourceARN': 'string'
},
'DestinationSchema': {
'RecordFormatType': 'JSON'|'CSV'
}
},
],
'ReferenceDataSources': [
{
'TableName': 'string',
'S3ReferenceDataSource': {
'BucketARN': 'string',
'FileKey': 'string'
},
'ReferenceSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
}
},
]
},
'FlinkApplicationConfiguration': {
'CheckpointConfiguration': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'CheckpointingEnabled': True|False,
'CheckpointInterval': 123,
'MinPauseBetweenCheckpoints': 123
},
'MonitoringConfiguration': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'MetricsLevel': 'APPLICATION'|'TASK'|'OPERATOR'|'PARALLELISM',
'LogLevel': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'ParallelismConfiguration': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'Parallelism': 123,
'ParallelismPerKPU': 123,
'AutoScalingEnabled': True|False
}
},
'EnvironmentProperties': {
'PropertyGroups': [
{
'PropertyGroupId': 'string',
'PropertyMap': {
'string': 'string'
}
},
]
},
'ApplicationCodeConfiguration': {
'CodeContent': {
'TextContent': 'string',
'ZipFileContent': b'bytes',
'S3ContentLocation': {
'BucketARN': 'string',
'FileKey': 'string',
'ObjectVersion': 'string'
}
},
'CodeContentType': 'PLAINTEXT'|'ZIPFILE'
},
'ApplicationSnapshotConfiguration': {
'SnapshotsEnabled': True|False,
'SnapshotMode': 'APPLICATION_SNAPSHOTS_LEGACY'|'ENHANCED_SNAPSHOTS'
},
'ApplicationSystemRollbackConfiguration': {
'RollbackEnabled': True|False
},
'VpcConfigurations': [
{
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
],
'ZeppelinApplicationConfiguration': {
'MonitoringConfiguration': {
'LogLevel': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'CatalogConfiguration': {
'GlueDataCatalogConfiguration': {
'DatabaseARN': 'string'
}
},
'DeployAsApplicationConfiguration': {
'S3ContentLocation': {
'BucketARN': 'string',
'BasePath': 'string'
}
},
'CustomArtifactsConfiguration': [
{
'ArtifactType': 'UDF'|'DEPENDENCY_JAR',
'S3ContentLocation': {
'BucketARN': 'string',
'FileKey': 'string',
'ObjectVersion': 'string'
},
'MavenReference': {
'GroupId': 'string',
'ArtifactId': 'string',
'Version': 'string'
}
},
]
},
'ApplicationEncryptionConfiguration': {
'KeyId': 'string',
'KeyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
}
},
CloudWatchLoggingOptions=[
{
'LogStreamARN': 'string'
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ApplicationMode='STREAMING'|'INTERACTIVE'
)
string
[REQUIRED]
The name of your application (for example, sample-app).
string
A summary description of the application.
string
[REQUIRED]
The runtime environment for the application.
string
[REQUIRED]
The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.
dict
Use this parameter to configure the application.
SqlApplicationConfiguration (dict) --
The creation and update parameters for a SQL-based Kinesis Data Analytics application.
Inputs (list) --
The array of Input objects describing the input streams used by the application.
(dict) --
When you configure the application input for a SQL-based Kinesis Data Analytics application, you specify the streaming source, the in-application stream name that is created, and the mapping between the two.
NamePrefix (string) -- [REQUIRED]
The name prefix to use when creating an in-application stream. Suppose that you specify a prefix " MyInApplicationStream." Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names " MyInApplicationStream_001," " MyInApplicationStream_002," and so on.
InputProcessingConfiguration (dict) --
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.
InputLambdaProcessor (dict) -- [REQUIRED]
The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.
ResourceARN (string) -- [REQUIRED]
The ARN of the Amazon Lambda function that operates on records in the stream.
KinesisStreamsInput (dict) --
If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN).
ResourceARN (string) -- [REQUIRED]
The ARN of the input Kinesis data stream to read.
KinesisFirehoseInput (dict) --
If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN.
ResourceARN (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the delivery stream.
InputParallelism (dict) --
Describes the number of in-application streams to create.
Count (integer) --
The number of in-application streams to create.
InputSchema (dict) -- [REQUIRED]
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.
RecordFormat (dict) -- [REQUIRED]
Specifies the format of the records on the streaming source.
RecordFormatType (string) -- [REQUIRED]
The type of record format.
MappingParameters (dict) --
When you configure 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.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) -- [REQUIRED]
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) -- [REQUIRED]
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) -- [REQUIRED]
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) -- [REQUIRED]
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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.
Name (string) -- [REQUIRED]
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) -- [REQUIRED]
The type of column created in the in-application input stream or reference table.
Outputs (list) --
The array of Output objects describing the destination streams used by the application.
(dict) --
Describes a SQL-based Kinesis Data Analytics application's 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 a Kinesis data stream or a Kinesis Data Firehose delivery stream.
Name (string) -- [REQUIRED]
The name of the in-application stream.
KinesisStreamsOutput (dict) --
Identifies a Kinesis data stream as the destination.
ResourceARN (string) -- [REQUIRED]
The ARN of the destination Kinesis data stream to write to.
KinesisFirehoseOutput (dict) --
Identifies a Kinesis Data Firehose delivery stream as the destination.
ResourceARN (string) -- [REQUIRED]
The ARN of the destination delivery stream to write to.
LambdaOutput (dict) --
Identifies an Amazon Lambda function as the destination.
ResourceARN (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the destination Lambda function to write to.
DestinationSchema (dict) -- [REQUIRED]
Describes the data format when records are written to the destination.
RecordFormatType (string) -- [REQUIRED]
Specifies the format of the records on the output stream.
ReferenceDataSources (list) --
The array of ReferenceDataSource objects describing the reference data sources used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the reference data source by providing the source information (Amazon 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.
TableName (string) -- [REQUIRED]
The name of the in-application table to create.
S3ReferenceDataSource (dict) --
Identifies the S3 bucket and object that contains the reference data. A SQL-based Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.
BucketARN (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
FileKey (string) --
The object key name containing the reference data.
ReferenceSchema (dict) -- [REQUIRED]
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.
RecordFormat (dict) -- [REQUIRED]
Specifies the format of the records on the streaming source.
RecordFormatType (string) -- [REQUIRED]
The type of record format.
MappingParameters (dict) --
When you configure 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.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) -- [REQUIRED]
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) -- [REQUIRED]
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) -- [REQUIRED]
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) -- [REQUIRED]
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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.
Name (string) -- [REQUIRED]
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) -- [REQUIRED]
The type of column created in the in-application input stream or reference table.
FlinkApplicationConfiguration (dict) --
The creation and update parameters for a Managed Service for Apache Flink application.
CheckpointConfiguration (dict) --
Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.
ConfigurationType (string) -- [REQUIRED]
Describes whether the application uses Managed Service for Apache Flink' default checkpointing behavior. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.
CheckpointingEnabled (boolean) --
Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
CheckpointInterval (integer) --
Describes the interval in milliseconds between checkpoint operations.
MinPauseBetweenCheckpoints (integer) --
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.
MonitoringConfiguration (dict) --
Describes configuration parameters for Amazon CloudWatch logging for an application.
ConfigurationType (string) -- [REQUIRED]
Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.
MetricsLevel (string) --
Describes the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs.
LogLevel (string) --
Describes the verbosity of the CloudWatch Logs for an application.
ParallelismConfiguration (dict) --
Describes parameters for how an application executes multiple tasks simultaneously.
ConfigurationType (string) -- [REQUIRED]
Describes whether the application uses the default parallelism for the Managed Service for Apache Flink service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.
Parallelism (integer) --
Describes the initial number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled is set to True, Managed Service for Apache Flink increases the CurrentParallelism value in response to application load. The service can increase the CurrentParallelism value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 64 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
ParallelismPerKPU (integer) --
Describes the number of parallel tasks that a Managed Service for Apache Flink application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Managed Service for Apache Flink Pricing.
AutoScalingEnabled (boolean) --
Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.
EnvironmentProperties (dict) --
Describes execution properties for a Managed Service for Apache Flink application.
PropertyGroups (list) -- [REQUIRED]
Describes the execution property groups.
(dict) --
Property key-value pairs passed into an application.
PropertyGroupId (string) -- [REQUIRED]
Describes the key of an application execution property key-value pair.
PropertyMap (dict) -- [REQUIRED]
Describes the value of an application execution property key-value pair.
(string) --
(string) --
ApplicationCodeConfiguration (dict) --
The code location and type parameters for a Managed Service for Apache Flink application.
CodeContent (dict) --
The location and type of the application code.
TextContent (string) --
The text-format code for a Managed Service for Apache Flink application.
ZipFileContent (bytes) --
The zip-format code for a Managed Service for Apache Flink application.
S3ContentLocation (dict) --
Information about the Amazon S3 bucket that contains the application code.
BucketARN (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKey (string) -- [REQUIRED]
The file key for the object containing the application code.
ObjectVersion (string) --
The version of the object containing the application code.
CodeContentType (string) -- [REQUIRED]
Specifies whether the code content is in text or zip format.
ApplicationSnapshotConfiguration (dict) --
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
SnapshotsEnabled (boolean) -- [REQUIRED]
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
SnapshotMode (string) --
Specifies the snapshot mode for a Managed Service for Apache Flink application. To use enhanced snapshots, specify ENHANCED_SNAPSHOTS. If you don't specify this parameter, the application uses APPLICATION_SNAPSHOTS_LEGACY. For more information, see Enhanced Snapshots.
To use ENHANCED_SNAPSHOTS, the application must use Apache Flink version 1.20 or later.
ApplicationSystemRollbackConfiguration (dict) --
Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.
RollbackEnabled (boolean) -- [REQUIRED]
Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.
VpcConfigurations (list) --
The array of descriptions of VPC configurations available to the application.
(dict) --
Describes the parameters of a VPC used by the application.
SubnetIds (list) -- [REQUIRED]
The array of Subnet IDs used by the VPC configuration.
(string) --
SecurityGroupIds (list) -- [REQUIRED]
The array of SecurityGroup IDs used by the VPC configuration.
(string) --
ZeppelinApplicationConfiguration (dict) --
The configuration parameters for a Managed Service for Apache Flink Studio notebook.
MonitoringConfiguration (dict) --
The monitoring configuration of a Managed Service for Apache Flink Studio notebook.
LogLevel (string) -- [REQUIRED]
The verbosity of the CloudWatch Logs for an application.
CatalogConfiguration (dict) --
The Amazon Glue Data Catalog that you use in queries in a Managed Service for Apache Flink Studio notebook.
GlueDataCatalogConfiguration (dict) -- [REQUIRED]
The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Managed Service for Apache Flink Studio notebook.
DatabaseARN (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the database.
DeployAsApplicationConfiguration (dict) --
The information required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.
S3ContentLocation (dict) -- [REQUIRED]
The description of an Amazon S3 object that contains the Amazon Data Analytics application, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.
BucketARN (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the S3 bucket.
BasePath (string) --
The base path for the S3 bucket.
CustomArtifactsConfiguration (list) --
Custom artifacts are dependency JARs and user-defined functions (UDF).
(dict) --
Specifies dependency JARs, as well as JAR files that contain user-defined functions (UDF).
ArtifactType (string) -- [REQUIRED]
UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.
S3ContentLocation (dict) --
For a Managed Service for Apache Flink application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.
BucketARN (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKey (string) -- [REQUIRED]
The file key for the object containing the application code.
ObjectVersion (string) --
The version of the object containing the application code.
MavenReference (dict) --
The parameters required to fully specify a Maven reference.
GroupId (string) -- [REQUIRED]
The group ID of the Maven reference.
ArtifactId (string) -- [REQUIRED]
The artifact ID of the Maven reference.
Version (string) -- [REQUIRED]
The version of the Maven reference.
ApplicationEncryptionConfiguration (dict) --
The configuration to manage encryption at rest.
KeyId (string) --
The key ARN, key ID, alias ARN, or alias name of the KMS key used for encryption at rest.
KeyType (string) -- [REQUIRED]
Specifies the type of key used for encryption at rest.
list
Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.
(dict) --
Provides a description of Amazon CloudWatch logging options, including the log stream Amazon Resource Name (ARN).
LogStreamARN (string) -- [REQUIRED]
The ARN of the CloudWatch log to receive application messages.
list
A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.
(dict) --
A key-value pair (the value is optional) that you can define and assign to Amazon 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.
Key (string) -- [REQUIRED]
The key of the key-value tag.
Value (string) --
The value of the key-value tag. The value is optional.
string
Use the STREAMING mode to create a Managed Service for Apache Flink application. To create a Managed Service for Apache Flink Studio notebook, use the INTERACTIVE mode.
dict
Response Syntax
{
'ApplicationDetail': {
'ApplicationARN': 'string',
'ApplicationDescription': 'string',
'ApplicationName': 'string',
'RuntimeEnvironment': 'SQL-1_0'|'FLINK-1_6'|'FLINK-1_8'|'ZEPPELIN-FLINK-1_0'|'FLINK-1_11'|'FLINK-1_13'|'ZEPPELIN-FLINK-2_0'|'FLINK-1_15'|'ZEPPELIN-FLINK-3_0'|'FLINK-1_18'|'FLINK-1_19'|'FLINK-1_20'|'FLINK-2_2'|'FLINK-2_3',
'ServiceExecutionRole': 'string',
'ApplicationStatus': 'DELETING'|'STARTING'|'STOPPING'|'READY'|'RUNNING'|'UPDATING'|'AUTOSCALING'|'FORCE_STOPPING'|'ROLLING_BACK'|'MAINTENANCE'|'ROLLED_BACK',
'ApplicationVersionId': 123,
'CreateTimestamp': datetime(2015, 1, 1),
'LastUpdateTimestamp': datetime(2015, 1, 1),
'ApplicationConfigurationDescription': {
'SqlApplicationConfigurationDescription': {
'InputDescriptions': [
{
'InputId': 'string',
'NamePrefix': 'string',
'InAppStreamNames': [
'string',
],
'InputProcessingConfigurationDescription': {
'InputLambdaProcessorDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
}
},
'KinesisStreamsInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'InputSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
},
'InputParallelism': {
'Count': 123
},
'InputStartingPositionConfiguration': {
'InputStartingPosition': 'NOW'|'TRIM_HORIZON'|'LAST_STOPPED_POINT'
}
},
],
'OutputDescriptions': [
{
'OutputId': 'string',
'Name': 'string',
'KinesisStreamsOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'LambdaOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'DestinationSchema': {
'RecordFormatType': 'JSON'|'CSV'
}
},
],
'ReferenceDataSourceDescriptions': [
{
'ReferenceId': 'string',
'TableName': 'string',
'S3ReferenceDataSourceDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ReferenceRoleARN': 'string'
},
'ReferenceSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
}
},
]
},
'ApplicationCodeConfigurationDescription': {
'CodeContentType': 'PLAINTEXT'|'ZIPFILE',
'CodeContentDescription': {
'TextContent': 'string',
'CodeMD5': 'string',
'CodeSize': 123,
'S3ApplicationCodeLocationDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ObjectVersion': 'string'
}
}
},
'RunConfigurationDescription': {
'ApplicationRestoreConfigurationDescription': {
'ApplicationRestoreType': 'SKIP_RESTORE_FROM_SNAPSHOT'|'RESTORE_FROM_LATEST_SNAPSHOT'|'RESTORE_FROM_CUSTOM_SNAPSHOT',
'SnapshotName': 'string',
'SnapshotArn': 'string'
},
'FlinkRunConfigurationDescription': {
'AllowNonRestoredState': True|False
}
},
'FlinkApplicationConfigurationDescription': {
'CheckpointConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'CheckpointingEnabled': True|False,
'CheckpointInterval': 123,
'MinPauseBetweenCheckpoints': 123
},
'MonitoringConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'MetricsLevel': 'APPLICATION'|'TASK'|'OPERATOR'|'PARALLELISM',
'LogLevel': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'ParallelismConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'Parallelism': 123,
'ParallelismPerKPU': 123,
'CurrentParallelism': 123,
'AutoScalingEnabled': True|False
},
'JobPlanDescription': 'string'
},
'EnvironmentPropertyDescriptions': {
'PropertyGroupDescriptions': [
{
'PropertyGroupId': 'string',
'PropertyMap': {
'string': 'string'
}
},
]
},
'ApplicationSnapshotConfigurationDescription': {
'SnapshotsEnabled': True|False,
'SnapshotMode': 'APPLICATION_SNAPSHOTS_LEGACY'|'ENHANCED_SNAPSHOTS'
},
'ApplicationSystemRollbackConfigurationDescription': {
'RollbackEnabled': True|False
},
'VpcConfigurationDescriptions': [
{
'VpcConfigurationId': 'string',
'VpcId': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
],
'ZeppelinApplicationConfigurationDescription': {
'MonitoringConfigurationDescription': {
'LogLevel': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'CatalogConfigurationDescription': {
'GlueDataCatalogConfigurationDescription': {
'DatabaseARN': 'string'
}
},
'DeployAsApplicationConfigurationDescription': {
'S3ContentLocationDescription': {
'BucketARN': 'string',
'BasePath': 'string'
}
},
'CustomArtifactsConfigurationDescription': [
{
'ArtifactType': 'UDF'|'DEPENDENCY_JAR',
'S3ContentLocationDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ObjectVersion': 'string'
},
'MavenReferenceDescription': {
'GroupId': 'string',
'ArtifactId': 'string',
'Version': 'string'
}
},
]
},
'ApplicationEncryptionConfigurationDescription': {
'KeyId': 'string',
'KeyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
}
},
'CloudWatchLoggingOptionDescriptions': [
{
'CloudWatchLoggingOptionId': 'string',
'LogStreamARN': 'string',
'RoleARN': 'string'
},
],
'ApplicationMaintenanceConfigurationDescription': {
'ApplicationMaintenanceWindowStartTime': 'string',
'ApplicationMaintenanceWindowEndTime': 'string'
},
'ApplicationVersionUpdatedFrom': 123,
'ApplicationVersionRolledBackFrom': 123,
'ApplicationVersionCreateTimestamp': datetime(2015, 1, 1),
'ConditionalToken': 'string',
'ApplicationVersionRolledBackTo': 123,
'ApplicationMode': 'STREAMING'|'INTERACTIVE'
}
}
Response Structure
(dict) --
ApplicationDetail (dict) --
In response to your CreateApplication request, Managed Service for Apache Flink returns a response with details of the application it created.
ApplicationARN (string) --
The ARN of the application.
ApplicationDescription (string) --
The description of the application.
ApplicationName (string) --
The name of the application.
RuntimeEnvironment (string) --
The runtime environment for the application.
ServiceExecutionRole (string) --
Specifies the IAM role that the application uses to access external resources.
ApplicationStatus (string) --
The status of the application.
ApplicationVersionId (integer) --
Provides the current application version. Managed Service for Apache Flink updates the ApplicationVersionId each time you update the application.
CreateTimestamp (datetime) --
The current timestamp when the application was created.
LastUpdateTimestamp (datetime) --
The current timestamp when the application was last updated.
ApplicationConfigurationDescription (dict) --
Describes details about the application code and starting parameters for a Managed Service for Apache Flink application.
SqlApplicationConfigurationDescription (dict) --
The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
InputDescriptions (list) --
The array of InputDescription objects describing the input streams used by the application.
(dict) --
Describes the application input configuration for a SQL-based Kinesis Data Analytics application.
InputId (string) --
The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.
NamePrefix (string) --
The in-application name prefix.
InAppStreamNames (list) --
Returns the in-application stream names that are mapped to the stream source.
(string) --
InputProcessingConfigurationDescription (dict) --
The description of the preprocessor that executes on records in this input before the application's code is run.
InputLambdaProcessorDescription (dict) --
Provides configuration information about the associated InputLambdaProcessorDescription
ResourceARN (string) --
The ARN of the Amazon Lambda function that is used to preprocess the records in the stream.
RoleARN (string) --
The ARN of the IAM role that is used to access the Amazon Lambda function.
KinesisStreamsInputDescription (dict) --
If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).
ResourceARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
KinesisFirehoseInputDescription (dict) --
If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the delivery stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.
InputSchema (dict) --
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.
RecordFormat (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When you configure 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.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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.
Name (string) --
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) --
The type of column created in the in-application input stream or reference table.
InputParallelism (dict) --
Describes the configured parallelism (number of in-application streams mapped to the streaming source).
Count (integer) --
The number of in-application streams to create.
InputStartingPositionConfiguration (dict) --
The point at which the application is configured to read from the input stream.
InputStartingPosition (string) --
The starting position on the stream.
NOW - Start reading just after the most recent record in the stream, and start at the request timestamp 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 Data Firehose delivery stream.
LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.
OutputDescriptions (list) --
The array of OutputDescription objects describing the destination streams used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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 a Kinesis data stream or a Kinesis Data Firehose delivery stream.
OutputId (string) --
A unique identifier for the output configuration.
Name (string) --
The name of the in-application stream that is configured as output.
KinesisStreamsOutputDescription (dict) --
Describes the Kinesis data stream that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
KinesisFirehoseOutputDescription (dict) --
Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the delivery stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
LambdaOutputDescription (dict) --
Describes the Lambda function that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the destination Lambda function.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.
DestinationSchema (dict) --
The data format used for writing data to the destination.
RecordFormatType (string) --
Specifies the format of the records on the output stream.
ReferenceDataSourceDescriptions (list) --
The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.
ReferenceId (string) --
The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.
TableName (string) --
The in-application table name created by the specific reference data source configuration.
S3ReferenceDataSourceDescription (dict) --
Provides the Amazon S3 bucket name, the object key name that contains the reference data.
BucketARN (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
FileKey (string) --
Amazon S3 object key name.
ReferenceRoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.
ReferenceSchema (dict) --
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.
RecordFormat (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When you configure 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.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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.
Name (string) --
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) --
The type of column created in the in-application input stream or reference table.
ApplicationCodeConfigurationDescription (dict) --
The details about the application code for a Managed Service for Apache Flink application.
CodeContentType (string) --
Specifies whether the code content is in text or zip format.
CodeContentDescription (dict) --
Describes details about the location and format of the application code.
TextContent (string) --
The text-format code
CodeMD5 (string) --
The checksum that can be used to validate zip-format code.
CodeSize (integer) --
The size in bytes of the application code. Can be used to validate zip-format code.
S3ApplicationCodeLocationDescription (dict) --
The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.
BucketARN (string) --
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKey (string) --
The file key for the object containing the application code.
ObjectVersion (string) --
The version of the object containing the application code.
RunConfigurationDescription (dict) --
The details about the starting properties for a Managed Service for Apache Flink application.
ApplicationRestoreConfigurationDescription (dict) --
Describes the restore behavior of a restarting application.
ApplicationRestoreType (string) --
Specifies how the application should be restored.
SnapshotName (string) --
The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.
SnapshotArn (string) --
The identifier of an existing enhanced snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType and SnapshotMode is ENHANCED_SNAPSHOTS.
FlinkRunConfigurationDescription (dict) --
Describes the starting parameters for a Managed Service for Apache Flink application.
AllowNonRestoredState (boolean) --
When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.
FlinkApplicationConfigurationDescription (dict) --
The details about a Managed Service for Apache Flink application.
CheckpointConfigurationDescription (dict) --
Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
ConfigurationType (string) --
Describes whether the application uses the default checkpointing behavior in Managed Service for Apache Flink.
CheckpointingEnabled (boolean) --
Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
CheckpointInterval (integer) --
Describes the interval in milliseconds between checkpoint operations.
MinPauseBetweenCheckpoints (integer) --
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
MonitoringConfigurationDescription (dict) --
Describes configuration parameters for Amazon CloudWatch logging for an application.
ConfigurationType (string) --
Describes whether to use the default CloudWatch logging configuration for an application.
MetricsLevel (string) --
Describes the granularity of the CloudWatch Logs for an application.
LogLevel (string) --
Describes the verbosity of the CloudWatch Logs for an application.
ParallelismConfigurationDescription (dict) --
Describes parameters for how an application executes multiple tasks simultaneously.
ConfigurationType (string) --
Describes whether the application uses the default parallelism for the Managed Service for Apache Flink service.
Parallelism (integer) --
Describes the initial number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled is set to True, then Managed Service for Apache Flink can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 64 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
ParallelismPerKPU (integer) --
Describes the number of parallel tasks that a Managed Service for Apache Flink application can perform per Kinesis Processing Unit (KPU) used by the application.
CurrentParallelism (integer) --
Describes the current number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled is set to True, Managed Service for Apache Flink can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
AutoScalingEnabled (boolean) --
Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.
JobPlanDescription (string) --
The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
EnvironmentPropertyDescriptions (dict) --
Describes execution properties for a Managed Service for Apache Flink application.
PropertyGroupDescriptions (list) --
Describes the execution property groups.
(dict) --
Property key-value pairs passed into an application.
PropertyGroupId (string) --
Describes the key of an application execution property key-value pair.
PropertyMap (dict) --
Describes the value of an application execution property key-value pair.
(string) --
(string) --
ApplicationSnapshotConfigurationDescription (dict) --
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
SnapshotsEnabled (boolean) --
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
SnapshotMode (string) --
Describes the snapshot mode of a Managed Service for Apache Flink application.
ApplicationSystemRollbackConfigurationDescription (dict) --
Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.
RollbackEnabled (boolean) --
Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.
VpcConfigurationDescriptions (list) --
The array of descriptions of VPC configurations available to the application.
(dict) --
Describes the parameters of a VPC used by the application.
VpcConfigurationId (string) --
The ID of the VPC configuration.
VpcId (string) --
The ID of the associated VPC.
SubnetIds (list) --
The array of Subnet IDs used by the VPC configuration.
(string) --
SecurityGroupIds (list) --
The array of SecurityGroup IDs used by the VPC configuration.
(string) --
ZeppelinApplicationConfigurationDescription (dict) --
The configuration parameters for a Managed Service for Apache Flink Studio notebook.
MonitoringConfigurationDescription (dict) --
The monitoring configuration of a Managed Service for Apache Flink Studio notebook.
LogLevel (string) --
Describes the verbosity of the CloudWatch Logs for an application.
CatalogConfigurationDescription (dict) --
The Amazon Glue Data Catalog that is associated with the Managed Service for Apache Flink Studio notebook.
GlueDataCatalogConfigurationDescription (dict) --
The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
DatabaseARN (string) --
The Amazon Resource Name (ARN) of the database.
DeployAsApplicationConfigurationDescription (dict) --
The parameters required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.
S3ContentLocationDescription (dict) --
The location that holds the data required to specify an Amazon Data Analytics application.
BucketARN (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
BasePath (string) --
The base path for the S3 bucket.
CustomArtifactsConfigurationDescription (list) --
Custom artifacts are dependency JARs and user-defined functions (UDF).
(dict) --
Specifies a dependency JAR or a JAR of user-defined functions.
ArtifactType (string) --
UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.
S3ContentLocationDescription (dict) --
For a Managed Service for Apache Flink application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.
BucketARN (string) --
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKey (string) --
The file key for the object containing the application code.
ObjectVersion (string) --
The version of the object containing the application code.
MavenReferenceDescription (dict) --
The parameters that are required to specify a Maven dependency.
GroupId (string) --
The group ID of the Maven reference.
ArtifactId (string) --
The artifact ID of the Maven reference.
Version (string) --
The version of the Maven reference.
ApplicationEncryptionConfigurationDescription (dict) --
Describes the encryption at rest configuration.
KeyId (string) --
The key ARN, key ID, alias ARN, or alias name of the KMS key used for encryption at rest.
KeyType (string) --
Specifies the type of key used for encryption at rest.
CloudWatchLoggingOptionDescriptions (list) --
Describes the application Amazon CloudWatch logging options.
(dict) --
Describes the Amazon CloudWatch logging option.
CloudWatchLoggingOptionId (string) --
The ID of the CloudWatch logging option description.
LogStreamARN (string) --
The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
RoleARN (string) --
The IAM ARN of the role to use to send application messages.
ApplicationMaintenanceConfigurationDescription (dict) --
The details of the maintenance configuration for the application.
ApplicationMaintenanceWindowStartTime (string) --
The start time for the maintenance window.
ApplicationMaintenanceWindowEndTime (string) --
The end time for the maintenance window.
ApplicationVersionUpdatedFrom (integer) --
The previous application version before the latest application update. RollbackApplication reverts the application to this version.
ApplicationVersionRolledBackFrom (integer) --
If you reverted the application using RollbackApplication, the application version when RollbackApplication was called.
ApplicationVersionCreateTimestamp (datetime) --
The timestamp that indicates when the application version was created.
ConditionalToken (string) --
A value you use to implement strong concurrency for application updates.
ApplicationVersionRolledBackTo (integer) --
The version to which you want to roll back the application.
ApplicationMode (string) --
To create a Managed Service for Apache Flink Studio notebook, you must set the mode to INTERACTIVE. However, for a Managed Service for Apache Flink application, the mode is optional.
{'ApplicationDetail': {'ApplicationConfigurationDescription': {'ApplicationSnapshotConfigurationDescription': {'SnapshotMode': 'APPLICATION_SNAPSHOTS_LEGACY '
'| '
'ENHANCED_SNAPSHOTS'},
'RunConfigurationDescription': {'ApplicationRestoreConfigurationDescription': {'SnapshotArn': 'string'}}}}}
Returns information about a specific Managed Service for Apache Flink application.
If you want to retrieve a list of all applications in your account, use the ListApplications operation.
See also: AWS API Documentation
Request Syntax
client.describe_application(
ApplicationName='string',
IncludeAdditionalDetails=True|False
)
string
[REQUIRED]
The name of the application.
boolean
Displays verbose information about a Managed Service for Apache Flink application, including the application's job plan.
dict
Response Syntax
{
'ApplicationDetail': {
'ApplicationARN': 'string',
'ApplicationDescription': 'string',
'ApplicationName': 'string',
'RuntimeEnvironment': 'SQL-1_0'|'FLINK-1_6'|'FLINK-1_8'|'ZEPPELIN-FLINK-1_0'|'FLINK-1_11'|'FLINK-1_13'|'ZEPPELIN-FLINK-2_0'|'FLINK-1_15'|'ZEPPELIN-FLINK-3_0'|'FLINK-1_18'|'FLINK-1_19'|'FLINK-1_20'|'FLINK-2_2'|'FLINK-2_3',
'ServiceExecutionRole': 'string',
'ApplicationStatus': 'DELETING'|'STARTING'|'STOPPING'|'READY'|'RUNNING'|'UPDATING'|'AUTOSCALING'|'FORCE_STOPPING'|'ROLLING_BACK'|'MAINTENANCE'|'ROLLED_BACK',
'ApplicationVersionId': 123,
'CreateTimestamp': datetime(2015, 1, 1),
'LastUpdateTimestamp': datetime(2015, 1, 1),
'ApplicationConfigurationDescription': {
'SqlApplicationConfigurationDescription': {
'InputDescriptions': [
{
'InputId': 'string',
'NamePrefix': 'string',
'InAppStreamNames': [
'string',
],
'InputProcessingConfigurationDescription': {
'InputLambdaProcessorDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
}
},
'KinesisStreamsInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'InputSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
},
'InputParallelism': {
'Count': 123
},
'InputStartingPositionConfiguration': {
'InputStartingPosition': 'NOW'|'TRIM_HORIZON'|'LAST_STOPPED_POINT'
}
},
],
'OutputDescriptions': [
{
'OutputId': 'string',
'Name': 'string',
'KinesisStreamsOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'LambdaOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'DestinationSchema': {
'RecordFormatType': 'JSON'|'CSV'
}
},
],
'ReferenceDataSourceDescriptions': [
{
'ReferenceId': 'string',
'TableName': 'string',
'S3ReferenceDataSourceDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ReferenceRoleARN': 'string'
},
'ReferenceSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
}
},
]
},
'ApplicationCodeConfigurationDescription': {
'CodeContentType': 'PLAINTEXT'|'ZIPFILE',
'CodeContentDescription': {
'TextContent': 'string',
'CodeMD5': 'string',
'CodeSize': 123,
'S3ApplicationCodeLocationDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ObjectVersion': 'string'
}
}
},
'RunConfigurationDescription': {
'ApplicationRestoreConfigurationDescription': {
'ApplicationRestoreType': 'SKIP_RESTORE_FROM_SNAPSHOT'|'RESTORE_FROM_LATEST_SNAPSHOT'|'RESTORE_FROM_CUSTOM_SNAPSHOT',
'SnapshotName': 'string',
'SnapshotArn': 'string'
},
'FlinkRunConfigurationDescription': {
'AllowNonRestoredState': True|False
}
},
'FlinkApplicationConfigurationDescription': {
'CheckpointConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'CheckpointingEnabled': True|False,
'CheckpointInterval': 123,
'MinPauseBetweenCheckpoints': 123
},
'MonitoringConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'MetricsLevel': 'APPLICATION'|'TASK'|'OPERATOR'|'PARALLELISM',
'LogLevel': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'ParallelismConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'Parallelism': 123,
'ParallelismPerKPU': 123,
'CurrentParallelism': 123,
'AutoScalingEnabled': True|False
},
'JobPlanDescription': 'string'
},
'EnvironmentPropertyDescriptions': {
'PropertyGroupDescriptions': [
{
'PropertyGroupId': 'string',
'PropertyMap': {
'string': 'string'
}
},
]
},
'ApplicationSnapshotConfigurationDescription': {
'SnapshotsEnabled': True|False,
'SnapshotMode': 'APPLICATION_SNAPSHOTS_LEGACY'|'ENHANCED_SNAPSHOTS'
},
'ApplicationSystemRollbackConfigurationDescription': {
'RollbackEnabled': True|False
},
'VpcConfigurationDescriptions': [
{
'VpcConfigurationId': 'string',
'VpcId': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
],
'ZeppelinApplicationConfigurationDescription': {
'MonitoringConfigurationDescription': {
'LogLevel': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'CatalogConfigurationDescription': {
'GlueDataCatalogConfigurationDescription': {
'DatabaseARN': 'string'
}
},
'DeployAsApplicationConfigurationDescription': {
'S3ContentLocationDescription': {
'BucketARN': 'string',
'BasePath': 'string'
}
},
'CustomArtifactsConfigurationDescription': [
{
'ArtifactType': 'UDF'|'DEPENDENCY_JAR',
'S3ContentLocationDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ObjectVersion': 'string'
},
'MavenReferenceDescription': {
'GroupId': 'string',
'ArtifactId': 'string',
'Version': 'string'
}
},
]
},
'ApplicationEncryptionConfigurationDescription': {
'KeyId': 'string',
'KeyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
}
},
'CloudWatchLoggingOptionDescriptions': [
{
'CloudWatchLoggingOptionId': 'string',
'LogStreamARN': 'string',
'RoleARN': 'string'
},
],
'ApplicationMaintenanceConfigurationDescription': {
'ApplicationMaintenanceWindowStartTime': 'string',
'ApplicationMaintenanceWindowEndTime': 'string'
},
'ApplicationVersionUpdatedFrom': 123,
'ApplicationVersionRolledBackFrom': 123,
'ApplicationVersionCreateTimestamp': datetime(2015, 1, 1),
'ConditionalToken': 'string',
'ApplicationVersionRolledBackTo': 123,
'ApplicationMode': 'STREAMING'|'INTERACTIVE'
}
}
Response Structure
(dict) --
ApplicationDetail (dict) --
Provides a description of the application, such as the application's Amazon Resource Name (ARN), status, and latest version.
ApplicationARN (string) --
The ARN of the application.
ApplicationDescription (string) --
The description of the application.
ApplicationName (string) --
The name of the application.
RuntimeEnvironment (string) --
The runtime environment for the application.
ServiceExecutionRole (string) --
Specifies the IAM role that the application uses to access external resources.
ApplicationStatus (string) --
The status of the application.
ApplicationVersionId (integer) --
Provides the current application version. Managed Service for Apache Flink updates the ApplicationVersionId each time you update the application.
CreateTimestamp (datetime) --
The current timestamp when the application was created.
LastUpdateTimestamp (datetime) --
The current timestamp when the application was last updated.
ApplicationConfigurationDescription (dict) --
Describes details about the application code and starting parameters for a Managed Service for Apache Flink application.
SqlApplicationConfigurationDescription (dict) --
The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
InputDescriptions (list) --
The array of InputDescription objects describing the input streams used by the application.
(dict) --
Describes the application input configuration for a SQL-based Kinesis Data Analytics application.
InputId (string) --
The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.
NamePrefix (string) --
The in-application name prefix.
InAppStreamNames (list) --
Returns the in-application stream names that are mapped to the stream source.
(string) --
InputProcessingConfigurationDescription (dict) --
The description of the preprocessor that executes on records in this input before the application's code is run.
InputLambdaProcessorDescription (dict) --
Provides configuration information about the associated InputLambdaProcessorDescription
ResourceARN (string) --
The ARN of the Amazon Lambda function that is used to preprocess the records in the stream.
RoleARN (string) --
The ARN of the IAM role that is used to access the Amazon Lambda function.
KinesisStreamsInputDescription (dict) --
If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).
ResourceARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
KinesisFirehoseInputDescription (dict) --
If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the delivery stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.
InputSchema (dict) --
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.
RecordFormat (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When you configure 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.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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.
Name (string) --
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) --
The type of column created in the in-application input stream or reference table.
InputParallelism (dict) --
Describes the configured parallelism (number of in-application streams mapped to the streaming source).
Count (integer) --
The number of in-application streams to create.
InputStartingPositionConfiguration (dict) --
The point at which the application is configured to read from the input stream.
InputStartingPosition (string) --
The starting position on the stream.
NOW - Start reading just after the most recent record in the stream, and start at the request timestamp 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 Data Firehose delivery stream.
LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.
OutputDescriptions (list) --
The array of OutputDescription objects describing the destination streams used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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 a Kinesis data stream or a Kinesis Data Firehose delivery stream.
OutputId (string) --
A unique identifier for the output configuration.
Name (string) --
The name of the in-application stream that is configured as output.
KinesisStreamsOutputDescription (dict) --
Describes the Kinesis data stream that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
KinesisFirehoseOutputDescription (dict) --
Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the delivery stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
LambdaOutputDescription (dict) --
Describes the Lambda function that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the destination Lambda function.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.
DestinationSchema (dict) --
The data format used for writing data to the destination.
RecordFormatType (string) --
Specifies the format of the records on the output stream.
ReferenceDataSourceDescriptions (list) --
The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.
ReferenceId (string) --
The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.
TableName (string) --
The in-application table name created by the specific reference data source configuration.
S3ReferenceDataSourceDescription (dict) --
Provides the Amazon S3 bucket name, the object key name that contains the reference data.
BucketARN (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
FileKey (string) --
Amazon S3 object key name.
ReferenceRoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.
ReferenceSchema (dict) --
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.
RecordFormat (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When you configure 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.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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.
Name (string) --
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) --
The type of column created in the in-application input stream or reference table.
ApplicationCodeConfigurationDescription (dict) --
The details about the application code for a Managed Service for Apache Flink application.
CodeContentType (string) --
Specifies whether the code content is in text or zip format.
CodeContentDescription (dict) --
Describes details about the location and format of the application code.
TextContent (string) --
The text-format code
CodeMD5 (string) --
The checksum that can be used to validate zip-format code.
CodeSize (integer) --
The size in bytes of the application code. Can be used to validate zip-format code.
S3ApplicationCodeLocationDescription (dict) --
The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.
BucketARN (string) --
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKey (string) --
The file key for the object containing the application code.
ObjectVersion (string) --
The version of the object containing the application code.
RunConfigurationDescription (dict) --
The details about the starting properties for a Managed Service for Apache Flink application.
ApplicationRestoreConfigurationDescription (dict) --
Describes the restore behavior of a restarting application.
ApplicationRestoreType (string) --
Specifies how the application should be restored.
SnapshotName (string) --
The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.
SnapshotArn (string) --
The identifier of an existing enhanced snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType and SnapshotMode is ENHANCED_SNAPSHOTS.
FlinkRunConfigurationDescription (dict) --
Describes the starting parameters for a Managed Service for Apache Flink application.
AllowNonRestoredState (boolean) --
When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.
FlinkApplicationConfigurationDescription (dict) --
The details about a Managed Service for Apache Flink application.
CheckpointConfigurationDescription (dict) --
Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
ConfigurationType (string) --
Describes whether the application uses the default checkpointing behavior in Managed Service for Apache Flink.
CheckpointingEnabled (boolean) --
Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
CheckpointInterval (integer) --
Describes the interval in milliseconds between checkpoint operations.
MinPauseBetweenCheckpoints (integer) --
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
MonitoringConfigurationDescription (dict) --
Describes configuration parameters for Amazon CloudWatch logging for an application.
ConfigurationType (string) --
Describes whether to use the default CloudWatch logging configuration for an application.
MetricsLevel (string) --
Describes the granularity of the CloudWatch Logs for an application.
LogLevel (string) --
Describes the verbosity of the CloudWatch Logs for an application.
ParallelismConfigurationDescription (dict) --
Describes parameters for how an application executes multiple tasks simultaneously.
ConfigurationType (string) --
Describes whether the application uses the default parallelism for the Managed Service for Apache Flink service.
Parallelism (integer) --
Describes the initial number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled is set to True, then Managed Service for Apache Flink can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 64 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
ParallelismPerKPU (integer) --
Describes the number of parallel tasks that a Managed Service for Apache Flink application can perform per Kinesis Processing Unit (KPU) used by the application.
CurrentParallelism (integer) --
Describes the current number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled is set to True, Managed Service for Apache Flink can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
AutoScalingEnabled (boolean) --
Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.
JobPlanDescription (string) --
The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
EnvironmentPropertyDescriptions (dict) --
Describes execution properties for a Managed Service for Apache Flink application.
PropertyGroupDescriptions (list) --
Describes the execution property groups.
(dict) --
Property key-value pairs passed into an application.
PropertyGroupId (string) --
Describes the key of an application execution property key-value pair.
PropertyMap (dict) --
Describes the value of an application execution property key-value pair.
(string) --
(string) --
ApplicationSnapshotConfigurationDescription (dict) --
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
SnapshotsEnabled (boolean) --
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
SnapshotMode (string) --
Describes the snapshot mode of a Managed Service for Apache Flink application.
ApplicationSystemRollbackConfigurationDescription (dict) --
Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.
RollbackEnabled (boolean) --
Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.
VpcConfigurationDescriptions (list) --
The array of descriptions of VPC configurations available to the application.
(dict) --
Describes the parameters of a VPC used by the application.
VpcConfigurationId (string) --
The ID of the VPC configuration.
VpcId (string) --
The ID of the associated VPC.
SubnetIds (list) --
The array of Subnet IDs used by the VPC configuration.
(string) --
SecurityGroupIds (list) --
The array of SecurityGroup IDs used by the VPC configuration.
(string) --
ZeppelinApplicationConfigurationDescription (dict) --
The configuration parameters for a Managed Service for Apache Flink Studio notebook.
MonitoringConfigurationDescription (dict) --
The monitoring configuration of a Managed Service for Apache Flink Studio notebook.
LogLevel (string) --
Describes the verbosity of the CloudWatch Logs for an application.
CatalogConfigurationDescription (dict) --
The Amazon Glue Data Catalog that is associated with the Managed Service for Apache Flink Studio notebook.
GlueDataCatalogConfigurationDescription (dict) --
The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
DatabaseARN (string) --
The Amazon Resource Name (ARN) of the database.
DeployAsApplicationConfigurationDescription (dict) --
The parameters required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.
S3ContentLocationDescription (dict) --
The location that holds the data required to specify an Amazon Data Analytics application.
BucketARN (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
BasePath (string) --
The base path for the S3 bucket.
CustomArtifactsConfigurationDescription (list) --
Custom artifacts are dependency JARs and user-defined functions (UDF).
(dict) --
Specifies a dependency JAR or a JAR of user-defined functions.
ArtifactType (string) --
UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.
S3ContentLocationDescription (dict) --
For a Managed Service for Apache Flink application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.
BucketARN (string) --
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKey (string) --
The file key for the object containing the application code.
ObjectVersion (string) --
The version of the object containing the application code.
MavenReferenceDescription (dict) --
The parameters that are required to specify a Maven dependency.
GroupId (string) --
The group ID of the Maven reference.
ArtifactId (string) --
The artifact ID of the Maven reference.
Version (string) --
The version of the Maven reference.
ApplicationEncryptionConfigurationDescription (dict) --
Describes the encryption at rest configuration.
KeyId (string) --
The key ARN, key ID, alias ARN, or alias name of the KMS key used for encryption at rest.
KeyType (string) --
Specifies the type of key used for encryption at rest.
CloudWatchLoggingOptionDescriptions (list) --
Describes the application Amazon CloudWatch logging options.
(dict) --
Describes the Amazon CloudWatch logging option.
CloudWatchLoggingOptionId (string) --
The ID of the CloudWatch logging option description.
LogStreamARN (string) --
The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
RoleARN (string) --
The IAM ARN of the role to use to send application messages.
ApplicationMaintenanceConfigurationDescription (dict) --
The details of the maintenance configuration for the application.
ApplicationMaintenanceWindowStartTime (string) --
The start time for the maintenance window.
ApplicationMaintenanceWindowEndTime (string) --
The end time for the maintenance window.
ApplicationVersionUpdatedFrom (integer) --
The previous application version before the latest application update. RollbackApplication reverts the application to this version.
ApplicationVersionRolledBackFrom (integer) --
If you reverted the application using RollbackApplication, the application version when RollbackApplication was called.
ApplicationVersionCreateTimestamp (datetime) --
The timestamp that indicates when the application version was created.
ConditionalToken (string) --
A value you use to implement strong concurrency for application updates.
ApplicationVersionRolledBackTo (integer) --
The version to which you want to roll back the application.
ApplicationMode (string) --
To create a Managed Service for Apache Flink Studio notebook, you must set the mode to INTERACTIVE. However, for a Managed Service for Apache Flink application, the mode is optional.
{'ApplicationVersionDetail': {'ApplicationConfigurationDescription': {'ApplicationSnapshotConfigurationDescription': {'SnapshotMode': 'APPLICATION_SNAPSHOTS_LEGACY '
'| '
'ENHANCED_SNAPSHOTS'},
'RunConfigurationDescription': {'ApplicationRestoreConfigurationDescription': {'SnapshotArn': 'string'}}}}}
Provides a detailed description of a specified version of the application. To see a list of all the versions of an application, invoke the ListApplicationVersions operation.
See also: AWS API Documentation
Request Syntax
client.describe_application_version(
ApplicationName='string',
ApplicationVersionId=123
)
string
[REQUIRED]
The name of the application for which you want to get the version description.
integer
[REQUIRED]
The ID of the application version for which you want to get the description.
dict
Response Syntax
{
'ApplicationVersionDetail': {
'ApplicationARN': 'string',
'ApplicationDescription': 'string',
'ApplicationName': 'string',
'RuntimeEnvironment': 'SQL-1_0'|'FLINK-1_6'|'FLINK-1_8'|'ZEPPELIN-FLINK-1_0'|'FLINK-1_11'|'FLINK-1_13'|'ZEPPELIN-FLINK-2_0'|'FLINK-1_15'|'ZEPPELIN-FLINK-3_0'|'FLINK-1_18'|'FLINK-1_19'|'FLINK-1_20'|'FLINK-2_2'|'FLINK-2_3',
'ServiceExecutionRole': 'string',
'ApplicationStatus': 'DELETING'|'STARTING'|'STOPPING'|'READY'|'RUNNING'|'UPDATING'|'AUTOSCALING'|'FORCE_STOPPING'|'ROLLING_BACK'|'MAINTENANCE'|'ROLLED_BACK',
'ApplicationVersionId': 123,
'CreateTimestamp': datetime(2015, 1, 1),
'LastUpdateTimestamp': datetime(2015, 1, 1),
'ApplicationConfigurationDescription': {
'SqlApplicationConfigurationDescription': {
'InputDescriptions': [
{
'InputId': 'string',
'NamePrefix': 'string',
'InAppStreamNames': [
'string',
],
'InputProcessingConfigurationDescription': {
'InputLambdaProcessorDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
}
},
'KinesisStreamsInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'InputSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
},
'InputParallelism': {
'Count': 123
},
'InputStartingPositionConfiguration': {
'InputStartingPosition': 'NOW'|'TRIM_HORIZON'|'LAST_STOPPED_POINT'
}
},
],
'OutputDescriptions': [
{
'OutputId': 'string',
'Name': 'string',
'KinesisStreamsOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'LambdaOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'DestinationSchema': {
'RecordFormatType': 'JSON'|'CSV'
}
},
],
'ReferenceDataSourceDescriptions': [
{
'ReferenceId': 'string',
'TableName': 'string',
'S3ReferenceDataSourceDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ReferenceRoleARN': 'string'
},
'ReferenceSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
}
},
]
},
'ApplicationCodeConfigurationDescription': {
'CodeContentType': 'PLAINTEXT'|'ZIPFILE',
'CodeContentDescription': {
'TextContent': 'string',
'CodeMD5': 'string',
'CodeSize': 123,
'S3ApplicationCodeLocationDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ObjectVersion': 'string'
}
}
},
'RunConfigurationDescription': {
'ApplicationRestoreConfigurationDescription': {
'ApplicationRestoreType': 'SKIP_RESTORE_FROM_SNAPSHOT'|'RESTORE_FROM_LATEST_SNAPSHOT'|'RESTORE_FROM_CUSTOM_SNAPSHOT',
'SnapshotName': 'string',
'SnapshotArn': 'string'
},
'FlinkRunConfigurationDescription': {
'AllowNonRestoredState': True|False
}
},
'FlinkApplicationConfigurationDescription': {
'CheckpointConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'CheckpointingEnabled': True|False,
'CheckpointInterval': 123,
'MinPauseBetweenCheckpoints': 123
},
'MonitoringConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'MetricsLevel': 'APPLICATION'|'TASK'|'OPERATOR'|'PARALLELISM',
'LogLevel': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'ParallelismConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'Parallelism': 123,
'ParallelismPerKPU': 123,
'CurrentParallelism': 123,
'AutoScalingEnabled': True|False
},
'JobPlanDescription': 'string'
},
'EnvironmentPropertyDescriptions': {
'PropertyGroupDescriptions': [
{
'PropertyGroupId': 'string',
'PropertyMap': {
'string': 'string'
}
},
]
},
'ApplicationSnapshotConfigurationDescription': {
'SnapshotsEnabled': True|False,
'SnapshotMode': 'APPLICATION_SNAPSHOTS_LEGACY'|'ENHANCED_SNAPSHOTS'
},
'ApplicationSystemRollbackConfigurationDescription': {
'RollbackEnabled': True|False
},
'VpcConfigurationDescriptions': [
{
'VpcConfigurationId': 'string',
'VpcId': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
],
'ZeppelinApplicationConfigurationDescription': {
'MonitoringConfigurationDescription': {
'LogLevel': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'CatalogConfigurationDescription': {
'GlueDataCatalogConfigurationDescription': {
'DatabaseARN': 'string'
}
},
'DeployAsApplicationConfigurationDescription': {
'S3ContentLocationDescription': {
'BucketARN': 'string',
'BasePath': 'string'
}
},
'CustomArtifactsConfigurationDescription': [
{
'ArtifactType': 'UDF'|'DEPENDENCY_JAR',
'S3ContentLocationDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ObjectVersion': 'string'
},
'MavenReferenceDescription': {
'GroupId': 'string',
'ArtifactId': 'string',
'Version': 'string'
}
},
]
},
'ApplicationEncryptionConfigurationDescription': {
'KeyId': 'string',
'KeyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
}
},
'CloudWatchLoggingOptionDescriptions': [
{
'CloudWatchLoggingOptionId': 'string',
'LogStreamARN': 'string',
'RoleARN': 'string'
},
],
'ApplicationMaintenanceConfigurationDescription': {
'ApplicationMaintenanceWindowStartTime': 'string',
'ApplicationMaintenanceWindowEndTime': 'string'
},
'ApplicationVersionUpdatedFrom': 123,
'ApplicationVersionRolledBackFrom': 123,
'ApplicationVersionCreateTimestamp': datetime(2015, 1, 1),
'ConditionalToken': 'string',
'ApplicationVersionRolledBackTo': 123,
'ApplicationMode': 'STREAMING'|'INTERACTIVE'
}
}
Response Structure
(dict) --
ApplicationVersionDetail (dict) --
Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.
ApplicationARN (string) --
The ARN of the application.
ApplicationDescription (string) --
The description of the application.
ApplicationName (string) --
The name of the application.
RuntimeEnvironment (string) --
The runtime environment for the application.
ServiceExecutionRole (string) --
Specifies the IAM role that the application uses to access external resources.
ApplicationStatus (string) --
The status of the application.
ApplicationVersionId (integer) --
Provides the current application version. Managed Service for Apache Flink updates the ApplicationVersionId each time you update the application.
CreateTimestamp (datetime) --
The current timestamp when the application was created.
LastUpdateTimestamp (datetime) --
The current timestamp when the application was last updated.
ApplicationConfigurationDescription (dict) --
Describes details about the application code and starting parameters for a Managed Service for Apache Flink application.
SqlApplicationConfigurationDescription (dict) --
The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
InputDescriptions (list) --
The array of InputDescription objects describing the input streams used by the application.
(dict) --
Describes the application input configuration for a SQL-based Kinesis Data Analytics application.
InputId (string) --
The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.
NamePrefix (string) --
The in-application name prefix.
InAppStreamNames (list) --
Returns the in-application stream names that are mapped to the stream source.
(string) --
InputProcessingConfigurationDescription (dict) --
The description of the preprocessor that executes on records in this input before the application's code is run.
InputLambdaProcessorDescription (dict) --
Provides configuration information about the associated InputLambdaProcessorDescription
ResourceARN (string) --
The ARN of the Amazon Lambda function that is used to preprocess the records in the stream.
RoleARN (string) --
The ARN of the IAM role that is used to access the Amazon Lambda function.
KinesisStreamsInputDescription (dict) --
If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).
ResourceARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
KinesisFirehoseInputDescription (dict) --
If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the delivery stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.
InputSchema (dict) --
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.
RecordFormat (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When you configure 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.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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.
Name (string) --
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) --
The type of column created in the in-application input stream or reference table.
InputParallelism (dict) --
Describes the configured parallelism (number of in-application streams mapped to the streaming source).
Count (integer) --
The number of in-application streams to create.
InputStartingPositionConfiguration (dict) --
The point at which the application is configured to read from the input stream.
InputStartingPosition (string) --
The starting position on the stream.
NOW - Start reading just after the most recent record in the stream, and start at the request timestamp 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 Data Firehose delivery stream.
LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.
OutputDescriptions (list) --
The array of OutputDescription objects describing the destination streams used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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 a Kinesis data stream or a Kinesis Data Firehose delivery stream.
OutputId (string) --
A unique identifier for the output configuration.
Name (string) --
The name of the in-application stream that is configured as output.
KinesisStreamsOutputDescription (dict) --
Describes the Kinesis data stream that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
KinesisFirehoseOutputDescription (dict) --
Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the delivery stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
LambdaOutputDescription (dict) --
Describes the Lambda function that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the destination Lambda function.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.
DestinationSchema (dict) --
The data format used for writing data to the destination.
RecordFormatType (string) --
Specifies the format of the records on the output stream.
ReferenceDataSourceDescriptions (list) --
The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.
ReferenceId (string) --
The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.
TableName (string) --
The in-application table name created by the specific reference data source configuration.
S3ReferenceDataSourceDescription (dict) --
Provides the Amazon S3 bucket name, the object key name that contains the reference data.
BucketARN (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
FileKey (string) --
Amazon S3 object key name.
ReferenceRoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.
ReferenceSchema (dict) --
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.
RecordFormat (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When you configure 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.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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.
Name (string) --
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) --
The type of column created in the in-application input stream or reference table.
ApplicationCodeConfigurationDescription (dict) --
The details about the application code for a Managed Service for Apache Flink application.
CodeContentType (string) --
Specifies whether the code content is in text or zip format.
CodeContentDescription (dict) --
Describes details about the location and format of the application code.
TextContent (string) --
The text-format code
CodeMD5 (string) --
The checksum that can be used to validate zip-format code.
CodeSize (integer) --
The size in bytes of the application code. Can be used to validate zip-format code.
S3ApplicationCodeLocationDescription (dict) --
The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.
BucketARN (string) --
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKey (string) --
The file key for the object containing the application code.
ObjectVersion (string) --
The version of the object containing the application code.
RunConfigurationDescription (dict) --
The details about the starting properties for a Managed Service for Apache Flink application.
ApplicationRestoreConfigurationDescription (dict) --
Describes the restore behavior of a restarting application.
ApplicationRestoreType (string) --
Specifies how the application should be restored.
SnapshotName (string) --
The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.
SnapshotArn (string) --
The identifier of an existing enhanced snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType and SnapshotMode is ENHANCED_SNAPSHOTS.
FlinkRunConfigurationDescription (dict) --
Describes the starting parameters for a Managed Service for Apache Flink application.
AllowNonRestoredState (boolean) --
When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.
FlinkApplicationConfigurationDescription (dict) --
The details about a Managed Service for Apache Flink application.
CheckpointConfigurationDescription (dict) --
Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
ConfigurationType (string) --
Describes whether the application uses the default checkpointing behavior in Managed Service for Apache Flink.
CheckpointingEnabled (boolean) --
Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
CheckpointInterval (integer) --
Describes the interval in milliseconds between checkpoint operations.
MinPauseBetweenCheckpoints (integer) --
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
MonitoringConfigurationDescription (dict) --
Describes configuration parameters for Amazon CloudWatch logging for an application.
ConfigurationType (string) --
Describes whether to use the default CloudWatch logging configuration for an application.
MetricsLevel (string) --
Describes the granularity of the CloudWatch Logs for an application.
LogLevel (string) --
Describes the verbosity of the CloudWatch Logs for an application.
ParallelismConfigurationDescription (dict) --
Describes parameters for how an application executes multiple tasks simultaneously.
ConfigurationType (string) --
Describes whether the application uses the default parallelism for the Managed Service for Apache Flink service.
Parallelism (integer) --
Describes the initial number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled is set to True, then Managed Service for Apache Flink can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 64 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
ParallelismPerKPU (integer) --
Describes the number of parallel tasks that a Managed Service for Apache Flink application can perform per Kinesis Processing Unit (KPU) used by the application.
CurrentParallelism (integer) --
Describes the current number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled is set to True, Managed Service for Apache Flink can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
AutoScalingEnabled (boolean) --
Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.
JobPlanDescription (string) --
The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
EnvironmentPropertyDescriptions (dict) --
Describes execution properties for a Managed Service for Apache Flink application.
PropertyGroupDescriptions (list) --
Describes the execution property groups.
(dict) --
Property key-value pairs passed into an application.
PropertyGroupId (string) --
Describes the key of an application execution property key-value pair.
PropertyMap (dict) --
Describes the value of an application execution property key-value pair.
(string) --
(string) --
ApplicationSnapshotConfigurationDescription (dict) --
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
SnapshotsEnabled (boolean) --
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
SnapshotMode (string) --
Describes the snapshot mode of a Managed Service for Apache Flink application.
ApplicationSystemRollbackConfigurationDescription (dict) --
Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.
RollbackEnabled (boolean) --
Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.
VpcConfigurationDescriptions (list) --
The array of descriptions of VPC configurations available to the application.
(dict) --
Describes the parameters of a VPC used by the application.
VpcConfigurationId (string) --
The ID of the VPC configuration.
VpcId (string) --
The ID of the associated VPC.
SubnetIds (list) --
The array of Subnet IDs used by the VPC configuration.
(string) --
SecurityGroupIds (list) --
The array of SecurityGroup IDs used by the VPC configuration.
(string) --
ZeppelinApplicationConfigurationDescription (dict) --
The configuration parameters for a Managed Service for Apache Flink Studio notebook.
MonitoringConfigurationDescription (dict) --
The monitoring configuration of a Managed Service for Apache Flink Studio notebook.
LogLevel (string) --
Describes the verbosity of the CloudWatch Logs for an application.
CatalogConfigurationDescription (dict) --
The Amazon Glue Data Catalog that is associated with the Managed Service for Apache Flink Studio notebook.
GlueDataCatalogConfigurationDescription (dict) --
The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
DatabaseARN (string) --
The Amazon Resource Name (ARN) of the database.
DeployAsApplicationConfigurationDescription (dict) --
The parameters required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.
S3ContentLocationDescription (dict) --
The location that holds the data required to specify an Amazon Data Analytics application.
BucketARN (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
BasePath (string) --
The base path for the S3 bucket.
CustomArtifactsConfigurationDescription (list) --
Custom artifacts are dependency JARs and user-defined functions (UDF).
(dict) --
Specifies a dependency JAR or a JAR of user-defined functions.
ArtifactType (string) --
UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.
S3ContentLocationDescription (dict) --
For a Managed Service for Apache Flink application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.
BucketARN (string) --
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKey (string) --
The file key for the object containing the application code.
ObjectVersion (string) --
The version of the object containing the application code.
MavenReferenceDescription (dict) --
The parameters that are required to specify a Maven dependency.
GroupId (string) --
The group ID of the Maven reference.
ArtifactId (string) --
The artifact ID of the Maven reference.
Version (string) --
The version of the Maven reference.
ApplicationEncryptionConfigurationDescription (dict) --
Describes the encryption at rest configuration.
KeyId (string) --
The key ARN, key ID, alias ARN, or alias name of the KMS key used for encryption at rest.
KeyType (string) --
Specifies the type of key used for encryption at rest.
CloudWatchLoggingOptionDescriptions (list) --
Describes the application Amazon CloudWatch logging options.
(dict) --
Describes the Amazon CloudWatch logging option.
CloudWatchLoggingOptionId (string) --
The ID of the CloudWatch logging option description.
LogStreamARN (string) --
The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
RoleARN (string) --
The IAM ARN of the role to use to send application messages.
ApplicationMaintenanceConfigurationDescription (dict) --
The details of the maintenance configuration for the application.
ApplicationMaintenanceWindowStartTime (string) --
The start time for the maintenance window.
ApplicationMaintenanceWindowEndTime (string) --
The end time for the maintenance window.
ApplicationVersionUpdatedFrom (integer) --
The previous application version before the latest application update. RollbackApplication reverts the application to this version.
ApplicationVersionRolledBackFrom (integer) --
If you reverted the application using RollbackApplication, the application version when RollbackApplication was called.
ApplicationVersionCreateTimestamp (datetime) --
The timestamp that indicates when the application version was created.
ConditionalToken (string) --
A value you use to implement strong concurrency for application updates.
ApplicationVersionRolledBackTo (integer) --
The version to which you want to roll back the application.
ApplicationMode (string) --
To create a Managed Service for Apache Flink Studio notebook, you must set the mode to INTERACTIVE. However, for a Managed Service for Apache Flink application, the mode is optional.
{'ApplicationDetail': {'ApplicationConfigurationDescription': {'ApplicationSnapshotConfigurationDescription': {'SnapshotMode': 'APPLICATION_SNAPSHOTS_LEGACY '
'| '
'ENHANCED_SNAPSHOTS'},
'RunConfigurationDescription': {'ApplicationRestoreConfigurationDescription': {'SnapshotArn': 'string'}}}}}
Reverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status or in the running status.
You can roll back an application only if it is in the UPDATING, AUTOSCALING, or RUNNING statuses.
When you rollback an application, it loads state data from the last successful snapshot. If the application has no snapshots, Managed Service for Apache Flink rejects the rollback request.
See also: AWS API Documentation
Request Syntax
client.rollback_application(
ApplicationName='string',
CurrentApplicationVersionId=123
)
string
[REQUIRED]
The name of the application.
integer
[REQUIRED]
The current application version ID. You can retrieve the application version ID using DescribeApplication.
dict
Response Syntax
{
'ApplicationDetail': {
'ApplicationARN': 'string',
'ApplicationDescription': 'string',
'ApplicationName': 'string',
'RuntimeEnvironment': 'SQL-1_0'|'FLINK-1_6'|'FLINK-1_8'|'ZEPPELIN-FLINK-1_0'|'FLINK-1_11'|'FLINK-1_13'|'ZEPPELIN-FLINK-2_0'|'FLINK-1_15'|'ZEPPELIN-FLINK-3_0'|'FLINK-1_18'|'FLINK-1_19'|'FLINK-1_20'|'FLINK-2_2'|'FLINK-2_3',
'ServiceExecutionRole': 'string',
'ApplicationStatus': 'DELETING'|'STARTING'|'STOPPING'|'READY'|'RUNNING'|'UPDATING'|'AUTOSCALING'|'FORCE_STOPPING'|'ROLLING_BACK'|'MAINTENANCE'|'ROLLED_BACK',
'ApplicationVersionId': 123,
'CreateTimestamp': datetime(2015, 1, 1),
'LastUpdateTimestamp': datetime(2015, 1, 1),
'ApplicationConfigurationDescription': {
'SqlApplicationConfigurationDescription': {
'InputDescriptions': [
{
'InputId': 'string',
'NamePrefix': 'string',
'InAppStreamNames': [
'string',
],
'InputProcessingConfigurationDescription': {
'InputLambdaProcessorDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
}
},
'KinesisStreamsInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'InputSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
},
'InputParallelism': {
'Count': 123
},
'InputStartingPositionConfiguration': {
'InputStartingPosition': 'NOW'|'TRIM_HORIZON'|'LAST_STOPPED_POINT'
}
},
],
'OutputDescriptions': [
{
'OutputId': 'string',
'Name': 'string',
'KinesisStreamsOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'LambdaOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'DestinationSchema': {
'RecordFormatType': 'JSON'|'CSV'
}
},
],
'ReferenceDataSourceDescriptions': [
{
'ReferenceId': 'string',
'TableName': 'string',
'S3ReferenceDataSourceDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ReferenceRoleARN': 'string'
},
'ReferenceSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
}
},
]
},
'ApplicationCodeConfigurationDescription': {
'CodeContentType': 'PLAINTEXT'|'ZIPFILE',
'CodeContentDescription': {
'TextContent': 'string',
'CodeMD5': 'string',
'CodeSize': 123,
'S3ApplicationCodeLocationDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ObjectVersion': 'string'
}
}
},
'RunConfigurationDescription': {
'ApplicationRestoreConfigurationDescription': {
'ApplicationRestoreType': 'SKIP_RESTORE_FROM_SNAPSHOT'|'RESTORE_FROM_LATEST_SNAPSHOT'|'RESTORE_FROM_CUSTOM_SNAPSHOT',
'SnapshotName': 'string',
'SnapshotArn': 'string'
},
'FlinkRunConfigurationDescription': {
'AllowNonRestoredState': True|False
}
},
'FlinkApplicationConfigurationDescription': {
'CheckpointConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'CheckpointingEnabled': True|False,
'CheckpointInterval': 123,
'MinPauseBetweenCheckpoints': 123
},
'MonitoringConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'MetricsLevel': 'APPLICATION'|'TASK'|'OPERATOR'|'PARALLELISM',
'LogLevel': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'ParallelismConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'Parallelism': 123,
'ParallelismPerKPU': 123,
'CurrentParallelism': 123,
'AutoScalingEnabled': True|False
},
'JobPlanDescription': 'string'
},
'EnvironmentPropertyDescriptions': {
'PropertyGroupDescriptions': [
{
'PropertyGroupId': 'string',
'PropertyMap': {
'string': 'string'
}
},
]
},
'ApplicationSnapshotConfigurationDescription': {
'SnapshotsEnabled': True|False,
'SnapshotMode': 'APPLICATION_SNAPSHOTS_LEGACY'|'ENHANCED_SNAPSHOTS'
},
'ApplicationSystemRollbackConfigurationDescription': {
'RollbackEnabled': True|False
},
'VpcConfigurationDescriptions': [
{
'VpcConfigurationId': 'string',
'VpcId': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
],
'ZeppelinApplicationConfigurationDescription': {
'MonitoringConfigurationDescription': {
'LogLevel': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'CatalogConfigurationDescription': {
'GlueDataCatalogConfigurationDescription': {
'DatabaseARN': 'string'
}
},
'DeployAsApplicationConfigurationDescription': {
'S3ContentLocationDescription': {
'BucketARN': 'string',
'BasePath': 'string'
}
},
'CustomArtifactsConfigurationDescription': [
{
'ArtifactType': 'UDF'|'DEPENDENCY_JAR',
'S3ContentLocationDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ObjectVersion': 'string'
},
'MavenReferenceDescription': {
'GroupId': 'string',
'ArtifactId': 'string',
'Version': 'string'
}
},
]
},
'ApplicationEncryptionConfigurationDescription': {
'KeyId': 'string',
'KeyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
}
},
'CloudWatchLoggingOptionDescriptions': [
{
'CloudWatchLoggingOptionId': 'string',
'LogStreamARN': 'string',
'RoleARN': 'string'
},
],
'ApplicationMaintenanceConfigurationDescription': {
'ApplicationMaintenanceWindowStartTime': 'string',
'ApplicationMaintenanceWindowEndTime': 'string'
},
'ApplicationVersionUpdatedFrom': 123,
'ApplicationVersionRolledBackFrom': 123,
'ApplicationVersionCreateTimestamp': datetime(2015, 1, 1),
'ConditionalToken': 'string',
'ApplicationVersionRolledBackTo': 123,
'ApplicationMode': 'STREAMING'|'INTERACTIVE'
},
'OperationId': 'string'
}
Response Structure
(dict) --
ApplicationDetail (dict) --
Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.
ApplicationARN (string) --
The ARN of the application.
ApplicationDescription (string) --
The description of the application.
ApplicationName (string) --
The name of the application.
RuntimeEnvironment (string) --
The runtime environment for the application.
ServiceExecutionRole (string) --
Specifies the IAM role that the application uses to access external resources.
ApplicationStatus (string) --
The status of the application.
ApplicationVersionId (integer) --
Provides the current application version. Managed Service for Apache Flink updates the ApplicationVersionId each time you update the application.
CreateTimestamp (datetime) --
The current timestamp when the application was created.
LastUpdateTimestamp (datetime) --
The current timestamp when the application was last updated.
ApplicationConfigurationDescription (dict) --
Describes details about the application code and starting parameters for a Managed Service for Apache Flink application.
SqlApplicationConfigurationDescription (dict) --
The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
InputDescriptions (list) --
The array of InputDescription objects describing the input streams used by the application.
(dict) --
Describes the application input configuration for a SQL-based Kinesis Data Analytics application.
InputId (string) --
The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.
NamePrefix (string) --
The in-application name prefix.
InAppStreamNames (list) --
Returns the in-application stream names that are mapped to the stream source.
(string) --
InputProcessingConfigurationDescription (dict) --
The description of the preprocessor that executes on records in this input before the application's code is run.
InputLambdaProcessorDescription (dict) --
Provides configuration information about the associated InputLambdaProcessorDescription
ResourceARN (string) --
The ARN of the Amazon Lambda function that is used to preprocess the records in the stream.
RoleARN (string) --
The ARN of the IAM role that is used to access the Amazon Lambda function.
KinesisStreamsInputDescription (dict) --
If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).
ResourceARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
KinesisFirehoseInputDescription (dict) --
If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the delivery stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.
InputSchema (dict) --
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.
RecordFormat (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When you configure 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.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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.
Name (string) --
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) --
The type of column created in the in-application input stream or reference table.
InputParallelism (dict) --
Describes the configured parallelism (number of in-application streams mapped to the streaming source).
Count (integer) --
The number of in-application streams to create.
InputStartingPositionConfiguration (dict) --
The point at which the application is configured to read from the input stream.
InputStartingPosition (string) --
The starting position on the stream.
NOW - Start reading just after the most recent record in the stream, and start at the request timestamp 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 Data Firehose delivery stream.
LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.
OutputDescriptions (list) --
The array of OutputDescription objects describing the destination streams used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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 a Kinesis data stream or a Kinesis Data Firehose delivery stream.
OutputId (string) --
A unique identifier for the output configuration.
Name (string) --
The name of the in-application stream that is configured as output.
KinesisStreamsOutputDescription (dict) --
Describes the Kinesis data stream that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
KinesisFirehoseOutputDescription (dict) --
Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the delivery stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
LambdaOutputDescription (dict) --
Describes the Lambda function that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the destination Lambda function.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.
DestinationSchema (dict) --
The data format used for writing data to the destination.
RecordFormatType (string) --
Specifies the format of the records on the output stream.
ReferenceDataSourceDescriptions (list) --
The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.
ReferenceId (string) --
The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.
TableName (string) --
The in-application table name created by the specific reference data source configuration.
S3ReferenceDataSourceDescription (dict) --
Provides the Amazon S3 bucket name, the object key name that contains the reference data.
BucketARN (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
FileKey (string) --
Amazon S3 object key name.
ReferenceRoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.
ReferenceSchema (dict) --
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.
RecordFormat (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When you configure 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.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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.
Name (string) --
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) --
The type of column created in the in-application input stream or reference table.
ApplicationCodeConfigurationDescription (dict) --
The details about the application code for a Managed Service for Apache Flink application.
CodeContentType (string) --
Specifies whether the code content is in text or zip format.
CodeContentDescription (dict) --
Describes details about the location and format of the application code.
TextContent (string) --
The text-format code
CodeMD5 (string) --
The checksum that can be used to validate zip-format code.
CodeSize (integer) --
The size in bytes of the application code. Can be used to validate zip-format code.
S3ApplicationCodeLocationDescription (dict) --
The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.
BucketARN (string) --
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKey (string) --
The file key for the object containing the application code.
ObjectVersion (string) --
The version of the object containing the application code.
RunConfigurationDescription (dict) --
The details about the starting properties for a Managed Service for Apache Flink application.
ApplicationRestoreConfigurationDescription (dict) --
Describes the restore behavior of a restarting application.
ApplicationRestoreType (string) --
Specifies how the application should be restored.
SnapshotName (string) --
The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.
SnapshotArn (string) --
The identifier of an existing enhanced snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType and SnapshotMode is ENHANCED_SNAPSHOTS.
FlinkRunConfigurationDescription (dict) --
Describes the starting parameters for a Managed Service for Apache Flink application.
AllowNonRestoredState (boolean) --
When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.
FlinkApplicationConfigurationDescription (dict) --
The details about a Managed Service for Apache Flink application.
CheckpointConfigurationDescription (dict) --
Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
ConfigurationType (string) --
Describes whether the application uses the default checkpointing behavior in Managed Service for Apache Flink.
CheckpointingEnabled (boolean) --
Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
CheckpointInterval (integer) --
Describes the interval in milliseconds between checkpoint operations.
MinPauseBetweenCheckpoints (integer) --
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
MonitoringConfigurationDescription (dict) --
Describes configuration parameters for Amazon CloudWatch logging for an application.
ConfigurationType (string) --
Describes whether to use the default CloudWatch logging configuration for an application.
MetricsLevel (string) --
Describes the granularity of the CloudWatch Logs for an application.
LogLevel (string) --
Describes the verbosity of the CloudWatch Logs for an application.
ParallelismConfigurationDescription (dict) --
Describes parameters for how an application executes multiple tasks simultaneously.
ConfigurationType (string) --
Describes whether the application uses the default parallelism for the Managed Service for Apache Flink service.
Parallelism (integer) --
Describes the initial number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled is set to True, then Managed Service for Apache Flink can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 64 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
ParallelismPerKPU (integer) --
Describes the number of parallel tasks that a Managed Service for Apache Flink application can perform per Kinesis Processing Unit (KPU) used by the application.
CurrentParallelism (integer) --
Describes the current number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled is set to True, Managed Service for Apache Flink can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
AutoScalingEnabled (boolean) --
Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.
JobPlanDescription (string) --
The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
EnvironmentPropertyDescriptions (dict) --
Describes execution properties for a Managed Service for Apache Flink application.
PropertyGroupDescriptions (list) --
Describes the execution property groups.
(dict) --
Property key-value pairs passed into an application.
PropertyGroupId (string) --
Describes the key of an application execution property key-value pair.
PropertyMap (dict) --
Describes the value of an application execution property key-value pair.
(string) --
(string) --
ApplicationSnapshotConfigurationDescription (dict) --
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
SnapshotsEnabled (boolean) --
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
SnapshotMode (string) --
Describes the snapshot mode of a Managed Service for Apache Flink application.
ApplicationSystemRollbackConfigurationDescription (dict) --
Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.
RollbackEnabled (boolean) --
Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.
VpcConfigurationDescriptions (list) --
The array of descriptions of VPC configurations available to the application.
(dict) --
Describes the parameters of a VPC used by the application.
VpcConfigurationId (string) --
The ID of the VPC configuration.
VpcId (string) --
The ID of the associated VPC.
SubnetIds (list) --
The array of Subnet IDs used by the VPC configuration.
(string) --
SecurityGroupIds (list) --
The array of SecurityGroup IDs used by the VPC configuration.
(string) --
ZeppelinApplicationConfigurationDescription (dict) --
The configuration parameters for a Managed Service for Apache Flink Studio notebook.
MonitoringConfigurationDescription (dict) --
The monitoring configuration of a Managed Service for Apache Flink Studio notebook.
LogLevel (string) --
Describes the verbosity of the CloudWatch Logs for an application.
CatalogConfigurationDescription (dict) --
The Amazon Glue Data Catalog that is associated with the Managed Service for Apache Flink Studio notebook.
GlueDataCatalogConfigurationDescription (dict) --
The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
DatabaseARN (string) --
The Amazon Resource Name (ARN) of the database.
DeployAsApplicationConfigurationDescription (dict) --
The parameters required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.
S3ContentLocationDescription (dict) --
The location that holds the data required to specify an Amazon Data Analytics application.
BucketARN (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
BasePath (string) --
The base path for the S3 bucket.
CustomArtifactsConfigurationDescription (list) --
Custom artifacts are dependency JARs and user-defined functions (UDF).
(dict) --
Specifies a dependency JAR or a JAR of user-defined functions.
ArtifactType (string) --
UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.
S3ContentLocationDescription (dict) --
For a Managed Service for Apache Flink application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.
BucketARN (string) --
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKey (string) --
The file key for the object containing the application code.
ObjectVersion (string) --
The version of the object containing the application code.
MavenReferenceDescription (dict) --
The parameters that are required to specify a Maven dependency.
GroupId (string) --
The group ID of the Maven reference.
ArtifactId (string) --
The artifact ID of the Maven reference.
Version (string) --
The version of the Maven reference.
ApplicationEncryptionConfigurationDescription (dict) --
Describes the encryption at rest configuration.
KeyId (string) --
The key ARN, key ID, alias ARN, or alias name of the KMS key used for encryption at rest.
KeyType (string) --
Specifies the type of key used for encryption at rest.
CloudWatchLoggingOptionDescriptions (list) --
Describes the application Amazon CloudWatch logging options.
(dict) --
Describes the Amazon CloudWatch logging option.
CloudWatchLoggingOptionId (string) --
The ID of the CloudWatch logging option description.
LogStreamARN (string) --
The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
RoleARN (string) --
The IAM ARN of the role to use to send application messages.
ApplicationMaintenanceConfigurationDescription (dict) --
The details of the maintenance configuration for the application.
ApplicationMaintenanceWindowStartTime (string) --
The start time for the maintenance window.
ApplicationMaintenanceWindowEndTime (string) --
The end time for the maintenance window.
ApplicationVersionUpdatedFrom (integer) --
The previous application version before the latest application update. RollbackApplication reverts the application to this version.
ApplicationVersionRolledBackFrom (integer) --
If you reverted the application using RollbackApplication, the application version when RollbackApplication was called.
ApplicationVersionCreateTimestamp (datetime) --
The timestamp that indicates when the application version was created.
ConditionalToken (string) --
A value you use to implement strong concurrency for application updates.
ApplicationVersionRolledBackTo (integer) --
The version to which you want to roll back the application.
ApplicationMode (string) --
To create a Managed Service for Apache Flink Studio notebook, you must set the mode to INTERACTIVE. However, for a Managed Service for Apache Flink application, the mode is optional.
OperationId (string) --
The operation ID that can be used to track the request.
{'RunConfiguration': {'ApplicationRestoreConfiguration': {'SnapshotArn': 'string'}}}
Starts the specified Managed Service for Apache Flink application. After creating an application, you must exclusively call this operation to start your application.
See also: AWS API Documentation
Request Syntax
client.start_application(
ApplicationName='string',
RunConfiguration={
'FlinkRunConfiguration': {
'AllowNonRestoredState': True|False
},
'SqlRunConfigurations': [
{
'InputId': 'string',
'InputStartingPositionConfiguration': {
'InputStartingPosition': 'NOW'|'TRIM_HORIZON'|'LAST_STOPPED_POINT'
}
},
],
'ApplicationRestoreConfiguration': {
'ApplicationRestoreType': 'SKIP_RESTORE_FROM_SNAPSHOT'|'RESTORE_FROM_LATEST_SNAPSHOT'|'RESTORE_FROM_CUSTOM_SNAPSHOT',
'SnapshotName': 'string',
'SnapshotArn': 'string'
}
}
)
string
[REQUIRED]
The name of the application.
dict
Identifies the run configuration (start parameters) of a Managed Service for Apache Flink application.
FlinkRunConfiguration (dict) --
Describes the starting parameters for a Managed Service for Apache Flink application.
AllowNonRestoredState (boolean) --
When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.
SqlRunConfigurations (list) --
Describes the starting parameters for a SQL-based Kinesis Data Analytics application application.
(dict) --
Describes the starting parameters for a SQL-based Kinesis Data Analytics application.
InputId (string) -- [REQUIRED]
The input source ID. You can get this ID by calling the DescribeApplication operation.
InputStartingPositionConfiguration (dict) -- [REQUIRED]
The point at which you want the application to start processing records from the streaming source.
InputStartingPosition (string) --
The starting position on the stream.
NOW - Start reading just after the most recent record in the stream, and start at the request timestamp 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 Data Firehose delivery stream.
LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.
ApplicationRestoreConfiguration (dict) --
Describes the restore behavior of a restarting application.
ApplicationRestoreType (string) -- [REQUIRED]
Specifies how the application should be restored.
SnapshotName (string) --
The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.
SnapshotArn (string) --
The identifier of an existing enhanced snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType and SnapshotMode is ENHANCED_SNAPSHOTS.
dict
Response Syntax
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
The operation ID that can be used to track the request.
{'ApplicationConfigurationUpdate': {'ApplicationSnapshotConfigurationUpdate': {'SnapshotModeUpdate': 'APPLICATION_SNAPSHOTS_LEGACY '
'| '
'ENHANCED_SNAPSHOTS'}},
'RunConfigurationUpdate': {'ApplicationRestoreConfiguration': {'SnapshotArn': 'string'}}}
Response {'ApplicationDetail': {'ApplicationConfigurationDescription': {'ApplicationSnapshotConfigurationDescription': {'SnapshotMode': 'APPLICATION_SNAPSHOTS_LEGACY '
'| '
'ENHANCED_SNAPSHOTS'},
'RunConfigurationDescription': {'ApplicationRestoreConfigurationDescription': {'SnapshotArn': 'string'}}}}}
Updates an existing Managed Service for Apache Flink application. Using this operation, you can update application code, input configuration, and output configuration.
Managed Service for Apache Flink updates the ApplicationVersionId each time you update your application.
See also: AWS API Documentation
Request Syntax
client.update_application(
ApplicationName='string',
CurrentApplicationVersionId=123,
ApplicationConfigurationUpdate={
'SqlApplicationConfigurationUpdate': {
'InputUpdates': [
{
'InputId': 'string',
'NamePrefixUpdate': 'string',
'InputProcessingConfigurationUpdate': {
'InputLambdaProcessorUpdate': {
'ResourceARNUpdate': 'string'
}
},
'KinesisStreamsInputUpdate': {
'ResourceARNUpdate': 'string'
},
'KinesisFirehoseInputUpdate': {
'ResourceARNUpdate': 'string'
},
'InputSchemaUpdate': {
'RecordFormatUpdate': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncodingUpdate': 'string',
'RecordColumnUpdates': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
},
'InputParallelismUpdate': {
'CountUpdate': 123
}
},
],
'OutputUpdates': [
{
'OutputId': 'string',
'NameUpdate': 'string',
'KinesisStreamsOutputUpdate': {
'ResourceARNUpdate': 'string'
},
'KinesisFirehoseOutputUpdate': {
'ResourceARNUpdate': 'string'
},
'LambdaOutputUpdate': {
'ResourceARNUpdate': 'string'
},
'DestinationSchemaUpdate': {
'RecordFormatType': 'JSON'|'CSV'
}
},
],
'ReferenceDataSourceUpdates': [
{
'ReferenceId': 'string',
'TableNameUpdate': 'string',
'S3ReferenceDataSourceUpdate': {
'BucketARNUpdate': 'string',
'FileKeyUpdate': 'string'
},
'ReferenceSchemaUpdate': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
}
},
]
},
'ApplicationCodeConfigurationUpdate': {
'CodeContentTypeUpdate': 'PLAINTEXT'|'ZIPFILE',
'CodeContentUpdate': {
'TextContentUpdate': 'string',
'ZipFileContentUpdate': b'bytes',
'S3ContentLocationUpdate': {
'BucketARNUpdate': 'string',
'FileKeyUpdate': 'string',
'ObjectVersionUpdate': 'string'
}
}
},
'FlinkApplicationConfigurationUpdate': {
'CheckpointConfigurationUpdate': {
'ConfigurationTypeUpdate': 'DEFAULT'|'CUSTOM',
'CheckpointingEnabledUpdate': True|False,
'CheckpointIntervalUpdate': 123,
'MinPauseBetweenCheckpointsUpdate': 123
},
'MonitoringConfigurationUpdate': {
'ConfigurationTypeUpdate': 'DEFAULT'|'CUSTOM',
'MetricsLevelUpdate': 'APPLICATION'|'TASK'|'OPERATOR'|'PARALLELISM',
'LogLevelUpdate': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'ParallelismConfigurationUpdate': {
'ConfigurationTypeUpdate': 'DEFAULT'|'CUSTOM',
'ParallelismUpdate': 123,
'ParallelismPerKPUUpdate': 123,
'AutoScalingEnabledUpdate': True|False
}
},
'EnvironmentPropertyUpdates': {
'PropertyGroups': [
{
'PropertyGroupId': 'string',
'PropertyMap': {
'string': 'string'
}
},
]
},
'ApplicationSnapshotConfigurationUpdate': {
'SnapshotsEnabledUpdate': True|False,
'SnapshotModeUpdate': 'APPLICATION_SNAPSHOTS_LEGACY'|'ENHANCED_SNAPSHOTS'
},
'ApplicationSystemRollbackConfigurationUpdate': {
'RollbackEnabledUpdate': True|False
},
'VpcConfigurationUpdates': [
{
'VpcConfigurationId': 'string',
'SubnetIdUpdates': [
'string',
],
'SecurityGroupIdUpdates': [
'string',
]
},
],
'ZeppelinApplicationConfigurationUpdate': {
'MonitoringConfigurationUpdate': {
'LogLevelUpdate': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'CatalogConfigurationUpdate': {
'GlueDataCatalogConfigurationUpdate': {
'DatabaseARNUpdate': 'string'
}
},
'DeployAsApplicationConfigurationUpdate': {
'S3ContentLocationUpdate': {
'BucketARNUpdate': 'string',
'BasePathUpdate': 'string'
}
},
'CustomArtifactsConfigurationUpdate': [
{
'ArtifactType': 'UDF'|'DEPENDENCY_JAR',
'S3ContentLocation': {
'BucketARN': 'string',
'FileKey': 'string',
'ObjectVersion': 'string'
},
'MavenReference': {
'GroupId': 'string',
'ArtifactId': 'string',
'Version': 'string'
}
},
]
},
'ApplicationEncryptionConfigurationUpdate': {
'KeyIdUpdate': 'string',
'KeyTypeUpdate': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
}
},
ServiceExecutionRoleUpdate='string',
RunConfigurationUpdate={
'FlinkRunConfiguration': {
'AllowNonRestoredState': True|False
},
'ApplicationRestoreConfiguration': {
'ApplicationRestoreType': 'SKIP_RESTORE_FROM_SNAPSHOT'|'RESTORE_FROM_LATEST_SNAPSHOT'|'RESTORE_FROM_CUSTOM_SNAPSHOT',
'SnapshotName': 'string',
'SnapshotArn': 'string'
}
},
CloudWatchLoggingOptionUpdates=[
{
'CloudWatchLoggingOptionId': 'string',
'LogStreamARNUpdate': 'string'
},
],
ConditionalToken='string',
RuntimeEnvironmentUpdate='SQL-1_0'|'FLINK-1_6'|'FLINK-1_8'|'ZEPPELIN-FLINK-1_0'|'FLINK-1_11'|'FLINK-1_13'|'ZEPPELIN-FLINK-2_0'|'FLINK-1_15'|'ZEPPELIN-FLINK-3_0'|'FLINK-1_18'|'FLINK-1_19'|'FLINK-1_20'|'FLINK-2_2'|'FLINK-2_3'
)
string
[REQUIRED]
The name of the application to update.
integer
The current application version ID. You must provide the CurrentApplicationVersionId or the ConditionalToken.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.
dict
Describes application configuration updates.
SqlApplicationConfigurationUpdate (dict) --
Describes updates to a SQL-based Kinesis Data Analytics application's configuration.
InputUpdates (list) --
The array of InputUpdate objects describing the new input streams used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes updates to a specific input configuration (identified by the InputId of an application).
InputId (string) -- [REQUIRED]
The input ID of the application input to be updated.
NamePrefixUpdate (string) --
The name prefix for in-application streams that Kinesis Data Analytics creates for the specific streaming source.
InputProcessingConfigurationUpdate (dict) --
Describes updates to an InputProcessingConfiguration.
InputLambdaProcessorUpdate (dict) -- [REQUIRED]
Provides update information for an InputLambdaProcessor.
ResourceARNUpdate (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the new Amazon Lambda function that is used to preprocess the records in the stream.
KinesisStreamsInputUpdate (dict) --
If a Kinesis data stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN).
ResourceARNUpdate (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the input Kinesis data stream to read.
KinesisFirehoseInputUpdate (dict) --
If a Kinesis Data Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN.
ResourceARNUpdate (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the input delivery stream to read.
InputSchemaUpdate (dict) --
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.
RecordFormatUpdate (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) -- [REQUIRED]
The type of record format.
MappingParameters (dict) --
When you configure 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.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) -- [REQUIRED]
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) -- [REQUIRED]
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) -- [REQUIRED]
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncodingUpdate (string) --
Specifies the encoding of the records in the streaming source; for example, UTF-8.
RecordColumnUpdates (list) --
A list of RecordColumn objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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.
Name (string) -- [REQUIRED]
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) -- [REQUIRED]
The type of column created in the in-application input stream or reference table.
InputParallelismUpdate (dict) --
Describes the parallelism updates (the number of in-application streams Kinesis Data Analytics creates for the specific streaming source).
CountUpdate (integer) -- [REQUIRED]
The number of in-application streams to create for the specified streaming source.
OutputUpdates (list) --
The array of OutputUpdate objects describing the new destination streams used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes updates to the output configuration identified by the OutputId.
OutputId (string) -- [REQUIRED]
Identifies the specific output configuration that you want to update.
NameUpdate (string) --
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.
KinesisStreamsOutputUpdate (dict) --
Describes a Kinesis data stream as the destination for the output.
ResourceARNUpdate (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Kinesis data stream where you want to write the output.
KinesisFirehoseOutputUpdate (dict) --
Describes a Kinesis Data Firehose delivery stream as the destination for the output.
ResourceARNUpdate (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the delivery stream to write to.
LambdaOutputUpdate (dict) --
Describes an Amazon Lambda function as the destination for the output.
ResourceARNUpdate (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the destination Amazon Lambda function.
DestinationSchemaUpdate (dict) --
Describes the data format when records are written to the destination.
RecordFormatType (string) -- [REQUIRED]
Specifies the format of the records on the output stream.
ReferenceDataSourceUpdates (list) --
The array of ReferenceDataSourceUpdate objects describing the new reference data sources used by the application.
(dict) --
When you update a reference data source configuration for a SQL-based Kinesis Data Analytics 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.
ReferenceId (string) -- [REQUIRED]
The ID of the reference data source that is being updated. You can use the DescribeApplication operation to get this value.
TableNameUpdate (string) --
The in-application table name that is created by this update.
S3ReferenceDataSourceUpdate (dict) --
Describes the S3 bucket name, object key name, and IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.
BucketARNUpdate (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
FileKeyUpdate (string) --
The object key name.
ReferenceSchemaUpdate (dict) --
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.
RecordFormat (dict) -- [REQUIRED]
Specifies the format of the records on the streaming source.
RecordFormatType (string) -- [REQUIRED]
The type of record format.
MappingParameters (dict) --
When you configure 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.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) -- [REQUIRED]
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) -- [REQUIRED]
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) -- [REQUIRED]
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) -- [REQUIRED]
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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.
Name (string) -- [REQUIRED]
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) -- [REQUIRED]
The type of column created in the in-application input stream or reference table.
ApplicationCodeConfigurationUpdate (dict) --
Describes updates to an application's code configuration.
CodeContentTypeUpdate (string) --
Describes updates to the code content type.
CodeContentUpdate (dict) --
Describes updates to the code content of an application.
TextContentUpdate (string) --
Describes an update to the text code for an application.
ZipFileContentUpdate (bytes) --
Describes an update to the zipped code for an application.
S3ContentLocationUpdate (dict) --
Describes an update to the location of code for an application.
BucketARNUpdate (string) --
The new Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKeyUpdate (string) --
The new file key for the object containing the application code.
ObjectVersionUpdate (string) --
The new version of the object containing the application code.
FlinkApplicationConfigurationUpdate (dict) --
Describes updates to a Managed Service for Apache Flink application's configuration.
CheckpointConfigurationUpdate (dict) --
Describes updates to an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
ConfigurationTypeUpdate (string) --
Describes updates to whether the application uses the default checkpointing behavior of Managed Service for Apache Flink. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.
CheckpointingEnabledUpdate (boolean) --
Describes updates to whether checkpointing is enabled for an application.
CheckpointIntervalUpdate (integer) --
Describes updates to the interval in milliseconds between checkpoint operations.
MinPauseBetweenCheckpointsUpdate (integer) --
Describes updates to the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
MonitoringConfigurationUpdate (dict) --
Describes updates to the configuration parameters for Amazon CloudWatch logging for an application.
ConfigurationTypeUpdate (string) --
Describes updates to whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.
MetricsLevelUpdate (string) --
Describes updates to the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs.
LogLevelUpdate (string) --
Describes updates to the verbosity of the CloudWatch Logs for an application.
ParallelismConfigurationUpdate (dict) --
Describes updates to the parameters for how an application executes multiple tasks simultaneously.
ConfigurationTypeUpdate (string) --
Describes updates to whether the application uses the default parallelism for the Managed Service for Apache Flink service, or if a custom parallelism is used. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.
ParallelismUpdate (integer) --
Describes updates to the initial number of parallel tasks an application can perform. If AutoScalingEnabled is set to True, then Managed Service for Apache Flink can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service will reduce CurrentParallelism down to the Parallelism setting.
ParallelismPerKPUUpdate (integer) --
Describes updates to the number of parallel tasks an application can perform per Kinesis Processing Unit (KPU) used by the application.
AutoScalingEnabledUpdate (boolean) --
Describes updates to whether the Managed Service for Apache Flink service can increase the parallelism of a Managed Service for Apache Flink application in response to increased throughput.
EnvironmentPropertyUpdates (dict) --
Describes updates to the environment properties for a Managed Service for Apache Flink application.
PropertyGroups (list) -- [REQUIRED]
Describes updates to the execution property groups.
(dict) --
Property key-value pairs passed into an application.
PropertyGroupId (string) -- [REQUIRED]
Describes the key of an application execution property key-value pair.
PropertyMap (dict) -- [REQUIRED]
Describes the value of an application execution property key-value pair.
(string) --
(string) --
ApplicationSnapshotConfigurationUpdate (dict) --
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
SnapshotsEnabledUpdate (boolean) -- [REQUIRED]
Describes updates to whether snapshots are enabled for an application.
SnapshotModeUpdate (string) --
Describes updates to the snapshot mode of a Managed Service for Apache Flink application. You can update the snapshot mode from APPLICATION_SNAPSHOTS_LEGACY to ENHANCED_SNAPSHOTS. You can't use UpdateApplication to change the snapshot mode back to APPLICATION_SNAPSHOTS_LEGACY.
To return to APPLICATION_SNAPSHOTS_LEGACY, use RollbackApplication. After you update an application that uses ENHANCED_SNAPSHOTS, you can't roll it back to APPLICATION_SNAPSHOTS_LEGACY.
To use ENHANCED_SNAPSHOTS, the application must use Apache Flink version 1.20 or later.
ApplicationSystemRollbackConfigurationUpdate (dict) --
Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.
RollbackEnabledUpdate (boolean) -- [REQUIRED]
Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.
VpcConfigurationUpdates (list) --
Updates to the array of descriptions of VPC configurations available to the application.
(dict) --
Describes updates to the VPC configuration used by the application.
VpcConfigurationId (string) -- [REQUIRED]
Describes an update to the ID of the VPC configuration.
SubnetIdUpdates (list) --
Describes updates to the array of Subnet IDs used by the VPC configuration.
(string) --
SecurityGroupIdUpdates (list) --
Describes updates to the array of SecurityGroup IDs used by the VPC configuration.
(string) --
ZeppelinApplicationConfigurationUpdate (dict) --
Updates to the configuration of a Managed Service for Apache Flink Studio notebook.
MonitoringConfigurationUpdate (dict) --
Updates to the monitoring configuration of a Managed Service for Apache Flink Studio notebook.
LogLevelUpdate (string) -- [REQUIRED]
Updates to the logging level for Apache Zeppelin within a Managed Service for Apache Flink Studio notebook.
CatalogConfigurationUpdate (dict) --
Updates to the configuration of the Amazon Glue Data Catalog that is associated with the Managed Service for Apache Flink Studio notebook.
GlueDataCatalogConfigurationUpdate (dict) -- [REQUIRED]
Updates to the configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
DatabaseARNUpdate (string) -- [REQUIRED]
The updated Amazon Resource Name (ARN) of the database.
DeployAsApplicationConfigurationUpdate (dict) --
Updates to the configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.
S3ContentLocationUpdate (dict) --
Updates to the location that holds the data required to specify an Amazon Data Analytics application.
BucketARNUpdate (string) --
The updated Amazon Resource Name (ARN) of the S3 bucket.
BasePathUpdate (string) --
The updated S3 bucket path.
CustomArtifactsConfigurationUpdate (list) --
Updates to the customer artifacts. Custom artifacts are dependency JAR files and user-defined functions (UDF).
(dict) --
Specifies dependency JARs, as well as JAR files that contain user-defined functions (UDF).
ArtifactType (string) -- [REQUIRED]
UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.
S3ContentLocation (dict) --
For a Managed Service for Apache Flink application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.
BucketARN (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKey (string) -- [REQUIRED]
The file key for the object containing the application code.
ObjectVersion (string) --
The version of the object containing the application code.
MavenReference (dict) --
The parameters required to fully specify a Maven reference.
GroupId (string) -- [REQUIRED]
The group ID of the Maven reference.
ArtifactId (string) -- [REQUIRED]
The artifact ID of the Maven reference.
Version (string) -- [REQUIRED]
The version of the Maven reference.
ApplicationEncryptionConfigurationUpdate (dict) --
Represents an update for encryption at rest configuration.
KeyIdUpdate (string) --
The key ARN, key ID, alias ARN, or alias name of the KMS key to be used for encryption at rest.
KeyTypeUpdate (string) -- [REQUIRED]
Specifies the type of key to be used for encryption at rest.
string
Describes updates to the service execution role.
dict
Describes updates to the application's starting parameters.
FlinkRunConfiguration (dict) --
Describes the starting parameters for a Managed Service for Apache Flink application.
AllowNonRestoredState (boolean) --
When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.
ApplicationRestoreConfiguration (dict) --
Describes updates to the restore behavior of a restarting application.
ApplicationRestoreType (string) -- [REQUIRED]
Specifies how the application should be restored.
SnapshotName (string) --
The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.
SnapshotArn (string) --
The identifier of an existing enhanced snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType and SnapshotMode is ENHANCED_SNAPSHOTS.
list
Describes application Amazon CloudWatch logging option updates. You can only update existing CloudWatch logging options with this action. To add a new CloudWatch logging option, use AddApplicationCloudWatchLoggingOption.
(dict) --
Describes the Amazon CloudWatch logging option updates.
CloudWatchLoggingOptionId (string) -- [REQUIRED]
The ID of the CloudWatch logging option to update
LogStreamARNUpdate (string) --
The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
string
A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get the application's current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.
string
Updates the Managed Service for Apache Flink runtime environment used to run your code. To avoid issues you must:
Ensure your new jar and dependencies are compatible with the new runtime selected.
Ensure your new code's state is compatible with the snapshot from which your application will start
dict
Response Syntax
{
'ApplicationDetail': {
'ApplicationARN': 'string',
'ApplicationDescription': 'string',
'ApplicationName': 'string',
'RuntimeEnvironment': 'SQL-1_0'|'FLINK-1_6'|'FLINK-1_8'|'ZEPPELIN-FLINK-1_0'|'FLINK-1_11'|'FLINK-1_13'|'ZEPPELIN-FLINK-2_0'|'FLINK-1_15'|'ZEPPELIN-FLINK-3_0'|'FLINK-1_18'|'FLINK-1_19'|'FLINK-1_20'|'FLINK-2_2'|'FLINK-2_3',
'ServiceExecutionRole': 'string',
'ApplicationStatus': 'DELETING'|'STARTING'|'STOPPING'|'READY'|'RUNNING'|'UPDATING'|'AUTOSCALING'|'FORCE_STOPPING'|'ROLLING_BACK'|'MAINTENANCE'|'ROLLED_BACK',
'ApplicationVersionId': 123,
'CreateTimestamp': datetime(2015, 1, 1),
'LastUpdateTimestamp': datetime(2015, 1, 1),
'ApplicationConfigurationDescription': {
'SqlApplicationConfigurationDescription': {
'InputDescriptions': [
{
'InputId': 'string',
'NamePrefix': 'string',
'InAppStreamNames': [
'string',
],
'InputProcessingConfigurationDescription': {
'InputLambdaProcessorDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
}
},
'KinesisStreamsInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'InputSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
},
'InputParallelism': {
'Count': 123
},
'InputStartingPositionConfiguration': {
'InputStartingPosition': 'NOW'|'TRIM_HORIZON'|'LAST_STOPPED_POINT'
}
},
],
'OutputDescriptions': [
{
'OutputId': 'string',
'Name': 'string',
'KinesisStreamsOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'LambdaOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'DestinationSchema': {
'RecordFormatType': 'JSON'|'CSV'
}
},
],
'ReferenceDataSourceDescriptions': [
{
'ReferenceId': 'string',
'TableName': 'string',
'S3ReferenceDataSourceDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ReferenceRoleARN': 'string'
},
'ReferenceSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
}
},
]
},
'ApplicationCodeConfigurationDescription': {
'CodeContentType': 'PLAINTEXT'|'ZIPFILE',
'CodeContentDescription': {
'TextContent': 'string',
'CodeMD5': 'string',
'CodeSize': 123,
'S3ApplicationCodeLocationDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ObjectVersion': 'string'
}
}
},
'RunConfigurationDescription': {
'ApplicationRestoreConfigurationDescription': {
'ApplicationRestoreType': 'SKIP_RESTORE_FROM_SNAPSHOT'|'RESTORE_FROM_LATEST_SNAPSHOT'|'RESTORE_FROM_CUSTOM_SNAPSHOT',
'SnapshotName': 'string',
'SnapshotArn': 'string'
},
'FlinkRunConfigurationDescription': {
'AllowNonRestoredState': True|False
}
},
'FlinkApplicationConfigurationDescription': {
'CheckpointConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'CheckpointingEnabled': True|False,
'CheckpointInterval': 123,
'MinPauseBetweenCheckpoints': 123
},
'MonitoringConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'MetricsLevel': 'APPLICATION'|'TASK'|'OPERATOR'|'PARALLELISM',
'LogLevel': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'ParallelismConfigurationDescription': {
'ConfigurationType': 'DEFAULT'|'CUSTOM',
'Parallelism': 123,
'ParallelismPerKPU': 123,
'CurrentParallelism': 123,
'AutoScalingEnabled': True|False
},
'JobPlanDescription': 'string'
},
'EnvironmentPropertyDescriptions': {
'PropertyGroupDescriptions': [
{
'PropertyGroupId': 'string',
'PropertyMap': {
'string': 'string'
}
},
]
},
'ApplicationSnapshotConfigurationDescription': {
'SnapshotsEnabled': True|False,
'SnapshotMode': 'APPLICATION_SNAPSHOTS_LEGACY'|'ENHANCED_SNAPSHOTS'
},
'ApplicationSystemRollbackConfigurationDescription': {
'RollbackEnabled': True|False
},
'VpcConfigurationDescriptions': [
{
'VpcConfigurationId': 'string',
'VpcId': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
],
'ZeppelinApplicationConfigurationDescription': {
'MonitoringConfigurationDescription': {
'LogLevel': 'INFO'|'WARN'|'ERROR'|'DEBUG'
},
'CatalogConfigurationDescription': {
'GlueDataCatalogConfigurationDescription': {
'DatabaseARN': 'string'
}
},
'DeployAsApplicationConfigurationDescription': {
'S3ContentLocationDescription': {
'BucketARN': 'string',
'BasePath': 'string'
}
},
'CustomArtifactsConfigurationDescription': [
{
'ArtifactType': 'UDF'|'DEPENDENCY_JAR',
'S3ContentLocationDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ObjectVersion': 'string'
},
'MavenReferenceDescription': {
'GroupId': 'string',
'ArtifactId': 'string',
'Version': 'string'
}
},
]
},
'ApplicationEncryptionConfigurationDescription': {
'KeyId': 'string',
'KeyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
}
},
'CloudWatchLoggingOptionDescriptions': [
{
'CloudWatchLoggingOptionId': 'string',
'LogStreamARN': 'string',
'RoleARN': 'string'
},
],
'ApplicationMaintenanceConfigurationDescription': {
'ApplicationMaintenanceWindowStartTime': 'string',
'ApplicationMaintenanceWindowEndTime': 'string'
},
'ApplicationVersionUpdatedFrom': 123,
'ApplicationVersionRolledBackFrom': 123,
'ApplicationVersionCreateTimestamp': datetime(2015, 1, 1),
'ConditionalToken': 'string',
'ApplicationVersionRolledBackTo': 123,
'ApplicationMode': 'STREAMING'|'INTERACTIVE'
},
'OperationId': 'string'
}
Response Structure
(dict) --
ApplicationDetail (dict) --
Describes application updates.
ApplicationARN (string) --
The ARN of the application.
ApplicationDescription (string) --
The description of the application.
ApplicationName (string) --
The name of the application.
RuntimeEnvironment (string) --
The runtime environment for the application.
ServiceExecutionRole (string) --
Specifies the IAM role that the application uses to access external resources.
ApplicationStatus (string) --
The status of the application.
ApplicationVersionId (integer) --
Provides the current application version. Managed Service for Apache Flink updates the ApplicationVersionId each time you update the application.
CreateTimestamp (datetime) --
The current timestamp when the application was created.
LastUpdateTimestamp (datetime) --
The current timestamp when the application was last updated.
ApplicationConfigurationDescription (dict) --
Describes details about the application code and starting parameters for a Managed Service for Apache Flink application.
SqlApplicationConfigurationDescription (dict) --
The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
InputDescriptions (list) --
The array of InputDescription objects describing the input streams used by the application.
(dict) --
Describes the application input configuration for a SQL-based Kinesis Data Analytics application.
InputId (string) --
The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.
NamePrefix (string) --
The in-application name prefix.
InAppStreamNames (list) --
Returns the in-application stream names that are mapped to the stream source.
(string) --
InputProcessingConfigurationDescription (dict) --
The description of the preprocessor that executes on records in this input before the application's code is run.
InputLambdaProcessorDescription (dict) --
Provides configuration information about the associated InputLambdaProcessorDescription
ResourceARN (string) --
The ARN of the Amazon Lambda function that is used to preprocess the records in the stream.
RoleARN (string) --
The ARN of the IAM role that is used to access the Amazon Lambda function.
KinesisStreamsInputDescription (dict) --
If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).
ResourceARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
KinesisFirehoseInputDescription (dict) --
If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the delivery stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.
InputSchema (dict) --
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.
RecordFormat (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When you configure 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.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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.
Name (string) --
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) --
The type of column created in the in-application input stream or reference table.
InputParallelism (dict) --
Describes the configured parallelism (number of in-application streams mapped to the streaming source).
Count (integer) --
The number of in-application streams to create.
InputStartingPositionConfiguration (dict) --
The point at which the application is configured to read from the input stream.
InputStartingPosition (string) --
The starting position on the stream.
NOW - Start reading just after the most recent record in the stream, and start at the request timestamp 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 Data Firehose delivery stream.
LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.
OutputDescriptions (list) --
The array of OutputDescription objects describing the destination streams used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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 a Kinesis data stream or a Kinesis Data Firehose delivery stream.
OutputId (string) --
A unique identifier for the output configuration.
Name (string) --
The name of the in-application stream that is configured as output.
KinesisStreamsOutputDescription (dict) --
Describes the Kinesis data stream that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
KinesisFirehoseOutputDescription (dict) --
Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the delivery stream.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
LambdaOutputDescription (dict) --
Describes the Lambda function that is configured as the destination where output is written.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the destination Lambda function.
RoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.
DestinationSchema (dict) --
The data format used for writing data to the destination.
RecordFormatType (string) --
Specifies the format of the records on the output stream.
ReferenceDataSourceDescriptions (list) --
The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.
(dict) --
For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.
ReferenceId (string) --
The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.
TableName (string) --
The in-application table name created by the specific reference data source configuration.
S3ReferenceDataSourceDescription (dict) --
Provides the Amazon S3 bucket name, the object key name that contains the reference data.
BucketARN (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
FileKey (string) --
Amazon S3 object key name.
ReferenceRoleARN (string) --
The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.
ReferenceSchema (dict) --
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.
RecordFormat (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When you configure 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.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
The path to the top-level parent that contains the records.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
The row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
For a SQL-based Kinesis Data Analytics application, 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.
Name (string) --
The name of the column that is created in the in-application input stream or reference table.
Mapping (string) --
A reference to the data element in the streaming input or the reference data source.
SqlType (string) --
The type of column created in the in-application input stream or reference table.
ApplicationCodeConfigurationDescription (dict) --
The details about the application code for a Managed Service for Apache Flink application.
CodeContentType (string) --
Specifies whether the code content is in text or zip format.
CodeContentDescription (dict) --
Describes details about the location and format of the application code.
TextContent (string) --
The text-format code
CodeMD5 (string) --
The checksum that can be used to validate zip-format code.
CodeSize (integer) --
The size in bytes of the application code. Can be used to validate zip-format code.
S3ApplicationCodeLocationDescription (dict) --
The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.
BucketARN (string) --
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKey (string) --
The file key for the object containing the application code.
ObjectVersion (string) --
The version of the object containing the application code.
RunConfigurationDescription (dict) --
The details about the starting properties for a Managed Service for Apache Flink application.
ApplicationRestoreConfigurationDescription (dict) --
Describes the restore behavior of a restarting application.
ApplicationRestoreType (string) --
Specifies how the application should be restored.
SnapshotName (string) --
The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.
SnapshotArn (string) --
The identifier of an existing enhanced snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType and SnapshotMode is ENHANCED_SNAPSHOTS.
FlinkRunConfigurationDescription (dict) --
Describes the starting parameters for a Managed Service for Apache Flink application.
AllowNonRestoredState (boolean) --
When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.
FlinkApplicationConfigurationDescription (dict) --
The details about a Managed Service for Apache Flink application.
CheckpointConfigurationDescription (dict) --
Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
ConfigurationType (string) --
Describes whether the application uses the default checkpointing behavior in Managed Service for Apache Flink.
CheckpointingEnabled (boolean) --
Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
CheckpointInterval (integer) --
Describes the interval in milliseconds between checkpoint operations.
MinPauseBetweenCheckpoints (integer) --
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.
MonitoringConfigurationDescription (dict) --
Describes configuration parameters for Amazon CloudWatch logging for an application.
ConfigurationType (string) --
Describes whether to use the default CloudWatch logging configuration for an application.
MetricsLevel (string) --
Describes the granularity of the CloudWatch Logs for an application.
LogLevel (string) --
Describes the verbosity of the CloudWatch Logs for an application.
ParallelismConfigurationDescription (dict) --
Describes parameters for how an application executes multiple tasks simultaneously.
ConfigurationType (string) --
Describes whether the application uses the default parallelism for the Managed Service for Apache Flink service.
Parallelism (integer) --
Describes the initial number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled is set to True, then Managed Service for Apache Flink can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 64 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
ParallelismPerKPU (integer) --
Describes the number of parallel tasks that a Managed Service for Apache Flink application can perform per Kinesis Processing Unit (KPU) used by the application.
CurrentParallelism (integer) --
Describes the current number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled is set to True, Managed Service for Apache Flink can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
AutoScalingEnabled (boolean) --
Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.
JobPlanDescription (string) --
The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
EnvironmentPropertyDescriptions (dict) --
Describes execution properties for a Managed Service for Apache Flink application.
PropertyGroupDescriptions (list) --
Describes the execution property groups.
(dict) --
Property key-value pairs passed into an application.
PropertyGroupId (string) --
Describes the key of an application execution property key-value pair.
PropertyMap (dict) --
Describes the value of an application execution property key-value pair.
(string) --
(string) --
ApplicationSnapshotConfigurationDescription (dict) --
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
SnapshotsEnabled (boolean) --
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
SnapshotMode (string) --
Describes the snapshot mode of a Managed Service for Apache Flink application.
ApplicationSystemRollbackConfigurationDescription (dict) --
Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.
RollbackEnabled (boolean) --
Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.
VpcConfigurationDescriptions (list) --
The array of descriptions of VPC configurations available to the application.
(dict) --
Describes the parameters of a VPC used by the application.
VpcConfigurationId (string) --
The ID of the VPC configuration.
VpcId (string) --
The ID of the associated VPC.
SubnetIds (list) --
The array of Subnet IDs used by the VPC configuration.
(string) --
SecurityGroupIds (list) --
The array of SecurityGroup IDs used by the VPC configuration.
(string) --
ZeppelinApplicationConfigurationDescription (dict) --
The configuration parameters for a Managed Service for Apache Flink Studio notebook.
MonitoringConfigurationDescription (dict) --
The monitoring configuration of a Managed Service for Apache Flink Studio notebook.
LogLevel (string) --
Describes the verbosity of the CloudWatch Logs for an application.
CatalogConfigurationDescription (dict) --
The Amazon Glue Data Catalog that is associated with the Managed Service for Apache Flink Studio notebook.
GlueDataCatalogConfigurationDescription (dict) --
The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.
DatabaseARN (string) --
The Amazon Resource Name (ARN) of the database.
DeployAsApplicationConfigurationDescription (dict) --
The parameters required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.
S3ContentLocationDescription (dict) --
The location that holds the data required to specify an Amazon Data Analytics application.
BucketARN (string) --
The Amazon Resource Name (ARN) of the S3 bucket.
BasePath (string) --
The base path for the S3 bucket.
CustomArtifactsConfigurationDescription (list) --
Custom artifacts are dependency JARs and user-defined functions (UDF).
(dict) --
Specifies a dependency JAR or a JAR of user-defined functions.
ArtifactType (string) --
UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.
S3ContentLocationDescription (dict) --
For a Managed Service for Apache Flink application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.
BucketARN (string) --
The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
FileKey (string) --
The file key for the object containing the application code.
ObjectVersion (string) --
The version of the object containing the application code.
MavenReferenceDescription (dict) --
The parameters that are required to specify a Maven dependency.
GroupId (string) --
The group ID of the Maven reference.
ArtifactId (string) --
The artifact ID of the Maven reference.
Version (string) --
The version of the Maven reference.
ApplicationEncryptionConfigurationDescription (dict) --
Describes the encryption at rest configuration.
KeyId (string) --
The key ARN, key ID, alias ARN, or alias name of the KMS key used for encryption at rest.
KeyType (string) --
Specifies the type of key used for encryption at rest.
CloudWatchLoggingOptionDescriptions (list) --
Describes the application Amazon CloudWatch logging options.
(dict) --
Describes the Amazon CloudWatch logging option.
CloudWatchLoggingOptionId (string) --
The ID of the CloudWatch logging option description.
LogStreamARN (string) --
The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
RoleARN (string) --
The IAM ARN of the role to use to send application messages.
ApplicationMaintenanceConfigurationDescription (dict) --
The details of the maintenance configuration for the application.
ApplicationMaintenanceWindowStartTime (string) --
The start time for the maintenance window.
ApplicationMaintenanceWindowEndTime (string) --
The end time for the maintenance window.
ApplicationVersionUpdatedFrom (integer) --
The previous application version before the latest application update. RollbackApplication reverts the application to this version.
ApplicationVersionRolledBackFrom (integer) --
If you reverted the application using RollbackApplication, the application version when RollbackApplication was called.
ApplicationVersionCreateTimestamp (datetime) --
The timestamp that indicates when the application version was created.
ConditionalToken (string) --
A value you use to implement strong concurrency for application updates.
ApplicationVersionRolledBackTo (integer) --
The version to which you want to roll back the application.
ApplicationMode (string) --
To create a Managed Service for Apache Flink Studio notebook, you must set the mode to INTERACTIVE. However, for a Managed Service for Apache Flink application, the mode is optional.
OperationId (string) --
The operation ID that can be used to track the request.