Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListReplacePermissionAssociationsWork

Retrieves the current status of the asynchronous tasks performed by AWS RAM when you perform the ReplacePermissionAssociationsWork operation.

Note

Always check the NextToken response parameter for a null value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

Request Syntax


POST /listreplacepermissionassociationswork HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string",
   "status": "string",
   "workIds": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

maxResults

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

nextToken

Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

Type: String

Required: No

status

Specifies that you want to see only the details about requests with a status that matches this value.

Type: String

Valid Values: IN_PROGRESS | COMPLETED | FAILED

Required: No

workIds

A list of IDs. These values come from the idfield of the replacePermissionAssociationsWorkstructure returned by the ReplacePermissionAssociations operation.

Type: Array of strings

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "replacePermissionAssociationsWorks": [ 
      { 
         "creationTime": number,
         "fromPermissionArn": "string",
         "fromPermissionVersion": "string",
         "id": "string",
         "lastUpdatedTime": number,
         "status": "string",
         "statusMessage": "string",
         "toPermissionArn": "string",
         "toPermissionVersion": "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.

nextToken

If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Type: String

replacePermissionAssociationsWorks

An array of data structures that provide details of the matching work IDs.

Type: Array of ReplacePermissionAssociationsWork objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidNextTokenException

The operation failed because the specified value for NextToken isn't valid. You must specify a value you received in the NextToken response of a previous call to this operation.

HTTP Status Code: 400

InvalidParameterException

The operation failed because a parameter you specified isn't valid.

HTTP Status Code: 400

ServerInternalException

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

HTTP Status Code: 500

ServiceUnavailableException

The operation failed because the service isn't available. Try again later.

HTTP Status Code: 503