Skip to content

List Endpoints

eventbridge_list_endpoints R Documentation

List the global endpoints associated with this account

Description

List the global endpoints associated with this account. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

Usage

eventbridge_list_endpoints(NamePrefix, HomeRegion, NextToken,
  MaxResults)

Arguments

NamePrefix

A value that will return a subset of the endpoints associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

HomeRegion

The primary Region of the endpoints associated with this account. For example "HomeRegion": "us-east-1".

NextToken

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.

MaxResults

The maximum number of results returned by the call.

Value

A list with the following syntax: 

list(
  Endpoints = list(
    list(
      Name = "string",
      Description = "string",
      Arn = "string",
      RoutingConfig = list(
        FailoverConfig = list(
          Primary = list(
            HealthCheck = "string"
          ),
          Secondary = list(
            Route = "string"
          )
        )
      ),
      ReplicationConfig = list(
        State = "ENABLED"|"DISABLED"
      ),
      EventBuses = list(
        list(
          EventBusArn = "string"
        )
      ),
      RoleArn = "string",
      EndpointId = "string",
      EndpointUrl = "string",
      State = "ACTIVE"|"CREATING"|"UPDATING"|"DELETING"|"CREATE_FAILED"|"UPDATE_FAILED"|"DELETE_FAILED",
      StateReason = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_endpoints(
  NamePrefix = "string",
  HomeRegion = "string",
  NextToken = "string",
  MaxResults = 123
)