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.Signer.StartSigningJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Initiates a signing job to be performed on the code provided. Signing jobs are viewable by the ListSigningJobs operation for two years after they are performed. Note the following requirements:

You must create an Amazon S3 source bucket. For more information, see Create a Bucket in the Amazon S3 Getting Started Guide.
Your S3 source bucket must be version enabled.
You must create an S3 destination bucket. Code signing uses your S3 destination bucket to write your signed code.
You specify the name of the source and destination buckets when calling the StartSigningJob operation.
You must also specify a request token that identifies your request to code signing.

You can call the DescribeSigningJob and the ListSigningJobs actions after you call StartSigningJob.

For a Java example that shows how to use this action, see http://docs.aws.amazon.com/acm/latest/userguide/

Synopsis

data StartSigningJob = StartSigningJob' {
- profileOwner :: Maybe Text
- source :: Source
- destination :: Destination
- profileName :: Text
- clientRequestToken :: Text
}
newStartSigningJob :: Source -> Destination -> Text -> Text -> StartSigningJob
startSigningJob_profileOwner :: Lens' StartSigningJob (Maybe Text)
startSigningJob_source :: Lens' StartSigningJob Source
startSigningJob_destination :: Lens' StartSigningJob Destination
startSigningJob_profileName :: Lens' StartSigningJob Text
startSigningJob_clientRequestToken :: Lens' StartSigningJob Text
data StartSigningJobResponse = StartSigningJobResponse' {
- jobId :: Maybe Text
- jobOwner :: Maybe Text
- httpStatus :: Int
}
newStartSigningJobResponse :: Int -> StartSigningJobResponse
startSigningJobResponse_jobId :: Lens' StartSigningJobResponse (Maybe Text)
startSigningJobResponse_jobOwner :: Lens' StartSigningJobResponse (Maybe Text)
startSigningJobResponse_httpStatus :: Lens' StartSigningJobResponse Int

Creating a Request

data StartSigningJob Source #

See: newStartSigningJob smart constructor.

Constructors

StartSigningJob'

Fields

profileOwner :: Maybe Text
The AWS account ID of the signing profile owner.
source :: Source
The S3 bucket that contains the object to sign or a BLOB that contains your raw code.
destination :: Destination
The S3 bucket in which to save your signed object. The destination contains the name of your bucket and an optional prefix.
profileName :: Text
The name of the signing profile.
clientRequestToken :: Text
String that identifies the signing request. All calls after the first that use this token return the same response as the first call.

Instances

Instances details

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

newStartSigningJob Source #

Arguments

:: Source	`$sel:source:StartSigningJob'`
-> Destination	`$sel:destination:StartSigningJob'`
-> Text	`$sel:profileName:StartSigningJob'`
-> Text	`$sel:clientRequestToken:StartSigningJob'`
-> StartSigningJob

Create a value of StartSigningJob 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:profileOwner:StartSigningJob', startSigningJob_profileOwner - The AWS account ID of the signing profile owner.

$sel:source:StartSigningJob', startSigningJob_source - The S3 bucket that contains the object to sign or a BLOB that contains your raw code.

$sel:destination:StartSigningJob', startSigningJob_destination - The S3 bucket in which to save your signed object. The destination contains the name of your bucket and an optional prefix.

$sel:profileName:StartSigningJob', startSigningJob_profileName - The name of the signing profile.

$sel:clientRequestToken:StartSigningJob', startSigningJob_clientRequestToken - String that identifies the signing request. All calls after the first that use this token return the same response as the first call.

Request Lenses

startSigningJob_profileOwner :: Lens' StartSigningJob (Maybe Text) Source #

The AWS account ID of the signing profile owner.

startSigningJob_source :: Lens' StartSigningJob Source Source #

The S3 bucket that contains the object to sign or a BLOB that contains your raw code.

startSigningJob_destination :: Lens' StartSigningJob Destination Source #

The S3 bucket in which to save your signed object. The destination contains the name of your bucket and an optional prefix.

startSigningJob_profileName :: Lens' StartSigningJob Text Source #

The name of the signing profile.

startSigningJob_clientRequestToken :: Lens' StartSigningJob Text Source #

String that identifies the signing request. All calls after the first that use this token return the same response as the first call.

Destructuring the Response

data StartSigningJobResponse Source #

See: newStartSigningJobResponse smart constructor.

Constructors

StartSigningJobResponse'
Fields jobId :: Maybe Text The ID of your signing job. jobOwner :: Maybe Text The AWS account ID of the signing job owner. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StartSigningJobResponse Source #
Instance details Defined in Amazonka.Signer.StartSigningJob Methods (==) :: StartSigningJobResponse -> StartSigningJobResponse -> Bool # (/=) :: StartSigningJobResponse -> StartSigningJobResponse -> Bool #
Read StartSigningJobResponse Source #
Instance details Defined in Amazonka.Signer.StartSigningJob Methods readsPrec :: Int -> ReadS StartSigningJobResponse # readList :: ReadS [StartSigningJobResponse] # readPrec :: ReadPrec StartSigningJobResponse # readListPrec :: ReadPrec [StartSigningJobResponse] #
Show StartSigningJobResponse Source #
Instance details Defined in Amazonka.Signer.StartSigningJob Methods showsPrec :: Int -> StartSigningJobResponse -> ShowS # show :: StartSigningJobResponse -> String # showList :: [StartSigningJobResponse] -> ShowS #
Generic StartSigningJobResponse Source #
Instance details Defined in Amazonka.Signer.StartSigningJob Associated Types type Rep StartSigningJobResponse :: Type -> Type # Methods from :: StartSigningJobResponse -> Rep StartSigningJobResponse x # to :: Rep StartSigningJobResponse x -> StartSigningJobResponse #
NFData StartSigningJobResponse Source #
Instance details Defined in Amazonka.Signer.StartSigningJob Methods rnf :: StartSigningJobResponse -> () #
type Rep StartSigningJobResponse Source #
Instance details Defined in Amazonka.Signer.StartSigningJob type Rep StartSigningJobResponse = D1 ('MetaData "StartSigningJobResponse" "Amazonka.Signer.StartSigningJob" "libZSservicesZSamazonka-signerZSamazonka-signer" 'False) (C1 ('MetaCons "StartSigningJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "jobOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartSigningJobResponse Source #

Arguments

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

Create a value of StartSigningJobResponse 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:jobId:StartSigningJobResponse', startSigningJobResponse_jobId - The ID of your signing job.

$sel:jobOwner:StartSigningJobResponse', startSigningJobResponse_jobOwner - The AWS account ID of the signing job owner.

$sel:httpStatus:StartSigningJobResponse', startSigningJobResponse_httpStatus - The response's http status code.

Response Lenses

startSigningJobResponse_jobId :: Lens' StartSigningJobResponse (Maybe Text) Source #

The ID of your signing job.

startSigningJobResponse_jobOwner :: Lens' StartSigningJobResponse (Maybe Text) Source #

The AWS account ID of the signing job owner.

startSigningJobResponse_httpStatus :: Lens' StartSigningJobResponse Int Source #

The response's http status code.