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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The SyncStatus will be updated as the edge configuration is acknowledged, and synced with the Edge Agent.

If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to SYNCING. You will have to wait for the sync status to reach a terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API again. If you invoke this API during the syncing process, a ResourceInUseException will be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into the SYNC_FAILED state.

Synopsis

Creating a Request

data StartEdgeConfigurationUpdate Source #

See: newStartEdgeConfigurationUpdate smart constructor.

Constructors

StartEdgeConfigurationUpdate'
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`. edgeConfig :: EdgeConfig The edge configuration details required to invoke the update process.

Instances

Instances details

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

newStartEdgeConfigurationUpdate Source #

Arguments

:: EdgeConfig	`StartEdgeConfigurationUpdate`
-> StartEdgeConfigurationUpdate

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

StartEdgeConfigurationUpdate, startEdgeConfigurationUpdate_streamARN - The Amazon Resource Name (ARN) of the stream. Specify either the StreamName or the StreamARN.

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

StartEdgeConfigurationUpdate, startEdgeConfigurationUpdate_edgeConfig - The edge configuration details required to invoke the update process.

Request Lenses

startEdgeConfigurationUpdate_streamARN :: Lens' StartEdgeConfigurationUpdate (Maybe Text) Source #

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

startEdgeConfigurationUpdate_streamName :: Lens' StartEdgeConfigurationUpdate (Maybe Text) Source #

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

startEdgeConfigurationUpdate_edgeConfig :: Lens' StartEdgeConfigurationUpdate EdgeConfig Source #

The edge configuration details required to invoke the update process.

Destructuring the Response

data StartEdgeConfigurationUpdateResponse Source #

See: newStartEdgeConfigurationUpdateResponse smart constructor.

Constructors

StartEdgeConfigurationUpdateResponse'

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 current sync status of the stream's edge configuration. When you invoke this API, the sync status will be set to the SYNCING state. Use the DescribeEdgeConfiguration API to get the latest status of the edge configuration.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic StartEdgeConfigurationUpdateResponse Source #
Instance details Defined in Amazonka.KinesisVideo.StartEdgeConfigurationUpdate Associated Types type Rep StartEdgeConfigurationUpdateResponse :: Type -> Type # Methods from :: StartEdgeConfigurationUpdateResponse -> Rep StartEdgeConfigurationUpdateResponse x # to :: Rep StartEdgeConfigurationUpdateResponse x -> StartEdgeConfigurationUpdateResponse #
Show StartEdgeConfigurationUpdateResponse Source #
Instance details Defined in Amazonka.KinesisVideo.StartEdgeConfigurationUpdate Methods showsPrec :: Int -> StartEdgeConfigurationUpdateResponse -> ShowS # show :: StartEdgeConfigurationUpdateResponse -> String # showList :: [StartEdgeConfigurationUpdateResponse] -> ShowS #
NFData StartEdgeConfigurationUpdateResponse Source #
Instance details Defined in Amazonka.KinesisVideo.StartEdgeConfigurationUpdate Methods rnf :: StartEdgeConfigurationUpdateResponse -> () #
Eq StartEdgeConfigurationUpdateResponse Source #
Instance details Defined in Amazonka.KinesisVideo.StartEdgeConfigurationUpdate Methods (==) :: StartEdgeConfigurationUpdateResponse -> StartEdgeConfigurationUpdateResponse -> Bool # (/=) :: StartEdgeConfigurationUpdateResponse -> StartEdgeConfigurationUpdateResponse -> Bool #
type Rep StartEdgeConfigurationUpdateResponse Source #
Instance details Defined in Amazonka.KinesisVideo.StartEdgeConfigurationUpdate type Rep StartEdgeConfigurationUpdateResponse = D1 ('MetaData "StartEdgeConfigurationUpdateResponse" "Amazonka.KinesisVideo.StartEdgeConfigurationUpdate" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "StartEdgeConfigurationUpdateResponse'" '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)))))

newStartEdgeConfigurationUpdateResponse Source #

Arguments

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

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

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

StartEdgeConfigurationUpdate, startEdgeConfigurationUpdateResponse_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:StartEdgeConfigurationUpdateResponse', startEdgeConfigurationUpdateResponse_failedStatusDetails - A description of the generated failure status.

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

StartEdgeConfigurationUpdate, startEdgeConfigurationUpdateResponse_streamARN - The Amazon Resource Name (ARN) of the stream.

StartEdgeConfigurationUpdate, startEdgeConfigurationUpdateResponse_streamName - The name of the stream from which the edge configuration was updated.

$sel:syncStatus:StartEdgeConfigurationUpdateResponse', startEdgeConfigurationUpdateResponse_syncStatus - The current sync status of the stream's edge configuration. When you invoke this API, the sync status will be set to the SYNCING state. Use the DescribeEdgeConfiguration API to get the latest status of the edge configuration.

$sel:httpStatus:StartEdgeConfigurationUpdateResponse', startEdgeConfigurationUpdateResponse_httpStatus - The response's http status code.

Response Lenses

startEdgeConfigurationUpdateResponse_creationTime :: Lens' StartEdgeConfigurationUpdateResponse (Maybe UTCTime) Source #

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

startEdgeConfigurationUpdateResponse_edgeConfig :: Lens' StartEdgeConfigurationUpdateResponse (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.

startEdgeConfigurationUpdateResponse_failedStatusDetails :: Lens' StartEdgeConfigurationUpdateResponse (Maybe Text) Source #

A description of the generated failure status.

startEdgeConfigurationUpdateResponse_lastUpdatedTime :: Lens' StartEdgeConfigurationUpdateResponse (Maybe UTCTime) Source #

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

startEdgeConfigurationUpdateResponse_streamARN :: Lens' StartEdgeConfigurationUpdateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the stream.

startEdgeConfigurationUpdateResponse_streamName :: Lens' StartEdgeConfigurationUpdateResponse (Maybe Text) Source #

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

startEdgeConfigurationUpdateResponse_syncStatus :: Lens' StartEdgeConfigurationUpdateResponse (Maybe SyncStatus) Source #

The current sync status of the stream's edge configuration. When you invoke this API, the sync status will be set to the SYNCING state. Use the DescribeEdgeConfiguration API to get the latest status of the edge configuration.

startEdgeConfigurationUpdateResponse_httpStatus :: Lens' StartEdgeConfigurationUpdateResponse Int Source #

The response's http status code.