StopPipe
Stop an existing pipe.
Request Syntax
POST /v1/pipes/Name/stop HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- Name
-
The name of the pipe.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_A-Za-z0-9]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Arn": "string",
"CreationTime": number,
"CurrentState": "string",
"DesiredState": "string",
"LastModifiedTime": number,
"Name": "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.
- Arn
-
The ARN of the pipe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
arn:aws([a-z]|\-)*:([a-zA-Z0-9\-]+):([a-z]|\d|\-)*:([0-9]{12})?:(.+) - CreationTime
-
The time the pipe was created.
Type: Timestamp
- CurrentState
-
The state the pipe is in.
Type: String
Valid Values:
RUNNING | STOPPED | CREATING | UPDATING | DELETING | STARTING | STOPPING | CREATE_FAILED | UPDATE_FAILED | START_FAILED | STOP_FAILED | DELETE_FAILED | CREATE_ROLLBACK_FAILED | DELETE_ROLLBACK_FAILED | UPDATE_ROLLBACK_FAILED - DesiredState
-
The state the pipe should be in.
Type: String
Valid Values:
RUNNING | STOPPED - LastModifiedTime
-
When the pipe was last updated, in ISO-8601 format
(YYYY-MM-DDThh:mm:ss.sTZD). Type: Timestamp
- Name
-
The name of the pipe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_A-Za-z0-9]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
An action you attempted resulted in an exception.
HTTP Status Code: 409
- InternalException
-
This exception occurs due to unexpected causes.
HTTP Status Code: 500
- NotFoundException
-
An entity that you specified does not exist.
HTTP Status Code: 404
- ThrottlingException
-
An action was throttled.
HTTP Status Code: 429
- ValidationException
-
Indicates that an error has occurred while performing a validate 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:
