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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the associations in your account and their properties.

This operation returns paginated results.

Synopsis

data ListAssociations = ListAssociations' {
- associationType :: Maybe AssociationEdgeType
- createdAfter :: Maybe POSIX
- createdBefore :: Maybe POSIX
- destinationArn :: Maybe Text
- destinationType :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortBy :: Maybe SortAssociationsBy
- sortOrder :: Maybe SortOrder
- sourceArn :: Maybe Text
- sourceType :: Maybe Text
}
newListAssociations :: ListAssociations
listAssociations_associationType :: Lens' ListAssociations (Maybe AssociationEdgeType)
listAssociations_createdAfter :: Lens' ListAssociations (Maybe UTCTime)
listAssociations_createdBefore :: Lens' ListAssociations (Maybe UTCTime)
listAssociations_destinationArn :: Lens' ListAssociations (Maybe Text)
listAssociations_destinationType :: Lens' ListAssociations (Maybe Text)
listAssociations_maxResults :: Lens' ListAssociations (Maybe Natural)
listAssociations_nextToken :: Lens' ListAssociations (Maybe Text)
listAssociations_sortBy :: Lens' ListAssociations (Maybe SortAssociationsBy)
listAssociations_sortOrder :: Lens' ListAssociations (Maybe SortOrder)
listAssociations_sourceArn :: Lens' ListAssociations (Maybe Text)
listAssociations_sourceType :: Lens' ListAssociations (Maybe Text)
data ListAssociationsResponse = ListAssociationsResponse' {
- associationSummaries :: Maybe [AssociationSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListAssociationsResponse :: Int -> ListAssociationsResponse
listAssociationsResponse_associationSummaries :: Lens' ListAssociationsResponse (Maybe [AssociationSummary])
listAssociationsResponse_nextToken :: Lens' ListAssociationsResponse (Maybe Text)
listAssociationsResponse_httpStatus :: Lens' ListAssociationsResponse Int

Creating a Request

data ListAssociations Source #

See: newListAssociations smart constructor.

Constructors

ListAssociations'

Fields

associationType :: Maybe AssociationEdgeType
A filter that returns only associations of the specified type.
createdAfter :: Maybe POSIX
A filter that returns only associations created on or after the specified time.
createdBefore :: Maybe POSIX
A filter that returns only associations created on or before the specified time.
destinationArn :: Maybe Text
A filter that returns only associations with the specified destination Amazon Resource Name (ARN).
destinationType :: Maybe Text
A filter that returns only associations with the specified destination type.
maxResults :: Maybe Natural
The maximum number of associations to return in the response. The default value is 10.
nextToken :: Maybe Text
If the previous call to ListAssociations didn't return the full set of associations, the call returns a token for getting the next set of associations.
sortBy :: Maybe SortAssociationsBy
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 associations with the specified source ARN.
sourceType :: Maybe Text
A filter that returns only associations with the specified source type.

Instances

Instances details

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

newListAssociations :: ListAssociations Source #

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

ListAssociations, listAssociations_associationType - A filter that returns only associations of the specified type.

ListAssociations, listAssociations_createdAfter - A filter that returns only associations created on or after the specified time.

ListAssociations, listAssociations_createdBefore - A filter that returns only associations created on or before the specified time.

ListAssociations, listAssociations_destinationArn - A filter that returns only associations with the specified destination Amazon Resource Name (ARN).

ListAssociations, listAssociations_destinationType - A filter that returns only associations with the specified destination type.

$sel:maxResults:ListAssociations', listAssociations_maxResults - The maximum number of associations to return in the response. The default value is 10.

ListAssociations, listAssociations_nextToken - If the previous call to ListAssociations didn't return the full set of associations, the call returns a token for getting the next set of associations.

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

$sel:sortOrder:ListAssociations', listAssociations_sortOrder - The sort order. The default value is Descending.

ListAssociations, listAssociations_sourceArn - A filter that returns only associations with the specified source ARN.

ListAssociations, listAssociations_sourceType - A filter that returns only associations with the specified source type.

Request Lenses

listAssociations_associationType :: Lens' ListAssociations (Maybe AssociationEdgeType) Source #

A filter that returns only associations of the specified type.

listAssociations_createdAfter :: Lens' ListAssociations (Maybe UTCTime) Source #

A filter that returns only associations created on or after the specified time.

listAssociations_createdBefore :: Lens' ListAssociations (Maybe UTCTime) Source #

A filter that returns only associations created on or before the specified time.

listAssociations_destinationArn :: Lens' ListAssociations (Maybe Text) Source #

A filter that returns only associations with the specified destination Amazon Resource Name (ARN).

listAssociations_destinationType :: Lens' ListAssociations (Maybe Text) Source #

A filter that returns only associations with the specified destination type.

listAssociations_maxResults :: Lens' ListAssociations (Maybe Natural) Source #

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

listAssociations_nextToken :: Lens' ListAssociations (Maybe Text) Source #

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

listAssociations_sortBy :: Lens' ListAssociations (Maybe SortAssociationsBy) Source #

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

listAssociations_sortOrder :: Lens' ListAssociations (Maybe SortOrder) Source #

The sort order. The default value is Descending.

listAssociations_sourceArn :: Lens' ListAssociations (Maybe Text) Source #

A filter that returns only associations with the specified source ARN.

listAssociations_sourceType :: Lens' ListAssociations (Maybe Text) Source #

A filter that returns only associations with the specified source type.

Destructuring the Response

data ListAssociationsResponse Source #

See: newListAssociationsResponse smart constructor.

Constructors

ListAssociationsResponse'
Fields associationSummaries :: Maybe [AssociationSummary] A list of associations and their properties. nextToken :: Maybe Text A token for getting the next set of associations, if there are any. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListAssociationsResponse Source #

Arguments

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

Create a value of ListAssociationsResponse 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:associationSummaries:ListAssociationsResponse', listAssociationsResponse_associationSummaries - A list of associations and their properties.

ListAssociations, listAssociationsResponse_nextToken - A token for getting the next set of associations, if there are any.

$sel:httpStatus:ListAssociationsResponse', listAssociationsResponse_httpStatus - The response's http status code.

Response Lenses

listAssociationsResponse_associationSummaries :: Lens' ListAssociationsResponse (Maybe [AssociationSummary]) Source #

A list of associations and their properties.

listAssociationsResponse_nextToken :: Lens' ListAssociationsResponse (Maybe Text) Source #

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

listAssociationsResponse_httpStatus :: Lens' ListAssociationsResponse Int Source #

The response's http status code.