StartTelemetryPipelineRefresh
Starts a refresh of an external-cloud telemetry pipeline. The refresh re-reads the connector's telemetry manifest and re-discovers the sources in scope.
The pipeline must be in the ACTIVE or UPDATE_FAILED state, with
no refresh already running. You can use GetTelemetryPipeline to track the
refresh.
Request Syntax
POST /StartTelemetryPipelineRefresh HTTP/1.1
Content-type: application/json
{
"PipelineIdentifier": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- PipelineIdentifier
-
The Amazon Resource Name (ARN) of the telemetry pipeline to refresh.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- amznErrorType
-
The name of the exception.
HTTP Status Code: 400
- ConflictException
-
The requested operation conflicts with the current state of the specified resource or with another request.
- ResourceId
-
The identifier of the resource which is in conflict with the requested operation.
- ResourceType
-
The type of the resource which is in conflict with the requested operation.
HTTP Status Code: 409
- InternalServerException
-
Indicates the request has failed to process because of an unknown server error, exception, or failure.
- amznErrorType
-
The name of the exception.
- retryAfterSeconds
-
The number of seconds to wait before retrying the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource (such as a telemetry rule) could not be found.
- ResourceId
-
The identifier of the resource which could not be found.
- ResourceType
-
The type of the resource which could not be found.
HTTP Status Code: 404
- TooManyRequestsException
-
The request throughput limit was exceeded.
HTTP Status Code: 429
- ValidationException
-
Indicates input validation failed. Check your request parameters and retry the request.
- Errors
-
The errors in the input which caused the exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: