update_ssh_public_key¶
Operation¶
update_ssh_public_key
¶
update_ssh_public_key(request: UpdateSSHPublicKeyInput | UpdateSSHPublicKeyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateSSHPublicKeyInputDict]) -> UpdateSSHPublicKeyOutput
Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user's SSH public key as part of a key rotation work flow.
The SSH public key affected by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateSSHPublicKeyInput | UpdateSSHPublicKeyInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[UpdateSSHPublicKeyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateSSHPublicKeyOutput
|
An instance of |
update_ssh_public_key
async
¶
update_ssh_public_key(request: UpdateSSHPublicKeyInput | UpdateSSHPublicKeyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateSSHPublicKeyInputDict]) -> UpdateSSHPublicKeyOutput
Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user's SSH public key as part of a key rotation work flow.
The SSH public key affected by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateSSHPublicKeyInput | UpdateSSHPublicKeyInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[UpdateSSHPublicKeyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateSSHPublicKeyOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
UpdateSSHPublicKeyInputDict
¶
Bases: TypedDict
Dictionary form of UpdateSSHPublicKeyInput.
Attributes¶
ssh_public_key_id
instance-attribute
¶
The unique identifier for the SSH public key.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
status
instance-attribute
¶
The status to assign to the SSH public key. Active means that the key
can be used for authentication with an CodeCommit repository. Inactive
means that the key cannot be used.
user_name
instance-attribute
¶
The name of the IAM user associated with the SSH public key.
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: _+=,.@-
UpdateSSHPublicKeyInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateSSHPublicKeyInput structure.
Attributes¶
ssh_public_key_id
class-attribute
instance-attribute
¶
ssh_public_key_id: str | None = ...
The unique identifier for the SSH public key.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
status
class-attribute
instance-attribute
¶
status: str | None = ...
The status to assign to the SSH public key. Active means that the key
can be used for authentication with an CodeCommit repository. Inactive
means that the key cannot be used.
user_name
class-attribute
instance-attribute
¶
user_name: str | None = ...
The name of the IAM user associated with the SSH public key.
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¶
UpdateSSHPublicKeyOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateSSHPublicKeyOutput structure.