Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetTelemetryPipeline

Retrieves information about a specific telemetry pipeline, including its configuration, status, and metadata.

Request Syntax


POST /GetTelemetryPipeline 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 identifier (name or ARN) of the telemetry pipeline to retrieve.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Pipeline": { 
      "Arn": "string",
      "Configuration": { 
         "Body": "string"
      },
      "CreatedTimeStamp": number,
      "LastUpdateTimeStamp": number,
      "Name": "string",
      "Status": "string",
      "StatusReason": { 
         "Description": "string"
      },
      "Tags": { 
         "string" : "string" 
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Pipeline

The complete telemetry pipeline resource information, including configuration, status, and metadata.

Type: TelemetryPipeline object

Errors

For information about the errors that are common to all actions, see Common Errors.

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

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