@aws-sdk/client-supportauthz 3.1077.0

package/dist-types/commands/TagResourceCommand.d.ts

@@ -0,0 +1,92 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { TagResourceInput, TagResourceOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, SupportAuthZClientResolvedConfig } from "../SupportAuthZClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link TagResourceCommand}.
+ */
+export interface TagResourceCommandInput extends TagResourceInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link TagResourceCommand}.
+ */
+export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataBearer {
+}
+declare const TagResourceCommand_base: {
+    new (input: TagResourceCommandInput): import("@smithy/core/client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, SupportAuthZClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: TagResourceCommandInput): import("@smithy/core/client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, SupportAuthZClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): {
+        [x: string]: unknown;
+    };
+};
+/**
+ * <p>Adds or overwrites one or more tags for a support permit resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SupportAuthZClient, TagResourceCommand } from "@aws-sdk/client-supportauthz"; // ES Modules import
+ * // const { SupportAuthZClient, TagResourceCommand } = require("@aws-sdk/client-supportauthz"); // CommonJS import
+ * // import type { SupportAuthZClientConfig } from "@aws-sdk/client-supportauthz";
+ * const config = {}; // type is SupportAuthZClientConfig
+ * const client = new SupportAuthZClient(config);
+ * const input = { // TagResourceInput
+ *   resourceArn: "STRING_VALUE", // required
+ *   tags: { // Tags // required
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ * };
+ * const command = new TagResourceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
+ * @see {@link TagResourceCommandInput} for command's `input` shape.
+ * @see {@link TagResourceCommandOutput} for command's `response` shape.
+ * @see {@link SupportAuthZClientResolvedConfig | config} for SupportAuthZClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient permissions to perform this operation.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal service error occurred. Try again later.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource does not exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request rate exceeded the allowed limit. Try again later.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by the service.</p>
+ *
+ * @throws {@link SupportAuthZServiceException}
+ * <p>Base exception class for all service exceptions from SupportAuthZ service.</p>
+ *
+ *
+ * @public
+ */
+export declare class TagResourceCommand extends TagResourceCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: TagResourceInput;
+            output: {};
+        };
+        sdk: {
+            input: TagResourceCommandInput;
+            output: TagResourceCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -0,0 +1,92 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UntagResourceInput, UntagResourceOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, SupportAuthZClientResolvedConfig } from "../SupportAuthZClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UntagResourceCommand}.
+ */
+export interface UntagResourceCommandInput extends UntagResourceInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UntagResourceCommand}.
+ */
+export interface UntagResourceCommandOutput extends UntagResourceOutput, __MetadataBearer {
+}
+declare const UntagResourceCommand_base: {
+    new (input: UntagResourceCommandInput): import("@smithy/core/client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, SupportAuthZClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UntagResourceCommandInput): import("@smithy/core/client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, SupportAuthZClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): {
+        [x: string]: unknown;
+    };
+};
+/**
+ * <p>Removes one or more tags from a support permit resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SupportAuthZClient, UntagResourceCommand } from "@aws-sdk/client-supportauthz"; // ES Modules import
+ * // const { SupportAuthZClient, UntagResourceCommand } = require("@aws-sdk/client-supportauthz"); // CommonJS import
+ * // import type { SupportAuthZClientConfig } from "@aws-sdk/client-supportauthz";
+ * const config = {}; // type is SupportAuthZClientConfig
+ * const client = new SupportAuthZClient(config);
+ * const input = { // UntagResourceInput
+ *   resourceArn: "STRING_VALUE", // required
+ *   tagKeys: [ // TagKeyList // required
+ *     "STRING_VALUE",
+ *   ],
+ * };
+ * const command = new UntagResourceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
+ * @see {@link UntagResourceCommandInput} for command's `input` shape.
+ * @see {@link UntagResourceCommandOutput} for command's `response` shape.
+ * @see {@link SupportAuthZClientResolvedConfig | config} for SupportAuthZClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient permissions to perform this operation.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal service error occurred. Try again later.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource does not exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request rate exceeded the allowed limit. Try again later.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by the service.</p>
+ *
+ * @throws {@link SupportAuthZServiceException}
+ * <p>Base exception class for all service exceptions from SupportAuthZ service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UntagResourceCommand extends UntagResourceCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UntagResourceInput;
+            output: {};
+        };
+        sdk: {
+            input: UntagResourceCommandInput;
+            output: UntagResourceCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./CreateSupportPermitCommand";
+export * from "./DeleteSupportPermitCommand";
+export * from "./GetActionCommand";
+export * from "./GetSupportPermitCommand";
+export * from "./ListActionsCommand";
+export * from "./ListSupportPermitRequestsCommand";
+export * from "./ListSupportPermitsCommand";
+export * from "./ListTagsForResourceCommand";
+export * from "./RejectSupportPermitRequestCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,44 @@
+import type { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+    region?: string | undefined | Provider<string | undefined>;
+}
+/**
+ * @public
+ */
+export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
+    defaultSigningName: string;
+};
+/**
+ * @internal
+ */
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;
+/**
+ * @internal
+ */
+export declare const commonParams: {
+    readonly UseFIPS: {
+        readonly type: "builtInParams";
+        readonly name: "useFipsEndpoint";
+    };
+    readonly Endpoint: {
+        readonly type: "builtInParams";
+        readonly name: "endpoint";
+    };
+    readonly Region: {
+        readonly type: "builtInParams";
+        readonly name: "region";
+    };
+};
+/**
+ * @internal
+ */
+export interface EndpointParameters extends __EndpointParameters {
+    UseFIPS?: boolean | undefined;
+    Endpoint?: string | undefined;
+    Region?: string | undefined;
+}

package/dist-types/endpoint/bdd.d.ts

@@ -0,0 +1,2 @@
+import { BinaryDecisionDiagram } from "@smithy/core/endpoints";
+export declare const bdd: BinaryDecisionDiagram;

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,8 @@
+import type { EndpointV2, Logger } from "@smithy/types";
+import type { EndpointParameters } from "./EndpointParameters";
+/**
+ * @internal
+ */
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,9 @@
+import type { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import type { HttpHandlerExtensionConfiguration } from "@smithy/core/protocols";
+import type { DefaultExtensionConfiguration } from "@smithy/types";
+import type { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
+/**
+ * @internal
+ */
+export interface SupportAuthZExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * <fullname>AWS Support Authorization</fullname> <p>AWS SupportAuthZ enables you to control and authorize the actions that AWS support operators can perform on your resources. You create cryptographically signed support permits specifying which actions operators can perform, on which resources, and under what time-window conditions. Permits are signed using a customer-managed AWS KMS key (ECC_NIST_P384, SIGN_VERIFY) to ensure non-repudiation.</p>
+ *
+ * @packageDocumentation
+ */
+export * from "./SupportAuthZClient";
+export * from "./SupportAuthZ";
+export type { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { SupportAuthZExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./schemas/schemas_0";
+export * from "./pagination";
+export * from "./models/enums";
+export * from "./models/errors";
+export * from "./models/models_0";
+export { SupportAuthZServiceException } from "./models/SupportAuthZServiceException";

package/dist-types/models/SupportAuthZServiceException.d.ts

@@ -0,0 +1,14 @@
+import { type ServiceExceptionOptions as __ServiceExceptionOptions, ServiceException as __ServiceException } from "@smithy/core/client";
+export type { __ServiceExceptionOptions };
+export { __ServiceException };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from SupportAuthZ service.
+ */
+export declare class SupportAuthZServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/dist-types/models/enums.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @public
+ * @enum
+ */
+export declare const SupportPermitStatus: {
+    /**
+     * <p>The permit is active and can be used by the support operator.</p>
+     */
+    readonly ACTIVE: "ACTIVE";
+    /**
+     * <p>The permit is being deleted.</p>
+     */
+    readonly DELETING: "DELETING";
+    /**
+     * <p>The permit is inactive and cannot be used.</p>
+     */
+    readonly INACTIVE: "INACTIVE";
+};
+/**
+ * @public
+ */
+export type SupportPermitStatus = (typeof SupportPermitStatus)[keyof typeof SupportPermitStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const SupportPermitRequestStatus: {
+    /**
+     * <p>The request has been accepted.</p>
+     */
+    readonly ACCEPTED: "ACCEPTED";
+    /**
+     * <p>The request has been cancelled.</p>
+     */
+    readonly CANCELLED: "CANCELLED";
+    /**
+     * <p>The request is pending customer review.</p>
+     */
+    readonly PENDING: "PENDING";
+    /**
+     * <p>The request has been rejected.</p>
+     */
+    readonly REJECTED: "REJECTED";
+};
+/**
+ * @public
+ */
+export type SupportPermitRequestStatus = (typeof SupportPermitRequestStatus)[keyof typeof SupportPermitRequestStatus];

package/dist-types/models/errors.d.ts

@@ -0,0 +1,146 @@
+import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/core/client";
+import type { ValidationExceptionField } from "./models_0";
+import { SupportAuthZServiceException as __BaseException } from "./SupportAuthZServiceException";
+/**
+ * <p>You don't have sufficient permissions to perform this operation.</p>
+ * @public
+ */
+export declare class AccessDeniedException extends __BaseException {
+    readonly name: "AccessDeniedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
+}
+/**
+ * <p>The request conflicts with the current state of the resource.</p>
+ * @public
+ */
+export declare class ConflictException extends __BaseException {
+    readonly name: "ConflictException";
+    readonly $fault: "client";
+    /**
+     * <p>The identifier of the resource that caused the conflict.</p>
+     * @public
+     */
+    resourceId: string | undefined;
+    /**
+     * <p>The type of the resource that caused the conflict.</p>
+     * @public
+     */
+    resourceType: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
+}
+/**
+ * <p>An internal service error occurred. Try again later.</p>
+ * @public
+ */
+export declare class InternalServerException extends __BaseException {
+    readonly name: "InternalServerException";
+    readonly $fault: "server";
+    $retryable: {};
+    /**
+     * <p>The number of seconds to wait before retrying the request.</p>
+     * @public
+     */
+    retryAfterSeconds?: number | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
+}
+/**
+ * <p>The request exceeds a service quota for your account.</p>
+ * @public
+ */
+export declare class ServiceQuotaExceededException extends __BaseException {
+    readonly name: "ServiceQuotaExceededException";
+    readonly $fault: "client";
+    /**
+     * <p>The identifier of the resource that exceeded the quota.</p>
+     * @public
+     */
+    resourceId: string | undefined;
+    /**
+     * <p>The type of the resource that exceeded the quota.</p>
+     * @public
+     */
+    resourceType: string | undefined;
+    /**
+     * <p>The service code of the originating service.</p>
+     * @public
+     */
+    serviceCode: string | undefined;
+    /**
+     * <p>The quota code of the exceeded quota.</p>
+     * @public
+     */
+    quotaCode: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
+}
+/**
+ * <p>The request rate exceeded the allowed limit. Try again later.</p>
+ * @public
+ */
+export declare class ThrottlingException extends __BaseException {
+    readonly name: "ThrottlingException";
+    readonly $fault: "client";
+    $retryable: {
+        throttling: boolean;
+    };
+    /**
+     * <p>The number of seconds to wait before retrying the request.</p>
+     * @public
+     */
+    retryAfterSeconds?: number | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
+}
+/**
+ * <p>The input fails to satisfy the constraints specified by the service.</p>
+ * @public
+ */
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
+    readonly $fault: "client";
+    /**
+     * <p>A list of fields that fail validation. Each entry identifies the field and the reason for the constraint violation.</p>
+     * @public
+     */
+    fieldList?: ValidationExceptionField[] | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+}
+/**
+ * <p>The specified resource does not exist.</p>
+ * @public
+ */
+export declare class ResourceNotFoundException extends __BaseException {
+    readonly name: "ResourceNotFoundException";
+    readonly $fault: "client";
+    /**
+     * <p>The identifier of the resource that was not found.</p>
+     * @public
+     */
+    resourceId: string | undefined;
+    /**
+     * <p>The type of the resource that was not found.</p>
+     * @public
+     */
+    resourceType: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
+}