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.DescribeEndpoint

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Constructors

DescribeEndpoint'
Fields homeRegion :: Maybe Text The primary Region of the endpoint you want to get information about. For example `"HomeRegion": "us-east-1"`. name :: Text The name of the endpoint you want to get information about. For example, `"Name":"us-east-2-custom_bus_A-endpoint"`.

Instances

Instances details

ToJSON DescribeEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint Methods toJSON :: DescribeEndpoint -> Value # toEncoding :: DescribeEndpoint -> Encoding # toJSONList :: [DescribeEndpoint] -> Value # toEncodingList :: [DescribeEndpoint] -> Encoding #
ToHeaders DescribeEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint Methods toHeaders :: DescribeEndpoint -> [Header] #
ToPath DescribeEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint Methods toPath :: DescribeEndpoint -> ByteString #
ToQuery DescribeEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint Methods toQuery :: DescribeEndpoint -> QueryString #
AWSRequest DescribeEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint Associated Types type AWSResponse DescribeEndpoint # Methods request :: (Service -> Service) -> DescribeEndpoint -> Request DescribeEndpoint # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEndpoint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEndpoint))) #
Generic DescribeEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint Associated Types type Rep DescribeEndpoint :: Type -> Type # Methods from :: DescribeEndpoint -> Rep DescribeEndpoint x # to :: Rep DescribeEndpoint x -> DescribeEndpoint #
Read DescribeEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint Methods readsPrec :: Int -> ReadS DescribeEndpoint # readList :: ReadS [DescribeEndpoint] # readPrec :: ReadPrec DescribeEndpoint # readListPrec :: ReadPrec [DescribeEndpoint] #
Show DescribeEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint Methods showsPrec :: Int -> DescribeEndpoint -> ShowS # show :: DescribeEndpoint -> String # showList :: [DescribeEndpoint] -> ShowS #
NFData DescribeEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint Methods rnf :: DescribeEndpoint -> () #
Eq DescribeEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint Methods (==) :: DescribeEndpoint -> DescribeEndpoint -> Bool # (/=) :: DescribeEndpoint -> DescribeEndpoint -> Bool #
Hashable DescribeEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint Methods hashWithSalt :: Int -> DescribeEndpoint -> Int # hash :: DescribeEndpoint -> Int #
type AWSResponse DescribeEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint type AWSResponse DescribeEndpoint = DescribeEndpointResponse
type Rep DescribeEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint type Rep DescribeEndpoint = D1 ('MetaData "DescribeEndpoint" "Amazonka.CloudWatchEvents.DescribeEndpoint" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "DescribeEndpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "homeRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeEndpoint Source #

Arguments

:: Text	`DescribeEndpoint`
-> DescribeEndpoint

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.

Constructors

DescribeEndpointResponse'

Fields

arn :: Maybe Text
The ARN of the endpoint you asked for information about.
creationTime :: Maybe POSIX
The time the endpoint you asked for information about was created.
description :: Maybe Text
The description of the endpoint you asked for information about.
endpointId :: Maybe Text
The ID of the endpoint you asked for information about.
endpointUrl :: Maybe Text
The URL of the endpoint you asked for information about.
eventBuses :: Maybe (NonEmpty EndpointEventBus)
The event buses being used by the endpoint you asked for information about.
lastModifiedTime :: Maybe POSIX
The last time the endpoint you asked for information about was modified.
name :: Maybe Text
The name of the endpoint you asked for information about.
replicationConfig :: Maybe ReplicationConfig
Whether replication is enabled or disabled for the endpoint you asked for information about.
roleArn :: Maybe Text
The ARN of the role used by the endpoint you asked for information about.
routingConfig :: Maybe RoutingConfig
The routing configuration of the endpoint you asked for information about.
state :: Maybe EndpointState
The current state of the endpoint you asked for information about.
stateReason :: Maybe Text
The reason the endpoint you asked for information about is in its current state.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeEndpointResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint Associated Types type Rep DescribeEndpointResponse :: Type -> Type # Methods from :: DescribeEndpointResponse -> Rep DescribeEndpointResponse x # to :: Rep DescribeEndpointResponse x -> DescribeEndpointResponse #
Read DescribeEndpointResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint Methods readsPrec :: Int -> ReadS DescribeEndpointResponse # readList :: ReadS [DescribeEndpointResponse] # readPrec :: ReadPrec DescribeEndpointResponse # readListPrec :: ReadPrec [DescribeEndpointResponse] #
Show DescribeEndpointResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint Methods showsPrec :: Int -> DescribeEndpointResponse -> ShowS # show :: DescribeEndpointResponse -> String # showList :: [DescribeEndpointResponse] -> ShowS #
NFData DescribeEndpointResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint Methods rnf :: DescribeEndpointResponse -> () #
Eq DescribeEndpointResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint Methods (==) :: DescribeEndpointResponse -> DescribeEndpointResponse -> Bool # (/=) :: DescribeEndpointResponse -> DescribeEndpointResponse -> Bool #
type Rep DescribeEndpointResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEndpoint type Rep DescribeEndpointResponse = D1 ('MetaData "DescribeEndpointResponse" "Amazonka.CloudWatchEvents.DescribeEndpoint" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "DescribeEndpointResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "endpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "endpointUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "eventBuses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty EndpointEventBus))) :: S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "replicationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicationConfig)) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "routingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RoutingConfig)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointState))) :: (S1 ('MetaSel ('Just "stateReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeEndpointResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeEndpointResponse'`
-> DescribeEndpointResponse

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.