Lightsail / Client / get_container_services

get_container_services

Lightsail.Client.get_container_services(**kwargs)

Returns information about one or more of your Amazon Lightsail container services.

See also: AWS API Documentation

Request Syntax

response = client.get_container_services(
    serviceName='string'
)

Parameters:

serviceName (string) –

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.

Return type:

dict

Returns:

Response Syntax

{
    'containerServices': [
        {
            'containerServiceName': 'string',
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                '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': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'power': 'nano'|'micro'|'small'|'medium'|'large'|'xlarge',
            'powerId': 'string',
            'state': 'PENDING'|'READY'|'RUNNING'|'UPDATING'|'DELETING'|'DISABLED'|'DEPLOYING',
            'stateDetail': {
                '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'
            },
            'scale': 123,
            'currentDeployment': {
                'version': 123,
                'state': 'ACTIVATING'|'ACTIVE'|'INACTIVE'|'FAILED',
                'containers': {
                    'string': {
                        'image': 'string',
                        'command': [
                            'string',
                        ],
                        'environment': {
                            'string': 'string'
                        },
                        'ports': {
                            'string': 'HTTP'|'HTTPS'|'TCP'|'UDP'
                        }
                    }
                },
                'publicEndpoint': {
                    'containerName': 'string',
                    'containerPort': 123,
                    'healthCheck': {
                        'healthyThreshold': 123,
                        'unhealthyThreshold': 123,
                        'timeoutSeconds': 123,
                        'intervalSeconds': 123,
                        'path': 'string',
                        'successCodes': 'string'
                    }
                },
                'createdAt': datetime(2015, 1, 1)
            },
            'nextDeployment': {
                'version': 123,
                'state': 'ACTIVATING'|'ACTIVE'|'INACTIVE'|'FAILED',
                'containers': {
                    'string': {
                        'image': 'string',
                        'command': [
                            'string',
                        ],
                        'environment': {
                            'string': 'string'
                        },
                        'ports': {
                            'string': 'HTTP'|'HTTPS'|'TCP'|'UDP'
                        }
                    }
                },
                'publicEndpoint': {
                    'containerName': 'string',
                    'containerPort': 123,
                    'healthCheck': {
                        'healthyThreshold': 123,
                        'unhealthyThreshold': 123,
                        'timeoutSeconds': 123,
                        'intervalSeconds': 123,
                        'path': 'string',
                        'successCodes': 'string'
                    }
                },
                'createdAt': datetime(2015, 1, 1)
            },
            'isDisabled': True|False,
            'principalArn': 'string',
            'privateDomainName': 'string',
            'publicDomainNames': {
                'string': [
                    'string',
                ]
            },
            'url': 'string',
            'privateRegistryAccess': {
                'ecrImagePullerRole': {
                    'isActive': True|False,
                    'principalArn': 'string'
                }
            }
        },
    ]
}

Response Structure

• (dict) –

  • containerServices (list) –

    An array of objects that describe one or more container services.

    • (dict) –

      Describes an Amazon Lightsail container service.

      • containerServiceName (string) –

        The name of the container service.

      • arn (string) –

        The Amazon Resource Name (ARN) of the container service.

      • createdAt (datetime) –

        The timestamp when the container service was created.

      • location (dict) –

        An object that describes the location of the container service, such as the Amazon Web Services Region and Availability Zone.

        • availabilityZone (string) –

          The Availability Zone. Follows the format us-east-2a (case-sensitive).

        • regionName (string) –

          The Amazon Web Services Region name.

      • resourceType (string) –

        The Lightsail resource type of the container service (i.e., ContainerService).

      • tags (list) –

        The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

        • (dict) –

          Describes a tag key and optional value assigned to an Amazon Lightsail resource.

          For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

          • key (string) –

            The key of the tag.

            Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

          • value (string) –

            The value of the tag.

            Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

      • power (string) –

        The power specification of the container service.

        The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.

      • powerId (string) –

        The ID of the power of the container service.

      • state (string) –

        The current state of the container service.

        The following container service states are possible:

        • PENDING - The container service is being created.

        • READY - The container service is running but it does not have an active container deployment.

        • DEPLOYING - The container service is launching a container deployment.

        • RUNNING - The container service is running and it has an active container deployment.

        • UPDATING - The container service capacity or its custom domains are being updated.

        • DELETING - The container service is being deleted.

        • DISABLED - The container service is disabled, and its active deployment and containers, if any, are shut down.

      • stateDetail (dict) –

        An object that describes the current state of the container service.

        Note

        The state detail is populated only when a container service is in a PENDING, DEPLOYING, or UPDATING state.

        • code (string) –

          The state code of the container service.

          The following state codes are possible:

          • The following state codes are possible if your container service is in a DEPLOYING or UPDATING state:

            • CREATING_SYSTEM_RESOURCES - The system resources for your container service are being created.

            • CREATING_NETWORK_INFRASTRUCTURE - The network infrastructure for your container service are being created.

            • PROVISIONING_CERTIFICATE - The SSL/TLS certificate for your container service is being created.

            • PROVISIONING_SERVICE - Your container service is being provisioned.

            • CREATING_DEPLOYMENT - Your deployment is being created on your container service.

            • EVALUATING_HEALTH_CHECK - The health of your deployment is being evaluated.

            • ACTIVATING_DEPLOYMENT - Your deployment is being activated.

          • The following state codes are possible if your container service is in a PENDING state:

            • CERTIFICATE_LIMIT_EXCEEDED - The SSL/TLS certificate required for your container service exceeds the maximum number of certificates allowed for your account.

            • UNKNOWN_ERROR - An error was experienced when your container service was being created.

        • message (string) –

          A message that provides more information for the state code.

          Note

          The state detail is populated only when a container service is in a PENDING, DEPLOYING, or UPDATING state.

      • scale (integer) –

        The scale specification of the container service.

        The scale specifies the allocated compute nodes of the container service.

      • currentDeployment (dict) –

        An object that describes the current container deployment of the container service.

        • version (integer) –

          The version number of the deployment.

        • state (string) –

          The state of the deployment.

          A deployment can be in one of the following states:

          • Activating - The deployment is being created.

          • Active - The deployment was successfully created, and it’s currently running on the container service. The container service can have only one deployment in an active state at a time.

          • Inactive - The deployment was previously successfully created, but it is not currently running on the container service.

          • Failed - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.

        • containers (dict) –

          An object that describes the configuration for the containers of the deployment.

          • (string) –

            • (dict) –

              Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.

              • image (string) –

                The name of the image used for the container.

                Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon ( :). For example, if your container service name is container-service-1, the container image label is mystaticsite, and you want to use the third ( 3) version of the registered container image, then you should specify :container-service-1.mystaticsite.3. To use the latest version of a container image, specify latest instead of a version number (for example, :container-service-1.mystaticsite.latest). Lightsail will automatically use the highest numbered version of the registered container image.

                Container images sourced from a public registry like Docker Hub don’t start with a colon. For example, nginx:latest or nginx.

              • command (list) –

                The launch command for the container.

                • (string) –

              • environment (dict) –

                The environment variables of the container.

                • (string) –

                  • (string) –

              • ports (dict) –

                The open firewall ports of the container.

                • (string) –

                  • (string) –

        • publicEndpoint (dict) –

          An object that describes the endpoint of the deployment.

          • containerName (string) –

            The name of the container entry of the deployment that the endpoint configuration applies to.

          • containerPort (integer) –

            The port of the specified container to which traffic is forwarded to.

          • healthCheck (dict) –

            An object that describes the health check configuration of the container.

            • healthyThreshold (integer) –

              The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.

            • unhealthyThreshold (integer) –

              The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

            • timeoutSeconds (integer) –

              The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.

            • intervalSeconds (integer) –

              The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.

            • path (string) –

              The path on the container on which to perform the health check. The default value is /.

            • successCodes (string) –

              The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).

        • createdAt (datetime) –

          The timestamp when the deployment was created.

      • nextDeployment (dict) –

        An object that describes the next deployment of the container service.

        This value is null when there is no deployment in a pending state.

        • version (integer) –

          The version number of the deployment.

        • state (string) –

          The state of the deployment.

          A deployment can be in one of the following states:

          • Activating - The deployment is being created.

          • Active - The deployment was successfully created, and it’s currently running on the container service. The container service can have only one deployment in an active state at a time.

          • Inactive - The deployment was previously successfully created, but it is not currently running on the container service.

          • Failed - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.

        • containers (dict) –

          An object that describes the configuration for the containers of the deployment.

          • (string) –

            • (dict) –

              Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.

              • image (string) –

                The name of the image used for the container.

                Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon ( :). For example, if your container service name is container-service-1, the container image label is mystaticsite, and you want to use the third ( 3) version of the registered container image, then you should specify :container-service-1.mystaticsite.3. To use the latest version of a container image, specify latest instead of a version number (for example, :container-service-1.mystaticsite.latest). Lightsail will automatically use the highest numbered version of the registered container image.

                Container images sourced from a public registry like Docker Hub don’t start with a colon. For example, nginx:latest or nginx.

              • command (list) –

                The launch command for the container.

                • (string) –

              • environment (dict) –

                The environment variables of the container.

                • (string) –

                  • (string) –

              • ports (dict) –

                The open firewall ports of the container.

                • (string) –

                  • (string) –

        • publicEndpoint (dict) –

          An object that describes the endpoint of the deployment.

          • containerName (string) –

            The name of the container entry of the deployment that the endpoint configuration applies to.

          • containerPort (integer) –

            The port of the specified container to which traffic is forwarded to.

          • healthCheck (dict) –

            An object that describes the health check configuration of the container.

            • healthyThreshold (integer) –

              The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.

            • unhealthyThreshold (integer) –

              The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

            • timeoutSeconds (integer) –

              The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.

            • intervalSeconds (integer) –

              The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.

            • path (string) –

              The path on the container on which to perform the health check. The default value is /.

            • successCodes (string) –

              The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).

        • createdAt (datetime) –

          The timestamp when the deployment was created.

      • isDisabled (boolean) –

        A Boolean value indicating whether the container service is disabled.

      • principalArn (string) –

        The principal ARN of the container service.

        The principal ARN can be used to create a trust relationship between your standard Amazon Web Services account and your Lightsail container service. This allows you to give your service permission to access resources in your standard Amazon Web Services account.

      • privateDomainName (string) –

        The private domain name of the container service.

        The private domain name is accessible only by other resources within the default virtual private cloud (VPC) of your Lightsail account.

      • publicDomainNames (dict) –

        The public domain name of the container service, such as example.com and www.example.com.

        You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.

        If you don’t specify public domain names, then you can use the default domain of the container service.

        Warning

        You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service.

        See CreateContainerService or UpdateContainerService for information about how to specify public domain names for your Lightsail container service.

        • (string) –

          • (list) –

            • (string) –

      • url (string) –

        The publicly accessible URL of the container service.

        If no public endpoint is specified in the currentDeployment, this URL returns a 404 response.

      • privateRegistryAccess (dict) –

        An object that describes the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

        For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

        • ecrImagePullerRole (dict) –

          An object that describes the activation status of the role that you can use to grant a Lightsail container service access to Amazon ECR private repositories. If the role is activated, the Amazon Resource Name (ARN) of the role is also listed.

          • isActive (boolean) –

            A Boolean value that indicates whether the role is activated.

          • principalArn (string) –

            The Amazon Resource Name (ARN) of the role, if it is activated.

Exceptions

• Lightsail.Client.exceptions.ServiceException

• Lightsail.Client.exceptions.InvalidInputException

• Lightsail.Client.exceptions.NotFoundException

• Lightsail.Client.exceptions.AccessDeniedException

• Lightsail.Client.exceptions.UnauthenticatedException