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.QuickSight.UpdateIpRestriction

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the content and status of IP rules. To use this operation, you need to provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

Synopsis

data UpdateIpRestriction = UpdateIpRestriction' {
- enabled :: Maybe Bool
- ipRestrictionRuleMap :: Maybe (HashMap Text Text)
- awsAccountId :: Text
}
newUpdateIpRestriction :: Text -> UpdateIpRestriction
updateIpRestriction_enabled :: Lens' UpdateIpRestriction (Maybe Bool)
updateIpRestriction_ipRestrictionRuleMap :: Lens' UpdateIpRestriction (Maybe (HashMap Text Text))
updateIpRestriction_awsAccountId :: Lens' UpdateIpRestriction Text
data UpdateIpRestrictionResponse = UpdateIpRestrictionResponse' {
- awsAccountId :: Maybe Text
- requestId :: Maybe Text
- status :: Int
}
newUpdateIpRestrictionResponse :: Int -> UpdateIpRestrictionResponse
updateIpRestrictionResponse_awsAccountId :: Lens' UpdateIpRestrictionResponse (Maybe Text)
updateIpRestrictionResponse_requestId :: Lens' UpdateIpRestrictionResponse (Maybe Text)
updateIpRestrictionResponse_status :: Lens' UpdateIpRestrictionResponse Int

Creating a Request

data UpdateIpRestriction Source #

See: newUpdateIpRestriction smart constructor.

Constructors

UpdateIpRestriction'
Fields enabled :: Maybe Bool A value that specifies whether IP rules are turned on. ipRestrictionRuleMap :: Maybe (HashMap Text Text) A map that describes the updated IP rules with CIDR ranges and descriptions. awsAccountId :: Text The ID of the Amazon Web Services account that contains the IP rules.

Instances

Instances details

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

newUpdateIpRestriction Source #

Arguments

:: Text	`UpdateIpRestriction`
-> UpdateIpRestriction

Create a value of UpdateIpRestriction 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:enabled:UpdateIpRestriction', updateIpRestriction_enabled - A value that specifies whether IP rules are turned on.

$sel:ipRestrictionRuleMap:UpdateIpRestriction', updateIpRestriction_ipRestrictionRuleMap - A map that describes the updated IP rules with CIDR ranges and descriptions.

UpdateIpRestriction, updateIpRestriction_awsAccountId - The ID of the Amazon Web Services account that contains the IP rules.

Request Lenses

updateIpRestriction_enabled :: Lens' UpdateIpRestriction (Maybe Bool) Source #

A value that specifies whether IP rules are turned on.

updateIpRestriction_ipRestrictionRuleMap :: Lens' UpdateIpRestriction (Maybe (HashMap Text Text)) Source #

A map that describes the updated IP rules with CIDR ranges and descriptions.

updateIpRestriction_awsAccountId :: Lens' UpdateIpRestriction Text Source #

The ID of the Amazon Web Services account that contains the IP rules.

Destructuring the Response

data UpdateIpRestrictionResponse Source #

See: newUpdateIpRestrictionResponse smart constructor.

Constructors

UpdateIpRestrictionResponse'
Fields awsAccountId :: Maybe Text The ID of the Amazon Web Services account that contains the IP rules. requestId :: Maybe Text The Amazon Web Services request ID for this operation. status :: Int The HTTP status of the request.

Instances

Instances details

Generic UpdateIpRestrictionResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateIpRestriction Associated Types type Rep UpdateIpRestrictionResponse :: Type -> Type # Methods from :: UpdateIpRestrictionResponse -> Rep UpdateIpRestrictionResponse x # to :: Rep UpdateIpRestrictionResponse x -> UpdateIpRestrictionResponse #
Read UpdateIpRestrictionResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateIpRestriction Methods readsPrec :: Int -> ReadS UpdateIpRestrictionResponse # readList :: ReadS [UpdateIpRestrictionResponse] # readPrec :: ReadPrec UpdateIpRestrictionResponse # readListPrec :: ReadPrec [UpdateIpRestrictionResponse] #
Show UpdateIpRestrictionResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateIpRestriction Methods showsPrec :: Int -> UpdateIpRestrictionResponse -> ShowS # show :: UpdateIpRestrictionResponse -> String # showList :: [UpdateIpRestrictionResponse] -> ShowS #
NFData UpdateIpRestrictionResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateIpRestriction Methods rnf :: UpdateIpRestrictionResponse -> () #
Eq UpdateIpRestrictionResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateIpRestriction Methods (==) :: UpdateIpRestrictionResponse -> UpdateIpRestrictionResponse -> Bool # (/=) :: UpdateIpRestrictionResponse -> UpdateIpRestrictionResponse -> Bool #
type Rep UpdateIpRestrictionResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateIpRestriction type Rep UpdateIpRestrictionResponse = D1 ('MetaData "UpdateIpRestrictionResponse" "Amazonka.QuickSight.UpdateIpRestriction" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "UpdateIpRestrictionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateIpRestrictionResponse Source #

Arguments

:: Int	`UpdateIpRestrictionResponse`
-> UpdateIpRestrictionResponse

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

UpdateIpRestriction, updateIpRestrictionResponse_awsAccountId - The ID of the Amazon Web Services account that contains the IP rules.

$sel:requestId:UpdateIpRestrictionResponse', updateIpRestrictionResponse_requestId - The Amazon Web Services request ID for this operation.

UpdateIpRestrictionResponse, updateIpRestrictionResponse_status - The HTTP status of the request.

Response Lenses

updateIpRestrictionResponse_awsAccountId :: Lens' UpdateIpRestrictionResponse (Maybe Text) Source #

The ID of the Amazon Web Services account that contains the IP rules.

updateIpRestrictionResponse_requestId :: Lens' UpdateIpRestrictionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateIpRestrictionResponse_status :: Lens' UpdateIpRestrictionResponse Int Source #

The HTTP status of the request.