@aws-sdk/client-service-catalog-appregistry 3.295.0 → 3.297.0

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

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { ServiceCatalogAppRegistryServiceException as __BaseException } from "./ServiceCatalogAppRegistryServiceException";
 /**
+ * @public
  * <p>Represents a Amazon Web Services Service Catalog AppRegistry application that is the top-level node in a hierarchy of related
  *        cloud resource abstractions.</p>
  */
@@ -35,6 +36,7 @@ export interface Application {
     tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p>Summary of a Amazon Web Services Service Catalog AppRegistry application.</p>
  */
 export interface ApplicationSummary {
@@ -64,6 +66,7 @@ export interface ApplicationSummary {
     lastUpdateTime?: Date;
 }
 /**
+ * @public
  * <p>
  *       The
  *       definition
@@ -84,6 +87,7 @@ export interface TagQueryConfiguration {
     tagKey?: string;
 }
 /**
+ * @public
  * <p>
  *       Includes all
  *       of the Service Catalog AppRegistry settings.
@@ -98,6 +102,9 @@ export interface AppRegistryConfiguration {
      */
     tagQueryConfiguration?: TagQueryConfiguration;
 }
+/**
+ * @public
+ */
 export interface AssociateAttributeGroupRequest {
     /**
      * <p>The name or ID of the application.</p>
@@ -108,6 +115,9 @@ export interface AssociateAttributeGroupRequest {
      */
     attributeGroup: string | undefined;
 }
+/**
+ * @public
+ */
 export interface AssociateAttributeGroupResponse {
     /**
      * <p>The Amazon resource name (ARN) of the application that was augmented with attributes.</p>
@@ -119,6 +129,7 @@ export interface AssociateAttributeGroupResponse {
     attributeGroupArn?: string;
 }
 /**
+ * @public
  * <p>There was a conflict when processing the request (for example, a resource with the given
  *       name already exists within the account).</p>
  */
@@ -131,6 +142,7 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
+ * @public
  * <p>The service is experiencing internal problems.</p>
  */
 export declare class InternalServerException extends __BaseException {
@@ -142,6 +154,7 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
+ * @public
  * <p>The specified resource does not exist.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -153,6 +166,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>The maximum number of resources per account has been reached.</p>
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
@@ -164,6 +178,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request has invalid or missing parameters.</p>
  */
 export declare class ValidationException extends __BaseException {
@@ -174,10 +189,16 @@ export declare class ValidationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum ResourceType {
     CFN_STACK = "CFN_STACK",
     RESOURCE_TAG_VALUE = "RESOURCE_TAG_VALUE"
 }
+/**
+ * @public
+ */
 export interface AssociateResourceRequest {
     /**
      * <p>The name or ID of the application.</p>
@@ -192,6 +213,9 @@ export interface AssociateResourceRequest {
      */
     resource: string | undefined;
 }
+/**
+ * @public
+ */
 export interface AssociateResourceResponse {
     /**
      * <p>The Amazon resource name (ARN) of the application that was augmented with attributes.</p>
@@ -203,6 +227,7 @@ export interface AssociateResourceResponse {
     resourceArn?: string;
 }
 /**
+ * @public
  * <p>Represents a Amazon Web Services Service Catalog AppRegistry attribute group that is rich metadata which describes an application and its components.</p>
  */
 export interface AttributeGroup {
@@ -236,6 +261,7 @@ export interface AttributeGroup {
     tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p>
  *       The details related to a specific AttributeGroup.
  *     </p>
@@ -266,6 +292,7 @@ export interface AttributeGroupDetails {
     name?: string;
 }
 /**
+ * @public
  * <p>Summary of a Amazon Web Services Service Catalog AppRegistry attribute group.</p>
  */
 export interface AttributeGroupSummary {
@@ -294,6 +321,9 @@ export interface AttributeGroupSummary {
      */
     lastUpdateTime?: Date;
 }
+/**
+ * @public
+ */
 export interface CreateApplicationRequest {
     /**
      * <p>The name of the application. The name must be unique in the region in which you are creating the application.</p>
@@ -315,12 +345,18 @@ export interface CreateApplicationRequest {
      */
     clientToken?: string;
 }
+/**
+ * @public
+ */
 export interface CreateApplicationResponse {
     /**
      * <p>Information about the application.</p>
      */
     application?: Application;
 }
+/**
+ * @public
+ */
 export interface CreateAttributeGroupRequest {
     /**
      * <p>The name of the attribute group.</p>
@@ -346,36 +382,54 @@ export interface CreateAttributeGroupRequest {
      */
     clientToken?: string;
 }
+/**
+ * @public
+ */
 export interface CreateAttributeGroupResponse {
     /**
      * <p>Information about the attribute group.</p>
      */
     attributeGroup?: AttributeGroup;
 }
+/**
+ * @public
+ */
 export interface DeleteApplicationRequest {
     /**
      * <p>The name or ID of the application.</p>
      */
     application: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteApplicationResponse {
     /**
      * <p>Information about the deleted application.</p>
      */
     application?: ApplicationSummary;
 }
+/**
+ * @public
+ */
 export interface DeleteAttributeGroupRequest {
     /**
      * <p>The name or ID of the attribute group that holds the attributes to describe the application.</p>
      */
     attributeGroup: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteAttributeGroupResponse {
     /**
      * <p>Information about the deleted attribute group.</p>
      */
     attributeGroup?: AttributeGroupSummary;
 }
+/**
+ * @public
+ */
 export interface DisassociateAttributeGroupRequest {
     /**
      * <p>The name or ID of the application.</p>
@@ -386,6 +440,9 @@ export interface DisassociateAttributeGroupRequest {
      */
     attributeGroup: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DisassociateAttributeGroupResponse {
     /**
      * <p>The Amazon resource name (ARN) that specifies the application.</p>
@@ -396,6 +453,9 @@ export interface DisassociateAttributeGroupResponse {
      */
     attributeGroupArn?: string;
 }
+/**
+ * @public
+ */
 export interface DisassociateResourceRequest {
     /**
      * <p>The name or ID of the application.</p>
@@ -410,6 +470,9 @@ export interface DisassociateResourceRequest {
      */
     resource: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DisassociateResourceResponse {
     /**
      * <p>The Amazon resource name (ARN) that specifies the application.</p>
@@ -420,12 +483,18 @@ export interface DisassociateResourceResponse {
      */
     resourceArn?: string;
 }
+/**
+ * @public
+ */
 export interface GetApplicationRequest {
     /**
      * <p>The name or ID of the application.</p>
      */
     application: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ResourceGroupState {
     CREATE_COMPLETE = "CREATE_COMPLETE",
     CREATE_FAILED = "CREATE_FAILED",
@@ -435,6 +504,7 @@ export declare enum ResourceGroupState {
     UPDATING = "UPDATING"
 }
 /**
+ * @public
  * <p>The information about the resource group integration.</p>
  */
 export interface ResourceGroup {
@@ -464,6 +534,7 @@ export interface ResourceGroup {
     errorMessage?: string;
 }
 /**
+ * @public
  * <p> The information about the service integration.</p>
  */
 export interface Integrations {
@@ -472,6 +543,9 @@ export interface Integrations {
      */
     resourceGroup?: ResourceGroup;
 }
+/**
+ * @public
+ */
 export interface GetApplicationResponse {
     /**
      * <p>The identifier of the application.</p>
@@ -517,6 +591,9 @@ export interface GetApplicationResponse {
      */
     integrations?: Integrations;
 }
+/**
+ * @public
+ */
 export interface GetAssociatedResourceRequest {
     /**
      * <p>The name or ID of the application.</p>
@@ -532,6 +609,7 @@ export interface GetAssociatedResourceRequest {
     resource: string | undefined;
 }
 /**
+ * @public
  * <p>The service integration information about the resource.</p>
  */
 export interface ResourceIntegrations {
@@ -541,6 +619,7 @@ export interface ResourceIntegrations {
     resourceGroup?: ResourceGroup;
 }
 /**
+ * @public
  * <p> The information about the resource.</p>
  */
 export interface Resource {
@@ -562,18 +641,27 @@ export interface Resource {
      */
     integrations?: ResourceIntegrations;
 }
+/**
+ * @public
+ */
 export interface GetAssociatedResourceResponse {
     /**
      * <p>The resource associated with the application.</p>
      */
     resource?: Resource;
 }
+/**
+ * @public
+ */
 export interface GetAttributeGroupRequest {
     /**
      * <p>The name or ID of the attribute group that holds the attributes to describe the application.</p>
      */
     attributeGroup: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetAttributeGroupResponse {
     /**
      * <p>The identifier of the attribute group.</p>
@@ -608,6 +696,9 @@ export interface GetAttributeGroupResponse {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface GetConfigurationResponse {
     /**
      * <p>
@@ -617,6 +708,9 @@ export interface GetConfigurationResponse {
      */
     configuration?: AppRegistryConfiguration;
 }
+/**
+ * @public
+ */
 export interface ListApplicationsRequest {
     /**
      * <p>The token to use to get the next page of results after a previous API call. </p>
@@ -627,6 +721,9 @@ export interface ListApplicationsRequest {
      */
     maxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListApplicationsResponse {
     /**
      * <p>This list of applications.</p>
@@ -637,6 +734,9 @@ export interface ListApplicationsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListAssociatedAttributeGroupsRequest {
     /**
      * <p>The name or ID of the application.</p>
@@ -651,6 +751,9 @@ export interface ListAssociatedAttributeGroupsRequest {
      */
     maxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListAssociatedAttributeGroupsResponse {
     /**
      * <p>A list of attribute group IDs.</p>
@@ -661,6 +764,9 @@ export interface ListAssociatedAttributeGroupsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListAssociatedResourcesRequest {
     /**
      * <p>The name or ID of the application.</p>
@@ -676,6 +782,7 @@ export interface ListAssociatedResourcesRequest {
     maxResults?: number;
 }
 /**
+ * @public
  * <p>
  *       The details
  *       related
@@ -690,6 +797,7 @@ export interface ResourceDetails {
     tagValue?: string;
 }
 /**
+ * @public
  * <p>The information about the resource.</p>
  */
 export interface ResourceInfo {
@@ -717,6 +825,9 @@ export interface ResourceInfo {
      */
     resourceDetails?: ResourceDetails;
 }
+/**
+ * @public
+ */
 export interface ListAssociatedResourcesResponse {
     /**
      * <p>Information about the resources.</p>
@@ -727,6 +838,9 @@ export interface ListAssociatedResourcesResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListAttributeGroupsRequest {
     /**
      * <p>The token to use to get the next page of results after a previous API call. </p>
@@ -737,6 +851,9 @@ export interface ListAttributeGroupsRequest {
      */
     maxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListAttributeGroupsResponse {
     /**
      * <p>This list of attribute groups.</p>
@@ -747,6 +864,9 @@ export interface ListAttributeGroupsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListAttributeGroupsForApplicationRequest {
     /**
      * <p>The name or ID of the application.</p>
@@ -761,6 +881,9 @@ export interface ListAttributeGroupsForApplicationRequest {
      */
     maxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListAttributeGroupsForApplicationResponse {
     /**
      * <p> The details related to a specific attribute group. </p>
@@ -771,18 +894,27 @@ export interface ListAttributeGroupsForApplicationResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>The Amazon resource name (ARN) that specifies the resource.</p>
      */
     resourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>The tags on the resource.</p>
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface PutConfigurationRequest {
     /**
      * <p>
@@ -792,6 +924,9 @@ export interface PutConfigurationRequest {
      */
     configuration: AppRegistryConfiguration | undefined;
 }
+/**
+ * @public
+ */
 export interface SyncResourceRequest {
     /**
      * <p>The type of resource of which the application will be associated.</p>
@@ -802,10 +937,16 @@ export interface SyncResourceRequest {
      */
     resource: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum SyncAction {
     NO_ACTION = "NO_ACTION",
     START_SYNC = "START_SYNC"
 }
+/**
+ * @public
+ */
 export interface SyncResourceResponse {
     /**
      * <p>The Amazon resource name (ARN) that specifies the application.</p>
@@ -820,6 +961,9 @@ export interface SyncResourceResponse {
      */
     actionTaken?: SyncAction | string;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The Amazon resource name (ARN) that specifies the resource.</p>
@@ -830,8 +974,14 @@ export interface TagResourceRequest {
      */
     tags: Record<string, string> | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The Amazon resource name (ARN) that specifies the resource.</p>
@@ -842,8 +992,14 @@ export interface UntagResourceRequest {
      */
     tagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateApplicationRequest {
     /**
      * <p>The name or ID of the application that will be updated.</p>
@@ -861,12 +1017,18 @@ export interface UpdateApplicationRequest {
      */
     description?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateApplicationResponse {
     /**
      * <p>The updated information of the application.</p>
      */
     application?: Application;
 }
+/**
+ * @public
+ */
 export interface UpdateAttributeGroupRequest {
     /**
      * <p>The name or ID of the attribute group that holds the attributes to describe the application.</p>
@@ -888,6 +1050,9 @@ export interface UpdateAttributeGroupRequest {
      */
     attributes?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateAttributeGroupResponse {
     /**
      * <p>The updated information of the attribute group.</p>

package/dist-types/pagination/Interfaces.d.ts

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { ServiceCatalogAppRegistryClient } from "../ServiceCatalogAppRegistryClient";
+/**
+ * @public
+ */
 export interface ServiceCatalogAppRegistryPaginationConfiguration extends PaginationConfiguration {
     client: ServiceCatalogAppRegistryClient;
 }

package/dist-types/pagination/ListApplicationsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListApplicationsCommandInput, ListApplicationsCommandOutput } from "../commands/ListApplicationsCommand";
 import { ServiceCatalogAppRegistryPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListApplications(config: ServiceCatalogAppRegistryPaginationConfiguration, input: ListApplicationsCommandInput, ...additionalArguments: any): Paginator<ListApplicationsCommandOutput>;

package/dist-types/pagination/ListAssociatedAttributeGroupsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListAssociatedAttributeGroupsCommandInput, ListAssociatedAttributeGroupsCommandOutput } from "../commands/ListAssociatedAttributeGroupsCommand";
 import { ServiceCatalogAppRegistryPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListAssociatedAttributeGroups(config: ServiceCatalogAppRegistryPaginationConfiguration, input: ListAssociatedAttributeGroupsCommandInput, ...additionalArguments: any): Paginator<ListAssociatedAttributeGroupsCommandOutput>;

package/dist-types/pagination/ListAssociatedResourcesPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListAssociatedResourcesCommandInput, ListAssociatedResourcesCommandOutput } from "../commands/ListAssociatedResourcesCommand";
 import { ServiceCatalogAppRegistryPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListAssociatedResources(config: ServiceCatalogAppRegistryPaginationConfiguration, input: ListAssociatedResourcesCommandInput, ...additionalArguments: any): Paginator<ListAssociatedResourcesCommandOutput>;

package/dist-types/pagination/ListAttributeGroupsForApplicationPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListAttributeGroupsForApplicationCommandInput, ListAttributeGroupsForApplicationCommandOutput } from "../commands/ListAttributeGroupsForApplicationCommand";
 import { ServiceCatalogAppRegistryPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListAttributeGroupsForApplication(config: ServiceCatalogAppRegistryPaginationConfiguration, input: ListAttributeGroupsForApplicationCommandInput, ...additionalArguments: any): Paginator<ListAttributeGroupsForApplicationCommandOutput>;

package/dist-types/pagination/ListAttributeGroupsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListAttributeGroupsCommandInput, ListAttributeGroupsCommandOutput } from "../commands/ListAttributeGroupsCommand";
 import { ServiceCatalogAppRegistryPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListAttributeGroups(config: ServiceCatalogAppRegistryPaginationConfiguration, input: ListAttributeGroupsCommandInput, ...additionalArguments: any): Paginator<ListAttributeGroupsCommandOutput>;