DeleteApplicationReferenceDataSource
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Deletes a reference data source configuration from the specified application configuration.
If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.
This operation requires permissions to perform the kinesisanalytics.DeleteApplicationReferenceDataSource
action.
Request Syntax
{
"ApplicationName": "string
",
"CurrentApplicationVersionId": number
,
"ReferenceId": "string
"
}
Request Parameters
The request accepts the following data in JSON format.
- ApplicationName
-
Name of an existing application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_.-]+
Required: Yes
- CurrentApplicationVersionId
-
Version of the application. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the
ConcurrentModificationException
is returned.Type: Long
Valid Range: Minimum value of 1. Maximum value of 999999999.
Required: Yes
- ReferenceId
-
ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Amazon Kinesis Analytics assigns an ID. You can use the DescribeApplication operation to get the reference ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
[a-zA-Z0-9_.-]+
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
- ConcurrentModificationException
-
Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.
HTTP Status Code: 400
- InvalidArgumentException
-
Specified input parameter value is invalid.
HTTP Status Code: 400
- ResourceInUseException
-
Application is not available for this operation.
HTTP Status Code: 400
- ResourceNotFoundException
-
Specified application can't be found.
HTTP Status Code: 400
- UnsupportedOperationException
-
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: