get_container_service_deployments `async` ¶

get_container_service_deployments(
    service_name: ContainerServiceName,
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
) -> GetContainerServiceDeploymentsResult

Returns the deployments for your Amazon Lightsail container service

A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.

The deployments are ordered by version in ascending order. The newest version is listed at the top of the response.

A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.

Parameters:

service_name (ContainerServiceName) –

The name of the container service for which to return deployments.

Raises:

AccessDeniedException –

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
InvalidInputException –

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 (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException –

Lightsail throws this exception when it cannot find a resource.
RegionSetupInProgressException –

Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
ServiceException –

A general service exception.
UnauthenticatedException –

Lightsail throws this exception when the user has not been authenticated.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_lightsail/_services/async_lightsail.py

async def get_container_service_deployments(
    self,
    service_name: "capo_lightsail.types.container_service_name.ContainerServiceName",
    *,
    config_overrides: Optional[AsyncLightsailClientConfig] = None,
) -> "capo_lightsail.types.get_container_service_deployments_result.GetContainerServiceDeploymentsResult":
    """<p>Returns the deployments for your Amazon Lightsail container service</p> <p>A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.</p> <p>The deployments are ordered by version in ascending order. The newest version is listed at the top of the response.</p> <note> <p>A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/lightsail.html">Amazon Lightsail endpoints and quotas</a> in the <i>Amazon Web Services General Reference</i>.</p> </note>

    Args:
        service_name: <p>The name of the container service for which to return deployments.</p>

    Raises:
        capo_lightsail.errors.access_denied_exception.AccessDeniedException: <p>Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.</p>
        capo_lightsail.errors.invalid_input_exception.InvalidInputException: <p>Lightsail throws this exception when user input does not conform to the validation rules of an input field.</p> <note> <p>Domain and distribution APIs are only available in the N. Virginia (<code>us-east-1</code>) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to <code>us-east-1</code> to create, view, or edit these resources.</p> </note>
        capo_lightsail.errors.not_found_exception.NotFoundException: <p>Lightsail throws this exception when it cannot find a resource.</p>
        capo_lightsail.errors.region_setup_in_progress_exception.RegionSetupInProgressException: <p>Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.</p>
        capo_lightsail.errors.service_exception.ServiceException: <p>A general service exception.</p>
        capo_lightsail.errors.unauthenticated_exception.UnauthenticatedException: <p>Lightsail throws this exception when the user has not been authenticated.</p>
        capo_lightsail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_lightsail.types.get_container_service_deployments_request.GetContainerServiceDeploymentsRequest]",
    ) -> AsyncOperationResponse[
        "capo_lightsail.types.get_container_service_deployments_result.GetContainerServiceDeploymentsResult"
    ]:
        import capo_lightsail._operations.lightsail_20161128.get_container_service_deployments

        (
            output,
            http_response,
        ) = await capo_lightsail._operations.lightsail_20161128.get_container_service_deployments.async_get_container_service_deployments(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetContainerServiceDeployments")
    )
    input_: capo_lightsail.types.get_container_service_deployments_request.GetContainerServiceDeploymentsRequest = {
        "service_name": service_name
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_container_service_deployments async ¶

get_container_service_deployments `async` ¶