AccessKey

Contains information about an Amazon Web Services access key.

This data type is used as a response element in the CreateAccessKey and ListAccessKeys operations.

The SecretAccessKey value is returned only in response to CreateAccessKey. You can get a secret access key only when you first create an access key; you cannot recover the secret access key later. If you lose a secret access key, you must create a new access key.

APIs.ioEngineeringPlatform

Properties

Name Type Description
UserName object
AccessKeyId object
Status object
SecretAccessKey object
CreateDate object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-accesskey-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AccessKey",
  "title": "AccessKey",
  "type": "object",
  "required": [
    "UserName",
    "AccessKeyId",
    "Status",
    "SecretAccessKey"
  ],
  "properties": {
    "UserName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/userNameType"
        },
        {
          "description": "The name of the IAM user that the access key is associated with."
        }
      ]
    },
    "AccessKeyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/accessKeyIdType"
        },
        {
          "description": "The ID for this access key."
        }
      ]
    },
    "Status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/statusType"
        },
        {
          "description": "The status of the access key. <code>Active</code> means that the key is valid for API calls, while <code>Inactive</code> means it is not. "
        }
      ]
    },
    "SecretAccessKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/accessKeySecretType"
        },
        {
          "description": "The secret key used to sign requests."
        }
      ]
    },
    "CreateDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/dateType"
        },
        {
          "description": "The date when the access key was created."
        }
      ]
    }
  },
  "description": "<p>Contains information about an Amazon Web Services access key.</p> <p> This data type is used as a response element in the <a>CreateAccessKey</a> and <a>ListAccessKeys</a> operations. </p> <note> <p>The <code>SecretAccessKey</code> value is returned only in response to <a>CreateAccessKey</a>. You can get a secret access key only when you first create an access key; you cannot recover the secret access key later. If you lose a secret access key, you must create a new access key.</p> </note>"
}