Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListIngressPoints

List all ingress endpoint resources.

Request Syntax


{
   "NextToken": "string",
   "PageSize": number
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

NextToken

If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

PageSize

The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

Response Syntax


{
   "IngressPoints": [ 
      { 
         "ARecord": "string",
         "IngressPointId": "string",
         "IngressPointName": "string",
         "Status": "string",
         "Type": "string"
      }
   ],
   "NextToken": "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.

IngressPoints

The list of ingress endpoints.

Type: Array of IngressPoint objects

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

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

ValidationException

The request validation has failed. For details, see the accompanying error message.

HTTP Status Code: 400