signer

package
v0.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 23, 2019 License: Apache-2.0 Imports: 7 Imported by: 13

Documentation

Overview

Package signer provides the client and types for making API requests to signer.

You can use Code Signing for Amazon FreeRTOS (AWS Signer) to sign code that you created for any of the IoT devices that Amazon Web Services supports. AWS Signer is integrated with Amazon FreeRTOS, AWS Certificate Manager, and AWS CloudTrail. Amazon FreeRTOS customers can use AWS Signer to sign code images before making them available for microcontrollers. You can use ACM to import third-party certificates to be used by AWS Signer. For general information about using AWS Signer, see the Code Signing for Amazon FreeRTOS Developer Guide (http://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html).

See https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25 for more information on this service.

See signer package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/signer/

Using the Client

To use signer with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the signer client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/signer/#New

Index

Constants

View Source
const (
	ServiceName = "signer" // Service's name
	ServiceID   = "Signer" // Service's identifier
	EndpointsID = "signer" // Service's Endpoint identifier
)
View Source
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeInternalServiceErrorException for service response error code
	// "InternalServiceErrorException".
	//
	// An internal error occurred.
	ErrCodeInternalServiceErrorException = "InternalServiceErrorException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// A specified resource could not be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The signing job has been throttled.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// You signing certificate could not be validated.
	ErrCodeValidationException = "ValidationException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type CancelSigningProfileInput

type CancelSigningProfileInput struct {

	// The name of the signing profile to be canceled.
	//
	// ProfileName is a required field
	ProfileName *string `location:"uri" locationName:"profileName" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/CancelSigningProfileRequest

func (CancelSigningProfileInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CancelSigningProfileInput) String

func (s CancelSigningProfileInput) String() string

String returns the string representation

func (*CancelSigningProfileInput) Validate

func (s *CancelSigningProfileInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelSigningProfileOutput

type CancelSigningProfileOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/CancelSigningProfileOutput

func (CancelSigningProfileOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CancelSigningProfileOutput) String

String returns the string representation

type CancelSigningProfileRequest

type CancelSigningProfileRequest struct {
	*aws.Request
	Input *CancelSigningProfileInput
	Copy  func(*CancelSigningProfileInput) CancelSigningProfileRequest
}

CancelSigningProfileRequest is the request type for the CancelSigningProfile API operation.

func (CancelSigningProfileRequest) Send

Send marshals and sends the CancelSigningProfile API request.

type CancelSigningProfileResponse added in v0.9.0

type CancelSigningProfileResponse struct {
	*CancelSigningProfileOutput
	// contains filtered or unexported fields
}

CancelSigningProfileResponse is the response type for the CancelSigningProfile API operation.

func (*CancelSigningProfileResponse) SDKResponseMetdata added in v0.9.0

func (r *CancelSigningProfileResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CancelSigningProfile request.

type Category

type Category string
const (
	CategoryAwsioT Category = "AWSIoT"
)

Enum values for Category

func (Category) MarshalValue

func (enum Category) MarshalValue() (string, error)

func (Category) MarshalValueBuf

func (enum Category) MarshalValueBuf(b []byte) ([]byte, error)

type Client added in v0.9.0

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to signer. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example:

// Create a client from just a config.
svc := signer.New(myConfig)

func (*Client) CancelSigningProfileRequest added in v0.9.0

func (c *Client) CancelSigningProfileRequest(input *CancelSigningProfileInput) CancelSigningProfileRequest

CancelSigningProfileRequest returns a request value for making API operation for AWS Signer.

Changes the state of an ACTIVE signing profile to CANCELED. A canceled profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs, and is deleted two years after cancelation.

// Example sending a request using CancelSigningProfileRequest.
req := client.CancelSigningProfileRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/CancelSigningProfile

func (*Client) DescribeSigningJobRequest added in v0.9.0

func (c *Client) DescribeSigningJobRequest(input *DescribeSigningJobInput) DescribeSigningJobRequest

DescribeSigningJobRequest returns a request value for making API operation for AWS Signer.

Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.

// Example sending a request using DescribeSigningJobRequest.
req := client.DescribeSigningJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/DescribeSigningJob

func (*Client) GetSigningPlatformRequest added in v0.9.0

func (c *Client) GetSigningPlatformRequest(input *GetSigningPlatformInput) GetSigningPlatformRequest

GetSigningPlatformRequest returns a request value for making API operation for AWS Signer.

Returns information on a specific signing platform.

// Example sending a request using GetSigningPlatformRequest.
req := client.GetSigningPlatformRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/GetSigningPlatform

func (*Client) GetSigningProfileRequest added in v0.9.0

func (c *Client) GetSigningProfileRequest(input *GetSigningProfileInput) GetSigningProfileRequest

GetSigningProfileRequest returns a request value for making API operation for AWS Signer.

Returns information on a specific signing profile.

// Example sending a request using GetSigningProfileRequest.
req := client.GetSigningProfileRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/GetSigningProfile

func (*Client) ListSigningJobsRequest added in v0.9.0

func (c *Client) ListSigningJobsRequest(input *ListSigningJobsInput) ListSigningJobsRequest

ListSigningJobsRequest returns a request value for making API operation for AWS Signer.

Lists all your signing jobs. You can use the maxResults parameter to limit the number of signing jobs that are returned in the response. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that AWS Signer returns in the nextToken parameter until all of your signing jobs have been returned.

// Example sending a request using ListSigningJobsRequest.
req := client.ListSigningJobsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListSigningJobs

func (*Client) ListSigningPlatformsRequest added in v0.9.0

func (c *Client) ListSigningPlatformsRequest(input *ListSigningPlatformsInput) ListSigningPlatformsRequest

ListSigningPlatformsRequest returns a request value for making API operation for AWS Signer.

Lists all signing platforms available in AWS Signer that match the request parameters. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that AWS Signer returns in the nextToken parameter until all of your signing jobs have been returned.

// Example sending a request using ListSigningPlatformsRequest.
req := client.ListSigningPlatformsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListSigningPlatforms

func (*Client) ListSigningProfilesRequest added in v0.9.0

func (c *Client) ListSigningProfilesRequest(input *ListSigningProfilesInput) ListSigningProfilesRequest

ListSigningProfilesRequest returns a request value for making API operation for AWS Signer.

Lists all available signing profiles in your AWS account. Returns only profiles with an ACTIVE status unless the includeCanceled request field is set to true. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that AWS Signer returns in the nextToken parameter until all of your signing jobs have been returned.

// Example sending a request using ListSigningProfilesRequest.
req := client.ListSigningProfilesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListSigningProfiles

func (*Client) PutSigningProfileRequest added in v0.9.0

func (c *Client) PutSigningProfileRequest(input *PutSigningProfileInput) PutSigningProfileRequest

PutSigningProfileRequest returns a request value for making API operation for AWS Signer.

Creates a signing profile. A signing profile is an AWS Signer template that can be used to carry out a pre-defined signing job. For more information, see http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html (http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html)

// Example sending a request using PutSigningProfileRequest.
req := client.PutSigningProfileRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/PutSigningProfile

func (*Client) StartSigningJobRequest added in v0.9.0

func (c *Client) StartSigningJobRequest(input *StartSigningJobInput) StartSigningJobRequest

StartSigningJobRequest returns a request value for making API operation for AWS Signer.

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 (http://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html) in the Amazon S3 Getting Started Guide.

  • Your S3 source bucket must be version enabled.

  • You must create an S3 destination bucket. AWS Signer 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 AWS Signer.

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/ (http://docs.aws.amazon.com/acm/latest/userguide/)

// Example sending a request using StartSigningJobRequest.
req := client.StartSigningJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/StartSigningJob

func (*Client) WaitUntilSuccessfulSigningJob added in v0.9.0

func (c *Client) WaitUntilSuccessfulSigningJob(ctx context.Context, input *DescribeSigningJobInput, opts ...aws.WaiterOption) error

WaitUntilSuccessfulSigningJob uses the signer API operation DescribeSigningJob to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type DescribeSigningJobInput

type DescribeSigningJobInput struct {

	// The ID of the signing job on input.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/DescribeSigningJobRequest

func (DescribeSigningJobInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeSigningJobInput) String

func (s DescribeSigningJobInput) String() string

String returns the string representation

func (*DescribeSigningJobInput) Validate

func (s *DescribeSigningJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeSigningJobOutput

type DescribeSigningJobOutput struct {

	// Date and time that the signing job was completed.
	CompletedAt *time.Time `locationName:"completedAt" type:"timestamp"`

	// Date and time that the signing job was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The ID of the signing job on output.
	JobId *string `locationName:"jobId" type:"string"`

	// A list of any overrides that were applied to the signing operation.
	Overrides *SigningPlatformOverrides `locationName:"overrides" type:"structure"`

	// The microcontroller platform to which your signed code image will be distributed.
	PlatformId *string `locationName:"platformId" type:"string"`

	// The name of the profile that initiated the signing operation.
	ProfileName *string `locationName:"profileName" min:"2" type:"string"`

	// The IAM principal that requested the signing job.
	RequestedBy *string `locationName:"requestedBy" type:"string"`

	// Name of the S3 bucket where the signed code image is saved by AWS Signer.
	SignedObject *SignedObject `locationName:"signedObject" type:"structure"`

	// Amazon Resource Name (ARN) of your code signing certificate.
	SigningMaterial *SigningMaterial `locationName:"signingMaterial" type:"structure"`

	// Map of user-assigned key-value pairs used during signing. These values contain
	// any information that you specified for use in your signing job.
	SigningParameters map[string]string `locationName:"signingParameters" type:"map"`

	// The object that contains the name of your S3 bucket or your raw code.
	Source *Source `locationName:"source" type:"structure"`

	// Status of the signing job.
	Status SigningStatus `locationName:"status" type:"string" enum:"true"`

	// String value that contains the status reason.
	StatusReason *string `locationName:"statusReason" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/DescribeSigningJobResponse

func (DescribeSigningJobOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeSigningJobOutput) String

func (s DescribeSigningJobOutput) String() string

String returns the string representation

type DescribeSigningJobRequest

type DescribeSigningJobRequest struct {
	*aws.Request
	Input *DescribeSigningJobInput
	Copy  func(*DescribeSigningJobInput) DescribeSigningJobRequest
}

DescribeSigningJobRequest is the request type for the DescribeSigningJob API operation.

func (DescribeSigningJobRequest) Send

Send marshals and sends the DescribeSigningJob API request.

type DescribeSigningJobResponse added in v0.9.0

type DescribeSigningJobResponse struct {
	*DescribeSigningJobOutput
	// contains filtered or unexported fields
}

DescribeSigningJobResponse is the response type for the DescribeSigningJob API operation.

func (*DescribeSigningJobResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeSigningJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeSigningJob request.

type Destination

type Destination struct {

	// The S3Destination object.
	S3 *S3Destination `locationName:"s3" type:"structure"`
	// contains filtered or unexported fields
}

Points to an S3Destination object that contains information about your S3 bucket. Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/Destination

func (Destination) MarshalFields

func (s Destination) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Destination) String

func (s Destination) String() string

String returns the string representation

type EncryptionAlgorithm

type EncryptionAlgorithm string
const (
	EncryptionAlgorithmRsa   EncryptionAlgorithm = "RSA"
	EncryptionAlgorithmEcdsa EncryptionAlgorithm = "ECDSA"
)

Enum values for EncryptionAlgorithm

func (EncryptionAlgorithm) MarshalValue

func (enum EncryptionAlgorithm) MarshalValue() (string, error)

func (EncryptionAlgorithm) MarshalValueBuf

func (enum EncryptionAlgorithm) MarshalValueBuf(b []byte) ([]byte, error)

type EncryptionAlgorithmOptions

type EncryptionAlgorithmOptions struct {

	// The set of accepted encryption algorithms that are allowed in an AWS Signer
	// job.
	//
	// AllowedValues is a required field
	AllowedValues []EncryptionAlgorithm `locationName:"allowedValues" type:"list" required:"true"`

	// The default encryption algorithm that is used by an AWS Signer job.
	//
	// DefaultValue is a required field
	DefaultValue EncryptionAlgorithm `locationName:"defaultValue" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

The encryption algorithm options that are available to an AWS Signer job. Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/EncryptionAlgorithmOptions

func (EncryptionAlgorithmOptions) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (EncryptionAlgorithmOptions) String

String returns the string representation

type GetSigningPlatformInput

type GetSigningPlatformInput struct {

	// The ID of the target signing platform.
	//
	// PlatformId is a required field
	PlatformId *string `location:"uri" locationName:"platformId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/GetSigningPlatformRequest

func (GetSigningPlatformInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetSigningPlatformInput) String

func (s GetSigningPlatformInput) String() string

String returns the string representation

func (*GetSigningPlatformInput) Validate

func (s *GetSigningPlatformInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSigningPlatformOutput

type GetSigningPlatformOutput struct {

	// The category type of the target signing platform.
	Category Category `locationName:"category" type:"string" enum:"true"`

	// The display name of the target signing platform.
	DisplayName *string `locationName:"displayName" type:"string"`

	// The maximum size (in MB) of the payload that can be signed by the target
	// platform.
	MaxSizeInMB *int64 `locationName:"maxSizeInMB" type:"integer"`

	// A list of partner entities that use the target signing platform.
	Partner *string `locationName:"partner" type:"string"`

	// The ID of the target signing platform.
	PlatformId *string `locationName:"platformId" type:"string"`

	// A list of configurations applied to the target platform at signing.
	SigningConfiguration *SigningConfiguration `locationName:"signingConfiguration" type:"structure"`

	// The format of the target platform's signing image.
	SigningImageFormat *SigningImageFormat `locationName:"signingImageFormat" type:"structure"`

	// The validation template that is used by the target signing platform.
	Target *string `locationName:"target" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/GetSigningPlatformResponse

func (GetSigningPlatformOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetSigningPlatformOutput) String

func (s GetSigningPlatformOutput) String() string

String returns the string representation

type GetSigningPlatformRequest

type GetSigningPlatformRequest struct {
	*aws.Request
	Input *GetSigningPlatformInput
	Copy  func(*GetSigningPlatformInput) GetSigningPlatformRequest
}

GetSigningPlatformRequest is the request type for the GetSigningPlatform API operation.

func (GetSigningPlatformRequest) Send

Send marshals and sends the GetSigningPlatform API request.

type GetSigningPlatformResponse added in v0.9.0

type GetSigningPlatformResponse struct {
	*GetSigningPlatformOutput
	// contains filtered or unexported fields
}

GetSigningPlatformResponse is the response type for the GetSigningPlatform API operation.

func (*GetSigningPlatformResponse) SDKResponseMetdata added in v0.9.0

func (r *GetSigningPlatformResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetSigningPlatform request.

type GetSigningProfileInput

type GetSigningProfileInput struct {

	// The name of the target signing profile.
	//
	// ProfileName is a required field
	ProfileName *string `location:"uri" locationName:"profileName" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/GetSigningProfileRequest

func (GetSigningProfileInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetSigningProfileInput) String

func (s GetSigningProfileInput) String() string

String returns the string representation

func (*GetSigningProfileInput) Validate

func (s *GetSigningProfileInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSigningProfileOutput

type GetSigningProfileOutput struct {

	// A list of overrides applied by the target signing profile for signing operations.
	Overrides *SigningPlatformOverrides `locationName:"overrides" type:"structure"`

	// The ID of the platform that is used by the target signing profile.
	PlatformId *string `locationName:"platformId" type:"string"`

	// The name of the target signing profile.
	ProfileName *string `locationName:"profileName" min:"2" type:"string"`

	// The ARN of the certificate that the target profile uses for signing operations.
	SigningMaterial *SigningMaterial `locationName:"signingMaterial" type:"structure"`

	// A map of key-value pairs for signing operations that is attached to the target
	// signing profile.
	SigningParameters map[string]string `locationName:"signingParameters" type:"map"`

	// The status of the target signing profile.
	Status SigningProfileStatus `locationName:"status" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/GetSigningProfileResponse

func (GetSigningProfileOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetSigningProfileOutput) String

func (s GetSigningProfileOutput) String() string

String returns the string representation

type GetSigningProfileRequest

type GetSigningProfileRequest struct {
	*aws.Request
	Input *GetSigningProfileInput
	Copy  func(*GetSigningProfileInput) GetSigningProfileRequest
}

GetSigningProfileRequest is the request type for the GetSigningProfile API operation.

func (GetSigningProfileRequest) Send

Send marshals and sends the GetSigningProfile API request.

type GetSigningProfileResponse added in v0.9.0

type GetSigningProfileResponse struct {
	*GetSigningProfileOutput
	// contains filtered or unexported fields
}

GetSigningProfileResponse is the response type for the GetSigningProfile API operation.

func (*GetSigningProfileResponse) SDKResponseMetdata added in v0.9.0

func (r *GetSigningProfileResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetSigningProfile request.

type HashAlgorithm

type HashAlgorithm string
const (
	HashAlgorithmSha1   HashAlgorithm = "SHA1"
	HashAlgorithmSha256 HashAlgorithm = "SHA256"
)

Enum values for HashAlgorithm

func (HashAlgorithm) MarshalValue

func (enum HashAlgorithm) MarshalValue() (string, error)

func (HashAlgorithm) MarshalValueBuf

func (enum HashAlgorithm) MarshalValueBuf(b []byte) ([]byte, error)

type HashAlgorithmOptions

type HashAlgorithmOptions struct {

	// The set of accepted hash algorithms allowed in an AWS Signer job.
	//
	// AllowedValues is a required field
	AllowedValues []HashAlgorithm `locationName:"allowedValues" type:"list" required:"true"`

	// The default hash algorithm that is used in an AWS Signer job.
	//
	// DefaultValue is a required field
	DefaultValue HashAlgorithm `locationName:"defaultValue" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

The hash algorithms that are available to an AWS Signer job. Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/HashAlgorithmOptions

func (HashAlgorithmOptions) MarshalFields

func (s HashAlgorithmOptions) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (HashAlgorithmOptions) String

func (s HashAlgorithmOptions) String() string

String returns the string representation

type ImageFormat

type ImageFormat string
const (
	ImageFormatJson ImageFormat = "JSON"
)

Enum values for ImageFormat

func (ImageFormat) MarshalValue

func (enum ImageFormat) MarshalValue() (string, error)

func (ImageFormat) MarshalValueBuf

func (enum ImageFormat) MarshalValueBuf(b []byte) ([]byte, error)

type ListSigningJobsInput

type ListSigningJobsInput struct {

	// Specifies the maximum number of items to return in the response. Use this
	// parameter when paginating results. If additional items exist beyond the number
	// you specify, the nextToken element is set in the response. Use the nextToken
	// value in a subsequent request to retrieve additional items.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// String for specifying the next set of paginated results to return. After
	// you receive a response with truncated results, use this parameter in a subsequent
	// request. Set it to the value of nextToken from the response that you just
	// received.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The ID of microcontroller platform that you specified for the distribution
	// of your code image.
	PlatformId *string `location:"querystring" locationName:"platformId" type:"string"`

	// The IAM principal that requested the signing job.
	RequestedBy *string `location:"querystring" locationName:"requestedBy" type:"string"`

	// A status value with which to filter your results.
	Status SigningStatus `location:"querystring" locationName:"status" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListSigningJobsRequest

func (ListSigningJobsInput) MarshalFields

func (s ListSigningJobsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListSigningJobsInput) String

func (s ListSigningJobsInput) String() string

String returns the string representation

func (*ListSigningJobsInput) Validate

func (s *ListSigningJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSigningJobsOutput

type ListSigningJobsOutput struct {

	// A list of your signing jobs.
	Jobs []SigningJob `locationName:"jobs" type:"list"`

	// String for specifying the next set of paginated results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListSigningJobsResponse

func (ListSigningJobsOutput) MarshalFields

func (s ListSigningJobsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListSigningJobsOutput) String

func (s ListSigningJobsOutput) String() string

String returns the string representation

type ListSigningJobsPaginator added in v0.9.0

type ListSigningJobsPaginator struct {
	aws.Pager
}

ListSigningJobsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListSigningJobsPaginator added in v0.9.0

func NewListSigningJobsPaginator(req ListSigningJobsRequest) ListSigningJobsPaginator

NewListSigningJobsRequestPaginator returns a paginator for ListSigningJobs. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListSigningJobsRequest(input)
p := signer.NewListSigningJobsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListSigningJobsPaginator) CurrentPage added in v0.9.0

type ListSigningJobsRequest

type ListSigningJobsRequest struct {
	*aws.Request
	Input *ListSigningJobsInput
	Copy  func(*ListSigningJobsInput) ListSigningJobsRequest
}

ListSigningJobsRequest is the request type for the ListSigningJobs API operation.

func (ListSigningJobsRequest) Send

Send marshals and sends the ListSigningJobs API request.

type ListSigningJobsResponse added in v0.9.0

type ListSigningJobsResponse struct {
	*ListSigningJobsOutput
	// contains filtered or unexported fields
}

ListSigningJobsResponse is the response type for the ListSigningJobs API operation.

func (*ListSigningJobsResponse) SDKResponseMetdata added in v0.9.0

func (r *ListSigningJobsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListSigningJobs request.

type ListSigningPlatformsInput

type ListSigningPlatformsInput struct {

	// The category type of a signing platform.
	Category *string `location:"querystring" locationName:"category" type:"string"`

	// The maximum number of results to be returned by this operation.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// Value for specifying the next set of paginated results to return. After you
	// receive a response with truncated results, use this parameter in a subsequent
	// request. Set it to the value of nextToken from the response that you just
	// received.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// Any partner entities connected to a signing platform.
	Partner *string `location:"querystring" locationName:"partner" type:"string"`

	// The validation template that is used by the target signing platform.
	Target *string `location:"querystring" locationName:"target" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListSigningPlatformsRequest

func (ListSigningPlatformsInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListSigningPlatformsInput) String

func (s ListSigningPlatformsInput) String() string

String returns the string representation

func (*ListSigningPlatformsInput) Validate

func (s *ListSigningPlatformsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSigningPlatformsOutput

type ListSigningPlatformsOutput struct {

	// Value for specifying the next set of paginated results to return.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of all platforms that match the request parameters.
	Platforms []SigningPlatform `locationName:"platforms" type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListSigningPlatformsResponse

func (ListSigningPlatformsOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListSigningPlatformsOutput) String

String returns the string representation

type ListSigningPlatformsPaginator added in v0.9.0

type ListSigningPlatformsPaginator struct {
	aws.Pager
}

ListSigningPlatformsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListSigningPlatformsPaginator added in v0.9.0

func NewListSigningPlatformsPaginator(req ListSigningPlatformsRequest) ListSigningPlatformsPaginator

NewListSigningPlatformsRequestPaginator returns a paginator for ListSigningPlatforms. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListSigningPlatformsRequest(input)
p := signer.NewListSigningPlatformsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListSigningPlatformsPaginator) CurrentPage added in v0.9.0

type ListSigningPlatformsRequest

type ListSigningPlatformsRequest struct {
	*aws.Request
	Input *ListSigningPlatformsInput
	Copy  func(*ListSigningPlatformsInput) ListSigningPlatformsRequest
}

ListSigningPlatformsRequest is the request type for the ListSigningPlatforms API operation.

func (ListSigningPlatformsRequest) Send

Send marshals and sends the ListSigningPlatforms API request.

type ListSigningPlatformsResponse added in v0.9.0

type ListSigningPlatformsResponse struct {
	*ListSigningPlatformsOutput
	// contains filtered or unexported fields
}

ListSigningPlatformsResponse is the response type for the ListSigningPlatforms API operation.

func (*ListSigningPlatformsResponse) SDKResponseMetdata added in v0.9.0

func (r *ListSigningPlatformsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListSigningPlatforms request.

type ListSigningProfilesInput

type ListSigningProfilesInput struct {

	// Designates whether to include profiles with the status of CANCELED.
	IncludeCanceled *bool `location:"querystring" locationName:"includeCanceled" type:"boolean"`

	// The maximum number of profiles to be returned.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// Value for specifying the next set of paginated results to return. After you
	// receive a response with truncated results, use this parameter in a subsequent
	// request. Set it to the value of nextToken from the response that you just
	// received.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListSigningProfilesRequest

func (ListSigningProfilesInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListSigningProfilesInput) String

func (s ListSigningProfilesInput) String() string

String returns the string representation

func (*ListSigningProfilesInput) Validate

func (s *ListSigningProfilesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSigningProfilesOutput

type ListSigningProfilesOutput struct {

	// Value for specifying the next set of paginated results to return.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of profiles that are available in the AWS account. This includes profiles
	// with the status of CANCELED if the includeCanceled parameter is set to true.
	Profiles []SigningProfile `locationName:"profiles" type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListSigningProfilesResponse

func (ListSigningProfilesOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListSigningProfilesOutput) String

func (s ListSigningProfilesOutput) String() string

String returns the string representation

type ListSigningProfilesPaginator added in v0.9.0

type ListSigningProfilesPaginator struct {
	aws.Pager
}

ListSigningProfilesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListSigningProfilesPaginator added in v0.9.0

func NewListSigningProfilesPaginator(req ListSigningProfilesRequest) ListSigningProfilesPaginator

NewListSigningProfilesRequestPaginator returns a paginator for ListSigningProfiles. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListSigningProfilesRequest(input)
p := signer.NewListSigningProfilesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListSigningProfilesPaginator) CurrentPage added in v0.9.0

type ListSigningProfilesRequest

type ListSigningProfilesRequest struct {
	*aws.Request
	Input *ListSigningProfilesInput
	Copy  func(*ListSigningProfilesInput) ListSigningProfilesRequest
}

ListSigningProfilesRequest is the request type for the ListSigningProfiles API operation.

func (ListSigningProfilesRequest) Send

Send marshals and sends the ListSigningProfiles API request.

type ListSigningProfilesResponse added in v0.9.0

type ListSigningProfilesResponse struct {
	*ListSigningProfilesOutput
	// contains filtered or unexported fields
}

ListSigningProfilesResponse is the response type for the ListSigningProfiles API operation.

func (*ListSigningProfilesResponse) SDKResponseMetdata added in v0.9.0

func (r *ListSigningProfilesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListSigningProfiles request.

type PutSigningProfileInput

type PutSigningProfileInput struct {

	// A subfield of platform. This specifies any different configuration options
	// that you want to apply to the chosen platform (such as a different hash-algorithm
	// or signing-algorithm).
	Overrides *SigningPlatformOverrides `locationName:"overrides" type:"structure"`

	// The ID of the signing profile to be created.
	//
	// PlatformId is a required field
	PlatformId *string `locationName:"platformId" type:"string" required:"true"`

	// The name of the signing profile to be created.
	//
	// ProfileName is a required field
	ProfileName *string `location:"uri" locationName:"profileName" min:"2" type:"string" required:"true"`

	// The AWS Certificate Manager certificate that will be used to sign code with
	// the new signing profile.
	//
	// SigningMaterial is a required field
	SigningMaterial *SigningMaterial `locationName:"signingMaterial" type:"structure" required:"true"`

	// Map of key-value pairs for signing. These can include any information that
	// you want to use during signing.
	SigningParameters map[string]string `locationName:"signingParameters" type:"map"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/PutSigningProfileRequest

func (PutSigningProfileInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutSigningProfileInput) String

func (s PutSigningProfileInput) String() string

String returns the string representation

func (*PutSigningProfileInput) Validate

func (s *PutSigningProfileInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutSigningProfileOutput

type PutSigningProfileOutput struct {

	// The Amazon Resource Name (ARN) of the signing profile created.
	Arn *string `locationName:"arn" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/PutSigningProfileResponse

func (PutSigningProfileOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutSigningProfileOutput) String

func (s PutSigningProfileOutput) String() string

String returns the string representation

type PutSigningProfileRequest

type PutSigningProfileRequest struct {
	*aws.Request
	Input *PutSigningProfileInput
	Copy  func(*PutSigningProfileInput) PutSigningProfileRequest
}

PutSigningProfileRequest is the request type for the PutSigningProfile API operation.

func (PutSigningProfileRequest) Send

Send marshals and sends the PutSigningProfile API request.

type PutSigningProfileResponse added in v0.9.0

type PutSigningProfileResponse struct {
	*PutSigningProfileOutput
	// contains filtered or unexported fields
}

PutSigningProfileResponse is the response type for the PutSigningProfile API operation.

func (*PutSigningProfileResponse) SDKResponseMetdata added in v0.9.0

func (r *PutSigningProfileResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutSigningProfile request.

type S3Destination

type S3Destination struct {

	// Name of the S3 bucket.
	BucketName *string `locationName:"bucketName" type:"string"`

	// An Amazon S3 prefix that you can use to limit responses to those that begin
	// with the specified prefix.
	Prefix *string `locationName:"prefix" type:"string"`
	// contains filtered or unexported fields
}

The name and prefix of the S3 bucket where AWS Signer saves your signed objects. Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/S3Destination

func (S3Destination) MarshalFields

func (s S3Destination) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (S3Destination) String

func (s S3Destination) String() string

String returns the string representation

type S3SignedObject

type S3SignedObject struct {

	// Name of the S3 bucket.
	BucketName *string `locationName:"bucketName" type:"string"`

	// Key name that uniquely identifies a signed code image in your bucket.
	Key *string `locationName:"key" type:"string"`
	// contains filtered or unexported fields
}

The S3 bucket name and key where AWS Signer saved your signed code image. Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/S3SignedObject

func (S3SignedObject) MarshalFields

func (s S3SignedObject) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (S3SignedObject) String

func (s S3SignedObject) String() string

String returns the string representation

type S3Source

type S3Source struct {

	// Name of the S3 bucket.
	//
	// BucketName is a required field
	BucketName *string `locationName:"bucketName" type:"string" required:"true"`

	// Key name of the bucket object that contains your unsigned code.
	//
	// Key is a required field
	Key *string `locationName:"key" type:"string" required:"true"`

	// Version of your source image in your version enabled S3 bucket.
	//
	// Version is a required field
	Version *string `locationName:"version" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about the S3 bucket where you saved your unsigned code. Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/S3Source

func (S3Source) MarshalFields

func (s S3Source) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (S3Source) String

func (s S3Source) String() string

String returns the string representation

func (*S3Source) Validate

func (s *S3Source) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SignedObject

type SignedObject struct {

	// The S3SignedObject.
	S3 *S3SignedObject `locationName:"s3" type:"structure"`
	// contains filtered or unexported fields
}

Points to an S3SignedObject object that contains information about your signed code image. Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SignedObject

func (SignedObject) MarshalFields

func (s SignedObject) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SignedObject) String

func (s SignedObject) String() string

String returns the string representation

type SigningConfiguration

type SigningConfiguration struct {

	// The encryption algorithm options that are available for an AWS Signer job.
	//
	// EncryptionAlgorithmOptions is a required field
	EncryptionAlgorithmOptions *EncryptionAlgorithmOptions `locationName:"encryptionAlgorithmOptions" type:"structure" required:"true"`

	// The hash algorithm options that are available for an AWS Signer job.
	//
	// HashAlgorithmOptions is a required field
	HashAlgorithmOptions *HashAlgorithmOptions `locationName:"hashAlgorithmOptions" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The configuration of an AWS Signer operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningConfiguration

func (SigningConfiguration) MarshalFields

func (s SigningConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SigningConfiguration) String

func (s SigningConfiguration) String() string

String returns the string representation

type SigningConfigurationOverrides

type SigningConfigurationOverrides struct {

	// A specified override of the default encryption algorithm that is used in
	// an AWS Signer job.
	EncryptionAlgorithm EncryptionAlgorithm `locationName:"encryptionAlgorithm" type:"string" enum:"true"`

	// A specified override of the default hash algorithm that is used in an AWS
	// Signer job.
	HashAlgorithm HashAlgorithm `locationName:"hashAlgorithm" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

A signing configuration that overrides the default encryption or hash algorithm of a signing job. Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningConfigurationOverrides

func (SigningConfigurationOverrides) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SigningConfigurationOverrides) String

String returns the string representation

type SigningImageFormat

type SigningImageFormat struct {

	// The default format of an AWS Signer signing image.
	//
	// DefaultFormat is a required field
	DefaultFormat ImageFormat `locationName:"defaultFormat" type:"string" required:"true" enum:"true"`

	// The supported formats of an AWS Signer signing image.
	//
	// SupportedFormats is a required field
	SupportedFormats []ImageFormat `locationName:"supportedFormats" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The image format of an AWS Signer platform or profile. Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningImageFormat

func (SigningImageFormat) MarshalFields

func (s SigningImageFormat) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SigningImageFormat) String

func (s SigningImageFormat) String() string

String returns the string representation

type SigningJob

type SigningJob struct {

	// The date and time that the signing job was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The ID of the signing job.
	JobId *string `locationName:"jobId" type:"string"`

	// A SignedObject structure that contains information about a signing job's
	// signed code image.
	SignedObject *SignedObject `locationName:"signedObject" type:"structure"`

	// A SigningMaterial object that contains the Amazon Resource Name (ARN) of
	// the certificate used for the signing job.
	SigningMaterial *SigningMaterial `locationName:"signingMaterial" type:"structure"`

	// A Source that contains information about a signing job's code image source.
	Source *Source `locationName:"source" type:"structure"`

	// The status of the signing job.
	Status SigningStatus `locationName:"status" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Contains information about a signing job. Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningJob

func (SigningJob) MarshalFields

func (s SigningJob) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SigningJob) String

func (s SigningJob) String() string

String returns the string representation

type SigningMaterial

type SigningMaterial struct {

	// The Amazon Resource Name (ARN) of the certificates that is used to sign your
	// code.
	//
	// CertificateArn is a required field
	CertificateArn *string `locationName:"certificateArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The ACM certificate that is used to sign your code. Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningMaterial

func (SigningMaterial) MarshalFields

func (s SigningMaterial) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SigningMaterial) String

func (s SigningMaterial) String() string

String returns the string representation

func (*SigningMaterial) Validate

func (s *SigningMaterial) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SigningPlatform

type SigningPlatform struct {

	// The category of an AWS Signer platform.
	Category Category `locationName:"category" type:"string" enum:"true"`

	// The display name of an AWS Signer platform.
	DisplayName *string `locationName:"displayName" type:"string"`

	// The maximum size (in MB) of code that can be signed by a AWS Signer platform.
	MaxSizeInMB *int64 `locationName:"maxSizeInMB" type:"integer"`

	// Any partner entities linked to an AWS Signer platform.
	Partner *string `locationName:"partner" type:"string"`

	// The ID of an AWS Signer platform.
	PlatformId *string `locationName:"platformId" type:"string"`

	// The configuration of an AWS Signer platform. This includes the designated
	// hash algorithm and encryption algorithm of a signing platform.
	SigningConfiguration *SigningConfiguration `locationName:"signingConfiguration" type:"structure"`

	// The signing image format that is used by an AWS Signer platform.
	SigningImageFormat *SigningImageFormat `locationName:"signingImageFormat" type:"structure"`

	// The types of targets that can be signed by an AWS Signer platform.
	Target *string `locationName:"target" type:"string"`
	// contains filtered or unexported fields
}

Contains information about the signing configurations and parameters that is used to perform an AWS Signer job. Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningPlatform

func (SigningPlatform) MarshalFields

func (s SigningPlatform) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SigningPlatform) String

func (s SigningPlatform) String() string

String returns the string representation

type SigningPlatformOverrides

type SigningPlatformOverrides struct {

	// A signing configuration that overrides the default encryption or hash algorithm
	// of a signing job.
	SigningConfiguration *SigningConfigurationOverrides `locationName:"signingConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

Any overrides that are applied to the signing configuration of an AWS Signer platform. Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningPlatformOverrides

func (SigningPlatformOverrides) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SigningPlatformOverrides) String

func (s SigningPlatformOverrides) String() string

String returns the string representation

type SigningProfile

type SigningProfile struct {

	// The ID of a platform that is available for use by a signing profile.
	PlatformId *string `locationName:"platformId" type:"string"`

	// The name of the AWS Signer profile.
	ProfileName *string `locationName:"profileName" min:"2" type:"string"`

	// The ACM certificate that is available for use by a signing profile.
	SigningMaterial *SigningMaterial `locationName:"signingMaterial" type:"structure"`

	// The parameters that are available for use by an AWS Signer user.
	SigningParameters map[string]string `locationName:"signingParameters" type:"map"`

	// The status of an AWS Signer profile.
	Status SigningProfileStatus `locationName:"status" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Contains information about the ACM certificates and AWS Signer configuration parameters that can be used by a given AWS Signer user. Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningProfile

func (SigningProfile) MarshalFields

func (s SigningProfile) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SigningProfile) String

func (s SigningProfile) String() string

String returns the string representation

type SigningProfileStatus

type SigningProfileStatus string
const (
	SigningProfileStatusActive   SigningProfileStatus = "Active"
	SigningProfileStatusCanceled SigningProfileStatus = "Canceled"
)

Enum values for SigningProfileStatus

func (SigningProfileStatus) MarshalValue

func (enum SigningProfileStatus) MarshalValue() (string, error)

func (SigningProfileStatus) MarshalValueBuf

func (enum SigningProfileStatus) MarshalValueBuf(b []byte) ([]byte, error)

type SigningStatus

type SigningStatus string
const (
	SigningStatusInProgress SigningStatus = "InProgress"
	SigningStatusFailed     SigningStatus = "Failed"
	SigningStatusSucceeded  SigningStatus = "Succeeded"
)

Enum values for SigningStatus

func (SigningStatus) MarshalValue

func (enum SigningStatus) MarshalValue() (string, error)

func (SigningStatus) MarshalValueBuf

func (enum SigningStatus) MarshalValueBuf(b []byte) ([]byte, error)

type Source

type Source struct {

	// The S3Source object.
	S3 *S3Source `locationName:"s3" type:"structure"`
	// contains filtered or unexported fields
}

An S3Source object that contains information about the S3 bucket where you saved your unsigned code. Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/Source

func (Source) MarshalFields

func (s Source) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Source) String

func (s Source) String() string

String returns the string representation

func (*Source) Validate

func (s *Source) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartSigningJobInput

type StartSigningJobInput struct {

	// String that identifies the signing request. All calls after the first that
	// use this token return the same response as the first call.
	//
	// ClientRequestToken is a required field
	ClientRequestToken *string `locationName:"clientRequestToken" type:"string" required:"true" idempotencyToken:"true"`

	// The S3 bucket in which to save your signed object. The destination contains
	// the name of your bucket and an optional prefix.
	//
	// Destination is a required field
	Destination *Destination `locationName:"destination" type:"structure" required:"true"`

	// The name of the signing profile.
	ProfileName *string `locationName:"profileName" min:"2" type:"string"`

	// The S3 bucket that contains the object to sign or a BLOB that contains your
	// raw code.
	//
	// Source is a required field
	Source *Source `locationName:"source" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/StartSigningJobRequest

func (StartSigningJobInput) MarshalFields

func (s StartSigningJobInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StartSigningJobInput) String

func (s StartSigningJobInput) String() string

String returns the string representation

func (*StartSigningJobInput) Validate

func (s *StartSigningJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartSigningJobOutput

type StartSigningJobOutput struct {

	// The ID of your signing job.
	JobId *string `locationName:"jobId" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/StartSigningJobResponse

func (StartSigningJobOutput) MarshalFields

func (s StartSigningJobOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StartSigningJobOutput) String

func (s StartSigningJobOutput) String() string

String returns the string representation

type StartSigningJobRequest

type StartSigningJobRequest struct {
	*aws.Request
	Input *StartSigningJobInput
	Copy  func(*StartSigningJobInput) StartSigningJobRequest
}

StartSigningJobRequest is the request type for the StartSigningJob API operation.

func (StartSigningJobRequest) Send

Send marshals and sends the StartSigningJob API request.

type StartSigningJobResponse added in v0.9.0

type StartSigningJobResponse struct {
	*StartSigningJobOutput
	// contains filtered or unexported fields
}

StartSigningJobResponse is the response type for the StartSigningJob API operation.

func (*StartSigningJobResponse) SDKResponseMetdata added in v0.9.0

func (r *StartSigningJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartSigningJob request.

Directories

Path Synopsis
Package signeriface provides an interface to enable mocking the AWS Signer service client for testing your code.
Package signeriface provides an interface to enable mocking the AWS Signer service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL