DescribeServiceCommand

Suggest an Edit

Return a full description of an App Runner service.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AppRunnerClient, DescribeServiceCommand } from "@aws-sdk/client-apprunner"; // ES Modules import
// const { AppRunnerClient, DescribeServiceCommand } = require("@aws-sdk/client-apprunner"); // CommonJS import
const client = new AppRunnerClient(config);
const input = { // DescribeServiceRequest
  ServiceArn: "STRING_VALUE", // required
};
const command = new DescribeServiceCommand(input);
const response = await client.send(command);
// { // DescribeServiceResponse
//   Service: { // Service
//     ServiceName: "STRING_VALUE", // required
//     ServiceId: "STRING_VALUE", // required
//     ServiceArn: "STRING_VALUE", // required
//     ServiceUrl: "STRING_VALUE",
//     CreatedAt: new Date("TIMESTAMP"), // required
//     UpdatedAt: new Date("TIMESTAMP"), // required
//     DeletedAt: new Date("TIMESTAMP"),
//     Status: "CREATE_FAILED" || "RUNNING" || "DELETED" || "DELETE_FAILED" || "PAUSED" || "OPERATION_IN_PROGRESS", // required
//     SourceConfiguration: { // SourceConfiguration
//       CodeRepository: { // CodeRepository
//         RepositoryUrl: "STRING_VALUE", // required
//         SourceCodeVersion: { // SourceCodeVersion
//           Type: "BRANCH", // required
//           Value: "STRING_VALUE", // required
//         },
//         CodeConfiguration: { // CodeConfiguration
//           ConfigurationSource: "REPOSITORY" || "API", // required
//           CodeConfigurationValues: { // CodeConfigurationValues
//             Runtime: "PYTHON_3" || "NODEJS_12" || "NODEJS_14" || "CORRETTO_8" || "CORRETTO_11" || "NODEJS_16" || "GO_1" || "DOTNET_6" || "PHP_81" || "RUBY_31" || "PYTHON_311" || "NODEJS_18", // required
//             BuildCommand: "STRING_VALUE",
//             StartCommand: "STRING_VALUE",
//             Port: "STRING_VALUE",
//             RuntimeEnvironmentVariables: { // RuntimeEnvironmentVariables
//               "<keys>": "STRING_VALUE",
//             },
//             RuntimeEnvironmentSecrets: { // RuntimeEnvironmentSecrets
//               "<keys>": "STRING_VALUE",
//             },
//           },
//         },
//         SourceDirectory: "STRING_VALUE",
//       },
//       ImageRepository: { // ImageRepository
//         ImageIdentifier: "STRING_VALUE", // required
//         ImageConfiguration: { // ImageConfiguration
//           RuntimeEnvironmentVariables: {
//             "<keys>": "STRING_VALUE",
//           },
//           StartCommand: "STRING_VALUE",
//           Port: "STRING_VALUE",
//           RuntimeEnvironmentSecrets: {
//             "<keys>": "STRING_VALUE",
//           },
//         },
//         ImageRepositoryType: "ECR" || "ECR_PUBLIC", // required
//       },
//       AutoDeploymentsEnabled: true || false,
//       AuthenticationConfiguration: { // AuthenticationConfiguration
//         ConnectionArn: "STRING_VALUE",
//         AccessRoleArn: "STRING_VALUE",
//       },
//     },
//     InstanceConfiguration: { // InstanceConfiguration
//       Cpu: "STRING_VALUE",
//       Memory: "STRING_VALUE",
//       InstanceRoleArn: "STRING_VALUE",
//     },
//     EncryptionConfiguration: { // EncryptionConfiguration
//       KmsKey: "STRING_VALUE", // required
//     },
//     HealthCheckConfiguration: { // HealthCheckConfiguration
//       Protocol: "TCP" || "HTTP",
//       Path: "STRING_VALUE",
//       Interval: Number("int"),
//       Timeout: Number("int"),
//       HealthyThreshold: Number("int"),
//       UnhealthyThreshold: Number("int"),
//     },
//     AutoScalingConfigurationSummary: { // AutoScalingConfigurationSummary
//       AutoScalingConfigurationArn: "STRING_VALUE",
//       AutoScalingConfigurationName: "STRING_VALUE",
//       AutoScalingConfigurationRevision: Number("int"),
//       Status: "ACTIVE" || "INACTIVE",
//       CreatedAt: new Date("TIMESTAMP"),
//       HasAssociatedService: true || false,
//       IsDefault: true || false,
//     },
//     NetworkConfiguration: { // NetworkConfiguration
//       EgressConfiguration: { // EgressConfiguration
//         EgressType: "DEFAULT" || "VPC",
//         VpcConnectorArn: "STRING_VALUE",
//       },
//       IngressConfiguration: { // IngressConfiguration
//         IsPubliclyAccessible: true || false,
//       },
//       IpAddressType: "IPV4" || "DUAL_STACK",
//     },
//     ObservabilityConfiguration: { // ServiceObservabilityConfiguration
//       ObservabilityEnabled: true || false, // required
//       ObservabilityConfigurationArn: "STRING_VALUE",
//     },
//   },
// };

DescribeServiceCommand Input

See DescribeServiceCommandInput for more details

Parameter
Type
Description
ServiceArn
Required
string | undefined

The Amazon Resource Name (ARN) of the App Runner service that you want a description for.

DescribeServiceCommand Output

See DescribeServiceCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Service
Required
Service | undefined

A full description of the App Runner service that you specified in this request.

Throws

Name
Fault
Details
InternalServiceErrorException
server

An unexpected service exception occurred.

InvalidRequestException
client

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.

ResourceNotFoundException
client

A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.

AppRunnerServiceException
Base exception class for all service exceptions from AppRunner service.