> **Experimental**
>
> `@aws-cdk/integ-tests-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump.
# AwsApiCallRequest

A AWS JavaScript SDK V2 request.

- Stability: [Experimental](/cdk/api/stability.html)
- Source: [`lib/assertions/providers/lambda-handler/types.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0-alpha.0/packages/@aws-cdk/integ-tests-alpha/lib/assertions/providers/lambda-handler/types.ts#L124)

## Example

```ts
// 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

- `api`: string (required) — The AWS api call to make i.e. getBucketLifecycle.

- `flattenResponse`: string = 'false' — 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 retrieve the
  `executionArn` from the response.

- `outputPaths`: string[] — Restrict the data returned by the API call to specific paths in the API response.

  **Default:** return all data

  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.

- `parameters`: any — Any parameters to pass to the api call.

  **Default:** no parameters

- `service`: string (required) — The AWS service i.e. S3.