Interface AwsApiCallRequest
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
AwsApiCallRequest.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:36.693Z")
@Stability(Experimental)
public interface AwsApiCallRequest
extends software.amazon.jsii.JsiiSerializable
(experimental) 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 software.amazon.awscdk.integtests.*; Object parameters; AwsApiCallRequest awsApiCallRequest = AwsApiCallRequest.builder() .api("api") .service("service") // the properties below are optional .flattenResponse("flattenResponse") .parameters(parameters) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forAwsApiCallRequest
static final class
An implementation forAwsApiCallRequest
-
Method Summary
Modifier and TypeMethodDescriptionstatic AwsApiCallRequest.Builder
builder()
getApi()
(experimental) The AWS api call to make i.e.default String
(experimental) Whether or not to flatten the response from the api call.default Object
(experimental) Any parameters to pass to the api call.(experimental) The AWS service i.e.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApi
(experimental) The AWS api call to make i.e. getBucketLifecycle. -
getService
(experimental) The AWS service i.e. S3. -
getFlattenResponse
(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'
-
getParameters
(experimental) Any parameters to pass to the api call.Default: - no parameters
-
builder
- Returns:
- a
AwsApiCallRequest.Builder
ofAwsApiCallRequest
-