Update an existing pipe. When you call UpdatePipe, only the fields that are included in the request are changed, the rest are unchanged. The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or TargetParameters objects. The fields in these objects are updated atomically as one and override existing values. This is by design and means that if you don't specify an "
},
{
"info": {
"name": "Amazon EventBridge Pipes DeletePipe",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://pipes.{region}.amazonaws.com/v1/pipes/:Name",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "Name",
"value": "",
"type": "path",
"description": "The name of the pipe."
}
]
},
"docs": "Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide."
},
{
"info": {
"name": "Amazon EventBridge Pipes ListPipes",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://pipes.{region}.amazonaws.com/v1/pipes",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "CurrentState",
"value": "",
"type": "query",
"description": "The state the pipe is in."
},
{
"name": "DesiredState",
"value": "",
"type": "query",
"description": "The state the pipe should be in."
},
{
"name": "Limit",
"value": "",
"type": "query",
"description": "The maximum number of pipes to include in the response."
},
{
"name": "NamePrefix",
"value": "",
"type": "query",
"description": "A value that will return a subset of the pipes associated with this account. For example, \"NamePrefix\": \"ABC\" will return all endpoints with \"ABC\" in the name."
},
{
"name": "NextToken",
"value": "",
"type": "query",
"description": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error."
},
{
"name": "SourcePrefix",
"value": "",
"type": "query",
"description": "The prefix matching the pipe source."
},
{
"name": "TargetPrefix",
"value": "",
"type": "query",
"description": "The prefix matching the pipe target."
}
]
},
"docs": "Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide."
},
{
"info": {
"name": "Amazon EventBridge Pipes ListTagsForResource",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://pipes.{region}.amazonaws.com/tags/:resourceArn",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "resourceArn",
"value": "",
"type": "path",
"description": "The ARN of the pipe for which you want to view tags."
}
]
},
"docs": "Displays the tags associated with a pipe."
},
{
"info": {
"name": "Amazon EventBridge Pipes TagResource",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://pipes.{region}.amazonaws.com/tags/:resourceArn",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "resourceArn",
"value": "",
"type": "path",
"description": "The ARN of the pipe."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
Assigns one or more tags (key-value pairs) to the specified pipe. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with a pipe that already has tags. If you specify a new ta"
},
{
"info": {
"name": "Amazon EventBridge Pipes StartPipe",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://pipes.{region}.amazonaws.com/v1/pipes/:Name/start",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "Name",
"value": "",
"type": "path",
"description": "The name of the pipe."
}
]
},
"docs": "Start an existing pipe."
},
{
"info": {
"name": "Amazon EventBridge Pipes StopPipe",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://pipes.{region}.amazonaws.com/v1/pipes/:Name/stop",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "Name",
"value": "",
"type": "path",
"description": "The name of the pipe."
}
]
},
"docs": "Stop an existing pipe."
},
{
"info": {
"name": "Amazon EventBridge Pipes UntagResource",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://pipes.{region}.amazonaws.com/tags/:resourceArn#tagKeys",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "resourceArn",
"value": "",
"type": "path",
"description": "The ARN of the pipe."
},
{
"name": "tagKeys",
"value": "",
"type": "query",
"description": "The list of tag keys to remove from the pipe."
}
]
},
"docs": "Removes one or more tags from the specified pipes."
}
],
"bundled": true
}