@aws-sdk/client-cloudwatchomni 3.1138.0

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

@@ -0,0 +1,285 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { CreateAccessGrantInput, CreateAccessGrantOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link CreateAccessGrantCommand}.
+ */
+export interface CreateAccessGrantCommandInput extends CreateAccessGrantInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateAccessGrantCommand}.
+ */
+export interface CreateAccessGrantCommandOutput extends CreateAccessGrantOutput, __MetadataBearer {
+}
+declare const CreateAccessGrantCommand_base: {
+    new (input: CreateAccessGrantCommandInput): import("@smithy/core/client").CommandImpl<CreateAccessGrantCommandInput, CreateAccessGrantCommandOutput, import("..").CloudWatchOmniClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: CreateAccessGrantCommandInput): import("@smithy/core/client").CommandImpl<CreateAccessGrantCommandInput, CreateAccessGrantCommandOutput, import("..").CloudWatchOmniClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Creates an AccessGrant that authorizes a principal to perform a set of
+ * actions on resources in a space.
+ *
+ * Optionally narrow the grant with scoped actions that limit it to specific
+ * resources and fields. Use ListAccessGrants and GetAccessGrant to retrieve
+ * grants, and DeleteAccessGrant to remove them.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CloudWatchOmniClient, CreateAccessGrantCommand } from "@aws-sdk/client-cloudwatchomni"; // ES Modules import
+ * // const { CloudWatchOmniClient, CreateAccessGrantCommand } = require("@aws-sdk/client-cloudwatchomni"); // CommonJS import
+ * // import type { CloudWatchOmniClientConfig } from "@aws-sdk/client-cloudwatchomni";
+ * const config = {}; // type is CloudWatchOmniClientConfig
+ * const client = new CloudWatchOmniClient(config);
+ * const input = { // CreateAccessGrantInput
+ *   domainId: "STRING_VALUE", // required
+ *   spaceId: "STRING_VALUE", // required
+ *   name: "STRING_VALUE", // required
+ *   principal: { // AccessGrantPrincipal
+ *     principalType: "IDC_USER" || "IDC_GROUP" || "IAM_USER" || "IAM_ROLE" || "IAM_ROOT" || "ACCESS_PROFILE" || "ALERT" || "AGENT", // required
+ *     principalId: "STRING_VALUE",
+ *     principalAttributes: [ // AccessGrantPrincipalAttributeList
+ *       { // AccessGrantPrincipalAttribute
+ *         key: "STRING_VALUE", // required
+ *         value: "STRING_VALUE", // required
+ *       },
+ *     ],
+ *   },
+ *   permission: "SPACE_ADMIN" || "READ" || "READ_WRITE_DELETE" || "CUSTOM", // required
+ *   scopedActions: [ // ScopedActionsList
+ *     { // ScopedActions
+ *       actions: [ // ScopedActionNameList // required
+ *         "STRING_VALUE",
+ *       ],
+ *       resources: [ // ResourceScopeList
+ *         { // ResourceScope
+ *           resourceType: "STRING_VALUE", // required
+ *           resourceArns: [ // ResourceArnList
+ *             "STRING_VALUE",
+ *           ],
+ *           tags: { // ResourceScopeTagMap
+ *             "<keys>": "STRING_VALUE",
+ *           },
+ *           signalTypes: [ // SignalTypeList
+ *             "LOGS" || "TRACES",
+ *           ],
+ *           rowScopeGroups: [ // RowScopeGroupList
+ *             [ // RowScopeGroup
+ *               { // RowScope
+ *                 field: "STRING_VALUE", // required
+ *                 operator: "IN", // required
+ *                 values: [ // RowScopeValueList // required
+ *                   "STRING_VALUE",
+ *                 ],
+ *               },
+ *             ],
+ *           ],
+ *         },
+ *       ],
+ *       contextConditions: { // ContextConditionsMap
+ *         "<keys>": [ // StringList
+ *           "STRING_VALUE",
+ *         ],
+ *       },
+ *     },
+ *   ],
+ *   tags: { // TagMap
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new CreateAccessGrantCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateAccessGrantOutput
+ * //   accessGrant: { // AccessGrant
+ * //     grantId: "STRING_VALUE", // required
+ * //     grantArn: "STRING_VALUE", // required
+ * //     name: "STRING_VALUE",
+ * //     accountId: "STRING_VALUE", // required
+ * //     domainId: "STRING_VALUE", // required
+ * //     principal: { // AccessGrantPrincipal
+ * //       principalType: "IDC_USER" || "IDC_GROUP" || "IAM_USER" || "IAM_ROLE" || "IAM_ROOT" || "ACCESS_PROFILE" || "ALERT" || "AGENT", // required
+ * //       principalId: "STRING_VALUE",
+ * //       principalAttributes: [ // AccessGrantPrincipalAttributeList
+ * //         { // AccessGrantPrincipalAttribute
+ * //           key: "STRING_VALUE", // required
+ * //           value: "STRING_VALUE", // required
+ * //         },
+ * //       ],
+ * //     },
+ * //     permission: "SPACE_ADMIN" || "READ" || "READ_WRITE_DELETE" || "CUSTOM", // required
+ * //     grantType: "SERVICE_MANAGED" || "CUSTOMER_MANAGED", // required
+ * //     createdBy: "STRING_VALUE", // required
+ * //     createdAt: new Date("TIMESTAMP"), // required
+ * //     updatedAt: new Date("TIMESTAMP"), // required
+ * //     spaceId: "STRING_VALUE", // required
+ * //     scopedActions: [ // ScopedActionsList
+ * //       { // ScopedActions
+ * //         actions: [ // ScopedActionNameList // required
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         resources: [ // ResourceScopeList
+ * //           { // ResourceScope
+ * //             resourceType: "STRING_VALUE", // required
+ * //             resourceArns: [ // ResourceArnList
+ * //               "STRING_VALUE",
+ * //             ],
+ * //             tags: { // ResourceScopeTagMap
+ * //               "<keys>": "STRING_VALUE",
+ * //             },
+ * //             signalTypes: [ // SignalTypeList
+ * //               "LOGS" || "TRACES",
+ * //             ],
+ * //             rowScopeGroups: [ // RowScopeGroupList
+ * //               [ // RowScopeGroup
+ * //                 { // RowScope
+ * //                   field: "STRING_VALUE", // required
+ * //                   operator: "IN", // required
+ * //                   values: [ // RowScopeValueList // required
+ * //                     "STRING_VALUE",
+ * //                   ],
+ * //                 },
+ * //               ],
+ * //             ],
+ * //           },
+ * //         ],
+ * //         contextConditions: { // ContextConditionsMap
+ * //           "<keys>": [ // StringList
+ * //             "STRING_VALUE",
+ * //           ],
+ * //         },
+ * //       },
+ * //     ],
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param CreateAccessGrantCommandInput - {@link CreateAccessGrantCommandInput}
+ * @returns {@link CreateAccessGrantCommandOutput}
+ * @see {@link CreateAccessGrantCommandInput} for command's `input` shape.
+ * @see {@link CreateAccessGrantCommandOutput} for command's `response` shape.
+ * @see {@link CloudWatchOmniClientResolvedConfig | config} for CloudWatchOmniClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  The caller is not authorized to perform this action.
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  The operation could not be completed because of a conflict with the current
+ * state of the resource.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  An unexpected error occurred while processing the request.
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  The specified resource does not exist.
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  A service quota was exceeded.
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  The request was throttled due to exceeding the allowed request rate.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  A parameter is specified incorrectly.
+ *
+ * @throws {@link CloudWatchOmniServiceException}
+ * <p>Base exception class for all service exceptions from CloudWatchOmni service.</p>
+ *
+ *
+ * @example Create an access grant
+ * ```javascript
+ * // The following example creates a custom access grant that authorizes an Identity Center user to read and update a specific dashboard in a space. Payloads are shown as JSON; on the wire they are CBOR-encoded.
+ * const input = {
+ *   clientToken: "3f2a9c1e-7b04-4d8a-9e15-6c2b8d0f4a73",
+ *   domainId: "d-1a2b3c4d5e",
+ *   name: "analyst-read-access",
+ *   permission: "CUSTOM",
+ *   principal: {
+ *     principalId: "94b6c7d8-1a2b-4c3d-9e4f-5a6b7c8d9e0f",
+ *     principalType: "IDC_USER"
+ *   },
+ *   scopedActions: [
+ *     {
+ *       actions: [
+ *         "cloudwatch:GetOmniDashboard",
+ *         "cloudwatch:UpdateOmniDashboard"
+ *       ],
+ *       resources: [
+ *         {
+ *           resourceArns: [
+ *             "arn:aws:cloudwatch:us-east-1:123456789012:omni-dashboard/c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f"
+ *           ],
+ *           resourceType: "OmniDashboard"
+ *         }
+ *       ]
+ *     }
+ *   ],
+ *   spaceId: "a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d",
+ *   tags: {
+ *     Team: "observability"
+ *   }
+ * };
+ * const command = new CreateAccessGrantCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   accessGrant: {
+ *     accountId: "123456789012",
+ *     createdAt: "2026-09-16T14:22:31Z",
+ *     createdBy: "arn:aws:iam::123456789012:role/ObservabilityAdmin",
+ *     domainId: "d-1a2b3c4d5e",
+ *     grantArn: "arn:aws:cloudwatch:us-east-1:123456789012:access-grant/7f3e9d21-4c8b-4f6a-b1d2-3e4f5a6b7c8d",
+ *     grantId: "7f3e9d21-4c8b-4f6a-b1d2-3e4f5a6b7c8d",
+ *     grantType: "CUSTOMER_MANAGED",
+ *     name: "analyst-read-access",
+ *     permission: "CUSTOM",
+ *     principal: {
+ *       principalId: "94b6c7d8-1a2b-4c3d-9e4f-5a6b7c8d9e0f",
+ *       principalType: "IDC_USER"
+ *     },
+ *     scopedActions: [
+ *       {
+ *         actions: [
+ *           "cloudwatch:GetOmniDashboard",
+ *           "cloudwatch:UpdateOmniDashboard"
+ *         ],
+ *         resources: [
+ *           {
+ *             resourceArns: [
+ *               "arn:aws:cloudwatch:us-east-1:123456789012:omni-dashboard/c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f"
+ *             ],
+ *             resourceType: "OmniDashboard"
+ *           }
+ *         ]
+ *       }
+ *     ],
+ *     spaceId: "a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d",
+ *     updatedAt: "2026-09-16T14:22:31Z"
+ *   }
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class CreateAccessGrantCommand extends CreateAccessGrantCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateAccessGrantInput;
+            output: CreateAccessGrantOutput;
+        };
+        sdk: {
+            input: CreateAccessGrantCommandInput;
+            output: CreateAccessGrantCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,143 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { CreateAccessProfileInput, CreateAccessProfileOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link CreateAccessProfileCommand}.
+ */
+export interface CreateAccessProfileCommandInput extends CreateAccessProfileInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateAccessProfileCommand}.
+ */
+export interface CreateAccessProfileCommandOutput extends CreateAccessProfileOutput, __MetadataBearer {
+}
+declare const CreateAccessProfileCommand_base: {
+    new (input: CreateAccessProfileCommandInput): import("@smithy/core/client").CommandImpl<CreateAccessProfileCommandInput, CreateAccessProfileCommandOutput, import("..").CloudWatchOmniClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: CreateAccessProfileCommandInput): import("@smithy/core/client").CommandImpl<CreateAccessProfileCommandInput, CreateAccessProfileCommandOutput, import("..").CloudWatchOmniClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Creates an access profile in a space.
+ *
+ * Use GetAccessProfile and ListAccessProfiles to retrieve profiles,
+ * and UpdateAccessProfile to modify one.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CloudWatchOmniClient, CreateAccessProfileCommand } from "@aws-sdk/client-cloudwatchomni"; // ES Modules import
+ * // const { CloudWatchOmniClient, CreateAccessProfileCommand } = require("@aws-sdk/client-cloudwatchomni"); // CommonJS import
+ * // import type { CloudWatchOmniClientConfig } from "@aws-sdk/client-cloudwatchomni";
+ * const config = {}; // type is CloudWatchOmniClientConfig
+ * const client = new CloudWatchOmniClient(config);
+ * const input = { // CreateAccessProfileInput
+ *   spaceId: "STRING_VALUE", // required
+ *   name: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   tags: { // TagMap
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new CreateAccessProfileCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateAccessProfileOutput
+ * //   accessProfile: { // AccessProfile
+ * //     profileId: "STRING_VALUE", // required
+ * //     spaceId: "STRING_VALUE", // required
+ * //     arn: "STRING_VALUE", // required
+ * //     name: "STRING_VALUE", // required
+ * //     description: "STRING_VALUE",
+ * //     createdAt: new Date("TIMESTAMP"), // required
+ * //     updatedAt: new Date("TIMESTAMP"), // required
+ * //     assumeStatus: "ALLOWED" || "DENIED",
+ * //     profileType: "SERVICE_MANAGED" || "CUSTOMER_MANAGED",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param CreateAccessProfileCommandInput - {@link CreateAccessProfileCommandInput}
+ * @returns {@link CreateAccessProfileCommandOutput}
+ * @see {@link CreateAccessProfileCommandInput} for command's `input` shape.
+ * @see {@link CreateAccessProfileCommandOutput} for command's `response` shape.
+ * @see {@link CloudWatchOmniClientResolvedConfig | config} for CloudWatchOmniClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  The caller is not authorized to perform this action.
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  The operation could not be completed because of a conflict with the current
+ * state of the resource.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  An unexpected error occurred while processing the request.
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  The specified resource does not exist.
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  A service quota was exceeded.
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  The request was throttled due to exceeding the allowed request rate.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  A parameter is specified incorrectly.
+ *
+ * @throws {@link CloudWatchOmniServiceException}
+ * <p>Base exception class for all service exceptions from CloudWatchOmni service.</p>
+ *
+ *
+ * @example Create an access profile
+ * ```javascript
+ * // The following example creates a customer-managed access profile in a space. Payloads are shown as JSON; on the wire they are CBOR-encoded.
+ * const input = {
+ *   clientToken: "3f2a9c1e-7b04-4d8a-9e15-6c2b8d0f4a73",
+ *   description: "Read-only access for analysts.",
+ *   name: "Analyst read-only profile",
+ *   spaceId: "a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d",
+ *   tags: {
+ *     Team: "observability"
+ *   }
+ * };
+ * const command = new CreateAccessProfileCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   accessProfile: {
+ *     arn: "arn:aws:cloudwatch:us-east-1:123456789012:access-profile/analyst-readonly",
+ *     assumeStatus: "ALLOWED",
+ *     createdAt: "2026-09-16T14:22:31Z",
+ *     description: "Read-only access for analysts.",
+ *     name: "Analyst read-only profile",
+ *     profileId: "analyst-readonly",
+ *     profileType: "CUSTOMER_MANAGED",
+ *     spaceId: "a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d",
+ *     updatedAt: "2026-09-16T14:22:31Z"
+ *   }
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class CreateAccessProfileCommand extends CreateAccessProfileCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateAccessProfileInput;
+            output: CreateAccessProfileOutput;
+        };
+        sdk: {
+            input: CreateAccessProfileCommandInput;
+            output: CreateAccessProfileCommandOutput;
+        };
+    };
+}