amazonka-ecr-public-2.0: Amazon Elastic Container Registry Public 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.ECRPublic.DescribeRegistries

Description

Returns details for a public registry.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeRegistries Source #

See: newDescribeRegistries smart constructor.

Constructors

DescribeRegistries' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of repository results returned by DescribeRegistries in paginated output. When this parameter is used, DescribeRegistries only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRegistries request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRegistries returns up to 100 results and a nextToken value, if applicable.

  • nextToken :: Maybe Text

    The nextToken value returned from a previous paginated DescribeRegistries request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Instances

Instances details
ToJSON DescribeRegistries Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

ToHeaders DescribeRegistries Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

ToPath DescribeRegistries Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

ToQuery DescribeRegistries Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

AWSPager DescribeRegistries Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

AWSRequest DescribeRegistries Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

Associated Types

type AWSResponse DescribeRegistries #

Generic DescribeRegistries Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

Associated Types

type Rep DescribeRegistries :: Type -> Type #

Read DescribeRegistries Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

Show DescribeRegistries Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

NFData DescribeRegistries Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

Methods

rnf :: DescribeRegistries -> () #

Eq DescribeRegistries Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

Hashable DescribeRegistries Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

type AWSResponse DescribeRegistries Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

type Rep DescribeRegistries Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

type Rep DescribeRegistries = D1 ('MetaData "DescribeRegistries" "Amazonka.ECRPublic.DescribeRegistries" "amazonka-ecr-public-2.0-37SU5CHdiHw3VhMeSkOlop" 'False) (C1 ('MetaCons "DescribeRegistries'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDescribeRegistries :: DescribeRegistries Source #

Create a value of DescribeRegistries 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:maxResults:DescribeRegistries', describeRegistries_maxResults - The maximum number of repository results returned by DescribeRegistries in paginated output. When this parameter is used, DescribeRegistries only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRegistries request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRegistries returns up to 100 results and a nextToken value, if applicable.

DescribeRegistries, describeRegistries_nextToken - The nextToken value returned from a previous paginated DescribeRegistries request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Request Lenses

describeRegistries_maxResults :: Lens' DescribeRegistries (Maybe Natural) Source #

The maximum number of repository results returned by DescribeRegistries in paginated output. When this parameter is used, DescribeRegistries only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRegistries request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRegistries returns up to 100 results and a nextToken value, if applicable.

describeRegistries_nextToken :: Lens' DescribeRegistries (Maybe Text) Source #

The nextToken value returned from a previous paginated DescribeRegistries request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Destructuring the Response

data DescribeRegistriesResponse Source #

See: newDescribeRegistriesResponse smart constructor.

Constructors

DescribeRegistriesResponse' 

Fields

  • nextToken :: Maybe Text

    The nextToken value to include in a future DescribeRepositories request. When the results of a DescribeRepositories request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

  • httpStatus :: Int

    The response's http status code.

  • registries :: [Registry]

    An object containing the details for a public registry.

Instances

Instances details
Generic DescribeRegistriesResponse Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

Associated Types

type Rep DescribeRegistriesResponse :: Type -> Type #

Read DescribeRegistriesResponse Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

Show DescribeRegistriesResponse Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

NFData DescribeRegistriesResponse Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

Eq DescribeRegistriesResponse Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

type Rep DescribeRegistriesResponse Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeRegistries

type Rep DescribeRegistriesResponse = D1 ('MetaData "DescribeRegistriesResponse" "Amazonka.ECRPublic.DescribeRegistries" "amazonka-ecr-public-2.0-37SU5CHdiHw3VhMeSkOlop" 'False) (C1 ('MetaCons "DescribeRegistriesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "registries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Registry]))))

newDescribeRegistriesResponse Source #

Create a value of DescribeRegistriesResponse 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:

DescribeRegistries, describeRegistriesResponse_nextToken - The nextToken value to include in a future DescribeRepositories request. When the results of a DescribeRepositories request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:DescribeRegistriesResponse', describeRegistriesResponse_httpStatus - The response's http status code.

$sel:registries:DescribeRegistriesResponse', describeRegistriesResponse_registries - An object containing the details for a public registry.

Response Lenses

describeRegistriesResponse_nextToken :: Lens' DescribeRegistriesResponse (Maybe Text) Source #

The nextToken value to include in a future DescribeRepositories request. When the results of a DescribeRepositories request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

describeRegistriesResponse_registries :: Lens' DescribeRegistriesResponse [Registry] Source #

An object containing the details for a public registry.