Ably · Schema

aws_access_keys_response

RealtimeWebSocketsPub/SubMessagingStreamingPush NotificationsChatLiveSync

Properties

Name Type Description
authenticationMode string Authentication method is using AWS credentials (AWS key ID and secret key).
accessKeyId string The AWS key ID for the AWS IAM user. See the Ably AWS authentication docs for details.
View JSON Schema on GitHub

JSON Schema

ably-aws-access-keys-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/aws_access_keys_response",
  "title": "aws_access_keys_response",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "authenticationMode": {
      "type": "string",
      "enum": [
        "credentials"
      ],
      "description": "Authentication method is using AWS credentials (AWS key ID and secret key).",
      "example": "credentials"
    },
    "accessKeyId": {
      "type": "string",
      "description": "The AWS key ID for the AWS IAM user. See the Ably <a href=\"https://ably.com/docs/general/aws-authentication/\">AWS authentication docs</a> for details.",
      "example": "AKIAIOSFODNN7EXAMPLE"
    }
  }
}