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.GreengrassV2.GetDeployment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a deployment. Deployments define the components that run on Greengrass core devices.

Synopsis

data GetDeployment = GetDeployment' {
- deploymentId :: Text
}
newGetDeployment :: Text -> GetDeployment
getDeployment_deploymentId :: Lens' GetDeployment Text
data GetDeploymentResponse = GetDeploymentResponse' {
- components :: Maybe (HashMap Text ComponentDeploymentSpecification)
- creationTimestamp :: Maybe POSIX
- deploymentId :: Maybe Text
- deploymentName :: Maybe Text
- deploymentPolicies :: Maybe DeploymentPolicies
- deploymentStatus :: Maybe DeploymentStatus
- iotJobArn :: Maybe Text
- iotJobConfiguration :: Maybe DeploymentIoTJobConfiguration
- iotJobId :: Maybe Text
- isLatestForTarget :: Maybe Bool
- parentTargetArn :: Maybe Text
- revisionId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- targetArn :: Maybe Text
- httpStatus :: Int
}
newGetDeploymentResponse :: Int -> GetDeploymentResponse
getDeploymentResponse_components :: Lens' GetDeploymentResponse (Maybe (HashMap Text ComponentDeploymentSpecification))
getDeploymentResponse_creationTimestamp :: Lens' GetDeploymentResponse (Maybe UTCTime)
getDeploymentResponse_deploymentId :: Lens' GetDeploymentResponse (Maybe Text)
getDeploymentResponse_deploymentName :: Lens' GetDeploymentResponse (Maybe Text)
getDeploymentResponse_deploymentPolicies :: Lens' GetDeploymentResponse (Maybe DeploymentPolicies)
getDeploymentResponse_deploymentStatus :: Lens' GetDeploymentResponse (Maybe DeploymentStatus)
getDeploymentResponse_iotJobArn :: Lens' GetDeploymentResponse (Maybe Text)
getDeploymentResponse_iotJobConfiguration :: Lens' GetDeploymentResponse (Maybe DeploymentIoTJobConfiguration)
getDeploymentResponse_iotJobId :: Lens' GetDeploymentResponse (Maybe Text)
getDeploymentResponse_isLatestForTarget :: Lens' GetDeploymentResponse (Maybe Bool)
getDeploymentResponse_parentTargetArn :: Lens' GetDeploymentResponse (Maybe Text)
getDeploymentResponse_revisionId :: Lens' GetDeploymentResponse (Maybe Text)
getDeploymentResponse_tags :: Lens' GetDeploymentResponse (Maybe (HashMap Text Text))
getDeploymentResponse_targetArn :: Lens' GetDeploymentResponse (Maybe Text)
getDeploymentResponse_httpStatus :: Lens' GetDeploymentResponse Int

Creating a Request

data GetDeployment Source #

See: newGetDeployment smart constructor.

Constructors

GetDeployment'
Fields deploymentId :: Text The ID of the deployment.

Instances

Instances details

ToHeaders GetDeployment Source #
Instance details Defined in Amazonka.GreengrassV2.GetDeployment Methods toHeaders :: GetDeployment -> [Header] #
ToPath GetDeployment Source #
Instance details Defined in Amazonka.GreengrassV2.GetDeployment Methods toPath :: GetDeployment -> ByteString #
ToQuery GetDeployment Source #
Instance details Defined in Amazonka.GreengrassV2.GetDeployment Methods toQuery :: GetDeployment -> QueryString #
AWSRequest GetDeployment Source #
Instance details Defined in Amazonka.GreengrassV2.GetDeployment Associated Types type AWSResponse GetDeployment # Methods request :: (Service -> Service) -> GetDeployment -> Request GetDeployment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDeployment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDeployment))) #
Generic GetDeployment Source #
Instance details Defined in Amazonka.GreengrassV2.GetDeployment Associated Types type Rep GetDeployment :: Type -> Type # Methods from :: GetDeployment -> Rep GetDeployment x # to :: Rep GetDeployment x -> GetDeployment #
Read GetDeployment Source #
Instance details Defined in Amazonka.GreengrassV2.GetDeployment Methods readsPrec :: Int -> ReadS GetDeployment # readList :: ReadS [GetDeployment] # readPrec :: ReadPrec GetDeployment # readListPrec :: ReadPrec [GetDeployment] #
Show GetDeployment Source #
Instance details Defined in Amazonka.GreengrassV2.GetDeployment Methods showsPrec :: Int -> GetDeployment -> ShowS # show :: GetDeployment -> String # showList :: [GetDeployment] -> ShowS #
NFData GetDeployment Source #
Instance details Defined in Amazonka.GreengrassV2.GetDeployment Methods rnf :: GetDeployment -> () #
Eq GetDeployment Source #
Instance details Defined in Amazonka.GreengrassV2.GetDeployment Methods (==) :: GetDeployment -> GetDeployment -> Bool # (/=) :: GetDeployment -> GetDeployment -> Bool #
Hashable GetDeployment Source #
Instance details Defined in Amazonka.GreengrassV2.GetDeployment Methods hashWithSalt :: Int -> GetDeployment -> Int # hash :: GetDeployment -> Int #
type AWSResponse GetDeployment Source #
Instance details Defined in Amazonka.GreengrassV2.GetDeployment type AWSResponse GetDeployment = GetDeploymentResponse
type Rep GetDeployment Source #
Instance details Defined in Amazonka.GreengrassV2.GetDeployment type Rep GetDeployment = D1 ('MetaData "GetDeployment" "Amazonka.GreengrassV2.GetDeployment" "amazonka-greengrassv2-2.0-CXiJQl197i43YI1Cz5IpiZ" 'False) (C1 ('MetaCons "GetDeployment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetDeployment Source #

Arguments

:: Text	`GetDeployment`
-> GetDeployment

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

GetDeployment, getDeployment_deploymentId - The ID of the deployment.

Request Lenses

getDeployment_deploymentId :: Lens' GetDeployment Text Source #

The ID of the deployment.

Destructuring the Response

data GetDeploymentResponse Source #

See: newGetDeploymentResponse smart constructor.

Constructors

GetDeploymentResponse'

Fields

components :: Maybe (HashMap Text ComponentDeploymentSpecification)
The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.
creationTimestamp :: Maybe POSIX
The time at which the deployment was created, expressed in ISO 8601 format.
deploymentId :: Maybe Text
The ID of the deployment.
deploymentName :: Maybe Text
The name of the deployment.
deploymentPolicies :: Maybe DeploymentPolicies
The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
deploymentStatus :: Maybe DeploymentStatus
The status of the deployment.
iotJobArn :: Maybe Text
The ARN of the IoT job that applies the deployment to target devices.
iotJobConfiguration :: Maybe DeploymentIoTJobConfiguration
The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
iotJobId :: Maybe Text
The ID of the IoT job that applies the deployment to target devices.
isLatestForTarget :: Maybe Bool
Whether or not the deployment is the latest revision for its target.
parentTargetArn :: Maybe Text
The parent deployment's target ARN within a subdeployment.
revisionId :: Maybe Text
The revision number of the deployment.
tags :: Maybe (HashMap Text Text)
A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
targetArn :: Maybe Text
The ARN of the target IoT thing or thing group.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetDeploymentResponse Source #
Instance details Defined in Amazonka.GreengrassV2.GetDeployment Associated Types type Rep GetDeploymentResponse :: Type -> Type # Methods from :: GetDeploymentResponse -> Rep GetDeploymentResponse x # to :: Rep GetDeploymentResponse x -> GetDeploymentResponse #
Read GetDeploymentResponse Source #
Instance details Defined in Amazonka.GreengrassV2.GetDeployment Methods readsPrec :: Int -> ReadS GetDeploymentResponse # readList :: ReadS [GetDeploymentResponse] # readPrec :: ReadPrec GetDeploymentResponse # readListPrec :: ReadPrec [GetDeploymentResponse] #
Show GetDeploymentResponse Source #
Instance details Defined in Amazonka.GreengrassV2.GetDeployment Methods showsPrec :: Int -> GetDeploymentResponse -> ShowS # show :: GetDeploymentResponse -> String # showList :: [GetDeploymentResponse] -> ShowS #
NFData GetDeploymentResponse Source #
Instance details Defined in Amazonka.GreengrassV2.GetDeployment Methods rnf :: GetDeploymentResponse -> () #
Eq GetDeploymentResponse Source #
Instance details Defined in Amazonka.GreengrassV2.GetDeployment Methods (==) :: GetDeploymentResponse -> GetDeploymentResponse -> Bool # (/=) :: GetDeploymentResponse -> GetDeploymentResponse -> Bool #
type Rep GetDeploymentResponse Source #
Instance details Defined in Amazonka.GreengrassV2.GetDeployment type Rep GetDeploymentResponse = D1 ('MetaData "GetDeploymentResponse" "Amazonka.GreengrassV2.GetDeployment" "amazonka-greengrassv2-2.0-CXiJQl197i43YI1Cz5IpiZ" 'False) (C1 ('MetaCons "GetDeploymentResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "components") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text ComponentDeploymentSpecification))) :: (S1 ('MetaSel ('Just "creationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "deploymentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "deploymentPolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentPolicies))) :: (S1 ('MetaSel ('Just "deploymentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentStatus)) :: S1 ('MetaSel ('Just "iotJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "iotJobConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentIoTJobConfiguration)) :: S1 ('MetaSel ('Just "iotJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "isLatestForTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "parentTargetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "revisionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "targetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetDeploymentResponse Source #

Arguments

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

Create a value of GetDeploymentResponse 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:components:GetDeploymentResponse', getDeploymentResponse_components - The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.

GetDeploymentResponse, getDeploymentResponse_creationTimestamp - The time at which the deployment was created, expressed in ISO 8601 format.

GetDeployment, getDeploymentResponse_deploymentId - The ID of the deployment.

GetDeploymentResponse, getDeploymentResponse_deploymentName - The name of the deployment.

$sel:deploymentPolicies:GetDeploymentResponse', getDeploymentResponse_deploymentPolicies - The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.

GetDeploymentResponse, getDeploymentResponse_deploymentStatus - The status of the deployment.

GetDeploymentResponse, getDeploymentResponse_iotJobArn - The ARN of the IoT job that applies the deployment to target devices.

$sel:iotJobConfiguration:GetDeploymentResponse', getDeploymentResponse_iotJobConfiguration - The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

GetDeploymentResponse, getDeploymentResponse_iotJobId - The ID of the IoT job that applies the deployment to target devices.

GetDeploymentResponse, getDeploymentResponse_isLatestForTarget - Whether or not the deployment is the latest revision for its target.

GetDeploymentResponse, getDeploymentResponse_parentTargetArn - The parent deployment's target ARN within a subdeployment.

GetDeploymentResponse, getDeploymentResponse_revisionId - The revision number of the deployment.

$sel:tags:GetDeploymentResponse', getDeploymentResponse_tags - A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.

GetDeploymentResponse, getDeploymentResponse_targetArn - The ARN of the target IoT thing or thing group.

$sel:httpStatus:GetDeploymentResponse', getDeploymentResponse_httpStatus - The response's http status code.

Response Lenses

getDeploymentResponse_components :: Lens' GetDeploymentResponse (Maybe (HashMap Text ComponentDeploymentSpecification)) Source #

The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.

getDeploymentResponse_creationTimestamp :: Lens' GetDeploymentResponse (Maybe UTCTime) Source #

The time at which the deployment was created, expressed in ISO 8601 format.

getDeploymentResponse_deploymentId :: Lens' GetDeploymentResponse (Maybe Text) Source #

The ID of the deployment.

getDeploymentResponse_deploymentName :: Lens' GetDeploymentResponse (Maybe Text) Source #

The name of the deployment.

getDeploymentResponse_deploymentPolicies :: Lens' GetDeploymentResponse (Maybe DeploymentPolicies) Source #

The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.

getDeploymentResponse_deploymentStatus :: Lens' GetDeploymentResponse (Maybe DeploymentStatus) Source #

The status of the deployment.

getDeploymentResponse_iotJobArn :: Lens' GetDeploymentResponse (Maybe Text) Source #

The ARN of the IoT job that applies the deployment to target devices.

getDeploymentResponse_iotJobConfiguration :: Lens' GetDeploymentResponse (Maybe DeploymentIoTJobConfiguration) Source #

The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

getDeploymentResponse_iotJobId :: Lens' GetDeploymentResponse (Maybe Text) Source #

The ID of the IoT job that applies the deployment to target devices.

getDeploymentResponse_isLatestForTarget :: Lens' GetDeploymentResponse (Maybe Bool) Source #

Whether or not the deployment is the latest revision for its target.

getDeploymentResponse_parentTargetArn :: Lens' GetDeploymentResponse (Maybe Text) Source #

The parent deployment's target ARN within a subdeployment.

getDeploymentResponse_revisionId :: Lens' GetDeploymentResponse (Maybe Text) Source #

The revision number of the deployment.

getDeploymentResponse_tags :: Lens' GetDeploymentResponse (Maybe (HashMap Text Text)) Source #

A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.

getDeploymentResponse_targetArn :: Lens' GetDeploymentResponse (Maybe Text) Source #

The ARN of the target IoT thing or thing group.

getDeploymentResponse_httpStatus :: Lens' GetDeploymentResponse Int Source #

The response's http status code.