update_ssh_public_key `async` ¶

update_ssh_public_key(
    user_name: userNameType,
    ssh_public_key_id: publicKeyIdType,
    status: statusType,
    *,
    config_overrides: Optional[AsyncIAMClientConfig] = None,
) -> None

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:

user_name (userNameType) –

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: _+=,.@-
ssh_public_key_id (publicKeyIdType) –

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 (statusType) –

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.

Raises:

InvalidInputException –

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
NoSuchEntityException –

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_iam/_services/async_iam.py

async def update_ssh_public_key(
    self,
    user_name: "capo_iam.types.user_name_type.userNameType",
    ssh_public_key_id: "capo_iam.types.public_key_id_type.publicKeyIdType",
    status: "capo_iam.types.status_type.statusType",
    *,
    config_overrides: Optional[AsyncIAMClientConfig] = None,
) -> None:
    """<p>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.</p> <p>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 <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up CodeCommit for SSH connections</a> in the <i>CodeCommit User Guide</i>.</p>

    Args:
        user_name: <p>The name of the IAM user associated with the SSH public key.</p> <p>This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-</p>
        ssh_public_key_id: <p>The unique identifier for the SSH public key.</p> <p>This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters that can consist of any upper or lowercased letter or digit.</p>
        status: <p>The status to assign to the SSH public key. <code>Active</code> means that the key can be used for authentication with an CodeCommit repository. <code>Inactive</code> means that the key cannot be used.</p>

    Raises:
        capo_iam.errors.invalid_input_exception.InvalidInputException: <p>The request was rejected because an invalid or out-of-range value was supplied for an input parameter.</p>
        capo_iam.errors.no_such_entity_exception.NoSuchEntityException: <p>The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.</p>
        capo_iam.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iam.types.update_ssh_public_key_request.UpdateSSHPublicKeyRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_iam._operations.aws_identity_management_v20100508.update_ssh_public_key

        (
            output,
            http_response,
        ) = await capo_iam._operations.aws_identity_management_v20100508.update_ssh_public_key.async_update_ssh_public_key(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateSSHPublicKey")
    )
    input_: capo_iam.types.update_ssh_public_key_request.UpdateSSHPublicKeyRequest = {
        "user_name": user_name,
        "ssh_public_key_id": ssh_public_key_id,
        "status": status,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

update_ssh_public_key async ¶

update_ssh_public_key `async` ¶