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

Description

List the schemas.

This operation returns paginated results.

Synopsis

Creating a Request

data ListSchemas Source #

See: newListSchemas smart constructor.

Constructors

ListSchemas' 

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.

  • schemaNamePrefix :: Maybe Text

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

  • registryName :: Text

    The name of the registry.

Instances

Instances details
ToHeaders ListSchemas Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

Methods

toHeaders :: ListSchemas -> [Header] #

ToPath ListSchemas Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

ToQuery ListSchemas Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

AWSPager ListSchemas Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

AWSRequest ListSchemas Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

Associated Types

type AWSResponse ListSchemas #

Generic ListSchemas Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

Associated Types

type Rep ListSchemas :: Type -> Type #

Read ListSchemas Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

Show ListSchemas Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

NFData ListSchemas Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

Methods

rnf :: ListSchemas -> () #

Eq ListSchemas Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

Hashable ListSchemas Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

type AWSResponse ListSchemas Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

type Rep ListSchemas Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

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

newListSchemas Source #

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

ListSchemas, listSchemas_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:schemaNamePrefix:ListSchemas', listSchemas_schemaNamePrefix - Specifying this limits the results to only those schema names that start with the specified prefix.

ListSchemas, listSchemas_registryName - The name of the registry.

Request Lenses

listSchemas_nextToken :: Lens' ListSchemas (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.

listSchemas_schemaNamePrefix :: Lens' ListSchemas (Maybe Text) Source #

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

Destructuring the Response

data ListSchemasResponse Source #

See: newListSchemasResponse smart constructor.

Constructors

ListSchemasResponse' 

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 [SchemaSummary]

    An array of schema summaries.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListSchemasResponse Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

Associated Types

type Rep ListSchemasResponse :: Type -> Type #

Read ListSchemasResponse Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

Show ListSchemasResponse Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

NFData ListSchemasResponse Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

Methods

rnf :: ListSchemasResponse -> () #

Eq ListSchemasResponse Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

type Rep ListSchemasResponse Source # 
Instance details

Defined in Amazonka.Schemas.ListSchemas

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

newListSchemasResponse Source #

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

ListSchemas, listSchemasResponse_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:ListSchemasResponse', listSchemasResponse_schemas - An array of schema summaries.

$sel:httpStatus:ListSchemasResponse', listSchemasResponse_httpStatus - The response's http status code.

Response Lenses

listSchemasResponse_nextToken :: Lens' ListSchemasResponse (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.