iam_upload_signing_certificate: Uploads an X

Description Usage Arguments Details Request syntax Examples

View source: R/iam_operations.R

Description

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

Usage

1
iam_upload_signing_certificate(UserName, CertificateBody)

Arguments

UserName

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: \_+=,[email protected]

CertificateBody

[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 (U+0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through U+00FF)

  • The special characters tab (U+0009), line feed (U+000A), and carriage return (U+000D)

Details

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

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, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.

Request syntax

1
2
3
4
svc$upload_signing_certificate(
  UserName = "string",
  CertificateBody = "string"
)

Examples

1
2
3
4
5
6
# The following command uploads a signing certificate for the IAM user
# named Bob.
svc$upload_signing_certificate(
  CertificateBody = "-----BEGIN CERTIFICATE-----<certificate-body>-----END CERTIFICATE-----",
  UserName = "Bob"
)

paws.security.identity documentation built on Jan. 14, 2020, 5:08 p.m.