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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new version of the specified IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.

Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Requires permission to access the CreatePolicyVersion action.

Synopsis

Creating a Request

data CreatePolicyVersion Source #

The input for the CreatePolicyVersion operation.

See: newCreatePolicyVersion smart constructor.

Constructors

CreatePolicyVersion'

Fields

setAsDefault :: Maybe Bool
Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
policyName :: Text
The policy name.
policyDocument :: Text
The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.

Instances

Instances details

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

newCreatePolicyVersion Source #

Arguments

:: Text	`CreatePolicyVersion`
-> Text	`CreatePolicyVersion`
-> CreatePolicyVersion

Create a value of CreatePolicyVersion 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:setAsDefault:CreatePolicyVersion', createPolicyVersion_setAsDefault - Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

CreatePolicyVersion, createPolicyVersion_policyName - The policy name.

CreatePolicyVersion, createPolicyVersion_policyDocument - The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.

Request Lenses

createPolicyVersion_setAsDefault :: Lens' CreatePolicyVersion (Maybe Bool) Source #

Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

createPolicyVersion_policyName :: Lens' CreatePolicyVersion Text Source #

The policy name.

createPolicyVersion_policyDocument :: Lens' CreatePolicyVersion Text Source #

The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.

Destructuring the Response

data CreatePolicyVersionResponse Source #

The output of the CreatePolicyVersion operation.

See: newCreatePolicyVersionResponse smart constructor.

Constructors

CreatePolicyVersionResponse'
Fields isDefaultVersion :: Maybe Bool Specifies whether the policy version is the default. policyArn :: Maybe Text The policy ARN. policyDocument :: Maybe Text The JSON document that describes the policy. policyVersionId :: Maybe Text The policy version ID. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreatePolicyVersionResponse Source #

Arguments

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

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

CreatePolicyVersionResponse, createPolicyVersionResponse_isDefaultVersion - Specifies whether the policy version is the default.

CreatePolicyVersionResponse, createPolicyVersionResponse_policyArn - The policy ARN.

CreatePolicyVersion, createPolicyVersionResponse_policyDocument - The JSON document that describes the policy.

CreatePolicyVersionResponse, createPolicyVersionResponse_policyVersionId - The policy version ID.

$sel:httpStatus:CreatePolicyVersionResponse', createPolicyVersionResponse_httpStatus - The response's http status code.

Response Lenses

createPolicyVersionResponse_isDefaultVersion :: Lens' CreatePolicyVersionResponse (Maybe Bool) Source #

Specifies whether the policy version is the default.

createPolicyVersionResponse_policyArn :: Lens' CreatePolicyVersionResponse (Maybe Text) Source #

The policy ARN.

createPolicyVersionResponse_policyDocument :: Lens' CreatePolicyVersionResponse (Maybe Text) Source #

The JSON document that describes the policy.

createPolicyVersionResponse_policyVersionId :: Lens' CreatePolicyVersionResponse (Maybe Text) Source #

The policy version ID.

createPolicyVersionResponse_httpStatus :: Lens' CreatePolicyVersionResponse Int Source #

The response's http status code.