Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ECR.DescribeRepositories

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes image repositories in a registry.

This operation returns paginated results.

Synopsis

data DescribeRepositories = DescribeRepositories' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- registryId :: Maybe Text
- repositoryNames :: Maybe (NonEmpty Text)
}
newDescribeRepositories :: DescribeRepositories
describeRepositories_maxResults :: Lens' DescribeRepositories (Maybe Natural)
describeRepositories_nextToken :: Lens' DescribeRepositories (Maybe Text)
describeRepositories_registryId :: Lens' DescribeRepositories (Maybe Text)
describeRepositories_repositoryNames :: Lens' DescribeRepositories (Maybe (NonEmpty Text))
data DescribeRepositoriesResponse = DescribeRepositoriesResponse' {
- nextToken :: Maybe Text
- repositories :: Maybe [Repository]
- httpStatus :: Int
}
newDescribeRepositoriesResponse :: Int -> DescribeRepositoriesResponse
describeRepositoriesResponse_nextToken :: Lens' DescribeRepositoriesResponse (Maybe Text)
describeRepositoriesResponse_repositories :: Lens' DescribeRepositoriesResponse (Maybe [Repository])
describeRepositoriesResponse_httpStatus :: Lens' DescribeRepositoriesResponse Int

Creating a Request

data DescribeRepositories Source #

See: newDescribeRepositories smart constructor.

Constructors

DescribeRepositories'

Fields

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

Instances

Instances details

ToJSON DescribeRepositories Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories Methods toJSON :: DescribeRepositories -> Value # toEncoding :: DescribeRepositories -> Encoding # toJSONList :: [DescribeRepositories] -> Value # toEncodingList :: [DescribeRepositories] -> Encoding #
ToHeaders DescribeRepositories Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories Methods toHeaders :: DescribeRepositories -> [Header] #
ToPath DescribeRepositories Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories Methods toPath :: DescribeRepositories -> ByteString #
ToQuery DescribeRepositories Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories Methods toQuery :: DescribeRepositories -> QueryString #
AWSPager DescribeRepositories Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories Methods page :: DescribeRepositories -> AWSResponse DescribeRepositories -> Maybe DescribeRepositories #
AWSRequest DescribeRepositories Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories Associated Types type AWSResponse DescribeRepositories # Methods request :: (Service -> Service) -> DescribeRepositories -> Request DescribeRepositories # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeRepositories -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeRepositories))) #
Generic DescribeRepositories Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories Associated Types type Rep DescribeRepositories :: Type -> Type # Methods from :: DescribeRepositories -> Rep DescribeRepositories x # to :: Rep DescribeRepositories x -> DescribeRepositories #
Read DescribeRepositories Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories Methods readsPrec :: Int -> ReadS DescribeRepositories # readList :: ReadS [DescribeRepositories] # readPrec :: ReadPrec DescribeRepositories # readListPrec :: ReadPrec [DescribeRepositories] #
Show DescribeRepositories Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories Methods showsPrec :: Int -> DescribeRepositories -> ShowS # show :: DescribeRepositories -> String # showList :: [DescribeRepositories] -> ShowS #
NFData DescribeRepositories Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories Methods rnf :: DescribeRepositories -> () #
Eq DescribeRepositories Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories Methods (==) :: DescribeRepositories -> DescribeRepositories -> Bool # (/=) :: DescribeRepositories -> DescribeRepositories -> Bool #
Hashable DescribeRepositories Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories Methods hashWithSalt :: Int -> DescribeRepositories -> Int # hash :: DescribeRepositories -> Int #
type AWSResponse DescribeRepositories Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories type AWSResponse DescribeRepositories = DescribeRepositoriesResponse
type Rep DescribeRepositories Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories type Rep DescribeRepositories = D1 ('MetaData "DescribeRepositories" "Amazonka.ECR.DescribeRepositories" "amazonka-ecr-2.0-BqgZWPod2JCFn2nq69DCrJ" 'False) (C1 ('MetaCons "DescribeRepositories'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "registryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "repositoryNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))))))

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

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.

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.

Request Lenses

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.

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

Destructuring the Response

data DescribeRepositoriesResponse Source #

See: newDescribeRepositoriesResponse smart constructor.

Constructors

DescribeRepositoriesResponse'

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.
repositories :: Maybe [Repository]
A list of repository objects corresponding to valid repositories.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeRepositoriesResponse Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories Associated Types type Rep DescribeRepositoriesResponse :: Type -> Type # Methods from :: DescribeRepositoriesResponse -> Rep DescribeRepositoriesResponse x # to :: Rep DescribeRepositoriesResponse x -> DescribeRepositoriesResponse #
Read DescribeRepositoriesResponse Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories Methods readsPrec :: Int -> ReadS DescribeRepositoriesResponse # readList :: ReadS [DescribeRepositoriesResponse] # readPrec :: ReadPrec DescribeRepositoriesResponse # readListPrec :: ReadPrec [DescribeRepositoriesResponse] #
Show DescribeRepositoriesResponse Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories Methods showsPrec :: Int -> DescribeRepositoriesResponse -> ShowS # show :: DescribeRepositoriesResponse -> String # showList :: [DescribeRepositoriesResponse] -> ShowS #
NFData DescribeRepositoriesResponse Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories Methods rnf :: DescribeRepositoriesResponse -> () #
Eq DescribeRepositoriesResponse Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories Methods (==) :: DescribeRepositoriesResponse -> DescribeRepositoriesResponse -> Bool # (/=) :: DescribeRepositoriesResponse -> DescribeRepositoriesResponse -> Bool #
type Rep DescribeRepositoriesResponse Source #
Instance details Defined in Amazonka.ECR.DescribeRepositories type Rep DescribeRepositoriesResponse = D1 ('MetaData "DescribeRepositoriesResponse" "Amazonka.ECR.DescribeRepositories" "amazonka-ecr-2.0-BqgZWPod2JCFn2nq69DCrJ" 'False) (C1 ('MetaCons "DescribeRepositoriesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "repositories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Repository])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeRepositoriesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeRepositoriesResponse'`
-> DescribeRepositoriesResponse

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:

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

$sel:httpStatus:DescribeRepositoriesResponse', describeRepositoriesResponse_httpStatus - The response's http status code.

Response Lenses

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.

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

A list of repository objects corresponding to valid repositories.

describeRepositoriesResponse_httpStatus :: Lens' DescribeRepositoriesResponse Int Source #

The response's http status code.