List Pipes
eventbridgepipes_list_pipes | R Documentation |
Get the pipes associated with this account¶
Description¶
Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
Usage¶
eventbridgepipes_list_pipes(NamePrefix, DesiredState, CurrentState,
SourcePrefix, TargetPrefix, NextToken, Limit)
Arguments¶
NamePrefix
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.DesiredState
The state the pipe should be in.
CurrentState
The state the pipe is in.
SourcePrefix
The prefix matching the pipe source.
TargetPrefix
The prefix matching the pipe target.
NextToken
If
nextToken
is returned, there are more results available. The value ofnextToken
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.Limit
The maximum number of pipes to include in the response.
Value¶
A list with the following syntax:
list(
Pipes = list(
list(
Name = "string",
Arn = "string",
DesiredState = "RUNNING"|"STOPPED",
CurrentState = "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",
StateReason = "string",
CreationTime = as.POSIXct(
"2015-01-01"
),
LastModifiedTime = as.POSIXct(
"2015-01-01"
),
Source = "string",
Target = "string",
Enrichment = "string"
)
),
NextToken = "string"
)
Request syntax¶
svc$list_pipes(
NamePrefix = "string",
DesiredState = "RUNNING"|"STOPPED",
CurrentState = "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",
SourcePrefix = "string",
TargetPrefix = "string",
NextToken = "string",
Limit = 123
)