amazonka-schemas-2.0: Amazon Schemas 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.Schemas.ListRegistries

Description

List the registries.

This operation returns paginated results.

Synopsis

Creating a Request

data ListRegistries Source #

See: newListRegistries smart constructor.

Constructors

ListRegistries' 

Fields

  • limit :: Maybe Int
     
  • nextToken :: Maybe Text

    The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

  • registryNamePrefix :: Maybe Text

    Specifying this limits the results to only those registry names that start with the specified prefix.

  • scope :: Maybe Text

    Can be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS.

Instances

Instances details
ToHeaders ListRegistries Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

Methods

toHeaders :: ListRegistries -> [Header] #

ToPath ListRegistries Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

Methods

toPath :: ListRegistries -> ByteString #

ToQuery ListRegistries Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

Methods

toQuery :: ListRegistries -> QueryString #

AWSPager ListRegistries Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

Methods

page :: ListRegistries -> AWSResponse ListRegistries -> Maybe ListRegistries #

AWSRequest ListRegistries Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

Associated Types

type AWSResponse ListRegistries #

Methods

request :: (Service -> Service) -> ListRegistries -> Request ListRegistries #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListRegistries -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListRegistries))) #

Generic ListRegistries Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

Associated Types

type Rep ListRegistries :: Type -> Type #

Methods

from :: ListRegistries -> Rep ListRegistries x #

to :: Rep ListRegistries x -> ListRegistries #

Read ListRegistries Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

Methods

readsPrec :: Int -> ReadS ListRegistries #

readList :: ReadS [ListRegistries] #

readPrec :: ReadPrec ListRegistries #

readListPrec :: ReadPrec [ListRegistries] #

Show ListRegistries Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

Methods

showsPrec :: Int -> ListRegistries -> ShowS #

show :: ListRegistries -> String #

showList :: [ListRegistries] -> ShowS #

NFData ListRegistries Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

Methods

rnf :: ListRegistries -> () #

Eq ListRegistries Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

Methods

(==) :: ListRegistries -> ListRegistries -> Bool #

(/=) :: ListRegistries -> ListRegistries -> Bool #

Hashable ListRegistries Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

Methods

hashWithSalt :: Int -> ListRegistries -> Int #

hash :: ListRegistries -> Int #

type AWSResponse ListRegistries Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

type AWSResponse ListRegistries = ListRegistriesResponse
type Rep ListRegistries Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

type Rep ListRegistries = D1 ('MetaData "ListRegistries" "Amazonka.Schemas.ListRegistries" "amazonka-schemas-2.0-BJyIo2S2AS7BU9nZBCcS3" 'False) (C1 ('MetaCons "ListRegistries'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "registryNamePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListRegistries :: ListRegistries Source #

Create a value of ListRegistries 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:limit:ListRegistries', listRegistries_limit - Undocumented member.

ListRegistries, listRegistries_nextToken - The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

$sel:registryNamePrefix:ListRegistries', listRegistries_registryNamePrefix - Specifying this limits the results to only those registry names that start with the specified prefix.

$sel:scope:ListRegistries', listRegistries_scope - Can be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS.

Request Lenses

listRegistries_limit :: Lens' ListRegistries (Maybe Int) Source #

Undocumented member.

listRegistries_nextToken :: Lens' ListRegistries (Maybe Text) Source #

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

listRegistries_registryNamePrefix :: Lens' ListRegistries (Maybe Text) Source #

Specifying this limits the results to only those registry names that start with the specified prefix.

listRegistries_scope :: Lens' ListRegistries (Maybe Text) Source #

Can be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS.

Destructuring the Response

data ListRegistriesResponse Source #

See: newListRegistriesResponse smart constructor.

Constructors

ListRegistriesResponse' 

Fields

  • nextToken :: Maybe Text

    The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

  • registries :: Maybe [RegistrySummary]

    An array of registry summaries.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListRegistriesResponse Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

Associated Types

type Rep ListRegistriesResponse :: Type -> Type #

Methods

from :: ListRegistriesResponse -> Rep ListRegistriesResponse x #

to :: Rep ListRegistriesResponse x -> ListRegistriesResponse #

Read ListRegistriesResponse Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

Methods

readsPrec :: Int -> ReadS ListRegistriesResponse #

readList :: ReadS [ListRegistriesResponse] #

readPrec :: ReadPrec ListRegistriesResponse #

readListPrec :: ReadPrec [ListRegistriesResponse] #

Show ListRegistriesResponse Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

Methods

showsPrec :: Int -> ListRegistriesResponse -> ShowS #

show :: ListRegistriesResponse -> String #

showList :: [ListRegistriesResponse] -> ShowS #

NFData ListRegistriesResponse Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

Methods

rnf :: ListRegistriesResponse -> () #

Eq ListRegistriesResponse Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

Methods

(==) :: ListRegistriesResponse -> ListRegistriesResponse -> Bool #

(/=) :: ListRegistriesResponse -> ListRegistriesResponse -> Bool #

type Rep ListRegistriesResponse Source # 
Instance details

Defined in Amazonka.Schemas.ListRegistries

type Rep ListRegistriesResponse = D1 ('MetaData "ListRegistriesResponse" "Amazonka.Schemas.ListRegistries" "amazonka-schemas-2.0-BJyIo2S2AS7BU9nZBCcS3" 'False) (C1 ('MetaCons "ListRegistriesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "registries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RegistrySummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListRegistriesResponse Source #

Arguments

:: Int

$sel:httpStatus:ListRegistriesResponse'

-> ListRegistriesResponse 

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

ListRegistries, listRegistriesResponse_nextToken - The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

$sel:registries:ListRegistriesResponse', listRegistriesResponse_registries - An array of registry summaries.

$sel:httpStatus:ListRegistriesResponse', listRegistriesResponse_httpStatus - The response's http status code.

Response Lenses

listRegistriesResponse_nextToken :: Lens' ListRegistriesResponse (Maybe Text) Source #

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

listRegistriesResponse_registries :: Lens' ListRegistriesResponse (Maybe [RegistrySummary]) Source #

An array of registry summaries.

listRegistriesResponse_httpStatus :: Lens' ListRegistriesResponse Int Source #

The response's http status code.