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

Description

Search the schemas

This operation returns paginated results.

Synopsis

Creating a Request

data SearchSchemas Source #

See: newSearchSchemas smart constructor.

Constructors

SearchSchemas' 

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.

  • registryName :: Text

    The name of the registry.

  • keywords :: Text

    Specifying this limits the results to only schemas that include the provided keywords.

Instances

Instances details
ToHeaders SearchSchemas Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

Methods

toHeaders :: SearchSchemas -> [Header] #

ToPath SearchSchemas Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

Methods

toPath :: SearchSchemas -> ByteString #

ToQuery SearchSchemas Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

Methods

toQuery :: SearchSchemas -> QueryString #

AWSPager SearchSchemas Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

Methods

page :: SearchSchemas -> AWSResponse SearchSchemas -> Maybe SearchSchemas #

AWSRequest SearchSchemas Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

Associated Types

type AWSResponse SearchSchemas #

Methods

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

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

Generic SearchSchemas Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

Associated Types

type Rep SearchSchemas :: Type -> Type #

Methods

from :: SearchSchemas -> Rep SearchSchemas x #

to :: Rep SearchSchemas x -> SearchSchemas #

Read SearchSchemas Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

Methods

readsPrec :: Int -> ReadS SearchSchemas #

readList :: ReadS [SearchSchemas] #

readPrec :: ReadPrec SearchSchemas #

readListPrec :: ReadPrec [SearchSchemas] #

Show SearchSchemas Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

Methods

showsPrec :: Int -> SearchSchemas -> ShowS #

show :: SearchSchemas -> String #

showList :: [SearchSchemas] -> ShowS #

NFData SearchSchemas Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

Methods

rnf :: SearchSchemas -> () #

Eq SearchSchemas Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

Methods

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

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

Hashable SearchSchemas Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

Methods

hashWithSalt :: Int -> SearchSchemas -> Int #

hash :: SearchSchemas -> Int #

type AWSResponse SearchSchemas Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

type AWSResponse SearchSchemas = SearchSchemasResponse
type Rep SearchSchemas Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

type Rep SearchSchemas = D1 ('MetaData "SearchSchemas" "Amazonka.Schemas.SearchSchemas" "amazonka-schemas-2.0-BJyIo2S2AS7BU9nZBCcS3" 'False) (C1 ('MetaCons "SearchSchemas'" '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 "registryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "keywords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSearchSchemas Source #

Arguments

:: Text

SearchSchemas

-> Text

$sel:keywords:SearchSchemas'

-> SearchSchemas 

Create a value of SearchSchemas 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:SearchSchemas', searchSchemas_limit - Undocumented member.

SearchSchemas, searchSchemas_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.

SearchSchemas, searchSchemas_registryName - The name of the registry.

$sel:keywords:SearchSchemas', searchSchemas_keywords - Specifying this limits the results to only schemas that include the provided keywords.

Request Lenses

searchSchemas_limit :: Lens' SearchSchemas (Maybe Int) Source #

Undocumented member.

searchSchemas_nextToken :: Lens' SearchSchemas (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.

searchSchemas_registryName :: Lens' SearchSchemas Text Source #

The name of the registry.

searchSchemas_keywords :: Lens' SearchSchemas Text Source #

Specifying this limits the results to only schemas that include the provided keywords.

Destructuring the Response

data SearchSchemasResponse Source #

See: newSearchSchemasResponse smart constructor.

Constructors

SearchSchemasResponse' 

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.

  • schemas :: Maybe [SearchSchemaSummary]

    An array of SearchSchemaSummary information.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic SearchSchemasResponse Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

Associated Types

type Rep SearchSchemasResponse :: Type -> Type #

Methods

from :: SearchSchemasResponse -> Rep SearchSchemasResponse x #

to :: Rep SearchSchemasResponse x -> SearchSchemasResponse #

Read SearchSchemasResponse Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

Methods

readsPrec :: Int -> ReadS SearchSchemasResponse #

readList :: ReadS [SearchSchemasResponse] #

readPrec :: ReadPrec SearchSchemasResponse #

readListPrec :: ReadPrec [SearchSchemasResponse] #

Show SearchSchemasResponse Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

Methods

showsPrec :: Int -> SearchSchemasResponse -> ShowS #

show :: SearchSchemasResponse -> String #

showList :: [SearchSchemasResponse] -> ShowS #

NFData SearchSchemasResponse Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

Methods

rnf :: SearchSchemasResponse -> () #

Eq SearchSchemasResponse Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

Methods

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

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

type Rep SearchSchemasResponse Source # 
Instance details

Defined in Amazonka.Schemas.SearchSchemas

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

newSearchSchemasResponse Source #

Arguments

:: Int

$sel:httpStatus:SearchSchemasResponse'

-> SearchSchemasResponse 

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

SearchSchemas, searchSchemasResponse_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:schemas:SearchSchemasResponse', searchSchemasResponse_schemas - An array of SearchSchemaSummary information.

$sel:httpStatus:SearchSchemasResponse', searchSchemasResponse_httpStatus - The response's http status code.

Response Lenses

searchSchemasResponse_nextToken :: Lens' SearchSchemasResponse (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.

searchSchemasResponse_schemas :: Lens' SearchSchemasResponse (Maybe [SearchSchemaSummary]) Source #

An array of SearchSchemaSummary information.

searchSchemasResponse_httpStatus :: Lens' SearchSchemasResponse Int Source #

The response's http status code.