IAM / Client / upload_signing_certificate

upload_signing_certificate

IAM.Client.upload_signing_certificate(**kwargs)

Uploads an X.509 signing certificate and associates it with the specified IAM user. Some Amazon Web Services services require you to use certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is Active.

For information about when you would use an X.509 signing certificate, see Managing server certificates in IAM in the IAM User Guide.

If the UserName is not specified, the IAM user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

Note

Because the body of an X.509 certificate can be large, you should use POST rather than GET when calling UploadSigningCertificate. For information about setting up signatures and authorization through the API, see Signing Amazon Web Services API requests in the Amazon Web Services General Reference. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

See also: AWS API Documentation

Request Syntax

response = client.upload_signing_certificate(
    UserName='string',
    CertificateBody='string'
)

Parameters:

• UserName (string) –

  The name of the user the signing certificate is for.

  This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

• CertificateBody (string) –

  [REQUIRED]

  The contents of the signing certificate.

  The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character ( \u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

  • The special characters tab ( \u0009), line feed ( \u000A), and carriage return ( \u000D)

Return type:

dict

Returns:

Response Syntax

{
    'Certificate': {
        'UserName': 'string',
        'CertificateId': 'string',
        'CertificateBody': 'string',
        'Status': 'Active'|'Inactive',
        'UploadDate': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) –

  Contains the response to a successful UploadSigningCertificate request.

  • Certificate (dict) –

    Information about the certificate.

    • UserName (string) –

      The name of the user the signing certificate is associated with.

    • CertificateId (string) –

      The ID for the signing certificate.

    • CertificateBody (string) –

      The contents of the signing certificate.

    • Status (string) –

      The status of the signing certificate. Active means that the key is valid for API calls, while Inactive means it is not.

    • UploadDate (datetime) –

      The date when the signing certificate was uploaded.

Exceptions

• IAM.Client.exceptions.LimitExceededException

• IAM.Client.exceptions.EntityAlreadyExistsException

• IAM.Client.exceptions.MalformedCertificateException

• IAM.Client.exceptions.InvalidCertificateException

• IAM.Client.exceptions.DuplicateCertificateException

• IAM.Client.exceptions.NoSuchEntityException

• IAM.Client.exceptions.ConcurrentModificationException

• IAM.Client.exceptions.ServiceFailureException

Examples

The following command uploads a signing certificate for the IAM user named Bob.

response = client.upload_signing_certificate(
    CertificateBody='-----BEGIN CERTIFICATE-----<certificate-body>-----END CERTIFICATE-----',
    UserName='Bob',
)

print(response)

Expected Output:

{
    'Certificate': {
        'CertificateBody': '-----BEGIN CERTIFICATE-----<certificate-body>-----END CERTIFICATE-----',
        'CertificateId': 'ID123456789012345EXAMPLE',
        'Status': 'Active',
        'UploadDate': datetime(2015, 6, 6, 21, 40, 8, 5, 157, 0),
        'UserName': 'Bob',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}