AwsApiInput

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

Bases: object

__init__(*, action, service, api_version=None, catch_error_pattern=None, parameters=None)

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

Attributes

action

The service action to call.

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

Return type

str

api_version

API version to use for the service.

default :default: - use latest available API version

see :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 :default: - do not catch errors

Return type

Optional[str]

parameters

The parameters for the service action.

default :default: - no parameters

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

Return type

Any

service

The service to call.

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

Return type

str