AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This operation is used with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves the properties of a container group definition, including all container definitions in the group.

To retrieve a container group definition, provide a resource identifier. If successful, this operation returns the complete properties of the container group definition.

Learn more

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeContainerGroupDefinition and EndDescribeContainerGroupDefinition.

Namespace: Amazon.GameLift
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<DescribeContainerGroupDefinitionResponse> DescribeContainerGroupDefinitionAsync(
         DescribeContainerGroupDefinitionRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.GameLift.Model.DescribeContainerGroupDefinitionRequest

Container for the necessary parameters to execute the DescribeContainerGroupDefinition service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DescribeContainerGroupDefinition service method, as returned by GameLift.

Exceptions

ExceptionCondition
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 resources 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also