AwsApiCallOptions

class aws_cdk.integ_tests_alpha.AwsApiCallOptions(*, api, service, output_paths=None, parameters=None)

Bases: object

(experimental) Options to perform an AWS JavaScript V2 API call.

Parameters:

  • api (str) – (experimental) The api call to make, i.e. getBucketLifecycle.

  • service (str) – (experimental) The AWS service, i.e. S3.

  • output_paths (Optional[Sequence[str]]) – (experimental) Restrict the data returned by the API call to specific paths in the API response. Use this to limit the data returned by the custom resource if working with API calls that could potentially result in custom response objects exceeding the hard limit of 4096 bytes. Default: - return all data

  • parameters (Optional[Any]) – (experimental) Any parameters to pass to the api call. Default: - no parameters

Stability:

experimental

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.integ_tests_alpha as integ_tests_alpha

# parameters: Any

aws_api_call_options = integ_tests_alpha.AwsApiCallOptions(
    api="api",
    service="service",

    # the properties below are optional
    output_paths=["outputPaths"],
    parameters=parameters
)

Attributes

api

(experimental) The api call to make, i.e. getBucketLifecycle.

Stability:

experimental

output_paths

(experimental) Restrict the data returned by the API call to specific paths in the API response.

Use this to limit the data returned by the custom resource if working with API calls that could potentially result in custom response objects exceeding the hard limit of 4096 bytes.

Default:

  • return all data

Stability:

experimental

parameters

(experimental) Any parameters to pass to the api call.

Default:

  • no parameters

Stability:

experimental

service

(experimental) The AWS service, i.e. S3.

Stability:

experimental