interface IApiCall 🔹

Language	Type name
.NET	Amazon.CDK.IntegTests.Alpha.IApiCall
Go	github.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2#IApiCall
Java	software.amazon.awscdk.integtests.alpha.IApiCall
Python	aws_cdk.integ_tests_alpha.IApiCall
TypeScript (source)	@aws-cdk/integ-tests-alpha » IApiCall

Implemented by AwsApiCall, HttpApiCall, LambdaInvokeFunction

Obtainable from ApiCallBase.assertAtPath(), ApiCallBase.expect(), ApiCallBase.next(), ApiCallBase.waitForAssertions(), AwsApiCall.assertAtPath(), AwsApiCall.waitForAssertions(), HttpApiCall.assertAtPath(), HttpApiCall.waitForAssertions()

Represents an ApiCall.

Properties

Name	Type	Description
node🔹	Node	The tree node.
provider🔹	AssertionsProvider	access the AssertionsProvider.

---

node🔹

Type: Node

The tree node.

---

provider🔹

Type: AssertionsProvider

access the AssertionsProvider.

This can be used to add additional IAM policies the the provider role policy Example

declare const apiCall: AwsApiCall;
apiCall.provider.addToRolePolicy({
  Effect: 'Allow',
  Action: ['s3:GetObject'],
  Resource: ['*'],
});

Methods

Name	Description
assertAtPath(path, expected)🔹	Assert that the ExpectedResult is equal to the result of the AwsApiCall at the given path.
expect(expected)🔹	Assert that the ExpectedResult is equal to the result of the AwsApiCall.
getAtt(attributeName)🔹	Returns the value of an attribute of the custom resource of an arbitrary type.
getAttString(attributeName)🔹	Returns the value of an attribute of the custom resource of type string.
next(next)🔹	Allows you to chain IApiCalls. This adds an explicit dependency betweent the two resources.
waitForAssertions(options?)🔹	Wait for the IApiCall to return the expected response.

---

assertAtPath(path, expected)🔹

public assertAtPath(path: string, expected: ExpectedResult): IApiCall

Parameters

• path string
• expected ExpectedResult

Returns

• IApiCall

Assert that the ExpectedResult is equal to the result of the AwsApiCall at the given path.

Providing a path will filter the output of the initial API call.

For example the SQS.receiveMessage api response would look like:

If you wanted to assert the value of Body you could do Example

const actual = {
  Messages: [{
    MessageId: '',
    ReceiptHandle: '',
    MD5OfBody: '',
    Body: 'hello',
    Attributes: {},
    MD5OfMessageAttributes: {},
    MessageAttributes: {}
  }]
};

declare const integ: IntegTest;
const message = integ.assertions.awsApiCall('SQS', 'receiveMessage');

message.assertAtPath('Messages.0.Body', ExpectedResult.stringLikeRegexp('hello'));

---

expect(expected)🔹

public expect(expected: ExpectedResult): IApiCall

Parameters

• expected ExpectedResult

Returns

• IApiCall

Assert that the ExpectedResult is equal to the result of the AwsApiCall. Example

declare const integ: IntegTest;
const invoke = integ.assertions.invokeFunction({
  functionName: 'my-func',
});
invoke.expect(ExpectedResult.objectLike({ Payload: 'OK' }));

---

getAtt(attributeName)🔹

public getAtt(attributeName: string): Reference

Parameters

• attributeName string — the name of the attribute.

Returns

• Reference

Returns the value of an attribute of the custom resource of an arbitrary type.

Attributes are returned from the custom resource provider through the Data map where the key is the attribute name.

---

getAttString(attributeName)🔹

public getAttString(attributeName: string): string

Parameters

• attributeName string — the name of the attribute.

Returns

• string

Returns the value of an attribute of the custom resource of type string.

Attributes are returned from the custom resource provider through the Data map where the key is the attribute name.

---

next(next)🔹

public next(next: IApiCall): IApiCall

Parameters

• next IApiCall

Returns

• IApiCall

Allows you to chain IApiCalls. This adds an explicit dependency betweent the two resources.

Returns the IApiCall provided as next Example

declare const first: IApiCall;
declare const second: IApiCall;

first.next(second);

---

waitForAssertions(options?)🔹

public waitForAssertions(options?: WaiterStateMachineOptions): IApiCall

Parameters

• options WaiterStateMachineOptions

Returns

• IApiCall

Wait for the IApiCall to return the expected response.

If no expected response is specified then it will wait for the IApiCall to return a success Example

declare const integ: IntegTest;
declare const executionArn: string;
integ.assertions.awsApiCall('StepFunctions', 'describeExecution', {
   executionArn,
}).waitForAssertions();