list_deployments ¶

def list_deployments(
    self,
    *,
    config_overrides: Optional[GreengrassV2ClientConfig] = None,
    target_arn: Optional["capo_greengrassv2.types.target_arn.TargetARN"] = None,
    history_filter: Optional[
        "capo_greengrassv2.types.deployment_history_filter.DeploymentHistoryFilter"
    ] = None,
    parent_target_arn: Optional[
        "capo_greengrassv2.types.thing_group_arn.ThingGroupARN"
    ] = None,
    max_results: Optional[
        "capo_greengrassv2.types.default_max_results.DefaultMaxResults"
    ] = None,
    next_token: Optional[
        "capo_greengrassv2.types.next_token_string.NextTokenString"
    ] = None,
) -> "capo_greengrassv2.types.list_deployments_response.ListDeploymentsResponse":
    """<p>Retrieves a paginated list of deployments.</p>

    Args:
        target_arn: <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group.</p>
        history_filter: <p>The filter for the list of deployments. Choose one of the following options:</p> <ul> <li> <p> <code>ALL</code> – The list includes all deployments.</p> </li> <li> <p> <code>LATEST_ONLY</code> – The list includes only the latest revision of each deployment.</p> </li> </ul> <p>Default: <code>LATEST_ONLY</code> </p>
        parent_target_arn: <p>The parent deployment's target <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> within a subdeployment.</p>
        max_results: <p>The maximum number of results to be returned per paginated request.</p> <p>Default: <code>50</code> </p>
        next_token: <p>The token to be used for the next set of paginated results.</p>

    Raises:
        capo_greengrassv2.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action.</p>
        capo_greengrassv2.errors.internal_server_exception.InternalServerException: <p>IoT Greengrass can't process your request right now. Try again later.</p>
        capo_greengrassv2.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.</p>
        capo_greengrassv2.errors.validation_exception.ValidationException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
        capo_greengrassv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_greengrassv2.types.list_deployments_request.ListDeploymentsRequest]",
    ) -> OperationResponse[
        "capo_greengrassv2.types.list_deployments_response.ListDeploymentsResponse"
    ]:
        import capo_greengrassv2._operations.greengrass_v2.list_deployments

        output, http_response = (
            capo_greengrassv2._operations.greengrass_v2.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_greengrassv2.types.list_deployments_request.ListDeploymentsRequest = {}
    if target_arn is not None:
        input_["target_arn"] = target_arn
    if history_filter is not None:
        input_["history_filter"] = history_filter
    if parent_target_arn is not None:
        input_["parent_target_arn"] = parent_target_arn
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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