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.KinesisVideo.DescribeEdgeConfiguration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API. Use this API to get the status of the configuration if the configuration is in sync with the Edge Agent.

Synopsis

Creating a Request

data DescribeEdgeConfiguration Source #

See: newDescribeEdgeConfiguration smart constructor.

Constructors

DescribeEdgeConfiguration'
Fields streamARN :: Maybe Text The Amazon Resource Name (ARN) of the stream. Specify either the `StreamName`or the `StreamARN`. streamName :: Maybe Text The name of the stream whose edge configuration you want to update. Specify either the `StreamName` or the `StreamARN`.

Instances

Instances details

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

newDescribeEdgeConfiguration :: DescribeEdgeConfiguration Source #

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

DescribeEdgeConfiguration, describeEdgeConfiguration_streamARN - The Amazon Resource Name (ARN) of the stream. Specify either the StreamNameor the StreamARN.

DescribeEdgeConfiguration, describeEdgeConfiguration_streamName - The name of the stream whose edge configuration you want to update. Specify either the StreamName or the StreamARN.

Request Lenses

describeEdgeConfiguration_streamARN :: Lens' DescribeEdgeConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of the stream. Specify either the StreamNameor the StreamARN.

describeEdgeConfiguration_streamName :: Lens' DescribeEdgeConfiguration (Maybe Text) Source #

The name of the stream whose edge configuration you want to update. Specify either the StreamName or the StreamARN.

Destructuring the Response

data DescribeEdgeConfigurationResponse Source #

See: newDescribeEdgeConfigurationResponse smart constructor.

Constructors

DescribeEdgeConfigurationResponse'

Fields

creationTime :: Maybe POSIX
The timestamp at which a stream’s edge configuration was first created.
edgeConfig :: Maybe EdgeConfig
A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on an IoT Hub Device setup at your premise.
failedStatusDetails :: Maybe Text
A description of the generated failure status.
lastUpdatedTime :: Maybe POSIX
The timestamp at which a stream’s edge configuration was last updated.
streamARN :: Maybe Text
The Amazon Resource Name (ARN) of the stream.
streamName :: Maybe Text
The name of the stream from which the edge configuration was updated.
syncStatus :: Maybe SyncStatus
The latest status of the edge configuration update.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeEdgeConfigurationResponse Source #
Instance details Defined in Amazonka.KinesisVideo.DescribeEdgeConfiguration Associated Types type Rep DescribeEdgeConfigurationResponse :: Type -> Type # Methods from :: DescribeEdgeConfigurationResponse -> Rep DescribeEdgeConfigurationResponse x # to :: Rep DescribeEdgeConfigurationResponse x -> DescribeEdgeConfigurationResponse #
Show DescribeEdgeConfigurationResponse Source #
Instance details Defined in Amazonka.KinesisVideo.DescribeEdgeConfiguration Methods showsPrec :: Int -> DescribeEdgeConfigurationResponse -> ShowS # show :: DescribeEdgeConfigurationResponse -> String # showList :: [DescribeEdgeConfigurationResponse] -> ShowS #
NFData DescribeEdgeConfigurationResponse Source #
Instance details Defined in Amazonka.KinesisVideo.DescribeEdgeConfiguration Methods rnf :: DescribeEdgeConfigurationResponse -> () #
Eq DescribeEdgeConfigurationResponse Source #
Instance details Defined in Amazonka.KinesisVideo.DescribeEdgeConfiguration Methods (==) :: DescribeEdgeConfigurationResponse -> DescribeEdgeConfigurationResponse -> Bool # (/=) :: DescribeEdgeConfigurationResponse -> DescribeEdgeConfigurationResponse -> Bool #
type Rep DescribeEdgeConfigurationResponse Source #
Instance details Defined in Amazonka.KinesisVideo.DescribeEdgeConfiguration type Rep DescribeEdgeConfigurationResponse = D1 ('MetaData "DescribeEdgeConfigurationResponse" "Amazonka.KinesisVideo.DescribeEdgeConfiguration" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "DescribeEdgeConfigurationResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "edgeConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EdgeConfig))) :: (S1 ('MetaSel ('Just "failedStatusDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lastUpdatedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "syncStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SyncStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeEdgeConfigurationResponse Source #

Arguments

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

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

DescribeEdgeConfigurationResponse, describeEdgeConfigurationResponse_creationTime - The timestamp at which a stream’s edge configuration was first created.

$sel:edgeConfig:DescribeEdgeConfigurationResponse', describeEdgeConfigurationResponse_edgeConfig - A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on an IoT Hub Device setup at your premise.

$sel:failedStatusDetails:DescribeEdgeConfigurationResponse', describeEdgeConfigurationResponse_failedStatusDetails - A description of the generated failure status.

$sel:lastUpdatedTime:DescribeEdgeConfigurationResponse', describeEdgeConfigurationResponse_lastUpdatedTime - The timestamp at which a stream’s edge configuration was last updated.

DescribeEdgeConfiguration, describeEdgeConfigurationResponse_streamARN - The Amazon Resource Name (ARN) of the stream.

DescribeEdgeConfiguration, describeEdgeConfigurationResponse_streamName - The name of the stream from which the edge configuration was updated.

$sel:syncStatus:DescribeEdgeConfigurationResponse', describeEdgeConfigurationResponse_syncStatus - The latest status of the edge configuration update.

$sel:httpStatus:DescribeEdgeConfigurationResponse', describeEdgeConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

describeEdgeConfigurationResponse_creationTime :: Lens' DescribeEdgeConfigurationResponse (Maybe UTCTime) Source #

The timestamp at which a stream’s edge configuration was first created.

describeEdgeConfigurationResponse_edgeConfig :: Lens' DescribeEdgeConfigurationResponse (Maybe EdgeConfig) Source #

A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on an IoT Hub Device setup at your premise.

describeEdgeConfigurationResponse_failedStatusDetails :: Lens' DescribeEdgeConfigurationResponse (Maybe Text) Source #

A description of the generated failure status.

describeEdgeConfigurationResponse_lastUpdatedTime :: Lens' DescribeEdgeConfigurationResponse (Maybe UTCTime) Source #

The timestamp at which a stream’s edge configuration was last updated.

describeEdgeConfigurationResponse_streamARN :: Lens' DescribeEdgeConfigurationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the stream.

describeEdgeConfigurationResponse_streamName :: Lens' DescribeEdgeConfigurationResponse (Maybe Text) Source #

The name of the stream from which the edge configuration was updated.

describeEdgeConfigurationResponse_syncStatus :: Lens' DescribeEdgeConfigurationResponse (Maybe SyncStatus) Source #

The latest status of the edge configuration update.

describeEdgeConfigurationResponse_httpStatus :: Lens' DescribeEdgeConfigurationResponse Int Source #

The response's http status code.