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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves metadata for a version of a component.

Synopsis

data DescribeComponent = DescribeComponent' {
- arn :: Text
}
newDescribeComponent :: Text -> DescribeComponent
describeComponent_arn :: Lens' DescribeComponent Text
data DescribeComponentResponse = DescribeComponentResponse' {
- arn :: Maybe Text
- componentName :: Maybe Text
- componentVersion :: Maybe Text
- creationTimestamp :: Maybe POSIX
- description :: Maybe Text
- platforms :: Maybe [ComponentPlatform]
- publisher :: Maybe Text
- status :: Maybe CloudComponentStatus
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newDescribeComponentResponse :: Int -> DescribeComponentResponse
describeComponentResponse_arn :: Lens' DescribeComponentResponse (Maybe Text)
describeComponentResponse_componentName :: Lens' DescribeComponentResponse (Maybe Text)
describeComponentResponse_componentVersion :: Lens' DescribeComponentResponse (Maybe Text)
describeComponentResponse_creationTimestamp :: Lens' DescribeComponentResponse (Maybe UTCTime)
describeComponentResponse_description :: Lens' DescribeComponentResponse (Maybe Text)
describeComponentResponse_platforms :: Lens' DescribeComponentResponse (Maybe [ComponentPlatform])
describeComponentResponse_publisher :: Lens' DescribeComponentResponse (Maybe Text)
describeComponentResponse_status :: Lens' DescribeComponentResponse (Maybe CloudComponentStatus)
describeComponentResponse_tags :: Lens' DescribeComponentResponse (Maybe (HashMap Text Text))
describeComponentResponse_httpStatus :: Lens' DescribeComponentResponse Int

Creating a Request

data DescribeComponent Source #

See: newDescribeComponent smart constructor.

Constructors

DescribeComponent'
Fields arn :: Text The ARN of the component version.

Instances

Instances details

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

newDescribeComponent Source #

Arguments

:: Text	`DescribeComponent`
-> DescribeComponent

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

DescribeComponent, describeComponent_arn - The ARN of the component version.

Request Lenses

describeComponent_arn :: Lens' DescribeComponent Text Source #

The ARN of the component version.

Destructuring the Response

data DescribeComponentResponse Source #

See: newDescribeComponentResponse smart constructor.

Constructors

DescribeComponentResponse'

Fields

arn :: Maybe Text
The ARN of the component version.
componentName :: Maybe Text
The name of the component.
componentVersion :: Maybe Text
The version of the component.
creationTimestamp :: Maybe POSIX
The time at which the component was created, expressed in ISO 8601 format.
description :: Maybe Text
The description of the component version.
platforms :: Maybe [ComponentPlatform]
The platforms that the component version supports.
publisher :: Maybe Text
The publisher of the component version.
status :: Maybe CloudComponentStatus
The status of the component version in IoT Greengrass V2. This status is different from the status of the component on a core device.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeComponentResponse Source #
Instance details Defined in Amazonka.GreengrassV2.DescribeComponent Associated Types type Rep DescribeComponentResponse :: Type -> Type # Methods from :: DescribeComponentResponse -> Rep DescribeComponentResponse x # to :: Rep DescribeComponentResponse x -> DescribeComponentResponse #
Read DescribeComponentResponse Source #
Instance details Defined in Amazonka.GreengrassV2.DescribeComponent Methods readsPrec :: Int -> ReadS DescribeComponentResponse # readList :: ReadS [DescribeComponentResponse] # readPrec :: ReadPrec DescribeComponentResponse # readListPrec :: ReadPrec [DescribeComponentResponse] #
Show DescribeComponentResponse Source #
Instance details Defined in Amazonka.GreengrassV2.DescribeComponent Methods showsPrec :: Int -> DescribeComponentResponse -> ShowS # show :: DescribeComponentResponse -> String # showList :: [DescribeComponentResponse] -> ShowS #
NFData DescribeComponentResponse Source #
Instance details Defined in Amazonka.GreengrassV2.DescribeComponent Methods rnf :: DescribeComponentResponse -> () #
Eq DescribeComponentResponse Source #
Instance details Defined in Amazonka.GreengrassV2.DescribeComponent Methods (==) :: DescribeComponentResponse -> DescribeComponentResponse -> Bool # (/=) :: DescribeComponentResponse -> DescribeComponentResponse -> Bool #
type Rep DescribeComponentResponse Source #
Instance details Defined in Amazonka.GreengrassV2.DescribeComponent type Rep DescribeComponentResponse = D1 ('MetaData "DescribeComponentResponse" "Amazonka.GreengrassV2.DescribeComponent" "amazonka-greengrassv2-2.0-CXiJQl197i43YI1Cz5IpiZ" 'False) (C1 ('MetaCons "DescribeComponentResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "componentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "componentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "creationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "platforms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ComponentPlatform])) :: S1 ('MetaSel ('Just "publisher") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudComponentStatus)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeComponentResponse Source #

Arguments

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

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

DescribeComponent, describeComponentResponse_arn - The ARN of the component version.

DescribeComponentResponse, describeComponentResponse_componentName - The name of the component.

DescribeComponentResponse, describeComponentResponse_componentVersion - The version of the component.

DescribeComponentResponse, describeComponentResponse_creationTimestamp - The time at which the component was created, expressed in ISO 8601 format.

DescribeComponentResponse, describeComponentResponse_description - The description of the component version.

DescribeComponentResponse, describeComponentResponse_platforms - The platforms that the component version supports.

DescribeComponentResponse, describeComponentResponse_publisher - The publisher of the component version.

DescribeComponentResponse, describeComponentResponse_status - The status of the component version in IoT Greengrass V2. This status is different from the status of the component on a core device.

$sel:tags:DescribeComponentResponse', describeComponentResponse_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.

$sel:httpStatus:DescribeComponentResponse', describeComponentResponse_httpStatus - The response's http status code.

Response Lenses

describeComponentResponse_arn :: Lens' DescribeComponentResponse (Maybe Text) Source #

The ARN of the component version.

describeComponentResponse_componentName :: Lens' DescribeComponentResponse (Maybe Text) Source #

The name of the component.

describeComponentResponse_componentVersion :: Lens' DescribeComponentResponse (Maybe Text) Source #

The version of the component.

describeComponentResponse_creationTimestamp :: Lens' DescribeComponentResponse (Maybe UTCTime) Source #

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

describeComponentResponse_description :: Lens' DescribeComponentResponse (Maybe Text) Source #

The description of the component version.

describeComponentResponse_platforms :: Lens' DescribeComponentResponse (Maybe [ComponentPlatform]) Source #

The platforms that the component version supports.

describeComponentResponse_publisher :: Lens' DescribeComponentResponse (Maybe Text) Source #

The publisher of the component version.

describeComponentResponse_status :: Lens' DescribeComponentResponse (Maybe CloudComponentStatus) Source #

The status of the component version in IoT Greengrass V2. This status is different from the status of the component on a core device.

describeComponentResponse_tags :: Lens' DescribeComponentResponse (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.

describeComponentResponse_httpStatus :: Lens' DescribeComponentResponse Int Source #

The response's http status code.