software.amazon.awscdk.integtests

Interface AwsApiCallRequest

All Known Implementing Classes:

AwsApiCallRequest.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:26.424Z")
public interface AwsApiCallRequest

(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

Nested Classes

Modifier and Type	Interface and Description
static class	AwsApiCallRequest.Builder A builder for AwsApiCallRequest
static class	AwsApiCallRequest.Jsii$Proxy An implementation for AwsApiCallRequest

Method Summary

Modifier and Type	Method and Description
static AwsApiCallRequest.Builder	builder()
java.lang.String	getApi() (experimental) The AWS api call to make i.e.
default java.lang.String	getFlattenResponse() (experimental) Whether or not to flatten the response from the api call.
default java.lang.Object	getParameters() (experimental) Any parameters to pass to the api call.
java.lang.String	getService() (experimental) The AWS service i.e.

Method Detail

getApi

java.lang.String getApi()

(experimental) The AWS api call to make i.e. getBucketLifecycle.

getService

java.lang.String getService()

(experimental) The AWS service i.e. S3.

getFlattenResponse

default java.lang.String 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

default java.lang.Object getParameters()

(experimental) Any parameters to pass to the api call.

Default: - no parameters

builder

static AwsApiCallRequest.Builder builder()

Returns:

a AwsApiCallRequest.Builder of AwsApiCallRequest