amazonka-sagemaker-2.0: Amazon SageMaker Service 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.SageMaker.ListModelMetadata

Description

Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.

This operation returns paginated results.

Synopsis

Creating a Request

data ListModelMetadata Source #

See: newListModelMetadata smart constructor.

Constructors

ListModelMetadata' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of models to return in the response.

  • nextToken :: Maybe Text

    If the response to a previous ListModelMetadataResponse request was truncated, the response includes a NextToken. To retrieve the next set of model metadata, use the token in the next request.

  • searchExpression :: Maybe ModelMetadataSearchExpression

    One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. Specify the Framework, FrameworkVersion, Domain or Task to filter supported. Filter names and values are case-sensitive.

Instances

Instances details
ToJSON ListModelMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

ToHeaders ListModelMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

ToPath ListModelMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

ToQuery ListModelMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

AWSPager ListModelMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

AWSRequest ListModelMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

Associated Types

type AWSResponse ListModelMetadata #

Generic ListModelMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

Associated Types

type Rep ListModelMetadata :: Type -> Type #

Read ListModelMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

Show ListModelMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

NFData ListModelMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

Methods

rnf :: ListModelMetadata -> () #

Eq ListModelMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

Hashable ListModelMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

type AWSResponse ListModelMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

type Rep ListModelMetadata Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

type Rep ListModelMetadata = D1 ('MetaData "ListModelMetadata" "Amazonka.SageMaker.ListModelMetadata" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListModelMetadata'" '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 "searchExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelMetadataSearchExpression)))))

newListModelMetadata :: ListModelMetadata Source #

Create a value of ListModelMetadata 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:ListModelMetadata', listModelMetadata_maxResults - The maximum number of models to return in the response.

ListModelMetadata, listModelMetadata_nextToken - If the response to a previous ListModelMetadataResponse request was truncated, the response includes a NextToken. To retrieve the next set of model metadata, use the token in the next request.

$sel:searchExpression:ListModelMetadata', listModelMetadata_searchExpression - One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. Specify the Framework, FrameworkVersion, Domain or Task to filter supported. Filter names and values are case-sensitive.

Request Lenses

listModelMetadata_maxResults :: Lens' ListModelMetadata (Maybe Natural) Source #

The maximum number of models to return in the response.

listModelMetadata_nextToken :: Lens' ListModelMetadata (Maybe Text) Source #

If the response to a previous ListModelMetadataResponse request was truncated, the response includes a NextToken. To retrieve the next set of model metadata, use the token in the next request.

listModelMetadata_searchExpression :: Lens' ListModelMetadata (Maybe ModelMetadataSearchExpression) Source #

One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. Specify the Framework, FrameworkVersion, Domain or Task to filter supported. Filter names and values are case-sensitive.

Destructuring the Response

data ListModelMetadataResponse Source #

See: newListModelMetadataResponse smart constructor.

Constructors

ListModelMetadataResponse' 

Fields

Instances

Instances details
Generic ListModelMetadataResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

Associated Types

type Rep ListModelMetadataResponse :: Type -> Type #

Read ListModelMetadataResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

Show ListModelMetadataResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

NFData ListModelMetadataResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

Eq ListModelMetadataResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

type Rep ListModelMetadataResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelMetadata

type Rep ListModelMetadataResponse = D1 ('MetaData "ListModelMetadataResponse" "Amazonka.SageMaker.ListModelMetadata" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListModelMetadataResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "modelMetadataSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ModelMetadataSummary]))))

newListModelMetadataResponse Source #

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

ListModelMetadata, listModelMetadataResponse_nextToken - A token for getting the next set of recommendations, if there are any.

$sel:httpStatus:ListModelMetadataResponse', listModelMetadataResponse_httpStatus - The response's http status code.

$sel:modelMetadataSummaries:ListModelMetadataResponse', listModelMetadataResponse_modelMetadataSummaries - A structure that holds model metadata.

Response Lenses

listModelMetadataResponse_nextToken :: Lens' ListModelMetadataResponse (Maybe Text) Source #

A token for getting the next set of recommendations, if there are any.