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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new HarvestJob record.

Synopsis

data CreateHarvestJob = CreateHarvestJob' {
- s3Destination :: S3Destination
- endTime :: Text
- originEndpointId :: Text
- startTime :: Text
- id :: Text
}
newCreateHarvestJob :: S3Destination -> Text -> Text -> Text -> Text -> CreateHarvestJob
createHarvestJob_s3Destination :: Lens' CreateHarvestJob S3Destination
createHarvestJob_endTime :: Lens' CreateHarvestJob Text
createHarvestJob_originEndpointId :: Lens' CreateHarvestJob Text
createHarvestJob_startTime :: Lens' CreateHarvestJob Text
createHarvestJob_id :: Lens' CreateHarvestJob Text
data CreateHarvestJobResponse = CreateHarvestJobResponse' {
- 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
}
newCreateHarvestJobResponse :: Int -> CreateHarvestJobResponse
createHarvestJobResponse_arn :: Lens' CreateHarvestJobResponse (Maybe Text)
createHarvestJobResponse_channelId :: Lens' CreateHarvestJobResponse (Maybe Text)
createHarvestJobResponse_createdAt :: Lens' CreateHarvestJobResponse (Maybe Text)
createHarvestJobResponse_endTime :: Lens' CreateHarvestJobResponse (Maybe Text)
createHarvestJobResponse_id :: Lens' CreateHarvestJobResponse (Maybe Text)
createHarvestJobResponse_originEndpointId :: Lens' CreateHarvestJobResponse (Maybe Text)
createHarvestJobResponse_s3Destination :: Lens' CreateHarvestJobResponse (Maybe S3Destination)
createHarvestJobResponse_startTime :: Lens' CreateHarvestJobResponse (Maybe Text)
createHarvestJobResponse_status :: Lens' CreateHarvestJobResponse (Maybe Status)
createHarvestJobResponse_httpStatus :: Lens' CreateHarvestJobResponse Int

Creating a Request

data CreateHarvestJob Source #

Configuration parameters used to create a new HarvestJob.

See: newCreateHarvestJob smart constructor.

Constructors

CreateHarvestJob'

Fields

s3Destination :: S3Destination
endTime :: Text
The end of the time-window which will be harvested
originEndpointId :: Text
The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.
startTime :: Text
The start of the time-window which will be harvested
id :: Text
The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted

Instances

Instances details

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

newCreateHarvestJob Source #

Arguments

:: S3Destination	`CreateHarvestJob`
-> Text	`CreateHarvestJob`
-> Text	`CreateHarvestJob`
-> Text	`CreateHarvestJob`
-> Text	`CreateHarvestJob`
-> CreateHarvestJob

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

CreateHarvestJob, createHarvestJob_s3Destination - Undocumented member.

CreateHarvestJob, createHarvestJob_endTime - The end of the time-window which will be harvested

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

CreateHarvestJob, createHarvestJob_startTime - The start of the time-window which will be harvested

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

Request Lenses

createHarvestJob_s3Destination :: Lens' CreateHarvestJob S3Destination Source #

Undocumented member.

createHarvestJob_endTime :: Lens' CreateHarvestJob Text Source #

The end of the time-window which will be harvested

createHarvestJob_originEndpointId :: Lens' CreateHarvestJob Text Source #

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

createHarvestJob_startTime :: Lens' CreateHarvestJob Text Source #

The start of the time-window which will be harvested

createHarvestJob_id :: Lens' CreateHarvestJob 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

Destructuring the Response

data CreateHarvestJobResponse Source #

See: newCreateHarvestJobResponse smart constructor.

Constructors

CreateHarvestJobResponse'

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

newCreateHarvestJobResponse Source #

Arguments

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

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

CreateHarvestJobResponse, createHarvestJobResponse_arn - The Amazon Resource Name (ARN) assigned to the HarvestJob.

CreateHarvestJobResponse, createHarvestJobResponse_channelId - The ID of the Channel that the HarvestJob will harvest from.

CreateHarvestJobResponse, createHarvestJobResponse_createdAt - The time the HarvestJob was submitted

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

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

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

CreateHarvestJob, createHarvestJobResponse_s3Destination - Undocumented member.

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

CreateHarvestJobResponse, createHarvestJobResponse_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:CreateHarvestJobResponse', createHarvestJobResponse_httpStatus - The response's http status code.

Response Lenses

createHarvestJobResponse_arn :: Lens' CreateHarvestJobResponse (Maybe Text) Source #

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

createHarvestJobResponse_channelId :: Lens' CreateHarvestJobResponse (Maybe Text) Source #

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

createHarvestJobResponse_createdAt :: Lens' CreateHarvestJobResponse (Maybe Text) Source #

The time the HarvestJob was submitted

createHarvestJobResponse_endTime :: Lens' CreateHarvestJobResponse (Maybe Text) Source #

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

createHarvestJobResponse_id :: Lens' CreateHarvestJobResponse (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.

createHarvestJobResponse_originEndpointId :: Lens' CreateHarvestJobResponse (Maybe Text) Source #

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

createHarvestJobResponse_s3Destination :: Lens' CreateHarvestJobResponse (Maybe S3Destination) Source #

Undocumented member.

createHarvestJobResponse_startTime :: Lens' CreateHarvestJobResponse (Maybe Text) Source #

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

createHarvestJobResponse_status :: Lens' CreateHarvestJobResponse (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.

createHarvestJobResponse_httpStatus :: Lens' CreateHarvestJobResponse Int Source #

The response's http status code.