ListEngagementMembers
Retrieves the details of member partners in an Engagement. This operation can only be
invoked by members of the Engagement. The ListEngagementMembers operation
allows you to fetch information about the members of a specific Engagement. This action
is restricted to members of the Engagement being queried.
Request Syntax
{
"Catalog": "string",
"Identifier": "string",
"MaxResults": number,
"NextToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
- Catalog
-
The catalog related to the request.
Type: String
Pattern:
^[a-zA-Z]+$Required: Yes
- Identifier
-
Identifier of the Engagement record to retrieve members from.
Type: String
Pattern:
^(arn:.*|eng-[0-9a-z]{14})$Required: Yes
- MaxResults
-
The maximum number of results to return in a single call.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No
- NextToken
-
The token for the next set of results.
Type: String
Required: No
Response Syntax
{
"EngagementMemberList": [
{
"AccountId": "string",
"CompanyName": "string",
"WebsiteUrl": "string"
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- EngagementMemberList
-
Provides a list of engagement members.
Type: Array of EngagementMember objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
- NextToken
-
A pagination token used to retrieve the next set of results. If there are more results available than can be returned in a single response, this token will be present. Use this token in a subsequent request to retrieve the next page of results. If there are no more results, this value will be null.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
This error occurs when you don't have permission to perform the requested action.
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.
HTTP Status Code: 400
- ResourceNotFoundException
-
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.
HTTP Status Code: 400
- ThrottlingException
-
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.
This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy the constraints specified by the service or business validation rules.
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
