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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see Data access control for Amazon OpenSearch Serverless.

Synopsis

data CreateAccessPolicy = CreateAccessPolicy' {
- clientToken :: Maybe Text
- description :: Maybe Text
- name :: Text
- policy :: Text
- type' :: AccessPolicyType
}
newCreateAccessPolicy :: Text -> Text -> AccessPolicyType -> CreateAccessPolicy
createAccessPolicy_clientToken :: Lens' CreateAccessPolicy (Maybe Text)
createAccessPolicy_description :: Lens' CreateAccessPolicy (Maybe Text)
createAccessPolicy_name :: Lens' CreateAccessPolicy Text
createAccessPolicy_policy :: Lens' CreateAccessPolicy Text
createAccessPolicy_type :: Lens' CreateAccessPolicy AccessPolicyType
data CreateAccessPolicyResponse = CreateAccessPolicyResponse' {
- accessPolicyDetail :: Maybe AccessPolicyDetail
- httpStatus :: Int
}
newCreateAccessPolicyResponse :: Int -> CreateAccessPolicyResponse
createAccessPolicyResponse_accessPolicyDetail :: Lens' CreateAccessPolicyResponse (Maybe AccessPolicyDetail)
createAccessPolicyResponse_httpStatus :: Lens' CreateAccessPolicyResponse Int

Creating a Request

data CreateAccessPolicy Source #

See: newCreateAccessPolicy smart constructor.

Constructors

CreateAccessPolicy'

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.
name :: Text
The name of the policy.
policy :: Text
The JSON policy document to use as the content for the policy.
type' :: AccessPolicyType
The type of policy.

Instances

Instances details

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

newCreateAccessPolicy Source #

Arguments

:: Text	`CreateAccessPolicy`
-> Text	`CreateAccessPolicy`
-> AccessPolicyType	`CreateAccessPolicy`
-> CreateAccessPolicy

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

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

CreateAccessPolicy, createAccessPolicy_name - The name of the policy.

CreateAccessPolicy, createAccessPolicy_policy - The JSON policy document to use as the content for the policy.

CreateAccessPolicy, createAccessPolicy_type - The type of policy.

Request Lenses

createAccessPolicy_clientToken :: Lens' CreateAccessPolicy (Maybe Text) Source #

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

createAccessPolicy_description :: Lens' CreateAccessPolicy (Maybe Text) Source #

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

createAccessPolicy_name :: Lens' CreateAccessPolicy Text Source #

The name of the policy.

createAccessPolicy_policy :: Lens' CreateAccessPolicy Text Source #

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

createAccessPolicy_type :: Lens' CreateAccessPolicy AccessPolicyType Source #

The type of policy.

Destructuring the Response

data CreateAccessPolicyResponse Source #

See: newCreateAccessPolicyResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateAccessPolicyResponse Source #

Arguments

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

Create a value of CreateAccessPolicyResponse 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:CreateAccessPolicyResponse', createAccessPolicyResponse_accessPolicyDetail - Details about the created access policy.

$sel:httpStatus:CreateAccessPolicyResponse', createAccessPolicyResponse_httpStatus - The response's http status code.

Response Lenses

createAccessPolicyResponse_accessPolicyDetail :: Lens' CreateAccessPolicyResponse (Maybe AccessPolicyDetail) Source #

Details about the created access policy.

createAccessPolicyResponse_httpStatus :: Lens' CreateAccessPolicyResponse Int Source #

The response's http status code.