@aws-cdk/integ-tests-alpha.AwsApiCallRequest

Experimental

@aws-cdk/integ-tests-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

AwsApiCallRequest Struct

A AWS JavaScript SDK V2 request.

Stability

Experimental

Source

lib/assertions/providers/lambda-handler/types.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as integ_tests_alpha from '@aws-cdk/integ-tests-alpha';

declare const parameters: any;
const awsApiCallRequest: integ_tests_alpha.AwsApiCallRequest = {
  api: 'api',
  service: 'service',

  // the properties below are optional
  flattenResponse: 'flattenResponse',
  outputPaths: ['outputPaths'],
  parameters: parameters,
};

Properties

apistringapistrapiStringApistringApi*stringrequired#

The AWS api call to make i.e. getBucketLifecycle.

flattenResponsestringflatten_responsestrflattenResponseStringFlattenResponsestringFlattenResponse*string= 'false'#

Whether or not to flatten the response from the api call.

notes

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 retrieve the executionArn from the response.

outputPathsstring[]output_pathstyping.List[str]outputPathsList<String>OutputPathsstring[]OutputPaths*[]*string= return all data#

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.

parametersanyparametersAnyparametersObjectParametersobjectParametersinterface{}= no parameters#

Any parameters to pass to the api call.

servicestringservicestrserviceStringServicestringService*stringrequired#

The AWS service i.e. S3.