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.MediaPackage.DescribeHarvestJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets details about an existing HarvestJob.

Synopsis

data DescribeHarvestJob = DescribeHarvestJob' {
- id :: Text
}
newDescribeHarvestJob :: Text -> DescribeHarvestJob
describeHarvestJob_id :: Lens' DescribeHarvestJob Text
data DescribeHarvestJobResponse = DescribeHarvestJobResponse' {
- arn :: Maybe Text
- channelId :: Maybe Text
- createdAt :: Maybe Text
- endTime :: Maybe Text
- id :: Maybe Text
- originEndpointId :: Maybe Text
- s3Destination :: Maybe S3Destination
- startTime :: Maybe Text
- status :: Maybe Status
- httpStatus :: Int
}
newDescribeHarvestJobResponse :: Int -> DescribeHarvestJobResponse
describeHarvestJobResponse_arn :: Lens' DescribeHarvestJobResponse (Maybe Text)
describeHarvestJobResponse_channelId :: Lens' DescribeHarvestJobResponse (Maybe Text)
describeHarvestJobResponse_createdAt :: Lens' DescribeHarvestJobResponse (Maybe Text)
describeHarvestJobResponse_endTime :: Lens' DescribeHarvestJobResponse (Maybe Text)
describeHarvestJobResponse_id :: Lens' DescribeHarvestJobResponse (Maybe Text)
describeHarvestJobResponse_originEndpointId :: Lens' DescribeHarvestJobResponse (Maybe Text)
describeHarvestJobResponse_s3Destination :: Lens' DescribeHarvestJobResponse (Maybe S3Destination)
describeHarvestJobResponse_startTime :: Lens' DescribeHarvestJobResponse (Maybe Text)
describeHarvestJobResponse_status :: Lens' DescribeHarvestJobResponse (Maybe Status)
describeHarvestJobResponse_httpStatus :: Lens' DescribeHarvestJobResponse Int

Creating a Request

data DescribeHarvestJob Source #

See: newDescribeHarvestJob smart constructor.

Constructors

DescribeHarvestJob'
Fields id :: Text The ID of the HarvestJob.

Instances

Instances details

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

newDescribeHarvestJob Source #

Arguments

:: Text	`DescribeHarvestJob`
-> DescribeHarvestJob

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

DescribeHarvestJob, describeHarvestJob_id - The ID of the HarvestJob.

Request Lenses

describeHarvestJob_id :: Lens' DescribeHarvestJob Text Source #

The ID of the HarvestJob.

Destructuring the Response

data DescribeHarvestJobResponse Source #

See: newDescribeHarvestJobResponse smart constructor.

Constructors

DescribeHarvestJobResponse'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) assigned to the HarvestJob.
channelId :: Maybe Text
The ID of the Channel that the HarvestJob will harvest from.
createdAt :: Maybe Text
The time the HarvestJob was submitted
endTime :: Maybe Text
The end of the time-window which will be harvested.
id :: Maybe Text
The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.
originEndpointId :: Maybe Text
The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.
s3Destination :: Maybe S3Destination
startTime :: Maybe Text
The start of the time-window which will be harvested.
status :: Maybe Status
The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeHarvestJobResponse Source #
Instance details Defined in Amazonka.MediaPackage.DescribeHarvestJob Associated Types type Rep DescribeHarvestJobResponse :: Type -> Type # Methods from :: DescribeHarvestJobResponse -> Rep DescribeHarvestJobResponse x # to :: Rep DescribeHarvestJobResponse x -> DescribeHarvestJobResponse #
Read DescribeHarvestJobResponse Source #
Instance details Defined in Amazonka.MediaPackage.DescribeHarvestJob Methods readsPrec :: Int -> ReadS DescribeHarvestJobResponse # readList :: ReadS [DescribeHarvestJobResponse] # readPrec :: ReadPrec DescribeHarvestJobResponse # readListPrec :: ReadPrec [DescribeHarvestJobResponse] #
Show DescribeHarvestJobResponse Source #
Instance details Defined in Amazonka.MediaPackage.DescribeHarvestJob Methods showsPrec :: Int -> DescribeHarvestJobResponse -> ShowS # show :: DescribeHarvestJobResponse -> String # showList :: [DescribeHarvestJobResponse] -> ShowS #
NFData DescribeHarvestJobResponse Source #
Instance details Defined in Amazonka.MediaPackage.DescribeHarvestJob Methods rnf :: DescribeHarvestJobResponse -> () #
Eq DescribeHarvestJobResponse Source #
Instance details Defined in Amazonka.MediaPackage.DescribeHarvestJob Methods (==) :: DescribeHarvestJobResponse -> DescribeHarvestJobResponse -> Bool # (/=) :: DescribeHarvestJobResponse -> DescribeHarvestJobResponse -> Bool #
type Rep DescribeHarvestJobResponse Source #
Instance details Defined in Amazonka.MediaPackage.DescribeHarvestJob type Rep DescribeHarvestJobResponse = D1 ('MetaData "DescribeHarvestJobResponse" "Amazonka.MediaPackage.DescribeHarvestJob" "amazonka-mediapackage-2.0-Ht5BbgvzDNJCrSLrgDmB6l" 'False) (C1 ('MetaCons "DescribeHarvestJobResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "channelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "originEndpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "s3Destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Destination))) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Status)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeHarvestJobResponse Source #

Arguments

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

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

DescribeHarvestJobResponse, describeHarvestJobResponse_arn - The Amazon Resource Name (ARN) assigned to the HarvestJob.

DescribeHarvestJobResponse, describeHarvestJobResponse_channelId - The ID of the Channel that the HarvestJob will harvest from.

DescribeHarvestJobResponse, describeHarvestJobResponse_createdAt - The time the HarvestJob was submitted

DescribeHarvestJobResponse, describeHarvestJobResponse_endTime - The end of the time-window which will be harvested.

DescribeHarvestJob, describeHarvestJobResponse_id - The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.

DescribeHarvestJobResponse, describeHarvestJobResponse_originEndpointId - The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.

DescribeHarvestJobResponse, describeHarvestJobResponse_s3Destination - Undocumented member.

DescribeHarvestJobResponse, describeHarvestJobResponse_startTime - The start of the time-window which will be harvested.

DescribeHarvestJobResponse, describeHarvestJobResponse_status - The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.

$sel:httpStatus:DescribeHarvestJobResponse', describeHarvestJobResponse_httpStatus - The response's http status code.

Response Lenses

describeHarvestJobResponse_arn :: Lens' DescribeHarvestJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) assigned to the HarvestJob.

describeHarvestJobResponse_channelId :: Lens' DescribeHarvestJobResponse (Maybe Text) Source #

The ID of the Channel that the HarvestJob will harvest from.

describeHarvestJobResponse_createdAt :: Lens' DescribeHarvestJobResponse (Maybe Text) Source #

The time the HarvestJob was submitted

describeHarvestJobResponse_endTime :: Lens' DescribeHarvestJobResponse (Maybe Text) Source #

The end of the time-window which will be harvested.

describeHarvestJobResponse_id :: Lens' DescribeHarvestJobResponse (Maybe Text) Source #

The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.

describeHarvestJobResponse_originEndpointId :: Lens' DescribeHarvestJobResponse (Maybe Text) Source #

The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.

describeHarvestJobResponse_s3Destination :: Lens' DescribeHarvestJobResponse (Maybe S3Destination) Source #

Undocumented member.

describeHarvestJobResponse_startTime :: Lens' DescribeHarvestJobResponse (Maybe Text) Source #

The start of the time-window which will be harvested.

describeHarvestJobResponse_status :: Lens' DescribeHarvestJobResponse (Maybe Status) Source #

The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.

describeHarvestJobResponse_httpStatus :: Lens' DescribeHarvestJobResponse Int Source #

The response's http status code.