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.OpenSearchServerless.UpdateAccessPolicy

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

Synopsis

data UpdateAccessPolicy = UpdateAccessPolicy' {
- clientToken :: Maybe Text
- description :: Maybe Text
- policy :: Maybe Text
- name :: Text
- policyVersion :: Text
- type' :: AccessPolicyType
}
newUpdateAccessPolicy :: Text -> Text -> AccessPolicyType -> UpdateAccessPolicy
updateAccessPolicy_clientToken :: Lens' UpdateAccessPolicy (Maybe Text)
updateAccessPolicy_description :: Lens' UpdateAccessPolicy (Maybe Text)
updateAccessPolicy_policy :: Lens' UpdateAccessPolicy (Maybe Text)
updateAccessPolicy_name :: Lens' UpdateAccessPolicy Text
updateAccessPolicy_policyVersion :: Lens' UpdateAccessPolicy Text
updateAccessPolicy_type :: Lens' UpdateAccessPolicy AccessPolicyType
data UpdateAccessPolicyResponse = UpdateAccessPolicyResponse' {
- accessPolicyDetail :: Maybe AccessPolicyDetail
- httpStatus :: Int
}
newUpdateAccessPolicyResponse :: Int -> UpdateAccessPolicyResponse
updateAccessPolicyResponse_accessPolicyDetail :: Lens' UpdateAccessPolicyResponse (Maybe AccessPolicyDetail)
updateAccessPolicyResponse_httpStatus :: Lens' UpdateAccessPolicyResponse Int

Creating a Request

data UpdateAccessPolicy Source #

See: newUpdateAccessPolicy smart constructor.

Constructors

UpdateAccessPolicy'

Fields

clientToken :: Maybe Text
Unique, case-sensitive identifier to ensure idempotency of the request.
description :: Maybe Text
A description of the policy. Typically used to store information about the permissions defined in the policy.
policy :: Maybe Text
The JSON policy document to use as the content for the policy.
name :: Text
The name of the policy.
policyVersion :: Text
The version of the policy being updated.
type' :: AccessPolicyType
The type of policy.

Instances

Instances details

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

newUpdateAccessPolicy Source #

Arguments

:: Text	`UpdateAccessPolicy`
-> Text	`UpdateAccessPolicy`
-> AccessPolicyType	`UpdateAccessPolicy`
-> UpdateAccessPolicy

Create a value of UpdateAccessPolicy 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:clientToken:UpdateAccessPolicy', updateAccessPolicy_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.

UpdateAccessPolicy, updateAccessPolicy_description - A description of the policy. Typically used to store information about the permissions defined in the policy.

UpdateAccessPolicy, updateAccessPolicy_policy - The JSON policy document to use as the content for the policy.

UpdateAccessPolicy, updateAccessPolicy_name - The name of the policy.

UpdateAccessPolicy, updateAccessPolicy_policyVersion - The version of the policy being updated.

UpdateAccessPolicy, updateAccessPolicy_type - The type of policy.

Request Lenses

updateAccessPolicy_clientToken :: Lens' UpdateAccessPolicy (Maybe Text) Source #

Unique, case-sensitive identifier to ensure idempotency of the request.

updateAccessPolicy_description :: Lens' UpdateAccessPolicy (Maybe Text) Source #

A description of the policy. Typically used to store information about the permissions defined in the policy.

updateAccessPolicy_policy :: Lens' UpdateAccessPolicy (Maybe Text) Source #

The JSON policy document to use as the content for the policy.

updateAccessPolicy_name :: Lens' UpdateAccessPolicy Text Source #

The name of the policy.

updateAccessPolicy_policyVersion :: Lens' UpdateAccessPolicy Text Source #

The version of the policy being updated.

updateAccessPolicy_type :: Lens' UpdateAccessPolicy AccessPolicyType Source #

The type of policy.

Destructuring the Response

data UpdateAccessPolicyResponse Source #

See: newUpdateAccessPolicyResponse smart constructor.

Constructors

UpdateAccessPolicyResponse'
Fields accessPolicyDetail :: Maybe AccessPolicyDetail Details about the updated access policy. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateAccessPolicyResponse Source #
Instance details Defined in Amazonka.OpenSearchServerless.UpdateAccessPolicy Associated Types type Rep UpdateAccessPolicyResponse :: Type -> Type # Methods from :: UpdateAccessPolicyResponse -> Rep UpdateAccessPolicyResponse x # to :: Rep UpdateAccessPolicyResponse x -> UpdateAccessPolicyResponse #
Read UpdateAccessPolicyResponse Source #
Instance details Defined in Amazonka.OpenSearchServerless.UpdateAccessPolicy Methods readsPrec :: Int -> ReadS UpdateAccessPolicyResponse # readList :: ReadS [UpdateAccessPolicyResponse] # readPrec :: ReadPrec UpdateAccessPolicyResponse # readListPrec :: ReadPrec [UpdateAccessPolicyResponse] #
Show UpdateAccessPolicyResponse Source #
Instance details Defined in Amazonka.OpenSearchServerless.UpdateAccessPolicy Methods showsPrec :: Int -> UpdateAccessPolicyResponse -> ShowS # show :: UpdateAccessPolicyResponse -> String # showList :: [UpdateAccessPolicyResponse] -> ShowS #
NFData UpdateAccessPolicyResponse Source #
Instance details Defined in Amazonka.OpenSearchServerless.UpdateAccessPolicy Methods rnf :: UpdateAccessPolicyResponse -> () #
Eq UpdateAccessPolicyResponse Source #
Instance details Defined in Amazonka.OpenSearchServerless.UpdateAccessPolicy Methods (==) :: UpdateAccessPolicyResponse -> UpdateAccessPolicyResponse -> Bool # (/=) :: UpdateAccessPolicyResponse -> UpdateAccessPolicyResponse -> Bool #
type Rep UpdateAccessPolicyResponse Source #
Instance details Defined in Amazonka.OpenSearchServerless.UpdateAccessPolicy type Rep UpdateAccessPolicyResponse = D1 ('MetaData "UpdateAccessPolicyResponse" "Amazonka.OpenSearchServerless.UpdateAccessPolicy" "amazonka-opensearchserverless-2.0-HnbMYszmsxrAMKjbvSoFws" 'False) (C1 ('MetaCons "UpdateAccessPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accessPolicyDetail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessPolicyDetail)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateAccessPolicyResponse Source #

Arguments

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

Create a value of UpdateAccessPolicyResponse 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:accessPolicyDetail:UpdateAccessPolicyResponse', updateAccessPolicyResponse_accessPolicyDetail - Details about the updated access policy.

$sel:httpStatus:UpdateAccessPolicyResponse', updateAccessPolicyResponse_httpStatus - The response's http status code.

Response Lenses

updateAccessPolicyResponse_accessPolicyDetail :: Lens' UpdateAccessPolicyResponse (Maybe AccessPolicyDetail) Source #

Details about the updated access policy.

updateAccessPolicyResponse_httpStatus :: Lens' UpdateAccessPolicyResponse Int Source #

The response's http status code.