- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetContainerServicesCommand
Returns information about one or more of your Amazon Lightsail container services.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LightsailClient, GetContainerServicesCommand } from "@aws-sdk/client-lightsail"; // ES Modules import
// const { LightsailClient, GetContainerServicesCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import
const client = new LightsailClient(config);
const input = { // GetContainerServicesRequest
serviceName: "STRING_VALUE",
};
const command = new GetContainerServicesCommand(input);
const response = await client.send(command);
// { // ContainerServicesListResult
// containerServices: [ // ContainerServiceList
// { // ContainerService
// containerServiceName: "STRING_VALUE",
// arn: "STRING_VALUE",
// createdAt: new Date("TIMESTAMP"),
// location: { // ResourceLocation
// availabilityZone: "STRING_VALUE",
// regionName: "us-east-1" || "us-east-2" || "us-west-1" || "us-west-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "eu-central-1" || "ca-central-1" || "ap-south-1" || "ap-southeast-1" || "ap-southeast-2" || "ap-northeast-1" || "ap-northeast-2" || "eu-north-1",
// },
// resourceType: "ContainerService" || "Instance" || "StaticIp" || "KeyPair" || "InstanceSnapshot" || "Domain" || "PeeredVpc" || "LoadBalancer" || "LoadBalancerTlsCertificate" || "Disk" || "DiskSnapshot" || "RelationalDatabase" || "RelationalDatabaseSnapshot" || "ExportSnapshotRecord" || "CloudFormationStackRecord" || "Alarm" || "ContactMethod" || "Distribution" || "Certificate" || "Bucket",
// tags: [ // TagList
// { // Tag
// key: "STRING_VALUE",
// value: "STRING_VALUE",
// },
// ],
// power: "nano" || "micro" || "small" || "medium" || "large" || "xlarge",
// powerId: "STRING_VALUE",
// state: "PENDING" || "READY" || "RUNNING" || "UPDATING" || "DELETING" || "DISABLED" || "DEPLOYING",
// stateDetail: { // ContainerServiceStateDetail
// code: "CREATING_SYSTEM_RESOURCES" || "CREATING_NETWORK_INFRASTRUCTURE" || "PROVISIONING_CERTIFICATE" || "PROVISIONING_SERVICE" || "CREATING_DEPLOYMENT" || "EVALUATING_HEALTH_CHECK" || "ACTIVATING_DEPLOYMENT" || "CERTIFICATE_LIMIT_EXCEEDED" || "UNKNOWN_ERROR",
// message: "STRING_VALUE",
// },
// scale: Number("int"),
// currentDeployment: { // ContainerServiceDeployment
// version: Number("int"),
// state: "ACTIVATING" || "ACTIVE" || "INACTIVE" || "FAILED",
// containers: { // ContainerMap
// "<keys>": { // Container
// image: "STRING_VALUE",
// command: [ // StringList
// "STRING_VALUE",
// ],
// environment: { // Environment
// "<keys>": "STRING_VALUE",
// },
// ports: { // PortMap
// "<keys>": "HTTP" || "HTTPS" || "TCP" || "UDP",
// },
// },
// },
// publicEndpoint: { // ContainerServiceEndpoint
// containerName: "STRING_VALUE",
// containerPort: Number("int"),
// healthCheck: { // ContainerServiceHealthCheckConfig
// healthyThreshold: Number("int"),
// unhealthyThreshold: Number("int"),
// timeoutSeconds: Number("int"),
// intervalSeconds: Number("int"),
// path: "STRING_VALUE",
// successCodes: "STRING_VALUE",
// },
// },
// createdAt: new Date("TIMESTAMP"),
// },
// nextDeployment: {
// version: Number("int"),
// state: "ACTIVATING" || "ACTIVE" || "INACTIVE" || "FAILED",
// containers: {
// "<keys>": {
// image: "STRING_VALUE",
// command: [
// "STRING_VALUE",
// ],
// environment: {
// "<keys>": "STRING_VALUE",
// },
// ports: {
// "<keys>": "HTTP" || "HTTPS" || "TCP" || "UDP",
// },
// },
// },
// publicEndpoint: {
// containerName: "STRING_VALUE",
// containerPort: Number("int"),
// healthCheck: {
// healthyThreshold: Number("int"),
// unhealthyThreshold: Number("int"),
// timeoutSeconds: Number("int"),
// intervalSeconds: Number("int"),
// path: "STRING_VALUE",
// successCodes: "STRING_VALUE",
// },
// },
// createdAt: new Date("TIMESTAMP"),
// },
// isDisabled: true || false,
// principalArn: "STRING_VALUE",
// privateDomainName: "STRING_VALUE",
// publicDomainNames: { // ContainerServicePublicDomains
// "<keys>": [ // ContainerServicePublicDomainsList
// "STRING_VALUE",
// ],
// },
// url: "STRING_VALUE",
// privateRegistryAccess: { // PrivateRegistryAccess
// ecrImagePullerRole: { // ContainerServiceECRImagePullerRole
// isActive: true || false,
// principalArn: "STRING_VALUE",
// },
// },
// },
// ],
// };
GetContainerServicesCommand Input
See GetContainerServicesCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
serviceName | string | undefined | The name of the container service for which to return information. When omitted, the response includes all of your container services in the Amazon Web Services Region where the request is made. |
GetContainerServicesCommand Output
See GetContainerServicesCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
containerServices | ContainerService[] | undefined | An array of objects that describe one or more container services. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. |
| InvalidInputException | client | Lightsail throws this exception when user input does not conform to the validation rules of an input field. Domain and distribution APIs are only available in the N. Virginia ( |
| NotFoundException | client | Lightsail throws this exception when it cannot find a resource. |
| ServiceException | server | A general service exception. |
| UnauthenticatedException | client | Lightsail throws this exception when the user has not been authenticated. |
| LightsailServiceException | Base exception class for all service exceptions from Lightsail service. |