CallApiGatewayHttpApiEndpointProps¶
-
class
aws_cdk.aws_stepfunctions_tasks.
CallApiGatewayHttpApiEndpointProps
(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, result_selector=None, timeout=None, method, api_path=None, auth_type=None, headers=None, query_parameters=None, request_body=None, api_id, api_stack, stage_name=None)¶ Bases:
aws_cdk.aws_stepfunctions_tasks.CallApiGatewayEndpointBaseProps
Properties for calling an HTTP API Endpoint.
- Parameters
comment (
Optional
[str
]) – An optional description for this state. Default: - No commentheartbeat (
Optional
[Duration
]) – Timeout for the heartbeat. Default: - Noneinput_path (
Optional
[str
]) – JSONPath expression to select part of the state to be the input to this state. May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}. Default: - The entire task input (JSON path ‘$’)integration_pattern (
Optional
[IntegrationPattern
]) – AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns Default: -IntegrationPattern.REQUEST_RESPONSE
for most tasks.IntegrationPattern.RUN_JOB
for the following exceptions:BatchSubmitJob
,EmrAddStep
,EmrCreateCluster
,EmrTerminationCluster
, andEmrContainersStartJobRun
.output_path (
Optional
[str
]) – JSONPath expression to select select a portion of the state output to pass to the next state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}. Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path ‘$’)result_path (
Optional
[str
]) – JSONPath expression to indicate where to inject the state’s output. May also be the special value JsonPath.DISCARD, which will cause the state’s input to become its output. Default: - Replaces the entire input with the result (JSON path ‘$’)result_selector (
Optional
[Mapping
[str
,Any
]]) – The JSON that will replace the state’s raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state’s raw result. Default: - Nonetimeout (
Optional
[Duration
]) – Timeout for the state machine. Default: - Nonemethod (
HttpMethod
) – Http method for the API.api_path (
Optional
[str
]) – Path parameters appended after API endpoint. Default: - No pathauth_type (
Optional
[AuthType
]) – Authentication methods. Default: AuthType.NO_AUTHheaders (
Optional
[TaskInput
]) – HTTP request information that does not relate to contents of the request. Default: - No headersquery_parameters (
Optional
[TaskInput
]) – Query strings attatched to end of request. Default: - No query parametersrequest_body (
Optional
[TaskInput
]) – HTTP Request body. Default: - No request bodyapi_id (
str
) – The Id of the API to call.api_stack (
Stack
) – The Stack in which the API is defined.stage_name (
Optional
[str
]) – Name of the stage where the API is deployed to in API Gateway. Default: ‘$default’
- ExampleMetadata
infused
Example:
import aws_cdk.aws_apigatewayv2 as apigatewayv2 http_api = apigatewayv2.HttpApi(self, "MyHttpApi") invoke_task = tasks.CallApiGatewayHttpApiEndpoint(self, "Call HTTP API", api_id=http_api.api_id, api_stack=Stack.of(http_api), method=tasks.HttpMethod.GET )
Attributes
-
api_id
¶ The Id of the API to call.
- Return type
str
-
api_path
¶ Path parameters appended after API endpoint.
- Default
No path
- Return type
Optional
[str
]
-
comment
¶ An optional description for this state.
- Default
No comment
- Return type
Optional
[str
]
-
headers
¶ HTTP request information that does not relate to contents of the request.
- Default
No headers
- Return type
Optional
[TaskInput
]
-
input_path
¶ JSONPath expression to select part of the state to be the input to this state.
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
- Default
The entire task input (JSON path ‘$’)
- Return type
Optional
[str
]
-
integration_pattern
¶ AWS Step Functions integrates with services directly in the Amazon States Language.
You can control these AWS services using service integration patterns
- Default
IntegrationPattern.REQUEST_RESPONSE
for most tasks.
IntegrationPattern.RUN_JOB
for the following exceptions:BatchSubmitJob
,EmrAddStep
,EmrCreateCluster
,EmrTerminationCluster
, andEmrContainersStartJobRun
.
-
method
¶ Http method for the API.
- Return type
-
output_path
¶ JSONPath expression to select select a portion of the state output to pass to the next state.
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
- Default
The entire JSON node determined by the state input, the task result,
and resultPath is passed to the next state (JSON path ‘$’)
- Return type
Optional
[str
]
-
query_parameters
¶ Query strings attatched to end of request.
- Default
No query parameters
- Return type
Optional
[TaskInput
]
-
result_path
¶ JSONPath expression to indicate where to inject the state’s output.
May also be the special value JsonPath.DISCARD, which will cause the state’s input to become its output.
- Default
Replaces the entire input with the result (JSON path ‘$’)
- Return type
Optional
[str
]
-
result_selector
¶ The JSON that will replace the state’s raw result and become the effective result before ResultPath is applied.
You can use ResultSelector to create a payload with values that are static or selected from the state’s raw result.
- Default
None
- See
- Return type
Optional
[Mapping
[str
,Any
]]
-
stage_name
¶ Name of the stage where the API is deployed to in API Gateway.
- Default
‘$default’
- Return type
Optional
[str
]