codegen-resources.service-2.json Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of apigatewaymanagementapi Show documentation
The AWS Java SDK for ApiGatewayManagementApi module holds the client classes that are used for communicating with ApiGatewayManagementApi.
There is a newer version: 2.28.3
Show newest version
{
  "metadata" : {
    "apiVersion" : "2018-11-29",
    "endpointPrefix" : "execute-api",
    "signingName" : "execute-api",
    "serviceFullName" : "AmazonApiGatewayManagementApi",
    "serviceId" : "ApiGatewayManagementApi",
    "protocol" : "rest-json",
    "jsonVersion" : "1.1",
    "uid" : "apigatewaymanagementapi-2018-11-29",
    "signatureVersion" : "v4"
  },
  "operations" : {
    "PostToConnection" : {
      "name" : "PostToConnection",
      "http" : {
        "method" : "POST",
        "requestUri" : "/@connections/{connectionId}",
        "responseCode" : 200
      },
      "input" : {
        "shape" : "PostToConnectionRequest"
      },
      "errors" : [ {
        "shape" : "GoneException",
        "documentation" : "The connection with the provided id no longer exists."
      }, {
        "shape" : "LimitExceededException",
        "documentation" : "The client is sending more than the allowed number of requests per unit of time."
      }, {
        "shape" : "PayloadTooLargeException",
        "documentation" : "The data has exceeded the maximum size allowed."
      }, {
        "shape" : "ForbiddenException",
        "documentation" : "The caller is not authorized to invoke this operation."
      } ],
      "documentation" : "Sends the provided data to the specified connection."
    }
  },
  "shapes" : {
    "Data" : {
      "type" : "blob",
      "max" : 131072,
      "documentation" : "The data to be sent to the client specified by its connection id."
    },
    "ForbiddenException" : {
      "type" : "structure",
      "members" : { },
      "exception" : true,
      "error" : {
        "httpStatusCode" : 403
      },
      "documentation" : "The caller is not authorized to invoke this operation."
    },
    "GoneException" : {
      "type" : "structure",
      "members" : { },
      "exception" : true,
      "error" : {
        "httpStatusCode" : 410
      },
      "documentation" : "The connection with the provided id no longer exists."
    },
    "LimitExceededException" : {
      "type" : "structure",
      "members" : { },
      "exception" : true,
      "error" : {
        "httpStatusCode" : 429
      },
      "documentation" : "The client is sending more than the allowed number of requests per unit of time."
    },
    "PayloadTooLargeException" : {
      "type" : "structure",
      "members" : {
        "Message" : {
          "shape" : "__string",
          "locationName" : "message"
        }
      },
      "exception" : true,
      "error" : {
        "httpStatusCode" : 413
      },
      "documentation" : "The data has exceeded the maximum size allowed."
    },
    "PostToConnectionRequest" : {
      "type" : "structure",
      "members" : {
        "Data" : {
          "shape" : "Data",
          "documentation" : "The data to be sent to the client specified by its connection id."
        },
        "ConnectionId" : {
          "shape" : "__string",
          "location" : "uri",
          "locationName" : "connectionId",
          "documentation" : "The identifier of the connection that a specific client is using."
        }
      },
      "required" : [ "ConnectionId", "Data" ],
      "payload" : "Data"
    },
    "__string" : {
      "type" : "string"
    }
  },
  "documentation" : "The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable."
}