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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).

Requires permission to access the UpdateDimension action.

Synopsis

data UpdateDimension = UpdateDimension' {
- name :: Text
- stringValues :: NonEmpty Text
}
newUpdateDimension :: Text -> NonEmpty Text -> UpdateDimension
updateDimension_name :: Lens' UpdateDimension Text
updateDimension_stringValues :: Lens' UpdateDimension (NonEmpty Text)
data UpdateDimensionResponse = UpdateDimensionResponse' {
- lastModifiedDate :: Maybe POSIX
- arn :: Maybe Text
- stringValues :: Maybe (NonEmpty Text)
- name :: Maybe Text
- creationDate :: Maybe POSIX
- type' :: Maybe DimensionType
- httpStatus :: Int
}
newUpdateDimensionResponse :: Int -> UpdateDimensionResponse
updateDimensionResponse_lastModifiedDate :: Lens' UpdateDimensionResponse (Maybe UTCTime)
updateDimensionResponse_arn :: Lens' UpdateDimensionResponse (Maybe Text)
updateDimensionResponse_stringValues :: Lens' UpdateDimensionResponse (Maybe (NonEmpty Text))
updateDimensionResponse_name :: Lens' UpdateDimensionResponse (Maybe Text)
updateDimensionResponse_creationDate :: Lens' UpdateDimensionResponse (Maybe UTCTime)
updateDimensionResponse_type :: Lens' UpdateDimensionResponse (Maybe DimensionType)
updateDimensionResponse_httpStatus :: Lens' UpdateDimensionResponse Int

Creating a Request

data UpdateDimension Source #

See: newUpdateDimension smart constructor.

Constructors

UpdateDimension'
Fields 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. 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/#").

Instances

Instances details

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

newUpdateDimension Source #

Arguments

:: Text	`$sel:name:UpdateDimension'`
-> NonEmpty Text	`$sel:stringValues:UpdateDimension'`
-> UpdateDimension

Create a value of UpdateDimension 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:name:UpdateDimension', updateDimension_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:stringValues:UpdateDimension', updateDimension_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/#").

Request Lenses

updateDimension_name :: Lens' UpdateDimension 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.

updateDimension_stringValues :: Lens' UpdateDimension (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/#").

Destructuring the Response

data UpdateDimensionResponse Source #

See: newUpdateDimensionResponse smart constructor.

Constructors

UpdateDimensionResponse'

Fields

lastModifiedDate :: Maybe POSIX
The date and time, in milliseconds since epoch, when the dimension was most recently updated.
arn :: Maybe Text
The Amazon Resource Name (ARN)of the created dimension.
stringValues :: Maybe (NonEmpty Text)
The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.
name :: Maybe Text
A unique identifier for the dimension.
creationDate :: Maybe POSIX
The date and time, in milliseconds since epoch, when the dimension was initially created.
type' :: Maybe DimensionType
The type of the dimension.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newUpdateDimensionResponse Source #

Arguments

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

Create a value of UpdateDimensionResponse 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:lastModifiedDate:UpdateDimensionResponse', updateDimensionResponse_lastModifiedDate - The date and time, in milliseconds since epoch, when the dimension was most recently updated.

$sel:arn:UpdateDimensionResponse', updateDimensionResponse_arn - The Amazon Resource Name (ARN)of the created dimension.

$sel:stringValues:UpdateDimension', updateDimensionResponse_stringValues - The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

$sel:name:UpdateDimension', updateDimensionResponse_name - A unique identifier for the dimension.

$sel:creationDate:UpdateDimensionResponse', updateDimensionResponse_creationDate - The date and time, in milliseconds since epoch, when the dimension was initially created.

$sel:type':UpdateDimensionResponse', updateDimensionResponse_type - The type of the dimension.

$sel:httpStatus:UpdateDimensionResponse', updateDimensionResponse_httpStatus - The response's http status code.

Response Lenses

updateDimensionResponse_lastModifiedDate :: Lens' UpdateDimensionResponse (Maybe UTCTime) Source #

The date and time, in milliseconds since epoch, when the dimension was most recently updated.

updateDimensionResponse_arn :: Lens' UpdateDimensionResponse (Maybe Text) Source #

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

updateDimensionResponse_stringValues :: Lens' UpdateDimensionResponse (Maybe (NonEmpty Text)) Source #

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

updateDimensionResponse_name :: Lens' UpdateDimensionResponse (Maybe Text) Source #

A unique identifier for the dimension.

updateDimensionResponse_creationDate :: Lens' UpdateDimensionResponse (Maybe UTCTime) Source #

The date and time, in milliseconds since epoch, when the dimension was initially created.

updateDimensionResponse_type :: Lens' UpdateDimensionResponse (Maybe DimensionType) Source #

The type of the dimension.

updateDimensionResponse_httpStatus :: Lens' UpdateDimensionResponse Int Source #

The response's http status code.