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 API is in preview release for Amazon Connect and is subject to change.

Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.

If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DescribeInstanceAsync.

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

Syntax

C#
public virtual DescribeInstanceResponse DescribeInstance(
         DescribeInstanceRequest request
)

Parameters

request
Type: Amazon.Connect.Model.DescribeInstanceRequest

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

Return Value


The response from the DescribeInstance service method, as returned by Connect.

Exceptions

ExceptionCondition
InternalServiceException Request processing failed because of an error or failure with the service.
InvalidRequestException The request is not valid.
ResourceNotFoundException The specified resource was not found.

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also