SSHPublicKey

Contains information about an SSH public key.

This data type is used as a response element in the GetSSHPublicKey and UploadSSHPublicKey operations.

APIs.ioEngineeringPlatform

Properties

Name Type Description
UserName object
SSHPublicKeyId object
Fingerprint object
SSHPublicKeyBody object
Status object
UploadDate object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-sshpublickey-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SSHPublicKey",
  "title": "SSHPublicKey",
  "type": "object",
  "required": [
    "UserName",
    "SSHPublicKeyId",
    "Fingerprint",
    "SSHPublicKeyBody",
    "Status"
  ],
  "properties": {
    "UserName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/userNameType"
        },
        {
          "description": "The name of the IAM user associated with the SSH public key."
        }
      ]
    },
    "SSHPublicKeyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/publicKeyIdType"
        },
        {
          "description": "The unique identifier for the SSH public key."
        }
      ]
    },
    "Fingerprint": {
      "allOf": [
        {
          "$ref": "#/components/schemas/publicKeyFingerprintType"
        },
        {
          "description": "The MD5 message digest of the SSH public key."
        }
      ]
    },
    "SSHPublicKeyBody": {
      "allOf": [
        {
          "$ref": "#/components/schemas/publicKeyMaterialType"
        },
        {
          "description": "The SSH public key."
        }
      ]
    },
    "Status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/statusType"
        },
        {
          "description": "The status of 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."
        }
      ]
    },
    "UploadDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/dateType"
        },
        {
          "description": "The date and time, in <a href=\"http://www.iso.org/iso/iso8601\">ISO 8601 date-time format</a>, when the SSH public key was uploaded."
        }
      ]
    }
  },
  "description": "<p>Contains information about an SSH public key.</p> <p>This data type is used as a response element in the <a>GetSSHPublicKey</a> and <a>UploadSSHPublicKey</a> operations. </p>"
}