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.Types.HarvestJob

Description

Synopsis

data HarvestJob = HarvestJob' {
- 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
}
newHarvestJob :: HarvestJob
harvestJob_arn :: Lens' HarvestJob (Maybe Text)
harvestJob_channelId :: Lens' HarvestJob (Maybe Text)
harvestJob_createdAt :: Lens' HarvestJob (Maybe Text)
harvestJob_endTime :: Lens' HarvestJob (Maybe Text)
harvestJob_id :: Lens' HarvestJob (Maybe Text)
harvestJob_originEndpointId :: Lens' HarvestJob (Maybe Text)
harvestJob_s3Destination :: Lens' HarvestJob (Maybe S3Destination)
harvestJob_startTime :: Lens' HarvestJob (Maybe Text)
harvestJob_status :: Lens' HarvestJob (Maybe Status)

Documentation

data HarvestJob Source #

A HarvestJob resource configuration

See: newHarvestJob smart constructor.

Constructors

HarvestJob'

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.

Instances

Instances details

FromJSON HarvestJob Source #
Instance details Defined in Amazonka.MediaPackage.Types.HarvestJob Methods parseJSON :: Value -> Parser HarvestJob # parseJSONList :: Value -> Parser [HarvestJob] #
Generic HarvestJob Source #
Instance details Defined in Amazonka.MediaPackage.Types.HarvestJob Associated Types type Rep HarvestJob :: Type -> Type # Methods from :: HarvestJob -> Rep HarvestJob x # to :: Rep HarvestJob x -> HarvestJob #
Read HarvestJob Source #
Instance details Defined in Amazonka.MediaPackage.Types.HarvestJob Methods readsPrec :: Int -> ReadS HarvestJob # readList :: ReadS [HarvestJob] # readPrec :: ReadPrec HarvestJob # readListPrec :: ReadPrec [HarvestJob] #
Show HarvestJob Source #
Instance details Defined in Amazonka.MediaPackage.Types.HarvestJob Methods showsPrec :: Int -> HarvestJob -> ShowS # show :: HarvestJob -> String # showList :: [HarvestJob] -> ShowS #
NFData HarvestJob Source #
Instance details Defined in Amazonka.MediaPackage.Types.HarvestJob Methods rnf :: HarvestJob -> () #
Eq HarvestJob Source #
Instance details Defined in Amazonka.MediaPackage.Types.HarvestJob Methods (==) :: HarvestJob -> HarvestJob -> Bool # (/=) :: HarvestJob -> HarvestJob -> Bool #
Hashable HarvestJob Source #
Instance details Defined in Amazonka.MediaPackage.Types.HarvestJob Methods hashWithSalt :: Int -> HarvestJob -> Int # hash :: HarvestJob -> Int #
type Rep HarvestJob Source #
Instance details Defined in Amazonka.MediaPackage.Types.HarvestJob type Rep HarvestJob = D1 ('MetaData "HarvestJob" "Amazonka.MediaPackage.Types.HarvestJob" "amazonka-mediapackage-2.0-Ht5BbgvzDNJCrSLrgDmB6l" 'False) (C1 ('MetaCons "HarvestJob'" '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)))))))

newHarvestJob :: HarvestJob Source #

Create a value of HarvestJob 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:arn:HarvestJob', harvestJob_arn - The Amazon Resource Name (ARN) assigned to the HarvestJob.

$sel:channelId:HarvestJob', harvestJob_channelId - The ID of the Channel that the HarvestJob will harvest from.

$sel:createdAt:HarvestJob', harvestJob_createdAt - The time the HarvestJob was submitted

$sel:endTime:HarvestJob', harvestJob_endTime - The end of the time-window which will be harvested.

$sel:id:HarvestJob', harvestJob_id - The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.

$sel:originEndpointId:HarvestJob', harvestJob_originEndpointId - The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.

$sel:s3Destination:HarvestJob', harvestJob_s3Destination - Undocumented member.

$sel:startTime:HarvestJob', harvestJob_startTime - The start of the time-window which will be harvested.

$sel:status:HarvestJob', harvestJob_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.

harvestJob_arn :: Lens' HarvestJob (Maybe Text) Source #

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

harvestJob_channelId :: Lens' HarvestJob (Maybe Text) Source #

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

harvestJob_createdAt :: Lens' HarvestJob (Maybe Text) Source #

The time the HarvestJob was submitted

harvestJob_endTime :: Lens' HarvestJob (Maybe Text) Source #

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

harvestJob_id :: Lens' HarvestJob (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.

harvestJob_originEndpointId :: Lens' HarvestJob (Maybe Text) Source #

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

harvestJob_s3Destination :: Lens' HarvestJob (Maybe S3Destination) Source #

Undocumented member.

harvestJob_startTime :: Lens' HarvestJob (Maybe Text) Source #

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

harvestJob_status :: Lens' HarvestJob (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.