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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Update an existing 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 UpdateEndpoint = UpdateEndpoint' {
- description :: Maybe Text
- eventBuses :: Maybe (NonEmpty EndpointEventBus)
- replicationConfig :: Maybe ReplicationConfig
- roleArn :: Maybe Text
- routingConfig :: Maybe RoutingConfig
- name :: Text
}
newUpdateEndpoint :: Text -> UpdateEndpoint
updateEndpoint_description :: Lens' UpdateEndpoint (Maybe Text)
updateEndpoint_eventBuses :: Lens' UpdateEndpoint (Maybe (NonEmpty EndpointEventBus))
updateEndpoint_replicationConfig :: Lens' UpdateEndpoint (Maybe ReplicationConfig)
updateEndpoint_roleArn :: Lens' UpdateEndpoint (Maybe Text)
updateEndpoint_routingConfig :: Lens' UpdateEndpoint (Maybe RoutingConfig)
updateEndpoint_name :: Lens' UpdateEndpoint Text
data UpdateEndpointResponse = UpdateEndpointResponse' {
- arn :: Maybe Text
- endpointId :: Maybe Text
- endpointUrl :: Maybe Text
- eventBuses :: Maybe (NonEmpty EndpointEventBus)
- name :: Maybe Text
- replicationConfig :: Maybe ReplicationConfig
- roleArn :: Maybe Text
- routingConfig :: Maybe RoutingConfig
- state :: Maybe EndpointState
- httpStatus :: Int
}
newUpdateEndpointResponse :: Int -> UpdateEndpointResponse
updateEndpointResponse_arn :: Lens' UpdateEndpointResponse (Maybe Text)
updateEndpointResponse_endpointId :: Lens' UpdateEndpointResponse (Maybe Text)
updateEndpointResponse_endpointUrl :: Lens' UpdateEndpointResponse (Maybe Text)
updateEndpointResponse_eventBuses :: Lens' UpdateEndpointResponse (Maybe (NonEmpty EndpointEventBus))
updateEndpointResponse_name :: Lens' UpdateEndpointResponse (Maybe Text)
updateEndpointResponse_replicationConfig :: Lens' UpdateEndpointResponse (Maybe ReplicationConfig)
updateEndpointResponse_roleArn :: Lens' UpdateEndpointResponse (Maybe Text)
updateEndpointResponse_routingConfig :: Lens' UpdateEndpointResponse (Maybe RoutingConfig)
updateEndpointResponse_state :: Lens' UpdateEndpointResponse (Maybe EndpointState)
updateEndpointResponse_httpStatus :: Lens' UpdateEndpointResponse Int

Creating a Request

data UpdateEndpoint Source #

See: newUpdateEndpoint smart constructor.

Constructors

UpdateEndpoint'

Fields

description :: Maybe Text
A description for the endpoint.
eventBuses :: Maybe (NonEmpty EndpointEventBus)
Define event buses used for replication.
replicationConfig :: Maybe ReplicationConfig
Whether event replication was enabled or disabled by this request.
roleArn :: Maybe Text
The ARN of the role used by event replication for this request.
routingConfig :: Maybe RoutingConfig
Configure the routing policy, including the health check and secondary Region..
name :: Text
The name of the endpoint you want to update.

Instances

Instances details

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

newUpdateEndpoint Source #

Arguments

:: Text	`UpdateEndpoint`
-> UpdateEndpoint

Create a value of UpdateEndpoint 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:

UpdateEndpoint, updateEndpoint_description - A description for the endpoint.

UpdateEndpoint, updateEndpoint_eventBuses - Define event buses used for replication.

UpdateEndpoint, updateEndpoint_replicationConfig - Whether event replication was enabled or disabled by this request.

UpdateEndpoint, updateEndpoint_roleArn - The ARN of the role used by event replication for this request.

UpdateEndpoint, updateEndpoint_routingConfig - Configure the routing policy, including the health check and secondary Region..

UpdateEndpoint, updateEndpoint_name - The name of the endpoint you want to update.

Request Lenses

updateEndpoint_description :: Lens' UpdateEndpoint (Maybe Text) Source #

A description for the endpoint.

updateEndpoint_eventBuses :: Lens' UpdateEndpoint (Maybe (NonEmpty EndpointEventBus)) Source #

Define event buses used for replication.

updateEndpoint_replicationConfig :: Lens' UpdateEndpoint (Maybe ReplicationConfig) Source #

Whether event replication was enabled or disabled by this request.

updateEndpoint_roleArn :: Lens' UpdateEndpoint (Maybe Text) Source #

The ARN of the role used by event replication for this request.

updateEndpoint_routingConfig :: Lens' UpdateEndpoint (Maybe RoutingConfig) Source #

Configure the routing policy, including the health check and secondary Region..

updateEndpoint_name :: Lens' UpdateEndpoint Text Source #

The name of the endpoint you want to update.

Destructuring the Response

data UpdateEndpointResponse Source #

See: newUpdateEndpointResponse smart constructor.

Constructors

UpdateEndpointResponse'

Fields

arn :: Maybe Text
The ARN of the endpoint you updated in this request.
endpointId :: Maybe Text
The ID of the endpoint you updated in this request.
endpointUrl :: Maybe Text
The URL of the endpoint you updated in this request.
eventBuses :: Maybe (NonEmpty EndpointEventBus)
The event buses used for replication for the endpoint you updated in this request.
name :: Maybe Text
The name of the endpoint you updated in this request.
replicationConfig :: Maybe ReplicationConfig
Whether event replication was enabled or disabled for the endpoint you updated in this request.
roleArn :: Maybe Text
The ARN of the role used by event replication for the endpoint you updated in this request.
routingConfig :: Maybe RoutingConfig
The routing configuration you updated in this request.
state :: Maybe EndpointState
The state of the endpoint you updated in this request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic UpdateEndpointResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.UpdateEndpoint Associated Types type Rep UpdateEndpointResponse :: Type -> Type # Methods from :: UpdateEndpointResponse -> Rep UpdateEndpointResponse x # to :: Rep UpdateEndpointResponse x -> UpdateEndpointResponse #
Read UpdateEndpointResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.UpdateEndpoint Methods readsPrec :: Int -> ReadS UpdateEndpointResponse # readList :: ReadS [UpdateEndpointResponse] # readPrec :: ReadPrec UpdateEndpointResponse # readListPrec :: ReadPrec [UpdateEndpointResponse] #
Show UpdateEndpointResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.UpdateEndpoint Methods showsPrec :: Int -> UpdateEndpointResponse -> ShowS # show :: UpdateEndpointResponse -> String # showList :: [UpdateEndpointResponse] -> ShowS #
NFData UpdateEndpointResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.UpdateEndpoint Methods rnf :: UpdateEndpointResponse -> () #
Eq UpdateEndpointResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.UpdateEndpoint Methods (==) :: UpdateEndpointResponse -> UpdateEndpointResponse -> Bool # (/=) :: UpdateEndpointResponse -> UpdateEndpointResponse -> Bool #
type Rep UpdateEndpointResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.UpdateEndpoint type Rep UpdateEndpointResponse = D1 ('MetaData "UpdateEndpointResponse" "Amazonka.CloudWatchEvents.UpdateEndpoint" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "UpdateEndpointResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") '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 "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 "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newUpdateEndpointResponse Source #

Arguments

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

Create a value of UpdateEndpointResponse 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:

UpdateEndpointResponse, updateEndpointResponse_arn - The ARN of the endpoint you updated in this request.

UpdateEndpointResponse, updateEndpointResponse_endpointId - The ID of the endpoint you updated in this request.

UpdateEndpointResponse, updateEndpointResponse_endpointUrl - The URL of the endpoint you updated in this request.

UpdateEndpoint, updateEndpointResponse_eventBuses - The event buses used for replication for the endpoint you updated in this request.

UpdateEndpoint, updateEndpointResponse_name - The name of the endpoint you updated in this request.

UpdateEndpoint, updateEndpointResponse_replicationConfig - Whether event replication was enabled or disabled for the endpoint you updated in this request.

UpdateEndpoint, updateEndpointResponse_roleArn - The ARN of the role used by event replication for the endpoint you updated in this request.

UpdateEndpoint, updateEndpointResponse_routingConfig - The routing configuration you updated in this request.

UpdateEndpointResponse, updateEndpointResponse_state - The state of the endpoint you updated in this request.

$sel:httpStatus:UpdateEndpointResponse', updateEndpointResponse_httpStatus - The response's http status code.

Response Lenses

updateEndpointResponse_arn :: Lens' UpdateEndpointResponse (Maybe Text) Source #

The ARN of the endpoint you updated in this request.

updateEndpointResponse_endpointId :: Lens' UpdateEndpointResponse (Maybe Text) Source #

The ID of the endpoint you updated in this request.

updateEndpointResponse_endpointUrl :: Lens' UpdateEndpointResponse (Maybe Text) Source #

The URL of the endpoint you updated in this request.

updateEndpointResponse_eventBuses :: Lens' UpdateEndpointResponse (Maybe (NonEmpty EndpointEventBus)) Source #

The event buses used for replication for the endpoint you updated in this request.

updateEndpointResponse_name :: Lens' UpdateEndpointResponse (Maybe Text) Source #

The name of the endpoint you updated in this request.

updateEndpointResponse_replicationConfig :: Lens' UpdateEndpointResponse (Maybe ReplicationConfig) Source #

Whether event replication was enabled or disabled for the endpoint you updated in this request.

updateEndpointResponse_roleArn :: Lens' UpdateEndpointResponse (Maybe Text) Source #

The ARN of the role used by event replication for the endpoint you updated in this request.

updateEndpointResponse_routingConfig :: Lens' UpdateEndpointResponse (Maybe RoutingConfig) Source #

The routing configuration you updated in this request.

updateEndpointResponse_state :: Lens' UpdateEndpointResponse (Maybe EndpointState) Source #

The state of the endpoint you updated in this request.

updateEndpointResponse_httpStatus :: Lens' UpdateEndpointResponse Int Source #

The response's http status code.