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.GlobalAccelerator.RemoveEndpoints

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Remove endpoints from an endpoint group.

The RemoveEndpoints API operation is the recommended option for removing endpoints. The alternative is to remove endpoints by updating an endpoint group by using the UpdateEndpointGroup API operation. There are two advantages to using AddEndpoints to remove endpoints instead:

It's more convenient, because you only need to specify the endpoints that you want to remove. With the UpdateEndpointGroup API operation, you must specify all of the endpoints in the endpoint group except the ones that you want to remove from the group.
It's faster, because Global Accelerator doesn't need to resolve any endpoints. With the UpdateEndpointGroup API operation, Global Accelerator must resolve all of the endpoints that remain in the group.

Creating a Request

data RemoveEndpoints Source #

See: newRemoveEndpoints smart constructor.

Constructors

RemoveEndpoints'
Fields endpointIdentifiers :: NonEmpty EndpointIdentifier The identifiers of the endpoints that you want to remove. endpointGroupArn :: Text The Amazon Resource Name (ARN) of the endpoint group.

Instances

Instances details

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

newRemoveEndpoints Source #

Arguments

:: NonEmpty EndpointIdentifier	`$sel:endpointIdentifiers:RemoveEndpoints'`
-> Text	`RemoveEndpoints`
-> RemoveEndpoints

Create a value of RemoveEndpoints 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:endpointIdentifiers:RemoveEndpoints', removeEndpoints_endpointIdentifiers - The identifiers of the endpoints that you want to remove.

RemoveEndpoints, removeEndpoints_endpointGroupArn - The Amazon Resource Name (ARN) of the endpoint group.

Request Lenses

removeEndpoints_endpointIdentifiers :: Lens' RemoveEndpoints (NonEmpty EndpointIdentifier) Source #

The identifiers of the endpoints that you want to remove.

removeEndpoints_endpointGroupArn :: Lens' RemoveEndpoints Text Source #

The Amazon Resource Name (ARN) of the endpoint group.

Destructuring the Response

data RemoveEndpointsResponse Source #

See: newRemoveEndpointsResponse smart constructor.

Constructors

RemoveEndpointsResponse'

Instances

Instances details

Generic RemoveEndpointsResponse Source #
Instance details Defined in Amazonka.GlobalAccelerator.RemoveEndpoints Associated Types type Rep RemoveEndpointsResponse :: Type -> Type # Methods from :: RemoveEndpointsResponse -> Rep RemoveEndpointsResponse x # to :: Rep RemoveEndpointsResponse x -> RemoveEndpointsResponse #
Read RemoveEndpointsResponse Source #
Instance details Defined in Amazonka.GlobalAccelerator.RemoveEndpoints Methods readsPrec :: Int -> ReadS RemoveEndpointsResponse # readList :: ReadS [RemoveEndpointsResponse] # readPrec :: ReadPrec RemoveEndpointsResponse # readListPrec :: ReadPrec [RemoveEndpointsResponse] #
Show RemoveEndpointsResponse Source #
Instance details Defined in Amazonka.GlobalAccelerator.RemoveEndpoints Methods showsPrec :: Int -> RemoveEndpointsResponse -> ShowS # show :: RemoveEndpointsResponse -> String # showList :: [RemoveEndpointsResponse] -> ShowS #
NFData RemoveEndpointsResponse Source #
Instance details Defined in Amazonka.GlobalAccelerator.RemoveEndpoints Methods rnf :: RemoveEndpointsResponse -> () #
Eq RemoveEndpointsResponse Source #
Instance details Defined in Amazonka.GlobalAccelerator.RemoveEndpoints Methods (==) :: RemoveEndpointsResponse -> RemoveEndpointsResponse -> Bool # (/=) :: RemoveEndpointsResponse -> RemoveEndpointsResponse -> Bool #
type Rep RemoveEndpointsResponse Source #
Instance details Defined in Amazonka.GlobalAccelerator.RemoveEndpoints type Rep RemoveEndpointsResponse = D1 ('MetaData "RemoveEndpointsResponse" "Amazonka.GlobalAccelerator.RemoveEndpoints" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "RemoveEndpointsResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newRemoveEndpointsResponse :: RemoveEndpointsResponse Source #

Create a value of RemoveEndpointsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.