AwsApiCallRequest

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

Bases: object

(experimental) A AWS JavaScript SDK V2 request.

Parameters:

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

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

  • flatten_response (Optional[str]) – (experimental) Whether or not to flatten the response from the api call. Valid values are ‘true’ or ‘false’ as strings Typically when using an SdkRequest you will be passing it as the actual value to an assertion provider so this would be set to ‘false’ (you want the actual response). If you are using the SdkRequest to perform more of a query to return a single value to use, then this should be set to ‘true’. For example, you could make a StepFunctions.startExecution api call and retreive the executionArn from the response. Default: ‘false’

  • 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_request = integ_tests_alpha.AwsApiCallRequest(
    api="api",
    service="service",

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

Attributes

api

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

Stability:

experimental

flatten_response

(experimental) Whether or not to flatten the response from the api call.

Valid values are ‘true’ or ‘false’ as strings

Typically when using an SdkRequest you will be passing it as the actual value to an assertion provider so this would be set to ‘false’ (you want the actual response).

If you are using the SdkRequest to perform more of a query to return a single value to use, then this should be set to ‘true’. For example, you could make a StepFunctions.startExecution api call and retreive the executionArn from the response.

Default:

‘false’

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