Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Rekognition.DescribeStreamProcessor

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.

Synopsis

Creating a Request

data DescribeStreamProcessor Source #

See: newDescribeStreamProcessor smart constructor.

Constructors

DescribeStreamProcessor'
Fields name :: Text Name of the stream processor for which you want information.

Instances

Instances details

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

newDescribeStreamProcessor Source #

Arguments

:: Text	`$sel:name:DescribeStreamProcessor'`
-> DescribeStreamProcessor

Create a value of DescribeStreamProcessor 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:name:DescribeStreamProcessor', describeStreamProcessor_name - Name of the stream processor for which you want information.

Request Lenses

describeStreamProcessor_name :: Lens' DescribeStreamProcessor Text Source #

Name of the stream processor for which you want information.

Destructuring the Response

data DescribeStreamProcessorResponse Source #

See: newDescribeStreamProcessorResponse smart constructor.

Constructors

DescribeStreamProcessorResponse'

Fields

status :: Maybe StreamProcessorStatus
Current status of the stream processor.
settings :: Maybe StreamProcessorSettings
Face recognition input parameters that are being used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.
input :: Maybe StreamProcessorInput
Kinesis video stream that provides the source streaming video.
output :: Maybe StreamProcessorOutput
Kinesis data stream to which Amazon Rekognition Video puts the analysis results.
streamProcessorArn :: Maybe Text
ARN of the stream processor.
statusMessage :: Maybe Text
Detailed status message about the stream processor.
name :: Maybe Text
Name of the stream processor.
creationTimestamp :: Maybe POSIX
Date and time the stream processor was created
lastUpdateTimestamp :: Maybe POSIX
The time, in Unix format, the stream processor was last updated. For example, when the stream processor moves from a running state to a failed state, or when the user starts or stops the stream processor.
roleArn :: Maybe Text
ARN of the IAM role that allows access to the stream processor.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeStreamProcessorResponse Source #
Instance details Defined in Amazonka.Rekognition.DescribeStreamProcessor Methods (==) :: DescribeStreamProcessorResponse -> DescribeStreamProcessorResponse -> Bool # (/=) :: DescribeStreamProcessorResponse -> DescribeStreamProcessorResponse -> Bool #
Read DescribeStreamProcessorResponse Source #
Instance details Defined in Amazonka.Rekognition.DescribeStreamProcessor Methods readsPrec :: Int -> ReadS DescribeStreamProcessorResponse # readList :: ReadS [DescribeStreamProcessorResponse] # readPrec :: ReadPrec DescribeStreamProcessorResponse # readListPrec :: ReadPrec [DescribeStreamProcessorResponse] #
Show DescribeStreamProcessorResponse Source #
Instance details Defined in Amazonka.Rekognition.DescribeStreamProcessor Methods showsPrec :: Int -> DescribeStreamProcessorResponse -> ShowS # show :: DescribeStreamProcessorResponse -> String # showList :: [DescribeStreamProcessorResponse] -> ShowS #
Generic DescribeStreamProcessorResponse Source #
Instance details Defined in Amazonka.Rekognition.DescribeStreamProcessor Associated Types type Rep DescribeStreamProcessorResponse :: Type -> Type # Methods from :: DescribeStreamProcessorResponse -> Rep DescribeStreamProcessorResponse x # to :: Rep DescribeStreamProcessorResponse x -> DescribeStreamProcessorResponse #
NFData DescribeStreamProcessorResponse Source #
Instance details Defined in Amazonka.Rekognition.DescribeStreamProcessor Methods rnf :: DescribeStreamProcessorResponse -> () #
type Rep DescribeStreamProcessorResponse Source #
Instance details Defined in Amazonka.Rekognition.DescribeStreamProcessor type Rep DescribeStreamProcessorResponse = D1 ('MetaData "DescribeStreamProcessorResponse" "Amazonka.Rekognition.DescribeStreamProcessor" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "DescribeStreamProcessorResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamProcessorStatus)) :: S1 ('MetaSel ('Just "settings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamProcessorSettings))) :: (S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamProcessorInput)) :: (S1 ('MetaSel ('Just "output") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamProcessorOutput)) :: S1 ('MetaSel ('Just "streamProcessorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "creationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "lastUpdateTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeStreamProcessorResponse Source #

Arguments

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

Create a value of DescribeStreamProcessorResponse 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:status:DescribeStreamProcessorResponse', describeStreamProcessorResponse_status - Current status of the stream processor.

$sel:settings:DescribeStreamProcessorResponse', describeStreamProcessorResponse_settings - Face recognition input parameters that are being used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.

$sel:input:DescribeStreamProcessorResponse', describeStreamProcessorResponse_input - Kinesis video stream that provides the source streaming video.

$sel:output:DescribeStreamProcessorResponse', describeStreamProcessorResponse_output - Kinesis data stream to which Amazon Rekognition Video puts the analysis results.

$sel:streamProcessorArn:DescribeStreamProcessorResponse', describeStreamProcessorResponse_streamProcessorArn - ARN of the stream processor.

$sel:statusMessage:DescribeStreamProcessorResponse', describeStreamProcessorResponse_statusMessage - Detailed status message about the stream processor.

$sel:name:DescribeStreamProcessor', describeStreamProcessorResponse_name - Name of the stream processor.

$sel:creationTimestamp:DescribeStreamProcessorResponse', describeStreamProcessorResponse_creationTimestamp - Date and time the stream processor was created

$sel:lastUpdateTimestamp:DescribeStreamProcessorResponse', describeStreamProcessorResponse_lastUpdateTimestamp - The time, in Unix format, the stream processor was last updated. For example, when the stream processor moves from a running state to a failed state, or when the user starts or stops the stream processor.

$sel:roleArn:DescribeStreamProcessorResponse', describeStreamProcessorResponse_roleArn - ARN of the IAM role that allows access to the stream processor.

$sel:httpStatus:DescribeStreamProcessorResponse', describeStreamProcessorResponse_httpStatus - The response's http status code.

Response Lenses

describeStreamProcessorResponse_status :: Lens' DescribeStreamProcessorResponse (Maybe StreamProcessorStatus) Source #

Current status of the stream processor.

describeStreamProcessorResponse_settings :: Lens' DescribeStreamProcessorResponse (Maybe StreamProcessorSettings) Source #

Face recognition input parameters that are being used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.

describeStreamProcessorResponse_input :: Lens' DescribeStreamProcessorResponse (Maybe StreamProcessorInput) Source #

Kinesis video stream that provides the source streaming video.

describeStreamProcessorResponse_output :: Lens' DescribeStreamProcessorResponse (Maybe StreamProcessorOutput) Source #

Kinesis data stream to which Amazon Rekognition Video puts the analysis results.

describeStreamProcessorResponse_streamProcessorArn :: Lens' DescribeStreamProcessorResponse (Maybe Text) Source #

ARN of the stream processor.

describeStreamProcessorResponse_statusMessage :: Lens' DescribeStreamProcessorResponse (Maybe Text) Source #

Detailed status message about the stream processor.

describeStreamProcessorResponse_name :: Lens' DescribeStreamProcessorResponse (Maybe Text) Source #

Name of the stream processor.

describeStreamProcessorResponse_creationTimestamp :: Lens' DescribeStreamProcessorResponse (Maybe UTCTime) Source #

Date and time the stream processor was created

describeStreamProcessorResponse_lastUpdateTimestamp :: Lens' DescribeStreamProcessorResponse (Maybe UTCTime) Source #

The time, in Unix format, the stream processor was last updated. For example, when the stream processor moves from a running state to a failed state, or when the user starts or stops the stream processor.

describeStreamProcessorResponse_roleArn :: Lens' DescribeStreamProcessorResponse (Maybe Text) Source #

ARN of the IAM role that allows access to the stream processor.

describeStreamProcessorResponse_httpStatus :: Lens' DescribeStreamProcessorResponse Int Source #

The response's http status code.