amazonka-iotwireless-2.0: Amazon IoT Wireless SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoTWireless.CreateDestination

Description

Creates a new destination that maps a device message to an AWS IoT rule.

Synopsis

Creating a Request

data CreateDestination Source #

See: newCreateDestination smart constructor.

Constructors

CreateDestination' 

Fields

  • clientRequestToken :: Maybe Text

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

  • description :: Maybe Text

    The description of the new resource.

  • tags :: Maybe [Tag]

    The tags to attach to the new destination. Tags are metadata that you can use to manage a resource.

  • name :: Text

    The name of the new resource.

  • expressionType :: ExpressionType

    The type of value in Expression.

  • expression :: Text

    The rule name or topic rule to send messages to.

  • roleArn :: Text

    The ARN of the IAM Role that authorizes the destination.

Instances

Instances details
ToJSON CreateDestination Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

ToHeaders CreateDestination Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

ToPath CreateDestination Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

ToQuery CreateDestination Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

AWSRequest CreateDestination Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

Associated Types

type AWSResponse CreateDestination #

Generic CreateDestination Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

Associated Types

type Rep CreateDestination :: Type -> Type #

Read CreateDestination Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

Show CreateDestination Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

NFData CreateDestination Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

Methods

rnf :: CreateDestination -> () #

Eq CreateDestination Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

Hashable CreateDestination Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

type AWSResponse CreateDestination Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

type Rep CreateDestination Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

type Rep CreateDestination = D1 ('MetaData "CreateDestination" "Amazonka.IoTWireless.CreateDestination" "amazonka-iotwireless-2.0-Dzx6Wen5AK9DyNP5TQU7zN" 'False) (C1 ('MetaCons "CreateDestination'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "expressionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExpressionType)) :*: (S1 ('MetaSel ('Just "expression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateDestination Source #

Create a value of CreateDestination 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:clientRequestToken:CreateDestination', createDestination_clientRequestToken - Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

CreateDestination, createDestination_description - The description of the new resource.

$sel:tags:CreateDestination', createDestination_tags - The tags to attach to the new destination. Tags are metadata that you can use to manage a resource.

CreateDestination, createDestination_name - The name of the new resource.

CreateDestination, createDestination_expressionType - The type of value in Expression.

CreateDestination, createDestination_expression - The rule name or topic rule to send messages to.

CreateDestination, createDestination_roleArn - The ARN of the IAM Role that authorizes the destination.

Request Lenses

createDestination_clientRequestToken :: Lens' CreateDestination (Maybe Text) Source #

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

createDestination_description :: Lens' CreateDestination (Maybe Text) Source #

The description of the new resource.

createDestination_tags :: Lens' CreateDestination (Maybe [Tag]) Source #

The tags to attach to the new destination. Tags are metadata that you can use to manage a resource.

createDestination_name :: Lens' CreateDestination Text Source #

The name of the new resource.

createDestination_expression :: Lens' CreateDestination Text Source #

The rule name or topic rule to send messages to.

createDestination_roleArn :: Lens' CreateDestination Text Source #

The ARN of the IAM Role that authorizes the destination.

Destructuring the Response

data CreateDestinationResponse Source #

See: newCreateDestinationResponse smart constructor.

Constructors

CreateDestinationResponse' 

Fields

Instances

Instances details
Generic CreateDestinationResponse Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

Associated Types

type Rep CreateDestinationResponse :: Type -> Type #

Read CreateDestinationResponse Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

Show CreateDestinationResponse Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

NFData CreateDestinationResponse Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

Eq CreateDestinationResponse Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

type Rep CreateDestinationResponse Source # 
Instance details

Defined in Amazonka.IoTWireless.CreateDestination

type Rep CreateDestinationResponse = D1 ('MetaData "CreateDestinationResponse" "Amazonka.IoTWireless.CreateDestination" "amazonka-iotwireless-2.0-Dzx6Wen5AK9DyNP5TQU7zN" 'False) (C1 ('MetaCons "CreateDestinationResponse'" '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))))

newCreateDestinationResponse Source #

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

CreateDestinationResponse, createDestinationResponse_arn - The Amazon Resource Name of the new resource.

CreateDestination, createDestinationResponse_name - The name of the new resource.

$sel:httpStatus:CreateDestinationResponse', createDestinationResponse_httpStatus - The response's http status code.

Response Lenses

createDestinationResponse_arn :: Lens' CreateDestinationResponse (Maybe Text) Source #

The Amazon Resource Name of the new resource.