AwsApiInput¶

class aws_cdk.aws_events_targets.AwsApiInput(*, action, service, api_version=None, catch_error_pattern=None, parameters=None)¶

Bases: object

Rule target input for an AwsApi target.

Parameters

action (str) – The service action to call.
service (str) – The service to call.
api_version (Optional[str]) – API version to use for the service. Default: - use latest available API version
catch_error_pattern (Optional[str]) – The regex pattern to use to catch API errors. The code property of the Error object will be tested against this pattern. If there is a match an error will not be thrown. Default: - do not catch errors
parameters (Optional[Any]) – The parameters for the service action. Default: - no parameters

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_events_targets as events_targets

# parameters: Any

aws_api_input = events_targets.AwsApiInput(
    action="action",
    service="service",

    # the properties below are optional
    api_version="apiVersion",
    catch_error_pattern="catchErrorPattern",
    parameters=parameters
)

Attributes

action¶

The service action to call.

See: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html
Return type: str

api_version¶

API version to use for the service.

Default

use latest available API version

See

https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/locking-api-versions.html

Return type

Optional[str]

catch_error_pattern¶

The regex pattern to use to catch API errors.

The code property of the Error object will be tested against this pattern. If there is a match an error will not be thrown.

Default

do not catch errors

Return type

Optional[str]

parameters¶

The parameters for the service action.

Default

no parameters

See

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html

Return type

Any

service¶

The service to call.

See: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html
Return type: str