ListEngagements
This action allows users to retrieve a list of Engagement records from Partner Central. This action can be used to manage and track various engagements across different stages of the partner selling process.
Request Syntax
{
"Catalog": "string
",
"CreatedBy": [ "string
" ],
"EngagementIdentifier": [ "string
" ],
"ExcludeCreatedBy": [ "string
" ],
"MaxResults": number
,
"NextToken": "string
",
"Sort": {
"SortBy": "string
",
"SortOrder": "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
-
Specifies the catalog related to the request.
Type: String
Pattern:
^[a-zA-Z]+$
Required: Yes
- CreatedBy
-
A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Pattern:
^([0-9]{12}|\w{1,12})$
Required: No
- EngagementIdentifier
-
An array of strings representing engagement identifiers to retrieve.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Pattern:
^(arn:.*|eng-[0-9a-z]{14})$
Required: No
- ExcludeCreatedBy
-
An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Pattern:
^([0-9]{12}|\w{1,12})$
Required: No
- MaxResults
-
The maximum number of results to return in a single call.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
The token for the next set of results. This value is returned from a previous call.
Type: String
Required: No
- Sort
-
Specifies the sorting parameters for listing Engagements.
Type: EngagementSort object
Required: No
Response Syntax
{
"EngagementSummaryList": [
{
"Arn": "string",
"CreatedAt": "string",
"CreatedBy": "string",
"Id": "string",
"MemberCount": number,
"Title": "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.
- EngagementSummaryList
-
An array of engagement summary objects.
Type: Array of EngagementSummary objects
- NextToken
-
The token to retrieve the next set of results. This field will be null if there are no more results.
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: