ResumeService
Resume an active AWS App Runner service. App Runner provisions compute capacity for the service.
This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations
call to track the operation's progress.
Request Syntax
{
"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.
- ServiceArn
-
The Amazon Resource Name (ARN) of the App Runner service that you want to resume.
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
{
"OperationId": "string",
"Service": {
"AutoScalingConfigurationSummary": {
"AutoScalingConfigurationArn": "string",
"AutoScalingConfigurationName": "string",
"AutoScalingConfigurationRevision": number,
"CreatedAt": number,
"HasAssociatedService": boolean,
"IsDefault": boolean,
"Status": "string"
},
"CreatedAt": number,
"DeletedAt": number,
"EncryptionConfiguration": {
"KmsKey": "string"
},
"HealthCheckConfiguration": {
"HealthyThreshold": number,
"Interval": number,
"Path": "string",
"Protocol": "string",
"Timeout": number,
"UnhealthyThreshold": number
},
"InstanceConfiguration": {
"Cpu": "string",
"InstanceRoleArn": "string",
"Memory": "string"
},
"NetworkConfiguration": {
"EgressConfiguration": {
"EgressType": "string",
"VpcConnectorArn": "string"
},
"IngressConfiguration": {
"IsPubliclyAccessible": boolean
},
"IpAddressType": "string"
},
"ObservabilityConfiguration": {
"ObservabilityConfigurationArn": "string",
"ObservabilityEnabled": boolean
},
"ServiceArn": "string",
"ServiceId": "string",
"ServiceName": "string",
"ServiceUrl": "string",
"SourceConfiguration": {
"AuthenticationConfiguration": {
"AccessRoleArn": "string",
"ConnectionArn": "string"
},
"AutoDeploymentsEnabled": boolean,
"CodeRepository": {
"CodeConfiguration": {
"CodeConfigurationValues": {
"BuildCommand": "string",
"Port": "string",
"Runtime": "string",
"RuntimeEnvironmentSecrets": {
"string" : "string"
},
"RuntimeEnvironmentVariables": {
"string" : "string"
},
"StartCommand": "string"
},
"ConfigurationSource": "string"
},
"RepositoryUrl": "string",
"SourceCodeVersion": {
"Type": "string",
"Value": "string"
},
"SourceDirectory": "string"
},
"ImageRepository": {
"ImageConfiguration": {
"Port": "string",
"RuntimeEnvironmentSecrets": {
"string" : "string"
},
"RuntimeEnvironmentVariables": {
"string" : "string"
},
"StartCommand": "string"
},
"ImageIdentifier": "string",
"ImageRepositoryType": "string"
}
},
"Status": "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.
- OperationId
-
The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track the operation's progress.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12} - Service
-
A description of the App Runner service that this request just resumed.
Type: Service object
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
- InvalidStateException
-
You can't perform this action when the resource is in its current state.
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
Resume a service
This example illustrates how to resume an App Runner service.
Sample Request
$ aws apprunner resume-service --cli-input-json "`cat`"
{
"ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa"
}Sample Response
{
"OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf",
"Service": {
"CreatedAt": "2020-11-20T19:05:25Z",
"UpdatedAt": "2020-11-23T12:41:37Z",
"ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa",
"ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa",
"ServiceName": "python-app",
"ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com",
"SourceConfiguration": {
"AuthenticationConfiguration": {
"ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e"
},
"AutoDeploymentsEnabled": true,
"CodeRepository": {
"CodeConfiguration": {
"CodeConfigurationValues": {
"BuildCommand": "[pip install -r requirements.txt]",
"Port": "8080",
"Runtime": "PYTHON_3",
"RuntimeEnvironmentVariables": [
{
"NAME": "Jane"
}
],
"StartCommand": "python server.py"
},
"ConfigurationSource": "Api"
},
"RepositoryUrl": "https://github.com/my-account/python-hello",
"SourceCodeVersion": {
"Type": "BRANCH",
"Value": "main"
}
}
},
"Status": "OPERATION_IN_PROGRESS",
"InstanceConfiguration": {
"CPU": "1 vCPU",
"Memory": "3 GB"
},
"NetworkConfiguration": {
"IpAddressType": "IPV4",
"EgressConfiguration": {
"EgressType": "DEFAULT"
},
"IngressConfiguration": {
"IsPubliclyAccessible": true
}
},
"ObservabilityConfiguration": {
"ObservabilityEnabled": false
}
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
