describe_container_fleet ¶

def describe_container_fleet(
    self,
    *,
    config_overrides: Optional[GameLiftClientConfig] = None,
    fleet_id: Optional["capo_gamelift.types.fleet_id_or_arn.FleetIdOrArn"] = None,
) -> "capo_gamelift.types.describe_container_fleet_output.DescribeContainerFleetOutput":
    """<p> <b>This API works with the following fleet types:</b> Container</p> <p>Retrieves the properties for a container fleet. When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. </p> <p> <b>Request options</b> </p> <ul> <li> <p>Get container fleet properties for a single fleet. Provide either the fleet ID or ARN value. </p> </li> </ul> <p> <b>Results</b> </p> <p>If successful, a <code>ContainerFleet</code> object is returned. This object includes the fleet properties, including information about the most recent deployment.</p> <note> <p>Some API operations limit the number of fleet IDs that are allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.</p> </note>

    Args:
        fleet_id: <p>A unique identifier for the container fleet to retrieve. You can use either the fleet ID or ARN value.</p>

    Raises:
        capo_gamelift.errors.internal_service_exception.InternalServiceException: <p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.</p>
        capo_gamelift.errors.invalid_request_exception.InvalidRequestException: <p>One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.</p>
        capo_gamelift.errors.not_found_exception.NotFoundException: <p>The requested resource was not found. The resource was either not created yet or deleted.</p>
        capo_gamelift.errors.unauthorized_exception.UnauthorizedException: <p>The client failed authentication. Clients should not retry such requests.</p>
        capo_gamelift.errors.unsupported_region_exception.UnsupportedRegionException: <p>The requested operation is not supported in the Region specified.</p>
        capo_gamelift.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_gamelift.types.describe_container_fleet_input.DescribeContainerFleetInput]",
    ) -> OperationResponse[
        "capo_gamelift.types.describe_container_fleet_output.DescribeContainerFleetOutput"
    ]:
        import capo_gamelift._operations.game_lift.describe_container_fleet

        output, http_response = (
            capo_gamelift._operations.game_lift.describe_container_fleet.describe_container_fleet(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_gamelift.types.describe_container_fleet_output.DescribeContainerFleetOutput",
    ) -> dict[str, Any]:
        import capo_gamelift.types.describe_container_fleet_output

        return capo_gamelift.types.describe_container_fleet_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeContainerFleet", redact_output=_redact_output),
    )
    input_: capo_gamelift.types.describe_container_fleet_input.DescribeContainerFleetInput = {}
    if fleet_id is not None:
        input_["fleet_id"] = fleet_id

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