libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SageMaker.ListTrialComponents

Description

Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:

  • ExperimentName
  • SourceArn
  • TrialName

This operation returns paginated results.

Synopsis

Creating a Request

data ListTrialComponents Source #

See: newListTrialComponents smart constructor.

Constructors

ListTrialComponents' 

Fields

  • createdAfter :: Maybe POSIX

    A filter that returns only components created after the specified time.

  • sourceArn :: Maybe Text

    A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn, you can't filter by ExperimentName or TrialName.

  • experimentName :: Maybe Text

    A filter that returns only components that are part of the specified experiment. If you specify ExperimentName, you can't filter by SourceArn or TrialName.

  • nextToken :: Maybe Text

    If the previous call to ListTrialComponents didn't return the full set of components, the call returns a token for getting the next set of components.

  • sortOrder :: Maybe SortOrder

    The sort order. The default value is Descending.

  • trialName :: Maybe Text

    A filter that returns only components that are part of the specified trial. If you specify TrialName, you can't filter by ExperimentName or SourceArn.

  • maxResults :: Maybe Natural

    The maximum number of components to return in the response. The default value is 10.

  • createdBefore :: Maybe POSIX

    A filter that returns only components created before the specified time.

  • sortBy :: Maybe SortTrialComponentsBy

    The property used to sort results. The default value is CreationTime.

Instances

Instances details
Eq ListTrialComponents Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

Read ListTrialComponents Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

Show ListTrialComponents Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

Generic ListTrialComponents Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

Associated Types

type Rep ListTrialComponents :: Type -> Type #

NFData ListTrialComponents Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

Methods

rnf :: ListTrialComponents -> () #

Hashable ListTrialComponents Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

ToJSON ListTrialComponents Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

AWSPager ListTrialComponents Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

AWSRequest ListTrialComponents Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

Associated Types

type AWSResponse ListTrialComponents #

ToHeaders ListTrialComponents Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

ToPath ListTrialComponents Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

ToQuery ListTrialComponents Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

type Rep ListTrialComponents Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

type AWSResponse ListTrialComponents Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

newListTrialComponents :: ListTrialComponents Source #

Create a value of ListTrialComponents 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:createdAfter:ListTrialComponents', listTrialComponents_createdAfter - A filter that returns only components created after the specified time.

$sel:sourceArn:ListTrialComponents', listTrialComponents_sourceArn - A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn, you can't filter by ExperimentName or TrialName.

$sel:experimentName:ListTrialComponents', listTrialComponents_experimentName - A filter that returns only components that are part of the specified experiment. If you specify ExperimentName, you can't filter by SourceArn or TrialName.

$sel:nextToken:ListTrialComponents', listTrialComponents_nextToken - If the previous call to ListTrialComponents didn't return the full set of components, the call returns a token for getting the next set of components.

$sel:sortOrder:ListTrialComponents', listTrialComponents_sortOrder - The sort order. The default value is Descending.

$sel:trialName:ListTrialComponents', listTrialComponents_trialName - A filter that returns only components that are part of the specified trial. If you specify TrialName, you can't filter by ExperimentName or SourceArn.

$sel:maxResults:ListTrialComponents', listTrialComponents_maxResults - The maximum number of components to return in the response. The default value is 10.

$sel:createdBefore:ListTrialComponents', listTrialComponents_createdBefore - A filter that returns only components created before the specified time.

$sel:sortBy:ListTrialComponents', listTrialComponents_sortBy - The property used to sort results. The default value is CreationTime.

Request Lenses

listTrialComponents_createdAfter :: Lens' ListTrialComponents (Maybe UTCTime) Source #

A filter that returns only components created after the specified time.

listTrialComponents_sourceArn :: Lens' ListTrialComponents (Maybe Text) Source #

A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn, you can't filter by ExperimentName or TrialName.

listTrialComponents_experimentName :: Lens' ListTrialComponents (Maybe Text) Source #

A filter that returns only components that are part of the specified experiment. If you specify ExperimentName, you can't filter by SourceArn or TrialName.

listTrialComponents_nextToken :: Lens' ListTrialComponents (Maybe Text) Source #

If the previous call to ListTrialComponents didn't return the full set of components, the call returns a token for getting the next set of components.

listTrialComponents_sortOrder :: Lens' ListTrialComponents (Maybe SortOrder) Source #

The sort order. The default value is Descending.

listTrialComponents_trialName :: Lens' ListTrialComponents (Maybe Text) Source #

A filter that returns only components that are part of the specified trial. If you specify TrialName, you can't filter by ExperimentName or SourceArn.

listTrialComponents_maxResults :: Lens' ListTrialComponents (Maybe Natural) Source #

The maximum number of components to return in the response. The default value is 10.

listTrialComponents_createdBefore :: Lens' ListTrialComponents (Maybe UTCTime) Source #

A filter that returns only components created before the specified time.

listTrialComponents_sortBy :: Lens' ListTrialComponents (Maybe SortTrialComponentsBy) Source #

The property used to sort results. The default value is CreationTime.

Destructuring the Response

data ListTrialComponentsResponse Source #

See: newListTrialComponentsResponse smart constructor.

Constructors

ListTrialComponentsResponse' 

Fields

Instances

Instances details
Eq ListTrialComponentsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

Read ListTrialComponentsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

Show ListTrialComponentsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

Generic ListTrialComponentsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

Associated Types

type Rep ListTrialComponentsResponse :: Type -> Type #

NFData ListTrialComponentsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

type Rep ListTrialComponentsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListTrialComponents

type Rep ListTrialComponentsResponse = D1 ('MetaData "ListTrialComponentsResponse" "Amazonka.SageMaker.ListTrialComponents" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "ListTrialComponentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "trialComponentSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TrialComponentSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTrialComponentsResponse Source #

Create a value of ListTrialComponentsResponse 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:trialComponentSummaries:ListTrialComponentsResponse', listTrialComponentsResponse_trialComponentSummaries - A list of the summaries of your trial components.

$sel:nextToken:ListTrialComponents', listTrialComponentsResponse_nextToken - A token for getting the next set of components, if there are any.

$sel:httpStatus:ListTrialComponentsResponse', listTrialComponentsResponse_httpStatus - The response's http status code.

Response Lenses

listTrialComponentsResponse_nextToken :: Lens' ListTrialComponentsResponse (Maybe Text) Source #

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