Class DescribeHttpConnectionCommandProtected

Describe a HttpConnection

Example

Use a bare-bones client and the command you need to make an API call.

import { EventsClient, DescribeHttpConnectionCommand } from "@stedi/sdk-client-events"; // ES Modules import
// const { EventsClient, DescribeHttpConnectionCommand } = require("@stedi/sdk-client-events"); // CommonJS import
const client = new EventsClient(config);
const input = { // DescribeHttpConnectionInput
  httpConnectionName: "STRING_VALUE", // required
};
const command = new DescribeHttpConnectionCommand(input);
const response = await client.send(command);
// { // DescribeHttpConnectionOutput
//   httpConnectionName: "STRING_VALUE", // required
//   idempotencyKey: "STRING_VALUE",
//   authorizationType: "BASIC" || "OAUTH_CLIENT_CREDENTIALS" || "API_KEY", // required
//   authorizationParameters: { // AuthorizationParameters
//     basicAuthParameters: { // BasicAuthParameters
//       username: "STRING_VALUE", // required
//       password: "STRING_VALUE", // required
//     },
//     apiKeyAuthParameters: { // ApiKeyAuthParameters
//       apiKeyName: "STRING_VALUE", // required
//       apiKeyValue: "STRING_VALUE", // required
//     },
//     oAuthParameters: { // OAuthParameters
//       authorizationEndpoint: "STRING_VALUE", // required
//       clientParameters: { // OAuthClientParameters
//         clientId: "STRING_VALUE", // required
//         clientSecret: "STRING_VALUE", // required
//       },
//       httpMethod: "GET" || "POST" || "PUT" || "PATCH" || "DELETE", // required
//       oAuthHttpParameters: { // HttpParameters
//         bodyParameters: [ // ParameterItems
//           { // Parameter
//             key: "STRING_VALUE", // required
//             value: "STRING_VALUE", // required
//           },
//         ],
//         headerParameters: [
//           {
//             key: "STRING_VALUE", // required
//             value: "STRING_VALUE", // required
//           },
//         ],
//         queryStringParameters: [
//           {
//             key: "STRING_VALUE", // required
//             value: "STRING_VALUE", // required
//           },
//         ],
//       },
//     },
//     invocationHttpParameters: {
//       bodyParameters: [
//         {
//           key: "STRING_VALUE", // required
//           value: "STRING_VALUE", // required
//         },
//       ],
//       headerParameters: [
//         {
//           key: "STRING_VALUE", // required
//           value: "STRING_VALUE", // required
//         },
//       ],
//       queryStringParameters: "<ParameterItems>",
//     },
//   },
//   connectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
//   stateReason: "STRING_VALUE",
//   resourceDetail: { // DescribeResourceDetail
//     status: "AVAILABLE" || "UNDER_CHANGE" || "CHANGE_FAILED" || "ERROR" || "CREATE_FAILED", // required
//     detailedStatus: "AVAILABLE_UPDATE_FAILED" || "UPDATE_FAILED" || "DELETE_FAILED",
//     statusMessage: "STRING_VALUE",
//     idempotencyKey: "STRING_VALUE", // required
//     createdAt: new Date("TIMESTAMP"), // required
//     updatedAt: new Date("TIMESTAMP"), // required
//   },
// };

Param

DescribeHttpConnectionCommandInput

Returns

DescribeHttpConnectionCommandOutput

See

• DescribeHttpConnectionCommandInput for command's input shape.
• DescribeHttpConnectionCommandOutput for command's response shape.
• config for EventsClient's config shape.

Throws

AccessDeniedException (client fault)

Throws

ProductUnavailableException (client fault)

Throws

ResourceAlreadyExistsException (client fault)

Throws

ResourceNotFoundException (client fault)

Throws

ResourceUnderChangeException (client fault)

Throws

ServiceException (server fault)

Throws

EventsServiceException

Base exception class for all service exceptions from Events service.