amazonka-ecr-2.0: Amazon EC2 Container Registry SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ECR.GetAuthorizationToken

Description

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.

Synopsis

Creating a Request

data GetAuthorizationToken Source #

See: newGetAuthorizationToken smart constructor.

Constructors

GetAuthorizationToken' 

Fields

  • registryIds :: Maybe (NonEmpty Text)

    A list of Amazon Web Services account IDs that are associated with the registries for which to get AuthorizationData objects. If you do not specify a registry, the default registry is assumed.

Instances

Instances details
ToJSON GetAuthorizationToken Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

ToHeaders GetAuthorizationToken Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

ToPath GetAuthorizationToken Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

ToQuery GetAuthorizationToken Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

AWSRequest GetAuthorizationToken Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

Associated Types

type AWSResponse GetAuthorizationToken #

Generic GetAuthorizationToken Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

Associated Types

type Rep GetAuthorizationToken :: Type -> Type #

Read GetAuthorizationToken Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

Show GetAuthorizationToken Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

NFData GetAuthorizationToken Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

Methods

rnf :: GetAuthorizationToken -> () #

Eq GetAuthorizationToken Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

Hashable GetAuthorizationToken Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

type AWSResponse GetAuthorizationToken Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

type Rep GetAuthorizationToken Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

type Rep GetAuthorizationToken = D1 ('MetaData "GetAuthorizationToken" "Amazonka.ECR.GetAuthorizationToken" "amazonka-ecr-2.0-BqgZWPod2JCFn2nq69DCrJ" 'False) (C1 ('MetaCons "GetAuthorizationToken'" 'PrefixI 'True) (S1 ('MetaSel ('Just "registryIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))))

newGetAuthorizationToken :: GetAuthorizationToken Source #

Create a value of GetAuthorizationToken with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:registryIds:GetAuthorizationToken', getAuthorizationToken_registryIds - A list of Amazon Web Services account IDs that are associated with the registries for which to get AuthorizationData objects. If you do not specify a registry, the default registry is assumed.

Request Lenses

getAuthorizationToken_registryIds :: Lens' GetAuthorizationToken (Maybe (NonEmpty Text)) Source #

A list of Amazon Web Services account IDs that are associated with the registries for which to get AuthorizationData objects. If you do not specify a registry, the default registry is assumed.

Destructuring the Response

data GetAuthorizationTokenResponse Source #

See: newGetAuthorizationTokenResponse smart constructor.

Constructors

GetAuthorizationTokenResponse' 

Fields

Instances

Instances details
Generic GetAuthorizationTokenResponse Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

Associated Types

type Rep GetAuthorizationTokenResponse :: Type -> Type #

Read GetAuthorizationTokenResponse Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

Show GetAuthorizationTokenResponse Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

NFData GetAuthorizationTokenResponse Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

Eq GetAuthorizationTokenResponse Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

type Rep GetAuthorizationTokenResponse Source # 
Instance details

Defined in Amazonka.ECR.GetAuthorizationToken

type Rep GetAuthorizationTokenResponse = D1 ('MetaData "GetAuthorizationTokenResponse" "Amazonka.ECR.GetAuthorizationToken" "amazonka-ecr-2.0-BqgZWPod2JCFn2nq69DCrJ" 'False) (C1 ('MetaCons "GetAuthorizationTokenResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "authorizationData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AuthorizationData])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetAuthorizationTokenResponse Source #

Create a value of GetAuthorizationTokenResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authorizationData:GetAuthorizationTokenResponse', getAuthorizationTokenResponse_authorizationData - A list of authorization token data objects that correspond to the registryIds values in the request.

$sel:httpStatus:GetAuthorizationTokenResponse', getAuthorizationTokenResponse_httpStatus - The response's http status code.

Response Lenses

getAuthorizationTokenResponse_authorizationData :: Lens' GetAuthorizationTokenResponse (Maybe [AuthorizationData]) Source #

A list of authorization token data objects that correspond to the registryIds values in the request.