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.

The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to 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 BeginGetObjectMetadata and EndGetObjectMetadata. For Unity the operation does not take CancellationToken as a parameter, and instead takes AmazonServiceCallback<GetObjectMetadataRequest, GetObjectMetadataResponse> and AsyncOptions as additional parameters.

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

Syntax

C#
public abstract Task<GetObjectMetadataResponse> GetObjectMetadataAsync(
         String bucketName,
         String key,
         String versionId,
         CancellationToken cancellationToken
)
Parameters
bucketName
Type: System.String

A property of GetObjectMetadataRequest used to execute the GetObjectMetadata service method.

key
Type: System.String

A property of GetObjectMetadataRequest used to execute the GetObjectMetadata service method.

versionId
Type: System.String

VersionId used to reference a specific version of the object.

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 GetObjectMetadata service method, as returned by S3.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone