get_deployments ¶

get_deployments(
    rest_api_id: String,
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    position: Optional[String] = None,
    limit: Optional[NullableInteger] = None,
) -> Deployments

Gets information about a Deployments collection.

Parameters:

rest_api_id (String) –

The string identifier of the associated RestApi.
position (Optional[String], default: None ) –

The current pagination position in the paged result set.
limit (Optional[NullableInteger], default: None ) –

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Raises:

BadRequestException –

The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
NotFoundException –

The requested resource is not found. Make sure that the request URI is correct.
ServiceUnavailableException –

The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
TooManyRequestsException –

The request has reached its throttling limit. Retry after the specified time period.
UnauthorizedException –

The request is denied because the caller has insufficient permissions.
UnknownServiceError –

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

Source code in docs_src/capo_api_gateway/_services/api_gateway.py

def get_deployments(
    self,
    rest_api_id: "capo_api_gateway.types.string.String",
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    position: Optional["capo_api_gateway.types.string.String"] = None,
    limit: Optional[
        "capo_api_gateway.types.nullable_integer.NullableInteger"
    ] = None,
) -> "capo_api_gateway.types.deployments.Deployments":
    """<p>Gets information about a Deployments collection.</p>

    Args:
        rest_api_id: <p>The string identifier of the associated RestApi.</p>
        position: <p>The current pagination position in the paged result set.</p>
        limit: <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>

    Raises:
        capo_api_gateway.errors.bad_request_exception.BadRequestException: <p>The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_api_gateway.errors.not_found_exception.NotFoundException: <p>The requested resource is not found. Make sure that the request URI is correct.</p>
        capo_api_gateway.errors.service_unavailable_exception.ServiceUnavailableException: <p>The requested service is not available. For details see the accompanying error message. Retry after the specified time period.</p>
        capo_api_gateway.errors.too_many_requests_exception.TooManyRequestsException: <p>The request has reached its throttling limit. Retry after the specified time period.</p>
        capo_api_gateway.errors.unauthorized_exception.UnauthorizedException: <p>The request is denied because the caller has insufficient permissions.</p>
        capo_api_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_api_gateway.types.get_deployments_request.GetDeploymentsRequest]",
    ) -> OperationResponse["capo_api_gateway.types.deployments.Deployments"]:
        import capo_api_gateway._operations.backplane_control_service.get_deployments

        output, http_response = (
            capo_api_gateway._operations.backplane_control_service.get_deployments.get_deployments(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDeployments")
    )
    input_: capo_api_gateway.types.get_deployments_request.GetDeploymentsRequest = {
        "rest_api_id": rest_api_id
    }
    if position is not None:
        input_["position"] = position
    if limit is not None:
        input_["limit"] = limit

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