Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoT.CreateDimension

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

Requires permission to access the CreateDimension action.

Synopsis

data CreateDimension = CreateDimension' {
- tags :: Maybe [Tag]
- name :: Text
- type' :: DimensionType
- stringValues :: NonEmpty Text
- clientRequestToken :: Text
}
newCreateDimension :: Text -> DimensionType -> NonEmpty Text -> Text -> CreateDimension
createDimension_tags :: Lens' CreateDimension (Maybe [Tag])
createDimension_name :: Lens' CreateDimension Text
createDimension_type :: Lens' CreateDimension DimensionType
createDimension_stringValues :: Lens' CreateDimension (NonEmpty Text)
createDimension_clientRequestToken :: Lens' CreateDimension Text
data CreateDimensionResponse = CreateDimensionResponse' {
- arn :: Maybe Text
- name :: Maybe Text
- httpStatus :: Int
}
newCreateDimensionResponse :: Int -> CreateDimensionResponse
createDimensionResponse_arn :: Lens' CreateDimensionResponse (Maybe Text)
createDimensionResponse_name :: Lens' CreateDimensionResponse (Maybe Text)
createDimensionResponse_httpStatus :: Lens' CreateDimensionResponse Int

Creating a Request

data CreateDimension Source #

See: newCreateDimension smart constructor.

Constructors

CreateDimension'

Fields

tags :: Maybe [Tag]
Metadata that can be used to manage the dimension.
name :: Text
A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.
type' :: DimensionType
Specifies the type of dimension. Supported types: TOPIC_FILTER.
stringValues :: NonEmpty Text
Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").
clientRequestToken :: Text
Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

Instances

Instances details

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

newCreateDimension Source #

Arguments

:: Text	`$sel:name:CreateDimension'`
-> DimensionType	`$sel:type':CreateDimension'`
-> NonEmpty Text	`$sel:stringValues:CreateDimension'`
-> Text	`$sel:clientRequestToken:CreateDimension'`
-> CreateDimension

Create a value of CreateDimension 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:CreateDimension', createDimension_tags - Metadata that can be used to manage the dimension.

$sel:name:CreateDimension', createDimension_name - A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

$sel:type':CreateDimension', createDimension_type - Specifies the type of dimension. Supported types: TOPIC_FILTER.

$sel:stringValues:CreateDimension', createDimension_stringValues - Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

$sel:clientRequestToken:CreateDimension', createDimension_clientRequestToken - Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

Request Lenses

createDimension_tags :: Lens' CreateDimension (Maybe [Tag]) Source #

Metadata that can be used to manage the dimension.

createDimension_name :: Lens' CreateDimension Text Source #

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

createDimension_type :: Lens' CreateDimension DimensionType Source #

Specifies the type of dimension. Supported types: TOPIC_FILTER.

createDimension_stringValues :: Lens' CreateDimension (NonEmpty Text) Source #

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

createDimension_clientRequestToken :: Lens' CreateDimension Text Source #

Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

Destructuring the Response

data CreateDimensionResponse Source #

See: newCreateDimensionResponse smart constructor.

Constructors

CreateDimensionResponse'
Fields arn :: Maybe Text The Amazon Resource Name (ARN) of the created dimension. name :: Maybe Text A unique identifier for the dimension. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateDimensionResponse Source #

Arguments

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

Create a value of CreateDimensionResponse 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:arn:CreateDimensionResponse', createDimensionResponse_arn - The Amazon Resource Name (ARN) of the created dimension.

$sel:name:CreateDimension', createDimensionResponse_name - A unique identifier for the dimension.

$sel:httpStatus:CreateDimensionResponse', createDimensionResponse_httpStatus - The response's http status code.

Response Lenses

createDimensionResponse_arn :: Lens' CreateDimensionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the created dimension.

createDimensionResponse_name :: Lens' CreateDimensionResponse (Maybe Text) Source #

A unique identifier for the dimension.

createDimensionResponse_httpStatus :: Lens' CreateDimensionResponse Int Source #

The response's http status code.