- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeauthorizeConnectionCommand
Removes all authorization parameters from the connection. This lets you remove the secret from the connection so you can reuse it without having to create a new connection.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { EventBridgeClient, DeauthorizeConnectionCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import
// const { EventBridgeClient, DeauthorizeConnectionCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import
const client = new EventBridgeClient(config);
const input = { // DeauthorizeConnectionRequest
Name: "STRING_VALUE", // required
};
const command = new DeauthorizeConnectionCommand(input);
const response = await client.send(command);
// { // DeauthorizeConnectionResponse
// ConnectionArn: "STRING_VALUE",
// ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING" || "ACTIVE" || "FAILED_CONNECTIVITY",
// CreationTime: new Date("TIMESTAMP"),
// LastModifiedTime: new Date("TIMESTAMP"),
// LastAuthorizedTime: new Date("TIMESTAMP"),
// };
DeauthorizeConnectionCommand Input
See DeauthorizeConnectionCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
Name Required | string | undefined | The name of the connection to remove authorization from. |
DeauthorizeConnectionCommand Output
See DeauthorizeConnectionCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
ConnectionArn | string | undefined | The ARN of the connection that authorization was removed from. |
ConnectionState | ConnectionState | undefined | The state of the connection. |
CreationTime | Date | undefined | A time stamp for the time that the connection was created. |
LastAuthorizedTime | Date | undefined | A time stamp for the time that the connection was last authorized. |
LastModifiedTime | Date | undefined | A time stamp for the time that the connection was last updated. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ConcurrentModificationException | client | There is concurrent modification on a rule, target, archive, or replay. |
InternalException | server | This exception occurs due to unexpected causes. |
ResourceNotFoundException | client | An entity that you specified does not exist. |
EventBridgeServiceException | Base exception class for all service exceptions from EventBridge service. |