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 |
Get the information about an existing global endpoint. 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 DescribeEndpoint = DescribeEndpoint' {
- homeRegion :: Maybe Text
- name :: Text
- newDescribeEndpoint :: Text -> DescribeEndpoint
- describeEndpoint_homeRegion :: Lens' DescribeEndpoint (Maybe Text)
- describeEndpoint_name :: Lens' DescribeEndpoint Text
- data DescribeEndpointResponse = DescribeEndpointResponse' {
- arn :: Maybe Text
- creationTime :: Maybe POSIX
- description :: Maybe Text
- endpointId :: Maybe Text
- endpointUrl :: Maybe Text
- eventBuses :: Maybe (NonEmpty EndpointEventBus)
- lastModifiedTime :: Maybe POSIX
- name :: Maybe Text
- replicationConfig :: Maybe ReplicationConfig
- roleArn :: Maybe Text
- routingConfig :: Maybe RoutingConfig
- state :: Maybe EndpointState
- stateReason :: Maybe Text
- httpStatus :: Int
- newDescribeEndpointResponse :: Int -> DescribeEndpointResponse
- describeEndpointResponse_arn :: Lens' DescribeEndpointResponse (Maybe Text)
- describeEndpointResponse_creationTime :: Lens' DescribeEndpointResponse (Maybe UTCTime)
- describeEndpointResponse_description :: Lens' DescribeEndpointResponse (Maybe Text)
- describeEndpointResponse_endpointId :: Lens' DescribeEndpointResponse (Maybe Text)
- describeEndpointResponse_endpointUrl :: Lens' DescribeEndpointResponse (Maybe Text)
- describeEndpointResponse_eventBuses :: Lens' DescribeEndpointResponse (Maybe (NonEmpty EndpointEventBus))
- describeEndpointResponse_lastModifiedTime :: Lens' DescribeEndpointResponse (Maybe UTCTime)
- describeEndpointResponse_name :: Lens' DescribeEndpointResponse (Maybe Text)
- describeEndpointResponse_replicationConfig :: Lens' DescribeEndpointResponse (Maybe ReplicationConfig)
- describeEndpointResponse_roleArn :: Lens' DescribeEndpointResponse (Maybe Text)
- describeEndpointResponse_routingConfig :: Lens' DescribeEndpointResponse (Maybe RoutingConfig)
- describeEndpointResponse_state :: Lens' DescribeEndpointResponse (Maybe EndpointState)
- describeEndpointResponse_stateReason :: Lens' DescribeEndpointResponse (Maybe Text)
- describeEndpointResponse_httpStatus :: Lens' DescribeEndpointResponse Int
Creating a Request
data DescribeEndpoint Source #
See: newDescribeEndpoint
smart constructor.
DescribeEndpoint' | |
|
Instances
Create a value of DescribeEndpoint
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:DescribeEndpoint'
, describeEndpoint_homeRegion
- The primary Region of the endpoint you want to get information about.
For example "HomeRegion": "us-east-1"
.
DescribeEndpoint
, describeEndpoint_name
- The name of the endpoint you want to get information about. For example,
"Name":"us-east-2-custom_bus_A-endpoint"
.
Request Lenses
describeEndpoint_homeRegion :: Lens' DescribeEndpoint (Maybe Text) Source #
The primary Region of the endpoint you want to get information about.
For example "HomeRegion": "us-east-1"
.
describeEndpoint_name :: Lens' DescribeEndpoint Text Source #
The name of the endpoint you want to get information about. For example,
"Name":"us-east-2-custom_bus_A-endpoint"
.
Destructuring the Response
data DescribeEndpointResponse Source #
See: newDescribeEndpointResponse
smart constructor.
DescribeEndpointResponse' | |
|
Instances
newDescribeEndpointResponse Source #
Create a value of DescribeEndpointResponse
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:
DescribeEndpointResponse
, describeEndpointResponse_arn
- The ARN of the endpoint you asked for information about.
DescribeEndpointResponse
, describeEndpointResponse_creationTime
- The time the endpoint you asked for information about was created.
DescribeEndpointResponse
, describeEndpointResponse_description
- The description of the endpoint you asked for information about.
DescribeEndpointResponse
, describeEndpointResponse_endpointId
- The ID of the endpoint you asked for information about.
DescribeEndpointResponse
, describeEndpointResponse_endpointUrl
- The URL of the endpoint you asked for information about.
DescribeEndpointResponse
, describeEndpointResponse_eventBuses
- The event buses being used by the endpoint you asked for information
about.
DescribeEndpointResponse
, describeEndpointResponse_lastModifiedTime
- The last time the endpoint you asked for information about was modified.
DescribeEndpoint
, describeEndpointResponse_name
- The name of the endpoint you asked for information about.
DescribeEndpointResponse
, describeEndpointResponse_replicationConfig
- Whether replication is enabled or disabled for the endpoint you asked
for information about.
DescribeEndpointResponse
, describeEndpointResponse_roleArn
- The ARN of the role used by the endpoint you asked for information
about.
DescribeEndpointResponse
, describeEndpointResponse_routingConfig
- The routing configuration of the endpoint you asked for information
about.
DescribeEndpointResponse
, describeEndpointResponse_state
- The current state of the endpoint you asked for information about.
DescribeEndpointResponse
, describeEndpointResponse_stateReason
- The reason the endpoint you asked for information about is in its
current state.
$sel:httpStatus:DescribeEndpointResponse'
, describeEndpointResponse_httpStatus
- The response's http status code.
Response Lenses
describeEndpointResponse_arn :: Lens' DescribeEndpointResponse (Maybe Text) Source #
The ARN of the endpoint you asked for information about.
describeEndpointResponse_creationTime :: Lens' DescribeEndpointResponse (Maybe UTCTime) Source #
The time the endpoint you asked for information about was created.
describeEndpointResponse_description :: Lens' DescribeEndpointResponse (Maybe Text) Source #
The description of the endpoint you asked for information about.
describeEndpointResponse_endpointId :: Lens' DescribeEndpointResponse (Maybe Text) Source #
The ID of the endpoint you asked for information about.
describeEndpointResponse_endpointUrl :: Lens' DescribeEndpointResponse (Maybe Text) Source #
The URL of the endpoint you asked for information about.
describeEndpointResponse_eventBuses :: Lens' DescribeEndpointResponse (Maybe (NonEmpty EndpointEventBus)) Source #
The event buses being used by the endpoint you asked for information about.
describeEndpointResponse_lastModifiedTime :: Lens' DescribeEndpointResponse (Maybe UTCTime) Source #
The last time the endpoint you asked for information about was modified.
describeEndpointResponse_name :: Lens' DescribeEndpointResponse (Maybe Text) Source #
The name of the endpoint you asked for information about.
describeEndpointResponse_replicationConfig :: Lens' DescribeEndpointResponse (Maybe ReplicationConfig) Source #
Whether replication is enabled or disabled for the endpoint you asked for information about.
describeEndpointResponse_roleArn :: Lens' DescribeEndpointResponse (Maybe Text) Source #
The ARN of the role used by the endpoint you asked for information about.
describeEndpointResponse_routingConfig :: Lens' DescribeEndpointResponse (Maybe RoutingConfig) Source #
The routing configuration of the endpoint you asked for information about.
describeEndpointResponse_state :: Lens' DescribeEndpointResponse (Maybe EndpointState) Source #
The current state of the endpoint you asked for information about.
describeEndpointResponse_stateReason :: Lens' DescribeEndpointResponse (Maybe Text) Source #
The reason the endpoint you asked for information about is in its current state.
describeEndpointResponse_httpStatus :: Lens' DescribeEndpointResponse Int Source #
The response's http status code.