Skip to content

HttpAction

Source code in docs_src/capo_iot/types/http_action.py
class HttpAction(TypedDict, closed=True):
    url: "capo_iot.types.url.Url"
    """<p>The endpoint URL. If substitution templates are used in the URL, you must also specify a <code>confirmationUrl</code>. If this is a new destination, a new <code>TopicRuleDestination</code> is created if possible.</p>"""
    confirmation_url: NotRequired["capo_iot.types.url.Url"]
    """<p>The URL to which 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 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.</p>"""
    headers: NotRequired["capo_iot.types.header_list.HeaderList"]
    """<p>The HTTP headers to send with the message data.</p>"""
    auth: NotRequired["capo_iot.types.http_authorization.HttpAuthorization"]
    """<p>The authentication method to use when sending data to an HTTPS endpoint.</p>"""
    enable_batching: NotRequired["capo_iot.types.enable_batching.EnableBatching"]
    """<p>Whether to process the HTTP action messages into a single request. Value can be true or false.</p>"""
    batch_config: NotRequired["capo_iot.types.batch_config.BatchConfig"]
    """<p>The configuration settings for batching. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/http_batching.html"> Batching HTTP action messages</a>.</p>"""

auth instance-attribute

auth: NotRequired[HttpAuthorization]

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

batch_config instance-attribute

batch_config: NotRequired[BatchConfig]

The configuration settings for batching. For more information, see Batching HTTP action messages.

confirmation_url instance-attribute

confirmation_url: NotRequired[Url]

The URL to which 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 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.

enable_batching instance-attribute

enable_batching: NotRequired[EnableBatching]

Whether to process the HTTP action messages into a single request. Value can be true or false.

headers instance-attribute

headers: NotRequired[HeaderList]

The HTTP headers to send with the message data.

url instance-attribute

url: Url

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.