Interface AwsApiCallRequest

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.693Z") @Stability(Experimental) public interface AwsApiCallRequest extends
(experimental) A AWS JavaScript SDK V2 request.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 Object parameters;
 AwsApiCallRequest awsApiCallRequest = AwsApiCallRequest.builder()
         // the properties below are optional
  • Method Details

    • getApi

      @Stability(Experimental) @NotNull String getApi()
      (experimental) The AWS api call to make i.e. getBucketLifecycle.
    • getService

      @Stability(Experimental) @NotNull String getService()
      (experimental) The AWS service i.e. S3.
    • getFlattenResponse

      @Stability(Experimental) @Nullable default 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

      @Stability(Experimental) @Nullable default Object getParameters()
      (experimental) Any parameters to pass to the api call.

      Default: - no parameters

    • builder

      @Stability(Experimental) static AwsApiCallRequest.Builder builder()
      a AwsApiCallRequest.Builder of AwsApiCallRequest