libZSservicesZSamazonka-ecrZSamazonka-ecr
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ECR.DescribeRepositories

Description

Describes image repositories in a registry.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeRepositories Source #

See: newDescribeRepositories smart constructor.

Constructors

DescribeRepositories' 

Fields

  • registryId :: Maybe Text

    The Amazon Web Services account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.

  • repositoryNames :: Maybe (NonEmpty Text)

    A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

  • nextToken :: Maybe Text

    The nextToken value returned from a previous paginated DescribeRepositories 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 option cannot be used when you specify repositories with repositoryNames.

    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.

  • maxResults :: Maybe Natural

    The maximum number of repository results returned by DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories 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 DescribeRepositories request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify repositories with repositoryNames.

Instances

Instances details
Eq DescribeRepositories Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

Read DescribeRepositories Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

Show DescribeRepositories Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

Generic DescribeRepositories Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

Associated Types

type Rep DescribeRepositories :: Type -> Type #

NFData DescribeRepositories Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

Methods

rnf :: DescribeRepositories -> () #

Hashable DescribeRepositories Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

ToJSON DescribeRepositories Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

AWSPager DescribeRepositories Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

AWSRequest DescribeRepositories Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

Associated Types

type AWSResponse DescribeRepositories #

ToHeaders DescribeRepositories Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

ToPath DescribeRepositories Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

ToQuery DescribeRepositories Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

type Rep DescribeRepositories Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

type Rep DescribeRepositories = D1 ('MetaData "DescribeRepositories" "Amazonka.ECR.DescribeRepositories" "libZSservicesZSamazonka-ecrZSamazonka-ecr" 'False) (C1 ('MetaCons "DescribeRepositories'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "registryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "repositoryNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse DescribeRepositories Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

newDescribeRepositories :: DescribeRepositories Source #

Create a value of DescribeRepositories 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:registryId:DescribeRepositories', describeRepositories_registryId - The Amazon Web Services account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.

$sel:repositoryNames:DescribeRepositories', describeRepositories_repositoryNames - A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

$sel:nextToken:DescribeRepositories', describeRepositories_nextToken - The nextToken value returned from a previous paginated DescribeRepositories 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 option cannot be used when you specify repositories with repositoryNames.

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.

$sel:maxResults:DescribeRepositories', describeRepositories_maxResults - The maximum number of repository results returned by DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories 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 DescribeRepositories request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify repositories with repositoryNames.

Request Lenses

describeRepositories_registryId :: Lens' DescribeRepositories (Maybe Text) Source #

The Amazon Web Services account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.

describeRepositories_repositoryNames :: Lens' DescribeRepositories (Maybe (NonEmpty Text)) Source #

A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

describeRepositories_nextToken :: Lens' DescribeRepositories (Maybe Text) Source #

The nextToken value returned from a previous paginated DescribeRepositories 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 option cannot be used when you specify repositories with repositoryNames.

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.

describeRepositories_maxResults :: Lens' DescribeRepositories (Maybe Natural) Source #

The maximum number of repository results returned by DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories 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 DescribeRepositories request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify repositories with repositoryNames.

Destructuring the Response

data DescribeRepositoriesResponse Source #

See: newDescribeRepositoriesResponse smart constructor.

Constructors

DescribeRepositoriesResponse' 

Fields

  • repositories :: Maybe [Repository]

    A list of repository objects corresponding to valid repositories.

  • 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.

Instances

Instances details
Eq DescribeRepositoriesResponse Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

Read DescribeRepositoriesResponse Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

Show DescribeRepositoriesResponse Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

Generic DescribeRepositoriesResponse Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

Associated Types

type Rep DescribeRepositoriesResponse :: Type -> Type #

NFData DescribeRepositoriesResponse Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

type Rep DescribeRepositoriesResponse Source # 
Instance details

Defined in Amazonka.ECR.DescribeRepositories

type Rep DescribeRepositoriesResponse = D1 ('MetaData "DescribeRepositoriesResponse" "Amazonka.ECR.DescribeRepositories" "libZSservicesZSamazonka-ecrZSamazonka-ecr" 'False) (C1 ('MetaCons "DescribeRepositoriesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "repositories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Repository])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeRepositoriesResponse Source #

Create a value of DescribeRepositoriesResponse 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:repositories:DescribeRepositoriesResponse', describeRepositoriesResponse_repositories - A list of repository objects corresponding to valid repositories.

$sel:nextToken:DescribeRepositories', describeRepositoriesResponse_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:DescribeRepositoriesResponse', describeRepositoriesResponse_httpStatus - The response's http status code.

Response Lenses

describeRepositoriesResponse_repositories :: Lens' DescribeRepositoriesResponse (Maybe [Repository]) Source #

A list of repository objects corresponding to valid repositories.

describeRepositoriesResponse_nextToken :: Lens' DescribeRepositoriesResponse (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.