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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists devices allocated to the stage, containing detailed device information and deployment status.

This operation returns paginated results.

Synopsis

data ListStageDevices = ListStageDevices' {
- excludeDevicesDeployedInOtherStage :: Maybe Bool
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- edgeDeploymentPlanName :: Text
- stageName :: Text
}
newListStageDevices :: Text -> Text -> ListStageDevices
listStageDevices_excludeDevicesDeployedInOtherStage :: Lens' ListStageDevices (Maybe Bool)
listStageDevices_maxResults :: Lens' ListStageDevices (Maybe Int)
listStageDevices_nextToken :: Lens' ListStageDevices (Maybe Text)
listStageDevices_edgeDeploymentPlanName :: Lens' ListStageDevices Text
listStageDevices_stageName :: Lens' ListStageDevices Text
data ListStageDevicesResponse = ListStageDevicesResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- deviceDeploymentSummaries :: [DeviceDeploymentSummary]
}
newListStageDevicesResponse :: Int -> ListStageDevicesResponse
listStageDevicesResponse_nextToken :: Lens' ListStageDevicesResponse (Maybe Text)
listStageDevicesResponse_httpStatus :: Lens' ListStageDevicesResponse Int
listStageDevicesResponse_deviceDeploymentSummaries :: Lens' ListStageDevicesResponse [DeviceDeploymentSummary]

Creating a Request

data ListStageDevices Source #

See: newListStageDevices smart constructor.

Constructors

ListStageDevices'

Fields

excludeDevicesDeployedInOtherStage :: Maybe Bool
Toggle for excluding devices deployed in other stages.
maxResults :: Maybe Int
The maximum number of requests to select.
nextToken :: Maybe Text
The response from the last list when returning a list large enough to neeed tokening.
edgeDeploymentPlanName :: Text
The name of the edge deployment plan.
stageName :: Text
The name of the stage in the deployment.

Instances

Instances details

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

newListStageDevices Source #

Arguments

:: Text	`ListStageDevices`
-> Text	`ListStageDevices`
-> ListStageDevices

Create a value of ListStageDevices 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:excludeDevicesDeployedInOtherStage:ListStageDevices', listStageDevices_excludeDevicesDeployedInOtherStage - Toggle for excluding devices deployed in other stages.

$sel:maxResults:ListStageDevices', listStageDevices_maxResults - The maximum number of requests to select.

ListStageDevices, listStageDevices_nextToken - The response from the last list when returning a list large enough to neeed tokening.

ListStageDevices, listStageDevices_edgeDeploymentPlanName - The name of the edge deployment plan.

ListStageDevices, listStageDevices_stageName - The name of the stage in the deployment.

Request Lenses

listStageDevices_excludeDevicesDeployedInOtherStage :: Lens' ListStageDevices (Maybe Bool) Source #

Toggle for excluding devices deployed in other stages.

listStageDevices_maxResults :: Lens' ListStageDevices (Maybe Int) Source #

The maximum number of requests to select.

listStageDevices_nextToken :: Lens' ListStageDevices (Maybe Text) Source #

The response from the last list when returning a list large enough to neeed tokening.

listStageDevices_edgeDeploymentPlanName :: Lens' ListStageDevices Text Source #

The name of the edge deployment plan.

listStageDevices_stageName :: Lens' ListStageDevices Text Source #

The name of the stage in the deployment.

Destructuring the Response

data ListStageDevicesResponse Source #

See: newListStageDevicesResponse smart constructor.

Constructors

ListStageDevicesResponse'
Fields nextToken :: Maybe Text The token to use when calling the next page of results. httpStatus :: Int The response's http status code. deviceDeploymentSummaries :: [DeviceDeploymentSummary] List of summaries of devices allocated to the stage.

Instances

Instances details

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

newListStageDevicesResponse Source #

Arguments

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

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

ListStageDevices, listStageDevicesResponse_nextToken - The token to use when calling the next page of results.

$sel:httpStatus:ListStageDevicesResponse', listStageDevicesResponse_httpStatus - The response's http status code.

$sel:deviceDeploymentSummaries:ListStageDevicesResponse', listStageDevicesResponse_deviceDeploymentSummaries - List of summaries of devices allocated to the stage.

Response Lenses

listStageDevicesResponse_nextToken :: Lens' ListStageDevicesResponse (Maybe Text) Source #

The token to use when calling the next page of results.

listStageDevicesResponse_httpStatus :: Lens' ListStageDevicesResponse Int Source #

The response's http status code.

listStageDevicesResponse_deviceDeploymentSummaries :: Lens' ListStageDevicesResponse [DeviceDeploymentSummary] Source #

List of summaries of devices allocated to the stage.