Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.ListTrialComponents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data ListTrialComponents = ListTrialComponents' {
- createdAfter :: Maybe POSIX
- createdBefore :: Maybe POSIX
- experimentName :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortBy :: Maybe SortTrialComponentsBy
- sortOrder :: Maybe SortOrder
- sourceArn :: Maybe Text
- trialName :: Maybe Text
}
newListTrialComponents :: ListTrialComponents
listTrialComponents_createdAfter :: Lens' ListTrialComponents (Maybe UTCTime)
listTrialComponents_createdBefore :: Lens' ListTrialComponents (Maybe UTCTime)
listTrialComponents_experimentName :: Lens' ListTrialComponents (Maybe Text)
listTrialComponents_maxResults :: Lens' ListTrialComponents (Maybe Natural)
listTrialComponents_nextToken :: Lens' ListTrialComponents (Maybe Text)
listTrialComponents_sortBy :: Lens' ListTrialComponents (Maybe SortTrialComponentsBy)
listTrialComponents_sortOrder :: Lens' ListTrialComponents (Maybe SortOrder)
listTrialComponents_sourceArn :: Lens' ListTrialComponents (Maybe Text)
listTrialComponents_trialName :: Lens' ListTrialComponents (Maybe Text)
data ListTrialComponentsResponse = ListTrialComponentsResponse' {
- nextToken :: Maybe Text
- trialComponentSummaries :: Maybe [TrialComponentSummary]
- httpStatus :: Int
}
newListTrialComponentsResponse :: Int -> ListTrialComponentsResponse
listTrialComponentsResponse_nextToken :: Lens' ListTrialComponentsResponse (Maybe Text)
listTrialComponentsResponse_trialComponentSummaries :: Lens' ListTrialComponentsResponse (Maybe [TrialComponentSummary])
listTrialComponentsResponse_httpStatus :: Lens' ListTrialComponentsResponse Int

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.
createdBefore :: Maybe POSIX
A filter that returns only components created before the specified time.
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.
maxResults :: Maybe Natural
The maximum number of components to return in the response. The default value is 10.
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.
sortBy :: Maybe SortTrialComponentsBy
The property used to sort results. The default value is CreationTime.
sortOrder :: Maybe SortOrder
The sort order. The default value is Descending.
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.
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.

Instances

Instances details

ToJSON ListTrialComponents Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents Methods toJSON :: ListTrialComponents -> Value # toEncoding :: ListTrialComponents -> Encoding # toJSONList :: [ListTrialComponents] -> Value # toEncodingList :: [ListTrialComponents] -> Encoding #
ToHeaders ListTrialComponents Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents Methods toHeaders :: ListTrialComponents -> [Header] #
ToPath ListTrialComponents Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents Methods toPath :: ListTrialComponents -> ByteString #
ToQuery ListTrialComponents Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents Methods toQuery :: ListTrialComponents -> QueryString #
AWSPager ListTrialComponents Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents Methods page :: ListTrialComponents -> AWSResponse ListTrialComponents -> Maybe ListTrialComponents #
AWSRequest ListTrialComponents Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents Associated Types type AWSResponse ListTrialComponents # Methods request :: (Service -> Service) -> ListTrialComponents -> Request ListTrialComponents # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListTrialComponents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTrialComponents))) #
Generic ListTrialComponents Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents Associated Types type Rep ListTrialComponents :: Type -> Type # Methods from :: ListTrialComponents -> Rep ListTrialComponents x # to :: Rep ListTrialComponents x -> ListTrialComponents #
Read ListTrialComponents Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents Methods readsPrec :: Int -> ReadS ListTrialComponents # readList :: ReadS [ListTrialComponents] # readPrec :: ReadPrec ListTrialComponents # readListPrec :: ReadPrec [ListTrialComponents] #
Show ListTrialComponents Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents Methods showsPrec :: Int -> ListTrialComponents -> ShowS # show :: ListTrialComponents -> String # showList :: [ListTrialComponents] -> ShowS #
NFData ListTrialComponents Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents Methods rnf :: ListTrialComponents -> () #
Eq ListTrialComponents Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents Methods (==) :: ListTrialComponents -> ListTrialComponents -> Bool # (/=) :: ListTrialComponents -> ListTrialComponents -> Bool #
Hashable ListTrialComponents Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents Methods hashWithSalt :: Int -> ListTrialComponents -> Int # hash :: ListTrialComponents -> Int #
type AWSResponse ListTrialComponents Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents type AWSResponse ListTrialComponents = ListTrialComponentsResponse
type Rep ListTrialComponents Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents type Rep ListTrialComponents = D1 ('MetaData "ListTrialComponents" "Amazonka.SageMaker.ListTrialComponents" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListTrialComponents'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "createdBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "experimentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortTrialComponentsBy))) :: (S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)) :: (S1 ('MetaSel ('Just "sourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "trialName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

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:

ListTrialComponents, listTrialComponents_createdAfter - A filter that returns only components created after the specified time.

ListTrialComponents, listTrialComponents_createdBefore - A filter that returns only components created before the specified time.

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:maxResults:ListTrialComponents', listTrialComponents_maxResults - The maximum number of components to return in the response. The default value is 10.

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:sortBy:ListTrialComponents', listTrialComponents_sortBy - The property used to sort results. The default value is CreationTime.

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

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.

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.

Request Lenses

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

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

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

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

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_maxResults :: Lens' ListTrialComponents (Maybe Natural) Source #

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

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_sortBy :: Lens' ListTrialComponents (Maybe SortTrialComponentsBy) Source #

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

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

The sort order. The default value is Descending.

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

Destructuring the Response

data ListTrialComponentsResponse Source #

See: newListTrialComponentsResponse smart constructor.

Constructors

ListTrialComponentsResponse'
Fields nextToken :: Maybe Text A token for getting the next set of components, if there are any. trialComponentSummaries :: Maybe [TrialComponentSummary] A list of the summaries of your trial components. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListTrialComponentsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents Associated Types type Rep ListTrialComponentsResponse :: Type -> Type # Methods from :: ListTrialComponentsResponse -> Rep ListTrialComponentsResponse x # to :: Rep ListTrialComponentsResponse x -> ListTrialComponentsResponse #
Read ListTrialComponentsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents Methods readsPrec :: Int -> ReadS ListTrialComponentsResponse # readList :: ReadS [ListTrialComponentsResponse] # readPrec :: ReadPrec ListTrialComponentsResponse # readListPrec :: ReadPrec [ListTrialComponentsResponse] #
Show ListTrialComponentsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents Methods showsPrec :: Int -> ListTrialComponentsResponse -> ShowS # show :: ListTrialComponentsResponse -> String # showList :: [ListTrialComponentsResponse] -> ShowS #
NFData ListTrialComponentsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents Methods rnf :: ListTrialComponentsResponse -> () #
Eq ListTrialComponentsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents Methods (==) :: ListTrialComponentsResponse -> ListTrialComponentsResponse -> Bool # (/=) :: ListTrialComponentsResponse -> ListTrialComponentsResponse -> Bool #
type Rep ListTrialComponentsResponse Source #
Instance details Defined in Amazonka.SageMaker.ListTrialComponents type Rep ListTrialComponentsResponse = D1 ('MetaData "ListTrialComponentsResponse" "Amazonka.SageMaker.ListTrialComponents" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListTrialComponentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "trialComponentSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TrialComponentSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTrialComponentsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListTrialComponentsResponse'`
-> ListTrialComponentsResponse

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:

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

ListTrialComponentsResponse, listTrialComponentsResponse_trialComponentSummaries - A list of the summaries of your trial components.

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

listTrialComponentsResponse_trialComponentSummaries :: Lens' ListTrialComponentsResponse (Maybe [TrialComponentSummary]) Source #

A list of the summaries of your trial components.

listTrialComponentsResponse_httpStatus :: Lens' ListTrialComponentsResponse Int Source #

The response's http status code.