AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoT::Types::HttpAction

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing HttpAction as input to an Aws::Client method, you can use a vanilla Hash:

{
  url: "Url", # required
  confirmation_url: "Url",
  headers: [
    {
      key: "HeaderKey", # required
      value: "HeaderValue", # required
    },
  ],
  auth: {
    sigv4: {
      signing_region: "SigningRegion", # required
      service_name: "ServiceName", # required
      role_arn: "AwsArn", # required
    },
  },
}

Send data to an HTTPS endpoint.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#authTypes::HttpAuthorization

The authentication method to use when sending data to an HTTPS endpoint.

Returns:

#confirmation_urlString

The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.

Returns:

  • (String)

    The URL to which AWS IoT sends a confirmation message.

#headersArray<Types::HttpActionHeader>

The HTTP headers to send with the message data.

Returns:

#urlString

The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl. If this is a new destination, a new TopicRuleDestination is created if possible.

Returns:

  • (String)

    The endpoint URL.