CancelProfileUpdateTask
Cancels an in-progress profile update task, stopping any pending changes to the partner profile.
Request Syntax
{
"Catalog": "string",
"ClientToken": "string",
"Identifier": "string",
"TaskId": "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 identifier for the partner account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9-]+Required: Yes
- Identifier
-
The unique identifier of the partner account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
(partner-[A-Za-z0-9]{13}|arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13})Required: Yes
- TaskId
-
The unique identifier of the profile update task to cancel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 80.
Pattern:
pprofiletask-[A-Za-z0-9]{13}Required: Yes
- ClientToken
-
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[A-Za-z0-9-_]+Required: No
Response Syntax
{
"Arn": "string",
"Catalog": "string",
"EndedAt": "string",
"ErrorDetailList": [
{
"Locale": "string",
"Message": "string",
"Reason": "string"
}
],
"Id": "string",
"StartedAt": "string",
"Status": "string",
"TaskDetails": {
"Description": "string",
"DisplayName": "string",
"IndustrySegments": [ "string" ],
"LocalizedContents": [
{
"Description": "string",
"DisplayName": "string",
"Locale": "string",
"LogoUrl": "string",
"WebsiteUrl": "string"
}
],
"LogoUrl": "string",
"PrimarySolutionType": "string",
"TranslationSourceLocale": "string",
"WebsiteUrl": "string"
},
"TaskId": "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.
- Arn
-
The Amazon Resource Name (ARN) of the canceled profile update task.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13} - Catalog
-
The catalog identifier for the partner account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9-]+ - Id
-
The unique identifier of the partner account.
Type: String
Pattern:
partner-[A-Za-z0-9]{13} - StartedAt
-
The timestamp when the profile update task was started.
Type: Timestamp
- Status
-
The current status of the profile update task (canceled).
Type: String
Valid Values:
IN_PROGRESS | CANCELED | SUCCEEDED | FAILED - TaskDetails
-
The details of the profile update task that was canceled.
Type: TaskDetails object
- TaskId
-
The unique identifier of the canceled profile update task.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 80.
Pattern:
pprofiletask-[A-Za-z0-9]{13} - EndedAt
-
The timestamp when the profile update task was ended (canceled).
Type: Timestamp
- ErrorDetailList
-
A list of error details if any errors occurred during the profile update task.
Type: Array of ErrorDetail objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- Reason
-
The specific reason for the access denial.
HTTP Status Code: 400
- ConflictException
-
The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.
- Reason
-
The specific reason for the conflict.
HTTP Status Code: 400
- InternalServerException
-
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- Reason
-
The specific reason why the resource was not found.
HTTP Status Code: 400
- ThrottlingException
-
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.
- QuotaCode
-
The quota code associated with the throttling error.
- ServiceCode
-
The service code associated with the throttling error.
HTTP Status Code: 400
- ValidationException
-
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.
- ErrorDetails
-
A list of detailed validation errors that occurred during request processing.
- Reason
-
The reason for the validation failure.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
