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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the ImageGenerationConfiguration for a given Kinesis video stream.

Synopsis

Creating a Request

data DescribeImageGenerationConfiguration Source #

See: newDescribeImageGenerationConfiguration smart constructor.

Constructors

DescribeImageGenerationConfiguration'
Fields streamARN :: Maybe Text The Amazon Resource Name (ARN) of the Kinesis video stream from which to retrieve the image generation configuration. You must specify either the `StreamName` or the `StreamARN`. streamName :: Maybe Text The name of the stream from which to retrieve the image generation configuration. You must specify either the `StreamName` or the `StreamARN`.

Instances

Instances details

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

newDescribeImageGenerationConfiguration :: DescribeImageGenerationConfiguration Source #

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

DescribeImageGenerationConfiguration, describeImageGenerationConfiguration_streamARN - The Amazon Resource Name (ARN) of the Kinesis video stream from which to retrieve the image generation configuration. You must specify either the StreamName or the StreamARN.

DescribeImageGenerationConfiguration, describeImageGenerationConfiguration_streamName - The name of the stream from which to retrieve the image generation configuration. You must specify either the StreamName or the StreamARN.

Request Lenses

describeImageGenerationConfiguration_streamARN :: Lens' DescribeImageGenerationConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Kinesis video stream from which to retrieve the image generation configuration. You must specify either the StreamName or the StreamARN.

describeImageGenerationConfiguration_streamName :: Lens' DescribeImageGenerationConfiguration (Maybe Text) Source #

The name of the stream from which to retrieve the image generation configuration. You must specify either the StreamName or the StreamARN.

Destructuring the Response

data DescribeImageGenerationConfigurationResponse Source #

See: newDescribeImageGenerationConfigurationResponse smart constructor.

Constructors

DescribeImageGenerationConfigurationResponse'
Fields imageGenerationConfiguration :: Maybe ImageGenerationConfiguration The structure that contains the information required for the Kinesis video stream (KVS) images delivery. If this structure is null, the configuration will be deleted from the stream. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeImageGenerationConfigurationResponse Source #
Instance details Defined in Amazonka.KinesisVideo.DescribeImageGenerationConfiguration Associated Types type Rep DescribeImageGenerationConfigurationResponse :: Type -> Type # Methods from :: DescribeImageGenerationConfigurationResponse -> Rep DescribeImageGenerationConfigurationResponse x # to :: Rep DescribeImageGenerationConfigurationResponse x -> DescribeImageGenerationConfigurationResponse #
Read DescribeImageGenerationConfigurationResponse Source #
Instance details Defined in Amazonka.KinesisVideo.DescribeImageGenerationConfiguration Methods readsPrec :: Int -> ReadS DescribeImageGenerationConfigurationResponse # readList :: ReadS [DescribeImageGenerationConfigurationResponse] # readPrec :: ReadPrec DescribeImageGenerationConfigurationResponse # readListPrec :: ReadPrec [DescribeImageGenerationConfigurationResponse] #
Show DescribeImageGenerationConfigurationResponse Source #
Instance details Defined in Amazonka.KinesisVideo.DescribeImageGenerationConfiguration Methods showsPrec :: Int -> DescribeImageGenerationConfigurationResponse -> ShowS # show :: DescribeImageGenerationConfigurationResponse -> String # showList :: [DescribeImageGenerationConfigurationResponse] -> ShowS #
NFData DescribeImageGenerationConfigurationResponse Source #
Instance details Defined in Amazonka.KinesisVideo.DescribeImageGenerationConfiguration Methods rnf :: DescribeImageGenerationConfigurationResponse -> () #
Eq DescribeImageGenerationConfigurationResponse Source #
Instance details Defined in Amazonka.KinesisVideo.DescribeImageGenerationConfiguration Methods (==) :: DescribeImageGenerationConfigurationResponse -> DescribeImageGenerationConfigurationResponse -> Bool # (/=) :: DescribeImageGenerationConfigurationResponse -> DescribeImageGenerationConfigurationResponse -> Bool #
type Rep DescribeImageGenerationConfigurationResponse Source #
Instance details Defined in Amazonka.KinesisVideo.DescribeImageGenerationConfiguration type Rep DescribeImageGenerationConfigurationResponse = D1 ('MetaData "DescribeImageGenerationConfigurationResponse" "Amazonka.KinesisVideo.DescribeImageGenerationConfiguration" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "DescribeImageGenerationConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "imageGenerationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageGenerationConfiguration)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeImageGenerationConfigurationResponse Source #

Arguments

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

Create a value of DescribeImageGenerationConfigurationResponse 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:imageGenerationConfiguration:DescribeImageGenerationConfigurationResponse', describeImageGenerationConfigurationResponse_imageGenerationConfiguration - The structure that contains the information required for the Kinesis video stream (KVS) images delivery. If this structure is null, the configuration will be deleted from the stream.

$sel:httpStatus:DescribeImageGenerationConfigurationResponse', describeImageGenerationConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

describeImageGenerationConfigurationResponse_imageGenerationConfiguration :: Lens' DescribeImageGenerationConfigurationResponse (Maybe ImageGenerationConfiguration) Source #

The structure that contains the information required for the Kinesis video stream (KVS) images delivery. If this structure is null, the configuration will be deleted from the stream.

describeImageGenerationConfigurationResponse_httpStatus :: Lens' DescribeImageGenerationConfigurationResponse Int Source #

The response's http status code.