| CARVIEW |
UpdateServiceSpecificCredential
Sets the status of a service-specific credential to Active or
Inactive. Service-specific credentials that are inactive cannot be used
for authentication to the service. This operation can be used to disable a user's
service-specific credential as part of a credential rotation work flow.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- ServiceSpecificCredentialId
-
The unique identifier of the service-specific credential.
This parameter allows (through its regex pattern
) a string of characters that can consist of any upper or lowercased letter or digit. Type: String
Length Constraints: Minimum length of 20. Maximum length of 128.
Pattern:
[\w]+Required: Yes
- Status
-
The status to be assigned to the service-specific credential.
Type: String
Valid Values:
Active | Inactive | ExpiredRequired: Yes
- UserName
-
The name of the IAM user associated with the service-specific credential. If you do not specify this value, then the operation assumes the user whose credentials are used to call the operation.
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: _+=,.@- Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\w+=,.@-]+Required: No
Errors
For information about the errors that are common to all actions, see Common Errors.
- NoSuchEntity
-
The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
HTTP Status Code: 404
Examples
Example
The following example shows how to set the state to "Active" for a service-specific credential associated with the specified IAM user.
Sample Request
https://iam.amazonaws.com/?Action=UpdateServiceSpecificCredential
&ServiceSpecificCredentialId=ACCA12345ABCDEXAMPLE
&UserName=Anika
&Status=Active
&Version=2010-05-08
&AUTHPARAMSSample Response
<UpdateServiceSpecificCredentialResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/">
<ResponseMetadata>
<RequestId>EXAMPLE8-90ab-cdef-fedc-ba987EXAMPLE</RequestId>
</ResponseMetadata>
</UpdateServiceSpecificCredentialResponse>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of it.
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.