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.IoT.CreatePolicy

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an IoT policy.

The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.

Requires permission to access the CreatePolicy action.

Synopsis

data CreatePolicy = CreatePolicy' {
- tags :: Maybe [Tag]
- policyName :: Text
- policyDocument :: Text
}
newCreatePolicy :: Text -> Text -> CreatePolicy
createPolicy_tags :: Lens' CreatePolicy (Maybe [Tag])
createPolicy_policyName :: Lens' CreatePolicy Text
createPolicy_policyDocument :: Lens' CreatePolicy Text
data CreatePolicyResponse = CreatePolicyResponse' {
- policyArn :: Maybe Text
- policyDocument :: Maybe Text
- policyName :: Maybe Text
- policyVersionId :: Maybe Text
- httpStatus :: Int
}
newCreatePolicyResponse :: Int -> CreatePolicyResponse
createPolicyResponse_policyArn :: Lens' CreatePolicyResponse (Maybe Text)
createPolicyResponse_policyDocument :: Lens' CreatePolicyResponse (Maybe Text)
createPolicyResponse_policyName :: Lens' CreatePolicyResponse (Maybe Text)
createPolicyResponse_policyVersionId :: Lens' CreatePolicyResponse (Maybe Text)
createPolicyResponse_httpStatus :: Lens' CreatePolicyResponse Int

Creating a Request

data CreatePolicy Source #

The input for the CreatePolicy operation.

See: newCreatePolicy smart constructor.

Constructors

CreatePolicy'

Fields

tags :: Maybe [Tag]
Metadata which can be used to manage the policy.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
policyName :: Text
The policy name.
policyDocument :: Text
The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.

Instances

Instances details

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

newCreatePolicy Source #

Arguments

:: Text	`CreatePolicy`
-> Text	`CreatePolicy`
-> CreatePolicy

Create a value of CreatePolicy 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:tags:CreatePolicy', createPolicy_tags - Metadata which can be used to manage the policy.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

CreatePolicy, createPolicy_policyName - The policy name.

CreatePolicy, createPolicy_policyDocument - The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.

Request Lenses

createPolicy_tags :: Lens' CreatePolicy (Maybe [Tag]) Source #

Metadata which can be used to manage the policy.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

createPolicy_policyName :: Lens' CreatePolicy Text Source #

The policy name.

createPolicy_policyDocument :: Lens' CreatePolicy Text Source #

The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.

Destructuring the Response

data CreatePolicyResponse Source #

The output from the CreatePolicy operation.

See: newCreatePolicyResponse smart constructor.

Constructors

CreatePolicyResponse'
Fields policyArn :: Maybe Text The policy ARN. policyDocument :: Maybe Text The JSON document that describes the policy. policyName :: Maybe Text The policy name. policyVersionId :: Maybe Text The policy version ID. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreatePolicyResponse Source #
Instance details Defined in Amazonka.IoT.CreatePolicy Associated Types type Rep CreatePolicyResponse :: Type -> Type # Methods from :: CreatePolicyResponse -> Rep CreatePolicyResponse x # to :: Rep CreatePolicyResponse x -> CreatePolicyResponse #
Read CreatePolicyResponse Source #
Instance details Defined in Amazonka.IoT.CreatePolicy Methods readsPrec :: Int -> ReadS CreatePolicyResponse # readList :: ReadS [CreatePolicyResponse] # readPrec :: ReadPrec CreatePolicyResponse # readListPrec :: ReadPrec [CreatePolicyResponse] #
Show CreatePolicyResponse Source #
Instance details Defined in Amazonka.IoT.CreatePolicy Methods showsPrec :: Int -> CreatePolicyResponse -> ShowS # show :: CreatePolicyResponse -> String # showList :: [CreatePolicyResponse] -> ShowS #
NFData CreatePolicyResponse Source #
Instance details Defined in Amazonka.IoT.CreatePolicy Methods rnf :: CreatePolicyResponse -> () #
Eq CreatePolicyResponse Source #
Instance details Defined in Amazonka.IoT.CreatePolicy Methods (==) :: CreatePolicyResponse -> CreatePolicyResponse -> Bool # (/=) :: CreatePolicyResponse -> CreatePolicyResponse -> Bool #
type Rep CreatePolicyResponse Source #
Instance details Defined in Amazonka.IoT.CreatePolicy type Rep CreatePolicyResponse = D1 ('MetaData "CreatePolicyResponse" "Amazonka.IoT.CreatePolicy" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreatePolicyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "policyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "policyDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "policyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "policyVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))