interface AwsApiCallRequest
Language | Type name |
---|---|
.NET | Amazon.CDK.IntegTests.Alpha.AwsApiCallRequest |
Go | github.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2#AwsApiCallRequest |
Java | software.amazon.awscdk.integtests.alpha.AwsApiCallRequest |
Python | aws_cdk.integ_tests_alpha.AwsApiCallRequest |
TypeScript (source) | @aws-cdk/integ-tests-alpha ยป AwsApiCallRequest |
A AWS JavaScript SDK V2 request.
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
Name | Type | Description |
---|---|---|
api | string | The AWS api call to make i.e. getBucketLifecycle. |
service | string | The AWS service i.e. S3. |
flatten | string | Whether or not to flatten the response from the api call. |
output | 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 AWS api call to make i.e. getBucketLifecycle.
service
Type:
string
The AWS service i.e. S3.
flattenResponse?
Type:
string
(optional, default: '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 retreive the
executionArn
from the response.
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.