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

RevokePipelineEndpointConnections

Revokes pipeline endpoints from specified endpoint IDs.

Request Syntax


POST /2022-01-01/osis/revokePipelineEndpointConnections HTTP/1.1
Content-type: application/json

{
   "EndpointIds": [ "string" ],
   "PipelineArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

EndpointIds

A list of endpoint IDs for which to revoke access to the pipeline.

Type: Array of strings

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

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]+$

Required: Yes

PipelineArn

The Amazon Resource Name (ARN) of the pipeline from which to revoke endpoint connections.

Type: String

Length Constraints: Minimum length of 46. Maximum length of 76.

Pattern: ^arn:(aws|aws\-cn|aws\-us\-gov|aws\-iso|aws\-iso\-b):osis:.+:pipeline\/.+$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "PipelineArn": "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.

PipelineArn

The Amazon Resource Name (ARN) of the pipeline from which endpoint connections were revoked.

Type: String

Length Constraints: Minimum length of 46. Maximum length of 76.

Pattern: ^arn:(aws|aws\-cn|aws\-us\-gov|aws\-iso|aws\-iso\-b):osis:.+:pipeline\/.+$

Errors

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

AccessDeniedException

You don't have permissions to access the resource.

HTTP Status Code: 403

DisabledOperationException

Exception is thrown when an operation has been disabled.

HTTP Status Code: 409

InternalException

The request failed because of an unknown error, exception, or failure (the failure is internal to the service).

HTTP Status Code: 500

LimitExceededException

You attempted to create more than the allowed number of tags.

HTTP Status Code: 409

ValidationException

An exception for missing or invalid input fields.

HTTP Status Code: 400