ListOperations
Return a list of operations that occurred on an AWS App Runner service.
The resulting list of OperationSummary objects is sorted in reverse chronological order. The first object on the list represents the last started operation.
Request Syntax
{
"MaxResults": number,
"NextToken": "string",
"ServiceArn": "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.
- MaxResults
-
The maximum number of results to include in each response (result page). It's used for a paginated request.
If you don't specify
MaxResults, the request retrieves all available results in a single response.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 20.
Required: No
- NextToken
-
A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.
If you don't specify
NextToken, the request retrieves the first result page.Type: String
Length Constraints: Minimum length of 0. Maximum length of 51200.
Pattern:
.*Required: No
- ServiceArn
-
The Amazon Resource Name (ARN) of the App Runner service that you want a list of operations for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern:
arn:aws(-[\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\w|\/|-){1,1011}Required: Yes
Response Syntax
{
"NextToken": "string",
"OperationSummaryList": [
{
"EndedAt": number,
"Id": "string",
"StartedAt": number,
"Status": "string",
"TargetArn": "string",
"Type": "string",
"UpdatedAt": number
}
]
}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
-
The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 51200.
Pattern:
.* - OperationSummaryList
-
A list of operation summary information records. In a paginated request, the request returns up to
MaxResultsrecords for each call.Type: Array of OperationSummary objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceErrorException
-
An unexpected service exception occurred.
HTTP Status Code: 500
- InvalidRequestException
-
One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
HTTP Status Code: 400
- ResourceNotFoundException
-
A resource doesn't exist for the specified Amazon Resource Name (ARN) in your AWS account.
HTTP Status Code: 400
Examples
List operations that occurred on a service
This example illustrates how to list all operations that occurred on an App Runner service so far. In this example, the service is new and only a single
operation of type CREATE_SERVICE has occurred.
Sample Request
$ aws apprunner list-operations --cli-input-json "`cat`"
{
"ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa"
}Sample Response
{
"OperationSummaryList": [
{
"EndedAt": 1606156217,
"Id": "17fe9f55-7e91-4097-b243-fcabbb69a4cf",
"StartedAt": 1606156014,
"Status": "SUCCEEDED",
"TargetArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa",
"Type": "CREATE_SERVICE",
"UpdatedAt": 1606156217
}
]
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
