| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CloudWatchEvents.ListEndpoints
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..
Synopsis
- data ListEndpoints = ListEndpoints' {
- homeRegion :: Maybe Text
- maxResults :: Maybe Natural
- namePrefix :: Maybe Text
- nextToken :: Maybe Text
- newListEndpoints :: ListEndpoints
- listEndpoints_homeRegion :: Lens' ListEndpoints (Maybe Text)
- listEndpoints_maxResults :: Lens' ListEndpoints (Maybe Natural)
- listEndpoints_namePrefix :: Lens' ListEndpoints (Maybe Text)
- listEndpoints_nextToken :: Lens' ListEndpoints (Maybe Text)
- data ListEndpointsResponse = ListEndpointsResponse' {}
- newListEndpointsResponse :: Int -> ListEndpointsResponse
- listEndpointsResponse_endpoints :: Lens' ListEndpointsResponse (Maybe [Endpoint])
- listEndpointsResponse_nextToken :: Lens' ListEndpointsResponse (Maybe Text)
- listEndpointsResponse_httpStatus :: Lens' ListEndpointsResponse Int
Creating a Request
data ListEndpoints Source #
See: newListEndpoints smart constructor.
Constructors
| ListEndpoints' | |
Fields
| |
Instances
newListEndpoints :: ListEndpoints Source #
Create a value of ListEndpoints with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:homeRegion:ListEndpoints', listEndpoints_homeRegion - The primary Region of the endpoints associated with this account. For
example "HomeRegion": "us-east-1".
$sel:maxResults:ListEndpoints', listEndpoints_maxResults - The maximum number of results returned by the call.
$sel:namePrefix:ListEndpoints', listEndpoints_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.
ListEndpoints, listEndpoints_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.
Request Lenses
listEndpoints_homeRegion :: Lens' ListEndpoints (Maybe Text) Source #
The primary Region of the endpoints associated with this account. For
example "HomeRegion": "us-east-1".
listEndpoints_maxResults :: Lens' ListEndpoints (Maybe Natural) Source #
The maximum number of results returned by the call.
listEndpoints_namePrefix :: Lens' ListEndpoints (Maybe Text) Source #
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.
listEndpoints_nextToken :: Lens' ListEndpoints (Maybe Text) Source #
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.
Destructuring the Response
data ListEndpointsResponse Source #
See: newListEndpointsResponse smart constructor.
Constructors
| ListEndpointsResponse' | |
Fields
| |
Instances
newListEndpointsResponse Source #
Create a value of ListEndpointsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpoints:ListEndpointsResponse', listEndpointsResponse_endpoints - The endpoints returned by the call.
ListEndpoints, listEndpointsResponse_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.
$sel:httpStatus:ListEndpointsResponse', listEndpointsResponse_httpStatus - The response's http status code.
Response Lenses
listEndpointsResponse_endpoints :: Lens' ListEndpointsResponse (Maybe [Endpoint]) Source #
The endpoints returned by the call.
listEndpointsResponse_nextToken :: Lens' ListEndpointsResponse (Maybe Text) Source #
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.
listEndpointsResponse_httpStatus :: Lens' ListEndpointsResponse Int Source #
The response's http status code.