interface AwsApiCallOptions 🔹

Language	Type name
.NET	Amazon.CDK.IntegTests.Alpha.AwsApiCallOptions
Go	github.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2#AwsApiCallOptions
Java	software.amazon.awscdk.integtests.alpha.AwsApiCallOptions
Python	aws_cdk.integ_tests_alpha.AwsApiCallOptions
TypeScript (source)	@aws-cdk/integ-tests-alpha » AwsApiCallOptions

Options to perform an AWS JavaScript V2 API call.

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 awsApiCallOptions: integ_tests_alpha.AwsApiCallOptions = {
  api: 'api',
  service: 'service',

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

Properties

Name	Type	Description
api🔹	string	The api call to make, i.e. getBucketLifecycle.
service🔹	string	The AWS service, i.e. S3.
outputPaths?🔹	string[]	Restrict the data returned by the API call to specific paths in the API response.
parameters?🔹	any	Any parameters to pass to the api call.

---

api🔹

Type: string

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

---

service🔹

Type: string

The AWS service, i.e. S3.

---

outputPaths?🔹

Type: string[] (optional, default: 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.

---

parameters?🔹

Type: any (optional, default: no parameters)

Any parameters to pass to the api call.