list_deployments ¶

def list_deployments(
    self,
    *,
    config_overrides: Optional[ProtonClientConfig] = None,
    next_token: Optional["capo_proton.types.next_token.NextToken"] = None,
    environment_name: Optional[
        "capo_proton.types.resource_name.ResourceName"
    ] = None,
    service_name: Optional["capo_proton.types.resource_name.ResourceName"] = None,
    service_instance_name: Optional[
        "capo_proton.types.resource_name.ResourceName"
    ] = None,
    component_name: Optional["capo_proton.types.resource_name.ResourceName"] = None,
    max_results: Optional[
        "capo_proton.types.max_page_results.MaxPageResults"
    ] = None,
) -> "capo_proton.types.list_deployments_output.ListDeploymentsOutput":
    """<p>List deployments. You can filter the result list by environment, service, or a single service instance.</p>

    Args:
        next_token: <p>A token that indicates the location of the next deployment in the array of deployment, after the list of deployment that was previously requested.</p>
        environment_name: <p>The name of an environment for result list filtering. Proton returns deployments associated with the environment.</p>
        service_name: <p>The name of a service for result list filtering. Proton returns deployments associated with service instances of the service.</p>
        service_instance_name: <p>The name of a service instance for result list filtering. Proton returns the deployments associated with the service instance.</p>
        component_name: <p>The name of a component for result list filtering. Proton returns deployments associated with that component.</p>
        max_results: <p>The maximum number of deployments to list.</p>

    Raises:
        capo_proton.errors.access_denied_exception.AccessDeniedException: <p>There <i>isn't</i> sufficient access for performing this action.</p>
        capo_proton.errors.internal_server_exception.InternalServerException: <p>The request failed to register with the service.</p>
        capo_proton.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource <i>wasn't</i> found.</p>
        capo_proton.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_proton.errors.validation_exception.ValidationException: <p>The input is invalid or an out-of-range value was supplied for the input parameter.</p>
        capo_proton.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_proton.types.list_deployments_input.ListDeploymentsInput]",
    ) -> OperationResponse[
        "capo_proton.types.list_deployments_output.ListDeploymentsOutput"
    ]:
        import capo_proton._operations.aws_proton20200720.list_deployments

        output, http_response = (
            capo_proton._operations.aws_proton20200720.list_deployments.list_deployments(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDeployments")
    )
    input_: capo_proton.types.list_deployments_input.ListDeploymentsInput = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if environment_name is not None:
        input_["environment_name"] = environment_name
    if service_name is not None:
        input_["service_name"] = service_name
    if service_instance_name is not None:
        input_["service_instance_name"] = service_instance_name
    if component_name is not None:
        input_["component_name"] = component_name
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output