update_access_key¶
Operation¶
async
¶
update_access_key(input: UpdateAccessKeyInput, plugins: list[Plugin] | None = None) -> UpdateAccessKeyOutput
Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user's key as part of a key rotation workflow.
If the UserName is not specified, the user name is determined
implicitly based on the Amazon Web Services access key ID used to sign
the request. If a temporary access key is used, then UserName is
required. If a long-term key is assigned to the user, then UserName is
not required. 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.
For information about rotating keys, see Managing keys and certificates in the IAM User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateAccessKeyInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
UpdateAccessKeyOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateAccessKeyInput structure.
Attributes¶
class-attribute
instance-attribute
¶
access_key_id: str | None = ...
The access key ID of the secret access key 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.
class-attribute
instance-attribute
¶
status: str | None = ...
The status you want to assign to the secret access key. Active means
that the key can be used for programmatic calls to Amazon Web Services,
while Inactive means that the key cannot be used.
class-attribute
instance-attribute
¶
user_name: str | None = ...
The name of the user whose key you want to update.
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: _+=,.@-
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateAccessKeyOutput structure.