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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the aliases of a specified image or image version.

This operation returns paginated results.

Synopsis

data ListAliases = ListAliases' {
- alias :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- version :: Maybe Natural
- imageName :: Text
}
newListAliases :: Text -> ListAliases
listAliases_alias :: Lens' ListAliases (Maybe Text)
listAliases_maxResults :: Lens' ListAliases (Maybe Natural)
listAliases_nextToken :: Lens' ListAliases (Maybe Text)
listAliases_version :: Lens' ListAliases (Maybe Natural)
listAliases_imageName :: Lens' ListAliases Text
data ListAliasesResponse = ListAliasesResponse' {
- nextToken :: Maybe Text
- sageMakerImageVersionAliases :: Maybe [Text]
- httpStatus :: Int
}
newListAliasesResponse :: Int -> ListAliasesResponse
listAliasesResponse_nextToken :: Lens' ListAliasesResponse (Maybe Text)
listAliasesResponse_sageMakerImageVersionAliases :: Lens' ListAliasesResponse (Maybe [Text])
listAliasesResponse_httpStatus :: Lens' ListAliasesResponse Int

Creating a Request

data ListAliases Source #

See: newListAliases smart constructor.

Constructors

ListAliases'

Fields

alias :: Maybe Text
The alias of the image version.
maxResults :: Maybe Natural
The maximum number of aliases to return.
nextToken :: Maybe Text
If the previous call to ListAliases didn't return the full set of aliases, the call returns a token for retrieving the next set of aliases.
version :: Maybe Natural
The version of the image. If image version is not specified, the aliases of all versions of the image are listed.
imageName :: Text
The name of the image.

Instances

Instances details

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

newListAliases Source #

Arguments

:: Text	`ListAliases`
-> ListAliases

Create a value of ListAliases 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:alias:ListAliases', listAliases_alias - The alias of the image version.

$sel:maxResults:ListAliases', listAliases_maxResults - The maximum number of aliases to return.

ListAliases, listAliases_nextToken - If the previous call to ListAliases didn't return the full set of aliases, the call returns a token for retrieving the next set of aliases.

ListAliases, listAliases_version - The version of the image. If image version is not specified, the aliases of all versions of the image are listed.

ListAliases, listAliases_imageName - The name of the image.

Request Lenses

listAliases_alias :: Lens' ListAliases (Maybe Text) Source #

The alias of the image version.

listAliases_maxResults :: Lens' ListAliases (Maybe Natural) Source #

The maximum number of aliases to return.

listAliases_nextToken :: Lens' ListAliases (Maybe Text) Source #

If the previous call to ListAliases didn't return the full set of aliases, the call returns a token for retrieving the next set of aliases.

listAliases_version :: Lens' ListAliases (Maybe Natural) Source #

The version of the image. If image version is not specified, the aliases of all versions of the image are listed.

listAliases_imageName :: Lens' ListAliases Text Source #

The name of the image.

Destructuring the Response

data ListAliasesResponse Source #

See: newListAliasesResponse smart constructor.

Constructors

ListAliasesResponse'
Fields nextToken :: Maybe Text A token for getting the next set of aliases, if more aliases exist. sageMakerImageVersionAliases :: Maybe [Text] A list of SageMaker image version aliases. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListAliasesResponse Source #

Arguments

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

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

ListAliases, listAliasesResponse_nextToken - A token for getting the next set of aliases, if more aliases exist.

$sel:sageMakerImageVersionAliases:ListAliasesResponse', listAliasesResponse_sageMakerImageVersionAliases - A list of SageMaker image version aliases.

$sel:httpStatus:ListAliasesResponse', listAliasesResponse_httpStatus - The response's http status code.

Response Lenses

listAliasesResponse_nextToken :: Lens' ListAliasesResponse (Maybe Text) Source #

A token for getting the next set of aliases, if more aliases exist.

listAliasesResponse_sageMakerImageVersionAliases :: Lens' ListAliasesResponse (Maybe [Text]) Source #

A list of SageMaker image version aliases.

listAliasesResponse_httpStatus :: Lens' ListAliasesResponse Int Source #

The response's http status code.