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.

Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.

The authorizationToken returned is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The CLI offers an get-login-password command that simplifies the login process. For more information, see Registry authentication in the Amazon Elastic Container Registry User Guide.

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 BeginGetAuthorizationToken and EndGetAuthorizationToken.

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

Syntax

C#
public virtual Task<GetAuthorizationTokenResponse> GetAuthorizationTokenAsync(
         GetAuthorizationTokenRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ECR.Model.GetAuthorizationTokenRequest

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

Exceptions

ExceptionCondition
InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
ServerException These errors are usually caused by a server-side issue.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also