URLEncodingFormat

class aws_cdk.aws_stepfunctions_tasks.URLEncodingFormat(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The style used when applying URL encoding to array values.

ExampleMetadata:: infused

Example:

import aws_cdk.aws_events as events


connection = events.Connection(self, "Connection",
    authorization=events.Authorization.basic("username", SecretValue.unsafe_plain_text("password"))
)

tasks.HttpInvoke(self, "Invoke HTTP API",
    api_root="https://api.example.com",
    api_endpoint=sfn.TaskInput.from_text("path/to/resource"),
    body=sfn.TaskInput.from_object({"foo": "bar"}),
    connection=connection,
    headers=sfn.TaskInput.from_object({"Content-Type": "application/json"}),
    method=sfn.TaskInput.from_text("POST"),
    query_string_parameters=sfn.TaskInput.from_object({"id": "123"}),
    url_encoding_format=tasks.URLEncodingFormat.BRACKETS
)

Attributes

BRACKETS

Encode arrays using brackets.

For example, {‘array’: [‘a’,’b’,’c’]} encodes to ‘array[]=a&array[]=b&array[]=c’

COMMAS

Encode arrays using commas.

For example, {‘array’: [‘a’,’b’,’c’]} encodes to ‘array=a,b,c,d’

DEFAULT: Apply the default URL encoding style (INDICES).

INDICES

Encode arrays using the index value.

For example, {‘array’: [‘a’,’b’,’c’]} encodes to ‘array[0]=a&array[1]=b&array[2]=c’

NONE: Do not apply URL encoding.

REPEAT

Repeat key for each item in the array.

For example, {‘array’: [‘a’,’b’,’c’]} encodes to ‘array[]=a&array[]=b&array[]=c’