How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon App Runner #X Amz Target=AppRunner.PauseService API

The #X Amz Target=AppRunner.PauseService API from Amazon App Runner — 1 operation(s) for #x amz target=apprunner.pauseservice.

Amazon App Runner #X Amz Target=AppRunner.PauseService API is one of 36 APIs that Amazon App Runner publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include #X Amz Target=AppRunner.PauseService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, a getting-started guide, an API reference, a JSON-LD context, and 8 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 56 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://apprunner.{region}.amazonaws.com, https://apprunner.{region}.amazonaws.com, http://apprunner.{region}.amazonaws.com.cn, https://apprunner.{region}.amazonaws.com.cn.

1 operations 1 paths 56 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://apprunner.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon App Runner #X Amz Target=AppRunner.PauseService API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

#X Amz Target=AppRunner.PauseService 1
POST
/#X-Amz-Target=AppRunner.PauseService
Pause an active App Runner service. App Runner reduces compute capacity for the service to zero and loses state (for example, ephemeral storage is removed). This is an asynchronous operation. On a su…
PauseService 8 params body → 200480481482483

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are Service (15 properties), CodeConfigurationValues (6 properties), HealthCheckConfiguration (6 properties), ImageConfiguration (4 properties). Each schema is shown below with its type and property counts.

HealthCheckHealthyThreshold
integer
Memory
string
NetworkConfiguration
object
Describes configuration settings related to network traffic of an App Runner service. Consists of embedded objects for each configurable network feature.
2 properties
StartCommand
string
InternalServiceErrorException
AutoScalingConfigurationSummary
object
Provides summary information about an App Runner automatic scaling configuration resource. This type contains limited information about an auto scaling configu…
3 properties
PauseServiceRequest
object
1 property 1 required
BuildCommand
string
Cpu
string
KmsKeyArn
string
ResourceNotFoundException
InvalidStateException
CodeConfigurationValues
object
Describes the basic configuration needed for building and running an App Runner service. This type doesn't support the full set of possible configuration optio…
6 properties 1 required
ImageRepositoryType
string
ServiceName
string
Runtime
string
InstanceConfiguration
object
Describes the runtime configuration of an App Runner service instance (scaling unit).
3 properties
RuntimeEnvironmentSecretsValue
string
CodeConfiguration
object
Describes the configuration that App Runner uses to build and run an App Runner service from a source code repository.
2 properties 1 required
UUID
string
IngressConfiguration
object
Network configuration settings for inbound network traffic.
1 property
AppRunnerResourceArn
string
HealthCheckPath
string
SourceConfiguration
object
Describes the source deployed to an App Runner service. It can be a code or an image repository.
4 properties
Timestamp
string
EncryptionConfiguration
object
Describes a custom encryption key that App Runner uses to encrypt copies of the source repository and service logs.
1 property 1 required
SourceCodeVersion
object
Identifies a version of code that App Runner refers to within a source code repository.
2 properties 2 required
AuthenticationConfiguration
object
Describes resources needed to authenticate access to some source repositories. The specific resource depends on the repository provider.
2 properties
Service
object
Describes an App Runner service. It can describe a service in any state, including deleted services. This type contains the full information about a service, i…
15 properties 10 required
RuntimeEnvironmentVariables
object
HealthCheckInterval
integer
NullableBoolean
boolean
PauseServiceResponse
object
2 properties 1 required
SourceCodeVersionType
string
ServiceId
string
ImageConfiguration
object
Describes the configuration that App Runner uses to run an App Runner service using an image pulled from a source image repository.
4 properties
HealthCheckTimeout
integer
ServiceStatus
string
AutoScalingConfigurationName
string
ServiceObservabilityConfiguration
object
Describes the observability configuration of an App Runner service. These are additional observability features, like tracing, that you choose to enable. They'…
2 properties 1 required
ImageRepository
object
Describes a source image repository.
3 properties 2 required
ConfigurationSource
string
CodeRepository
object
Describes a source code repository.
3 properties 2 required
RuntimeEnvironmentSecrets
object
InvalidRequestException
ImageIdentifier
string
HealthCheckUnhealthyThreshold
integer
RoleArn
string
EgressConfiguration
object
Describes configuration settings related to outbound network traffic of an App Runner service.
2 properties
RuntimeEnvironmentVariablesValue
string
Integer
integer
Boolean
boolean
HealthCheckProtocol
string
String
string
HealthCheckConfiguration
object
Describes the settings for the health check that App Runner performs to monitor the health of a service.
6 properties
EgressType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-app-runner-x-amz-target-apprunner-pauseservice-api-openapi.yml Raw ↑

Other APIs Amazon App Runner publishes across the network.

Amazon App Runner Amazon App Runner AWS App Runner API API
Amazon App Runner #X Amz Target=AppRunner.AssociateCustomDomain API
Amazon App Runner #X Amz Target=AppRunner.CreateAutoScalingConfiguration API
Amazon App Runner #X Amz Target=AppRunner.CreateConnection API
Amazon App Runner #X Amz Target=AppRunner.CreateObservabilityConfiguration API
Amazon App Runner #X Amz Target=AppRunner.CreateService API
Amazon App Runner #X Amz Target=AppRunner.CreateVpcConnector API
Amazon App Runner #X Amz Target=AppRunner.CreateVpcIngressConnection API
Amazon App Runner #X Amz Target=AppRunner.DeleteAutoScalingConfiguration API
Amazon App Runner #X Amz Target=AppRunner.DeleteConnection API
Amazon App Runner #X Amz Target=AppRunner.DeleteObservabilityConfiguration API
Amazon App Runner #X Amz Target=AppRunner.DeleteService API
Where this information came from

This is an independent, third-party profile of Amazon App Runner #X Amz Target=AppRunner.PauseService API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.