@aws-sdk/client-cloudcontrol 3.379.1 → 3.382.0

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

@@ -18,6 +18,7 @@ export declare class AlreadyExistsException extends __BaseException {
  */
 export interface CancelResourceRequestInput {
     /**
+     * @public
      * <p>The <code>RequestToken</code> of the <code>ProgressEvent</code> object returned by the
      *       resource operation request.</p>
      */
@@ -85,10 +86,12 @@ export type OperationStatus = (typeof OperationStatus)[keyof typeof OperationSta
  */
 export interface ProgressEvent {
     /**
+     * @public
      * <p>The name of the resource type used in the operation.</p>
      */
     TypeName?: string;
     /**
+     * @public
      * <p>The primary identifier for the resource.</p>
      *          <note>
      *             <p>In some cases, the resource identifier may be available before the resource operation
@@ -97,16 +100,19 @@ export interface ProgressEvent {
      */
     Identifier?: string;
     /**
+     * @public
      * <p>The unique token representing this resource operation request.</p>
      *          <p>Use the <code>RequestToken</code> with <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html">GetResourceRequestStatus</a> to return the current status of a resource operation
      *       request.</p>
      */
     RequestToken?: string;
     /**
+     * @public
      * <p>The resource operation type.</p>
      */
     Operation?: Operation | string;
     /**
+     * @public
      * <p>The current status of the resource operation request.</p>
      *          <ul>
      *             <li>
@@ -139,25 +145,30 @@ export interface ProgressEvent {
      */
     OperationStatus?: OperationStatus | string;
     /**
+     * @public
      * <p>When the resource operation request was initiated.</p>
      */
     EventTime?: Date;
     /**
+     * @public
      * <p>A JSON string containing the resource model, consisting of each resource property and its
      *       current value.</p>
      */
     ResourceModel?: string;
     /**
+     * @public
      * <p>Any message explaining the current status.</p>
      */
     StatusMessage?: string;
     /**
+     * @public
      * <p>For requests with a status of <code>FAILED</code>, the associated error code.</p>
      *          <p>For error code definitions, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-test-contract-errors.html">Handler error codes</a> in the <i>CloudFormation Command
      *         Line Interface User Guide for Extension Development</i>.</p>
      */
     ErrorCode?: HandlerErrorCode | string;
     /**
+     * @public
      * <p>When to next request the status of this resource operation request.</p>
      */
     RetryAfter?: Date;
@@ -167,6 +178,7 @@ export interface ProgressEvent {
  */
 export interface CancelResourceRequestOutput {
     /**
+     * @public
      * <p>Represents the current status of a resource operation request. For more information, see
      *         <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html">Managing resource operation requests</a> in the
      *         <i>Amazon Web Services Cloud Control API User Guide</i>.</p>
@@ -232,16 +244,19 @@ export declare class ConcurrentOperationException extends __BaseException {
  */
 export interface CreateResourceInput {
     /**
+     * @public
      * <p>The name of the resource type.</p>
      */
     TypeName: string | undefined;
     /**
+     * @public
      * <p>For private resource types, the type version to use in this resource
      *                                      operation. If you do not specify a resource version, CloudFormation
      *                                      uses the default version.</p>
      */
     TypeVersionId?: string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the Identity and Access Management
      *                                     (IAM) role for Cloud Control API to use when performing this resource
      *                                     operation. The role specified must have the permissions required for this
@@ -258,6 +273,7 @@ export interface CreateResourceInput {
      */
     RoleArn?: string;
     /**
+     * @public
      * <p>A unique identifier to ensure the idempotency of the resource request. As a
      *                                      best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can
      *                                      accurately distinguish between request retries and new resource requests. You
@@ -272,6 +288,7 @@ export interface CreateResourceInput {
      */
     ClientToken?: string;
     /**
+     * @public
      * <p>Structured data format representing the desired state of the resource, consisting of that
      *       resource's properties and their desired values.</p>
      *          <note>
@@ -298,6 +315,7 @@ export interface CreateResourceInput {
  */
 export interface CreateResourceOutput {
     /**
+     * @public
      * <p>Represents the current status of the resource creation request.</p>
      *          <p>After you have initiated a resource creation request, you can monitor the progress of your
      *       request by calling <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html">GetResourceRequestStatus</a> using the <code>RequestToken</code> of the
@@ -532,16 +550,19 @@ export declare class UnsupportedActionException extends __BaseException {
  */
 export interface DeleteResourceInput {
     /**
+     * @public
      * <p>The name of the resource type.</p>
      */
     TypeName: string | undefined;
     /**
+     * @public
      * <p>For private resource types, the type version to use in this resource
      *                                      operation. If you do not specify a resource version, CloudFormation
      *                                      uses the default version.</p>
      */
     TypeVersionId?: string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the Identity and Access Management
      *                                     (IAM) role for Cloud Control API to use when performing this resource
      *                                     operation. The role specified must have the permissions required for this
@@ -558,6 +579,7 @@ export interface DeleteResourceInput {
      */
     RoleArn?: string;
     /**
+     * @public
      * <p>A unique identifier to ensure the idempotency of the resource request. As a
      *                                      best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can
      *                                      accurately distinguish between request retries and new resource requests. You
@@ -572,6 +594,7 @@ export interface DeleteResourceInput {
      */
     ClientToken?: string;
     /**
+     * @public
      * <p>The identifier for the resource.</p>
      *          <p>You can specify the primary identifier, or any secondary identifier
      *                                             defined for the resource type in its resource schema. You can only specify
@@ -592,6 +615,7 @@ export interface DeleteResourceInput {
  */
 export interface DeleteResourceOutput {
     /**
+     * @public
      * <p>Represents the current status of the resource deletion request.</p>
      *          <p>After you have initiated a resource deletion request, you can monitor the progress of your
      *       request by calling <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html">GetResourceRequestStatus</a> using the <code>RequestToken</code> of the
@@ -604,16 +628,19 @@ export interface DeleteResourceOutput {
  */
 export interface GetResourceInput {
     /**
+     * @public
      * <p>The name of the resource type.</p>
      */
     TypeName: string | undefined;
     /**
+     * @public
      * <p>For private resource types, the type version to use in this resource
      *                                      operation. If you do not specify a resource version, CloudFormation
      *                                      uses the default version.</p>
      */
     TypeVersionId?: string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the Identity and Access Management
      *                                     (IAM) role for Cloud Control API to use when performing this resource
      *                                     operation. The role specified must have the permissions required for this
@@ -630,6 +657,7 @@ export interface GetResourceInput {
      */
     RoleArn?: string;
     /**
+     * @public
      * <p>The identifier for the resource.</p>
      *          <p>You can specify the primary identifier, or any secondary identifier
      *                                             defined for the resource type in its resource schema. You can only specify
@@ -651,12 +679,14 @@ export interface GetResourceInput {
  */
 export interface ResourceDescription {
     /**
+     * @public
      * <p>The primary identifier for the resource.</p>
      *          <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html">Identifying
      *         resources</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p>
      */
     Identifier?: string;
     /**
+     * @public
      * <p>A list of the resource properties and their current values.</p>
      */
     Properties?: string;
@@ -666,10 +696,12 @@ export interface ResourceDescription {
  */
 export interface GetResourceOutput {
     /**
+     * @public
      * <p>The name of the resource type.</p>
      */
     TypeName?: string;
     /**
+     * @public
      * <p>Represents information about a provisioned resource.</p>
      */
     ResourceDescription?: ResourceDescription;
@@ -679,6 +711,7 @@ export interface GetResourceOutput {
  */
 export interface GetResourceRequestStatusInput {
     /**
+     * @public
      * <p>A unique token used to track the progress of the resource operation request.</p>
      *          <p>Request tokens are included in the <code>ProgressEvent</code> type returned by a resource
      *       operation request.</p>
@@ -690,6 +723,7 @@ export interface GetResourceRequestStatusInput {
  */
 export interface GetResourceRequestStatusOutput {
     /**
+     * @public
      * <p>Represents the current status of the resource operation request.</p>
      */
     ProgressEvent?: ProgressEvent;
@@ -700,10 +734,12 @@ export interface GetResourceRequestStatusOutput {
  */
 export interface ResourceRequestStatusFilter {
     /**
+     * @public
      * <p>The operation types to include in the filter.</p>
      */
     Operations?: (Operation | string)[];
     /**
+     * @public
      * <p>The operation statuses to include in the filter.</p>
      *          <ul>
      *             <li>
@@ -740,6 +776,7 @@ export interface ResourceRequestStatusFilter {
  */
 export interface ListResourceRequestsInput {
     /**
+     * @public
      * <p>The maximum number of results to be returned with a single call. If the number of
      *       available results exceeds this maximum, the response includes a <code>NextToken</code> value
      *       that you can assign to the <code>NextToken</code> request parameter to get the next set of
@@ -748,6 +785,7 @@ export interface ListResourceRequestsInput {
      */
     MaxResults?: number;
     /**
+     * @public
      * <p>If the previous paginated request didn't return all of the remaining results,
      *                                    the response object's <code>NextToken</code> parameter value is set to a token.
      *                                    To retrieve the next set of results, call this action again and assign that token to
@@ -757,6 +795,7 @@ export interface ListResourceRequestsInput {
      */
     NextToken?: string;
     /**
+     * @public
      * <p>The filter criteria to apply to the requests returned.</p>
      */
     ResourceRequestStatusFilter?: ResourceRequestStatusFilter;
@@ -766,10 +805,12 @@ export interface ListResourceRequestsInput {
  */
 export interface ListResourceRequestsOutput {
     /**
+     * @public
      * <p>The requests that match the specified filter criteria.</p>
      */
     ResourceRequestStatusSummaries?: ProgressEvent[];
     /**
+     * @public
      * <p>If the request doesn't return all of the remaining results,
      *                                     <code>NextToken</code> is set to a token. To retrieve the next set of results, call
      *                                     <code>ListResources</code> again and assign that token to the request object's
@@ -783,16 +824,19 @@ export interface ListResourceRequestsOutput {
  */
 export interface ListResourcesInput {
     /**
+     * @public
      * <p>The name of the resource type.</p>
      */
     TypeName: string | undefined;
     /**
+     * @public
      * <p>For private resource types, the type version to use in this resource
      *                                      operation. If you do not specify a resource version, CloudFormation
      *                                      uses the default version.</p>
      */
     TypeVersionId?: string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the Identity and Access Management
      *                                     (IAM) role for Cloud Control API to use when performing this resource
      *                                     operation. The role specified must have the permissions required for this
@@ -809,6 +853,7 @@ export interface ListResourcesInput {
      */
     RoleArn?: string;
     /**
+     * @public
      * <p>If the previous paginated request didn't return all of the remaining results,
      *                                    the response object's <code>NextToken</code> parameter value is set to a token.
      *                                    To retrieve the next set of results, call this action again and assign that token to
@@ -818,10 +863,12 @@ export interface ListResourcesInput {
      */
     NextToken?: string;
     /**
+     * @public
      * <p>Reserved.</p>
      */
     MaxResults?: number;
     /**
+     * @public
      * <p>The resource model to use to select the resources to return.</p>
      */
     ResourceModel?: string;
@@ -831,15 +878,18 @@ export interface ListResourcesInput {
  */
 export interface ListResourcesOutput {
     /**
+     * @public
      * <p>The name of the resource type.</p>
      */
     TypeName?: string;
     /**
+     * @public
      * <p>Information about the specified resources, including primary identifier and resource
      *       model.</p>
      */
     ResourceDescriptions?: ResourceDescription[];
     /**
+     * @public
      * <p>If the request doesn't return all of the remaining results,
      *                                     <code>NextToken</code> is set to a token. To retrieve the next set of results, call
      *                                     <code>ListResources</code> again and assign that token to the request object's
@@ -853,16 +903,19 @@ export interface ListResourcesOutput {
  */
 export interface UpdateResourceInput {
     /**
+     * @public
      * <p>The name of the resource type.</p>
      */
     TypeName: string | undefined;
     /**
+     * @public
      * <p>For private resource types, the type version to use in this resource
      *                                      operation. If you do not specify a resource version, CloudFormation
      *                                      uses the default version.</p>
      */
     TypeVersionId?: string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the Identity and Access Management
      *                                     (IAM) role for Cloud Control API to use when performing this resource
      *                                     operation. The role specified must have the permissions required for this
@@ -879,6 +932,7 @@ export interface UpdateResourceInput {
      */
     RoleArn?: string;
     /**
+     * @public
      * <p>A unique identifier to ensure the idempotency of the resource request. As a
      *                                      best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can
      *                                      accurately distinguish between request retries and new resource requests. You
@@ -893,6 +947,7 @@ export interface UpdateResourceInput {
      */
     ClientToken?: string;
     /**
+     * @public
      * <p>The identifier for the resource.</p>
      *          <p>You can specify the primary identifier, or any secondary identifier
      *                                             defined for the resource type in its resource schema. You can only specify
@@ -908,6 +963,7 @@ export interface UpdateResourceInput {
      */
     Identifier: string | undefined;
     /**
+     * @public
      * <p>A JavaScript Object Notation (JSON) document listing the patch operations that represent
      *       the updates to apply to the current resource properties. For details, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-update.html#resource-operations-update-patch">Composing the patch document</a> in the <i>Amazon Web Services Cloud Control API User
      *       Guide</i>.</p>
@@ -919,6 +975,7 @@ export interface UpdateResourceInput {
  */
 export interface UpdateResourceOutput {
     /**
+     * @public
      * <p>Represents the current status of the resource update request.</p>
      *          <p>Use the <code>RequestToken</code> of the <code>ProgressEvent</code> with <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html">GetResourceRequestStatus</a> to return the current status of a resource operation
      *       request.</p>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-cloudcontrol",
   "description": "AWS SDK for JavaScript Cloudcontrol Client for Node.js, Browser and React Native",
-  "version": "3.379.1",
+  "version": "3.382.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.382.0",
+    "@aws-sdk/credential-provider-node": "3.382.0",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",