iam_update_signing_certificate: Changes the status of the specified user signing certificate...

Description Usage Arguments Details Request syntax Examples

View source: R/iam_operations.R

Description

Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user\'s signing certificate as part of a certificate rotation work flow.

Usage

1
iam_update_signing_certificate(UserName, CertificateId, Status)

Arguments

UserName

The name of the IAM user the signing certificate belongs to.

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]

CertificateId

[required] The ID of the signing certificate you want to update.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

Status

[required] The status you want to assign to the certificate. Active means that the certificate can be used for API calls to AWS Inactive means that the certificate cannot be used.

Details

If the UserName field is not specified, the 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.

Request syntax

1
2
3
4
5
svc$update_signing_certificate(
  UserName = "string",
  CertificateId = "string",
  Status = "Active"|"Inactive"
)

Examples

1
2
3
4
5
6
7
# The following command changes the status of a signing certificate for a
# user named Bob to Inactive.
svc$update_signing_certificate(
  CertificateId = "TA7SMP42TDN5Z26OBPJE7EXAMPLE",
  Status = "Inactive",
  UserName = "Bob"
)

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