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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes an edge deployment plan with deployment status per stage.

Synopsis

Creating a Request

data DescribeEdgeDeploymentPlan Source #

See: newDescribeEdgeDeploymentPlan smart constructor.

Constructors

DescribeEdgeDeploymentPlan'
Fields maxResults :: Maybe Int The maximum number of results to select (50 by default). nextToken :: Maybe Text If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned. edgeDeploymentPlanName :: Text The name of the deployment plan to describe.

Instances

Instances details

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

newDescribeEdgeDeploymentPlan Source #

Arguments

:: Text	`DescribeEdgeDeploymentPlan`
-> DescribeEdgeDeploymentPlan

Create a value of DescribeEdgeDeploymentPlan 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:maxResults:DescribeEdgeDeploymentPlan', describeEdgeDeploymentPlan_maxResults - The maximum number of results to select (50 by default).

DescribeEdgeDeploymentPlan, describeEdgeDeploymentPlan_nextToken - If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.

DescribeEdgeDeploymentPlan, describeEdgeDeploymentPlan_edgeDeploymentPlanName - The name of the deployment plan to describe.

Request Lenses

describeEdgeDeploymentPlan_maxResults :: Lens' DescribeEdgeDeploymentPlan (Maybe Int) Source #

The maximum number of results to select (50 by default).

describeEdgeDeploymentPlan_nextToken :: Lens' DescribeEdgeDeploymentPlan (Maybe Text) Source #

If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.

describeEdgeDeploymentPlan_edgeDeploymentPlanName :: Lens' DescribeEdgeDeploymentPlan Text Source #

The name of the deployment plan to describe.

Destructuring the Response

data DescribeEdgeDeploymentPlanResponse Source #

See: newDescribeEdgeDeploymentPlanResponse smart constructor.

Constructors

DescribeEdgeDeploymentPlanResponse'

Fields

creationTime :: Maybe POSIX
The time when the edge deployment plan was created.
edgeDeploymentFailed :: Maybe Int
The number of edge devices that failed the deployment.
edgeDeploymentPending :: Maybe Int
The number of edge devices yet to pick up deployment, or in progress.
edgeDeploymentSuccess :: Maybe Int
The number of edge devices with the successful deployment.
lastModifiedTime :: Maybe POSIX
The time when the edge deployment plan was last updated.
nextToken :: Maybe Text
Token to use when calling the next set of stages in the edge deployment plan.
httpStatus :: Int
The response's http status code.
edgeDeploymentPlanArn :: Text
The ARN of edge deployment plan.
edgeDeploymentPlanName :: Text
The name of the edge deployment plan.
modelConfigs :: [EdgeDeploymentModelConfig]
List of models associated with the edge deployment plan.
deviceFleetName :: Text
The device fleet used for this edge deployment plan.
stages :: [DeploymentStageStatusSummary]
List of stages in the edge deployment plan.

Instances

Instances details

Generic DescribeEdgeDeploymentPlanResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeEdgeDeploymentPlan Associated Types type Rep DescribeEdgeDeploymentPlanResponse :: Type -> Type # Methods from :: DescribeEdgeDeploymentPlanResponse -> Rep DescribeEdgeDeploymentPlanResponse x # to :: Rep DescribeEdgeDeploymentPlanResponse x -> DescribeEdgeDeploymentPlanResponse #
Read DescribeEdgeDeploymentPlanResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeEdgeDeploymentPlan Methods readsPrec :: Int -> ReadS DescribeEdgeDeploymentPlanResponse # readList :: ReadS [DescribeEdgeDeploymentPlanResponse] # readPrec :: ReadPrec DescribeEdgeDeploymentPlanResponse # readListPrec :: ReadPrec [DescribeEdgeDeploymentPlanResponse] #
Show DescribeEdgeDeploymentPlanResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeEdgeDeploymentPlan Methods showsPrec :: Int -> DescribeEdgeDeploymentPlanResponse -> ShowS # show :: DescribeEdgeDeploymentPlanResponse -> String # showList :: [DescribeEdgeDeploymentPlanResponse] -> ShowS #
NFData DescribeEdgeDeploymentPlanResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeEdgeDeploymentPlan Methods rnf :: DescribeEdgeDeploymentPlanResponse -> () #
Eq DescribeEdgeDeploymentPlanResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeEdgeDeploymentPlan Methods (==) :: DescribeEdgeDeploymentPlanResponse -> DescribeEdgeDeploymentPlanResponse -> Bool # (/=) :: DescribeEdgeDeploymentPlanResponse -> DescribeEdgeDeploymentPlanResponse -> Bool #
type Rep DescribeEdgeDeploymentPlanResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeEdgeDeploymentPlan type Rep DescribeEdgeDeploymentPlanResponse = D1 ('MetaData "DescribeEdgeDeploymentPlanResponse" "Amazonka.SageMaker.DescribeEdgeDeploymentPlan" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeEdgeDeploymentPlanResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "edgeDeploymentFailed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "edgeDeploymentPending") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: (S1 ('MetaSel ('Just "edgeDeploymentSuccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "edgeDeploymentPlanArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "edgeDeploymentPlanName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "modelConfigs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [EdgeDeploymentModelConfig]) :: (S1 ('MetaSel ('Just "deviceFleetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "stages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [DeploymentStageStatusSummary]))))))

newDescribeEdgeDeploymentPlanResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeEdgeDeploymentPlanResponse'`
-> Text	`DescribeEdgeDeploymentPlanResponse`
-> Text	`DescribeEdgeDeploymentPlan`
-> Text	`DescribeEdgeDeploymentPlanResponse`
-> DescribeEdgeDeploymentPlanResponse

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

DescribeEdgeDeploymentPlanResponse, describeEdgeDeploymentPlanResponse_creationTime - The time when the edge deployment plan was created.

DescribeEdgeDeploymentPlanResponse, describeEdgeDeploymentPlanResponse_edgeDeploymentFailed - The number of edge devices that failed the deployment.

DescribeEdgeDeploymentPlanResponse, describeEdgeDeploymentPlanResponse_edgeDeploymentPending - The number of edge devices yet to pick up deployment, or in progress.

DescribeEdgeDeploymentPlanResponse, describeEdgeDeploymentPlanResponse_edgeDeploymentSuccess - The number of edge devices with the successful deployment.

DescribeEdgeDeploymentPlanResponse, describeEdgeDeploymentPlanResponse_lastModifiedTime - The time when the edge deployment plan was last updated.

DescribeEdgeDeploymentPlan, describeEdgeDeploymentPlanResponse_nextToken - Token to use when calling the next set of stages in the edge deployment plan.

$sel:httpStatus:DescribeEdgeDeploymentPlanResponse', describeEdgeDeploymentPlanResponse_httpStatus - The response's http status code.

DescribeEdgeDeploymentPlanResponse, describeEdgeDeploymentPlanResponse_edgeDeploymentPlanArn - The ARN of edge deployment plan.

DescribeEdgeDeploymentPlan, describeEdgeDeploymentPlanResponse_edgeDeploymentPlanName - The name of the edge deployment plan.

$sel:modelConfigs:DescribeEdgeDeploymentPlanResponse', describeEdgeDeploymentPlanResponse_modelConfigs - List of models associated with the edge deployment plan.

DescribeEdgeDeploymentPlanResponse, describeEdgeDeploymentPlanResponse_deviceFleetName - The device fleet used for this edge deployment plan.

$sel:stages:DescribeEdgeDeploymentPlanResponse', describeEdgeDeploymentPlanResponse_stages - List of stages in the edge deployment plan.

Response Lenses

describeEdgeDeploymentPlanResponse_creationTime :: Lens' DescribeEdgeDeploymentPlanResponse (Maybe UTCTime) Source #

The time when the edge deployment plan was created.

describeEdgeDeploymentPlanResponse_edgeDeploymentFailed :: Lens' DescribeEdgeDeploymentPlanResponse (Maybe Int) Source #

The number of edge devices that failed the deployment.

describeEdgeDeploymentPlanResponse_edgeDeploymentPending :: Lens' DescribeEdgeDeploymentPlanResponse (Maybe Int) Source #

The number of edge devices yet to pick up deployment, or in progress.

describeEdgeDeploymentPlanResponse_edgeDeploymentSuccess :: Lens' DescribeEdgeDeploymentPlanResponse (Maybe Int) Source #

The number of edge devices with the successful deployment.

describeEdgeDeploymentPlanResponse_lastModifiedTime :: Lens' DescribeEdgeDeploymentPlanResponse (Maybe UTCTime) Source #

The time when the edge deployment plan was last updated.

describeEdgeDeploymentPlanResponse_nextToken :: Lens' DescribeEdgeDeploymentPlanResponse (Maybe Text) Source #

Token to use when calling the next set of stages in the edge deployment plan.

describeEdgeDeploymentPlanResponse_httpStatus :: Lens' DescribeEdgeDeploymentPlanResponse Int Source #

The response's http status code.

describeEdgeDeploymentPlanResponse_edgeDeploymentPlanArn :: Lens' DescribeEdgeDeploymentPlanResponse Text Source #

The ARN of edge deployment plan.

describeEdgeDeploymentPlanResponse_edgeDeploymentPlanName :: Lens' DescribeEdgeDeploymentPlanResponse Text Source #

The name of the edge deployment plan.

describeEdgeDeploymentPlanResponse_modelConfigs :: Lens' DescribeEdgeDeploymentPlanResponse [EdgeDeploymentModelConfig] Source #

List of models associated with the edge deployment plan.

describeEdgeDeploymentPlanResponse_deviceFleetName :: Lens' DescribeEdgeDeploymentPlanResponse Text Source #

The device fleet used for this edge deployment plan.

describeEdgeDeploymentPlanResponse_stages :: Lens' DescribeEdgeDeploymentPlanResponse [DeploymentStageStatusSummary] Source #

List of stages in the edge deployment plan.