Interface IAwsApiCallRequest
(experimental) A AWS JavaScript SDK V2 request.
Namespace: Amazon.CDK.IntegTests
Assembly: Amazon.CDK.IntegTests.dll
Syntax (csharp)
public interface IAwsApiCallRequest
Syntax (vb)
Public Interface IAwsApiCallRequest
Remarks
Stability: Experimental
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.IntegTests;
var parameters;
var awsApiCallRequest = new AwsApiCallRequest {
Api = "api",
Service = "service",
// the properties below are optional
FlattenResponse = "flattenResponse",
Parameters = parameters
};
Synopsis
Properties
Api | (experimental) The AWS api call to make i.e. getBucketLifecycle. |
FlattenResponse | (experimental) Whether or not to flatten the response from the api call. |
Parameters | (experimental) Any parameters to pass to the api call. |
Service | (experimental) The AWS service i.e. S3. |
Properties
Api
(experimental) The AWS api call to make i.e. getBucketLifecycle.
string Api { get; }
Property Value
System.String
Remarks
Stability: Experimental
FlattenResponse
(experimental) Whether or not to flatten the response from the api call.
virtual string FlattenResponse { get; }
Property Value
System.String
Remarks
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'
Stability: Experimental
Parameters
(experimental) Any parameters to pass to the api call.
virtual object Parameters { get; }
Property Value
System.Object
Remarks
Default: - no parameters
Stability: Experimental
Service
(experimental) The AWS service i.e. S3.
string Service { get; }
Property Value
System.String
Remarks
Stability: Experimental