AWS API Changes

2019/11/06 - AWS Signer - 3 new3 updated api methods

Changes Update signer client to latest version

TagResource (new)

Link ¶

Adds one or more tags to a signing profile. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the signing profile using its Amazon Resource Name (ARN). You specify the tag by using a key-value pair.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

Amazon Resource Name (ARN) for the signing profile.

type tags:

dict

param tags:

[REQUIRED]

One or more tags to be associated with the signing profile.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

ListTagsForResource (new)

Link ¶

Returns a list of the tags associated with a signing profile resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) for the signing profile.

rtype:

dict

returns:

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- tags (dict) --
  
  A list of tags associated with the signing profile.
  - (string) --
    - (string) --

UntagResource (new)

Link ¶

Remove one or more tags from a signing profile. Specify a list of tag keys to remove the tags.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

Amazon Resource Name (ARN) for the signing profile .

type tagKeys:

list

param tagKeys:

[REQUIRED]

A list of tag keys to be removed from the signing profile .

(string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

GetSigningProfile (updated)

Link ¶
Changes (response)

{'arn': 'string', 'tags': {'string': 'string'}}

Returns information on a specific signing profile.

See also: AWS API Documentation

Request Syntax

client.get_signing_profile(
    profileName='string'
)

type profileName:

string

param profileName:

[REQUIRED]

The name of the target signing profile.

rtype:

dict

returns:

Response Syntax

{
    'profileName': 'string',
    'signingMaterial': {
        'certificateArn': 'string'
    },
    'platformId': 'string',
    'overrides': {
        'signingConfiguration': {
            'encryptionAlgorithm': 'RSA'|'ECDSA',
            'hashAlgorithm': 'SHA1'|'SHA256'
        }
    },
    'signingParameters': {
        'string': 'string'
    },
    'status': 'Active'|'Canceled',
    'arn': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- profileName (string) --
  
  The name of the target signing profile.
- signingMaterial (dict) --
  
  The ARN of the certificate that the target profile uses for signing operations.
  - certificateArn (string) --
    
    The Amazon Resource Name (ARN) of the certificates that is used to sign your code.
- platformId (string) --
  
  The ID of the platform that is used by the target signing profile.
- overrides (dict) --
  
  A list of overrides applied by the target signing profile for signing operations.
  - signingConfiguration (dict) --
    
    A signing configuration that overrides the default encryption or hash algorithm of a signing job.
    - encryptionAlgorithm (string) --
      
      A specified override of the default encryption algorithm that is used in a code signing job.
    - hashAlgorithm (string) --
      
      A specified override of the default hash algorithm that is used in a code signing job.
- signingParameters (dict) --
  
  A map of key-value pairs for signing operations that is attached to the target signing profile.
  - (string) --
    - (string) --
- status (string) --
  
  The status of the target signing profile.
- arn (string) --
  
  The Amazon Resource Name (ARN) for the signing profile.
- tags (dict) --
  
  A list of tags associated with the signing profile.
  - (string) --
    - (string) --

ListSigningProfiles (updated)

Link ¶
Changes (response)

{'profiles': {'arn': 'string', 'tags': {'string': 'string'}}}

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, code signing 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 code signing returns in the nextToken parameter until all of your signing jobs have been returned.

See also: AWS API Documentation

Request Syntax

client.list_signing_profiles(
    includeCanceled=True|False,
    maxResults=123,
    nextToken='string'
)

type includeCanceled:

boolean

param includeCanceled:

Designates whether to include profiles with the status of CANCELED.

type maxResults:

integer

param maxResults:

The maximum number of profiles to be returned.

type nextToken:

string

param nextToken:

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.

rtype:

dict

returns:

Response Syntax

{
    'profiles': [
        {
            'profileName': 'string',
            'signingMaterial': {
                'certificateArn': 'string'
            },
            'platformId': 'string',
            'signingParameters': {
                'string': 'string'
            },
            'status': 'Active'|'Canceled',
            'arn': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- profiles (list) --
  
  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.
  - (dict) --
    
    Contains information about the ACM certificates and code signing configuration parameters that can be used by a given code signing user.
    - profileName (string) --
      
      The name of the signing profile.
    - signingMaterial (dict) --
      
      The ACM certificate that is available for use by a signing profile.
      - certificateArn (string) --
        
        The Amazon Resource Name (ARN) of the certificates that is used to sign your code.
    - platformId (string) --
      
      The ID of a platform that is available for use by a signing profile.
    - signingParameters (dict) --
      
      The parameters that are available for use by a code signing user.
      - (string) --
        
        (string) --
    - status (string) --
      
      The status of a code signing profile.
    - arn (string) --
      
      Amazon Resource Name (ARN) for the signing profile.
    - tags (dict) --
      
      A list of tags associated with the signing profile.
      - (string) --
        
        (string) --
- nextToken (string) --
  
  Value for specifying the next set of paginated results to return.

PutSigningProfile (updated)

Link ¶
Changes (request)

{'tags': {'string': 'string'}}

Creates a signing profile. A signing profile is a code signing 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

See also: AWS API Documentation

Request Syntax

client.put_signing_profile(
    profileName='string',
    signingMaterial={
        'certificateArn': 'string'
    },
    platformId='string',
    overrides={
        'signingConfiguration': {
            'encryptionAlgorithm': 'RSA'|'ECDSA',
            'hashAlgorithm': 'SHA1'|'SHA256'
        }
    },
    signingParameters={
        'string': 'string'
    },
    tags={
        'string': 'string'
    }
)

type profileName:

string

param profileName:

[REQUIRED]

The name of the signing profile to be created.

type signingMaterial:

dict

param signingMaterial:

[REQUIRED]

The AWS Certificate Manager certificate that will be used to sign code with the new signing profile.

certificateArn (string) -- [REQUIRED]

The Amazon Resource Name (ARN) of the certificates that is used to sign your code.

type platformId:

string

param platformId:

[REQUIRED]

The ID of the signing profile to be created.

type overrides:

dict

param overrides:

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

signingConfiguration (dict) --

A signing configuration that overrides the default encryption or hash algorithm of a signing job.
- encryptionAlgorithm (string) --
  
  A specified override of the default encryption algorithm that is used in a code signing job.
- hashAlgorithm (string) --
  
  A specified override of the default hash algorithm that is used in a code signing job.

type signingParameters:

dict

param signingParameters:

Map of key-value pairs for signing. These can include any information that you want to use during signing.

(string) --
- (string) --

type tags:

dict

param tags:

Tags to be associated with the signing profile being created.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string'
}

Response Structure

(dict) --
- arn (string) --
  
  The Amazon Resource Name (ARN) of the signing profile created.