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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a role alias.

Requires permission to access the CreateRoleAlias action.

Synopsis

data CreateRoleAlias = CreateRoleAlias' {
- credentialDurationSeconds :: Maybe Natural
- tags :: Maybe [Tag]
- roleAlias :: Text
- roleArn :: Text
}
newCreateRoleAlias :: Text -> Text -> CreateRoleAlias
createRoleAlias_credentialDurationSeconds :: Lens' CreateRoleAlias (Maybe Natural)
createRoleAlias_tags :: Lens' CreateRoleAlias (Maybe [Tag])
createRoleAlias_roleAlias :: Lens' CreateRoleAlias Text
createRoleAlias_roleArn :: Lens' CreateRoleAlias Text
data CreateRoleAliasResponse = CreateRoleAliasResponse' {
- roleAlias :: Maybe Text
- roleAliasArn :: Maybe Text
- httpStatus :: Int
}
newCreateRoleAliasResponse :: Int -> CreateRoleAliasResponse
createRoleAliasResponse_roleAlias :: Lens' CreateRoleAliasResponse (Maybe Text)
createRoleAliasResponse_roleAliasArn :: Lens' CreateRoleAliasResponse (Maybe Text)
createRoleAliasResponse_httpStatus :: Lens' CreateRoleAliasResponse Int

Creating a Request

data CreateRoleAlias Source #

See: newCreateRoleAlias smart constructor.

Constructors

CreateRoleAlias'

Fields

credentialDurationSeconds :: Maybe Natural
How long (in seconds) the credentials will be valid. The default value is 3,600 seconds.
This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.
tags :: Maybe [Tag]
Metadata which can be used to manage the role alias.
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..."
roleAlias :: Text
The role alias that points to a role ARN. This allows you to change the role without having to update the device.
roleArn :: Text
The role ARN.

Instances

Instances details

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

newCreateRoleAlias Source #

Arguments

:: Text	`CreateRoleAlias`
-> Text	`CreateRoleAlias`
-> CreateRoleAlias

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

CreateRoleAlias, createRoleAlias_credentialDurationSeconds - How long (in seconds) the credentials will be valid. The default value is 3,600 seconds.

This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.

$sel:tags:CreateRoleAlias', createRoleAlias_tags - Metadata which can be used to manage the role alias.

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

CreateRoleAlias, createRoleAlias_roleAlias - The role alias that points to a role ARN. This allows you to change the role without having to update the device.

CreateRoleAlias, createRoleAlias_roleArn - The role ARN.

Request Lenses

createRoleAlias_credentialDurationSeconds :: Lens' CreateRoleAlias (Maybe Natural) Source #

How long (in seconds) the credentials will be valid. The default value is 3,600 seconds.

This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.

createRoleAlias_tags :: Lens' CreateRoleAlias (Maybe [Tag]) Source #

Metadata which can be used to manage the role alias.

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

createRoleAlias_roleAlias :: Lens' CreateRoleAlias Text Source #

The role alias that points to a role ARN. This allows you to change the role without having to update the device.

createRoleAlias_roleArn :: Lens' CreateRoleAlias Text Source #

The role ARN.

Destructuring the Response

data CreateRoleAliasResponse Source #

See: newCreateRoleAliasResponse smart constructor.

Constructors

CreateRoleAliasResponse'
Fields roleAlias :: Maybe Text The role alias. roleAliasArn :: Maybe Text The role alias ARN. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateRoleAliasResponse Source #

Arguments

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

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

CreateRoleAlias, createRoleAliasResponse_roleAlias - The role alias.

CreateRoleAliasResponse, createRoleAliasResponse_roleAliasArn - The role alias ARN.

$sel:httpStatus:CreateRoleAliasResponse', createRoleAliasResponse_httpStatus - The response's http status code.

Response Lenses

createRoleAliasResponse_roleAlias :: Lens' CreateRoleAliasResponse (Maybe Text) Source #

The role alias.

createRoleAliasResponse_roleAliasArn :: Lens' CreateRoleAliasResponse (Maybe Text) Source #

The role alias ARN.

createRoleAliasResponse_httpStatus :: Lens' CreateRoleAliasResponse Int Source #

The response's http status code.