This API works with the following fleet types: Container
Retrieves information about a managed container fleet deployment.
Request options
Results
If successful, a FleetDeployment object is returned.
Parameters:
-
fleet_id
(Optional[FleetIdOrArn], default:
None
)
–
A unique identifier for the container fleet. You can use either the fleet ID or ARN value.
-
deployment_id
(Optional[DeploymentId], default:
None
)
–
A unique identifier for the deployment to return information for.
Raises:
-
InternalServiceException
–
The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
-
InvalidRequestException
–
One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
-
NotFoundException
–
The requested resource was not found. The resource was either not created yet or deleted.
-
UnauthorizedException
–
The client failed authentication. Clients should not retry such requests.
-
UnsupportedRegionException
–
The requested operation is not supported in the Region specified.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_gamelift/_services/game_lift.py
| def describe_fleet_deployment(
self,
*,
config_overrides: Optional[GameLiftClientConfig] = None,
fleet_id: Optional["capo_gamelift.types.fleet_id_or_arn.FleetIdOrArn"] = None,
deployment_id: Optional[
"capo_gamelift.types.deployment_id.DeploymentId"
] = None,
) -> "capo_gamelift.types.describe_fleet_deployment_output.DescribeFleetDeploymentOutput":
"""<p> <b>This API works with the following fleet types:</b> Container</p> <p>Retrieves information about a managed container fleet deployment. </p> <p> <b>Request options</b> </p> <ul> <li> <p>Get information about the latest deployment for a specific fleet. Provide the fleet ID or ARN.</p> </li> <li> <p> Get information about a specific deployment. Provide the fleet ID or ARN and the deployment ID.</p> </li> </ul> <p> <b>Results</b> </p> <p>If successful, a <code>FleetDeployment</code> object is returned.</p>
Args:
fleet_id: <p>A unique identifier for the container fleet. You can use either the fleet ID or ARN value.</p>
deployment_id: <p>A unique identifier for the deployment to return information for. </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_fleet_deployment_input.DescribeFleetDeploymentInput]",
) -> OperationResponse[
"capo_gamelift.types.describe_fleet_deployment_output.DescribeFleetDeploymentOutput"
]:
import capo_gamelift._operations.game_lift.describe_fleet_deployment
output, http_response = (
capo_gamelift._operations.game_lift.describe_fleet_deployment.describe_fleet_deployment(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeFleetDeployment")
)
input_: capo_gamelift.types.describe_fleet_deployment_input.DescribeFleetDeploymentInput = {}
if fleet_id is not None:
input_["fleet_id"] = fleet_id
if deployment_id is not None:
input_["deployment_id"] = deployment_id
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|