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.

Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.

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 BeginDescribeObjects and EndDescribeObjects.

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

Syntax

C#
public virtual Task<DescribeObjectsResponse> DescribeObjectsAsync(
         DescribeObjectsRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.DataPipeline.Model.DescribeObjectsRequest

Container for the necessary parameters to execute the DescribeObjects 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 DescribeObjects service method, as returned by DataPipeline.

Exceptions

ExceptionCondition
InternalServiceErrorException An internal service error occurred.
InvalidRequestException The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
PipelineDeletedException The specified pipeline has been deleted.
PipelineNotFoundException The specified pipeline was not found. Verify that you used the correct user and account identifiers.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also