@aws-sdk/client-ecs 3.296.0 → 3.297.0

package/dist-types/ECS.d.ts

@@ -57,6 +57,7 @@ import { UpdateTaskProtectionCommandInput, UpdateTaskProtectionCommandOutput } f
 import { UpdateTaskSetCommandInput, UpdateTaskSetCommandOutput } from "./commands/UpdateTaskSetCommand";
 import { ECSClient } from "./ECSClient";
 /**
+ * @public
  * <fullname>Amazon Elastic Container Service</fullname>
  *          <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes
  * 			it easy to run, stop, and manage Docker containers. You can host your cluster on a
@@ -73,6 +74,7 @@ import { ECSClient } from "./ECSClient";
  */
 export declare class ECS extends ECSClient {
     /**
+     * @public
      * <p>Creates a new capacity provider. Capacity providers are associated with an Amazon ECS
      * 			cluster and are used in capacity provider strategies to facilitate cluster auto
      * 			scaling.</p>
@@ -85,6 +87,7 @@ export declare class ECS extends ECSClient {
     createCapacityProvider(args: CreateCapacityProviderCommandInput, cb: (err: any, data?: CreateCapacityProviderCommandOutput) => void): void;
     createCapacityProvider(args: CreateCapacityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCapacityProviderCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code>
      * 			cluster when you launch your first container instance. However, you can create your own
      * 			cluster with a unique name with the <code>CreateCluster</code> action.</p>
@@ -101,6 +104,7 @@ export declare class ECS extends ECSClient {
     createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void;
     createCluster(args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void): void;
     /**
+     * @public
      * <p>Runs and maintains your desired number of tasks from a specified task definition. If
      * 			the number of tasks running in a service drops below the <code>desiredCount</code>,
      * 			Amazon ECS runs another copy of the task in the specified cluster. To update an existing
@@ -183,6 +187,7 @@ export declare class ECS extends ECSClient {
     createService(args: CreateServiceCommandInput, cb: (err: any, data?: CreateServiceCommandOutput) => void): void;
     createService(args: CreateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Create a task set in the specified cluster and service. This is used when a service
      * 			uses the <code>EXTERNAL</code> deployment controller type. For more information, see
      * 				<a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment
@@ -192,6 +197,7 @@ export declare class ECS extends ECSClient {
     createTaskSet(args: CreateTaskSetCommandInput, cb: (err: any, data?: CreateTaskSetCommandOutput) => void): void;
     createTaskSet(args: CreateTaskSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTaskSetCommandOutput) => void): void;
     /**
+     * @public
      * <p>Disables an account setting for a specified  user, role, or the root user for
      * 			an account.</p>
      */
@@ -199,12 +205,14 @@ export declare class ECS extends ECSClient {
     deleteAccountSetting(args: DeleteAccountSettingCommandInput, cb: (err: any, data?: DeleteAccountSettingCommandOutput) => void): void;
     deleteAccountSetting(args: DeleteAccountSettingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccountSettingCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes one or more custom attributes from an Amazon ECS resource.</p>
      */
     deleteAttributes(args: DeleteAttributesCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAttributesCommandOutput>;
     deleteAttributes(args: DeleteAttributesCommandInput, cb: (err: any, data?: DeleteAttributesCommandOutput) => void): void;
     deleteAttributes(args: DeleteAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAttributesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the specified capacity provider.</p>
      *          <note>
      *             <p>The <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers are
@@ -225,6 +233,7 @@ export declare class ECS extends ECSClient {
     deleteCapacityProvider(args: DeleteCapacityProviderCommandInput, cb: (err: any, data?: DeleteCapacityProviderCommandOutput) => void): void;
     deleteCapacityProvider(args: DeleteCapacityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCapacityProviderCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the specified cluster. The cluster transitions to the <code>INACTIVE</code>
      * 			state. Clusters with an <code>INACTIVE</code> status might remain discoverable in your
      * 			account for a period of time. However, this behavior is subject to change in the future.
@@ -236,6 +245,7 @@ export declare class ECS extends ECSClient {
     deleteCluster(args: DeleteClusterCommandInput, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void;
     deleteCluster(args: DeleteClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a specified service within a cluster. You can delete a service if you have no
      * 			running tasks in it and the desired task count is zero. If the service is actively
      * 			maintaining tasks, you can't delete it, and you must update the service to a desired
@@ -262,6 +272,7 @@ export declare class ECS extends ECSClient {
     deleteService(args: DeleteServiceCommandInput, cb: (err: any, data?: DeleteServiceCommandOutput) => void): void;
     deleteService(args: DeleteServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes one or more task definitions.</p>
      *          <p>You must deregister a task definition revision before you delete it. For more information,
      * 			see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterTaskDefinition.html">DeregisterTaskDefinition</a>.</p>
@@ -281,6 +292,7 @@ export declare class ECS extends ECSClient {
     deleteTaskDefinitions(args: DeleteTaskDefinitionsCommandInput, cb: (err: any, data?: DeleteTaskDefinitionsCommandOutput) => void): void;
     deleteTaskDefinitions(args: DeleteTaskDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTaskDefinitionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a specified task set within a service. This is used when a service uses the
      * 				<code>EXTERNAL</code> deployment controller type. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
      */
@@ -288,6 +300,7 @@ export declare class ECS extends ECSClient {
     deleteTaskSet(args: DeleteTaskSetCommandInput, cb: (err: any, data?: DeleteTaskSetCommandOutput) => void): void;
     deleteTaskSet(args: DeleteTaskSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTaskSetCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deregisters an Amazon ECS container instance from the specified cluster. This instance is
      * 			no longer available to run tasks.</p>
      *          <p>If you intend to use the container instance for some other purpose after
@@ -307,6 +320,7 @@ export declare class ECS extends ECSClient {
     deregisterContainerInstance(args: DeregisterContainerInstanceCommandInput, cb: (err: any, data?: DeregisterContainerInstanceCommandOutput) => void): void;
     deregisterContainerInstance(args: DeregisterContainerInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterContainerInstanceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deregisters the specified task definition by family and revision. Upon deregistration, the
      * 			task definition is marked as <code>INACTIVE</code>. Existing tasks and services that
      * 			reference an <code>INACTIVE</code> task definition continue to run without disruption.
@@ -330,18 +344,21 @@ export declare class ECS extends ECSClient {
     deregisterTaskDefinition(args: DeregisterTaskDefinitionCommandInput, cb: (err: any, data?: DeregisterTaskDefinitionCommandOutput) => void): void;
     deregisterTaskDefinition(args: DeregisterTaskDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterTaskDefinitionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes one or more of your capacity providers.</p>
      */
     describeCapacityProviders(args: DescribeCapacityProvidersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCapacityProvidersCommandOutput>;
     describeCapacityProviders(args: DescribeCapacityProvidersCommandInput, cb: (err: any, data?: DescribeCapacityProvidersCommandOutput) => void): void;
     describeCapacityProviders(args: DescribeCapacityProvidersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCapacityProvidersCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes one or more of your clusters.</p>
      */
     describeClusters(args: DescribeClustersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeClustersCommandOutput>;
     describeClusters(args: DescribeClustersCommandInput, cb: (err: any, data?: DescribeClustersCommandOutput) => void): void;
     describeClusters(args: DescribeClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClustersCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes one or more container instances. Returns metadata about each container
      * 			instance requested.</p>
      */
@@ -349,12 +366,14 @@ export declare class ECS extends ECSClient {
     describeContainerInstances(args: DescribeContainerInstancesCommandInput, cb: (err: any, data?: DescribeContainerInstancesCommandOutput) => void): void;
     describeContainerInstances(args: DescribeContainerInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeContainerInstancesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes the specified services running in your cluster.</p>
      */
     describeServices(args: DescribeServicesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeServicesCommandOutput>;
     describeServices(args: DescribeServicesCommandInput, cb: (err: any, data?: DescribeServicesCommandOutput) => void): void;
     describeServices(args: DescribeServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeServicesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes a task definition. You can specify a <code>family</code> and
      * 				<code>revision</code> to find information about a specific task definition, or you
      * 			can simply specify the family to find the latest <code>ACTIVE</code> revision in that
@@ -368,6 +387,7 @@ export declare class ECS extends ECSClient {
     describeTaskDefinition(args: DescribeTaskDefinitionCommandInput, cb: (err: any, data?: DescribeTaskDefinitionCommandOutput) => void): void;
     describeTaskDefinition(args: DescribeTaskDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTaskDefinitionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes a specified task or tasks.</p>
      *          <p>Currently, stopped tasks appear in the returned results for at least one hour.</p>
      */
@@ -375,6 +395,7 @@ export declare class ECS extends ECSClient {
     describeTasks(args: DescribeTasksCommandInput, cb: (err: any, data?: DescribeTasksCommandOutput) => void): void;
     describeTasks(args: DescribeTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTasksCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes the task sets in the specified cluster and service. This is used when a
      * 			service uses the <code>EXTERNAL</code> deployment controller type. For more information,
      * 			see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS Deployment
@@ -384,6 +405,7 @@ export declare class ECS extends ECSClient {
     describeTaskSets(args: DescribeTaskSetsCommandInput, cb: (err: any, data?: DescribeTaskSetsCommandOutput) => void): void;
     describeTaskSets(args: DescribeTaskSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTaskSetsCommandOutput) => void): void;
     /**
+     * @public
      * <note>
      *             <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
      *          </note>
@@ -393,6 +415,7 @@ export declare class ECS extends ECSClient {
     discoverPollEndpoint(args: DiscoverPollEndpointCommandInput, cb: (err: any, data?: DiscoverPollEndpointCommandOutput) => void): void;
     discoverPollEndpoint(args: DiscoverPollEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DiscoverPollEndpointCommandOutput) => void): void;
     /**
+     * @public
      * <p>Runs a command remotely on a container within a task.</p>
      *          <p>If you use a condition key in your IAM policy to refine the conditions for the policy
      * 			statement, for example limit the actions to a specific cluster, you receive an
@@ -405,18 +428,21 @@ export declare class ECS extends ECSClient {
     executeCommand(args: ExecuteCommandCommandInput, cb: (err: any, data?: ExecuteCommandCommandOutput) => void): void;
     executeCommand(args: ExecuteCommandCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteCommandCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the protection status of tasks in an Amazon ECS service.</p>
      */
     getTaskProtection(args: GetTaskProtectionCommandInput, options?: __HttpHandlerOptions): Promise<GetTaskProtectionCommandOutput>;
     getTaskProtection(args: GetTaskProtectionCommandInput, cb: (err: any, data?: GetTaskProtectionCommandOutput) => void): void;
     getTaskProtection(args: GetTaskProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTaskProtectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the account settings for a specified principal.</p>
      */
     listAccountSettings(args: ListAccountSettingsCommandInput, options?: __HttpHandlerOptions): Promise<ListAccountSettingsCommandOutput>;
     listAccountSettings(args: ListAccountSettingsCommandInput, cb: (err: any, data?: ListAccountSettingsCommandOutput) => void): void;
     listAccountSettings(args: ListAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountSettingsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the attributes for Amazon ECS resources within a specified target type and cluster.
      * 			When you specify a target type and cluster, <code>ListAttributes</code> returns a list
      * 			of attribute objects, one for each attribute on each resource. You can filter the list
@@ -429,12 +455,14 @@ export declare class ECS extends ECSClient {
     listAttributes(args: ListAttributesCommandInput, cb: (err: any, data?: ListAttributesCommandOutput) => void): void;
     listAttributes(args: ListAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAttributesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns a list of existing clusters.</p>
      */
     listClusters(args: ListClustersCommandInput, options?: __HttpHandlerOptions): Promise<ListClustersCommandOutput>;
     listClusters(args: ListClustersCommandInput, cb: (err: any, data?: ListClustersCommandOutput) => void): void;
     listClusters(args: ListClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListClustersCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns a list of container instances in a specified cluster. You can filter the
      * 			results of a <code>ListContainerInstances</code> operation with cluster query language
      * 			statements inside the <code>filter</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
@@ -443,6 +471,7 @@ export declare class ECS extends ECSClient {
     listContainerInstances(args: ListContainerInstancesCommandInput, cb: (err: any, data?: ListContainerInstancesCommandOutput) => void): void;
     listContainerInstances(args: ListContainerInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContainerInstancesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns a list of services. You can filter the results by cluster, launch type, and
      * 			scheduling strategy.</p>
      */
@@ -450,6 +479,7 @@ export declare class ECS extends ECSClient {
     listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void;
     listServices(args: ListServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServicesCommandOutput) => void): void;
     /**
+     * @public
      * <p>This operation lists all of the services that are associated with a Cloud Map
      * 			namespace. This list might include services in different clusters. In contrast,
      * 				<code>ListServices</code> can only list services in one cluster at a time. If you
@@ -460,12 +490,14 @@ export declare class ECS extends ECSClient {
     listServicesByNamespace(args: ListServicesByNamespaceCommandInput, cb: (err: any, data?: ListServicesByNamespaceCommandOutput) => void): void;
     listServicesByNamespace(args: ListServicesByNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServicesByNamespaceCommandOutput) => void): void;
     /**
+     * @public
      * <p>List the tags for an Amazon ECS resource.</p>
      */
     listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
     listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns a list of task definition families that are registered to your account. This
      * 			list includes task definition families that no longer have any <code>ACTIVE</code> task
      * 			definition revisions.</p>
@@ -478,6 +510,7 @@ export declare class ECS extends ECSClient {
     listTaskDefinitionFamilies(args: ListTaskDefinitionFamiliesCommandInput, cb: (err: any, data?: ListTaskDefinitionFamiliesCommandOutput) => void): void;
     listTaskDefinitionFamilies(args: ListTaskDefinitionFamiliesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTaskDefinitionFamiliesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns a list of task definitions that are registered to your account. You can filter
      * 			the results by family name with the <code>familyPrefix</code> parameter or by status
      * 			with the <code>status</code> parameter.</p>
@@ -486,6 +519,7 @@ export declare class ECS extends ECSClient {
     listTaskDefinitions(args: ListTaskDefinitionsCommandInput, cb: (err: any, data?: ListTaskDefinitionsCommandOutput) => void): void;
     listTaskDefinitions(args: ListTaskDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTaskDefinitionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns a list of tasks. You can filter the results by cluster, task definition
      * 			family, container instance, launch type, what IAM principal started the task, or by the
      * 			desired status of the task.</p>
@@ -496,6 +530,7 @@ export declare class ECS extends ECSClient {
     listTasks(args: ListTasksCommandInput, cb: (err: any, data?: ListTasksCommandOutput) => void): void;
     listTasks(args: ListTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTasksCommandOutput) => void): void;
     /**
+     * @public
      * <p>Modifies an account setting. Account settings are set on a per-Region basis.</p>
      *          <p>If you change the account setting for the root user, the default settings for all of
      * 			the users and roles that no individual account setting was specified are reset for.
@@ -525,6 +560,7 @@ export declare class ECS extends ECSClient {
     putAccountSetting(args: PutAccountSettingCommandInput, cb: (err: any, data?: PutAccountSettingCommandOutput) => void): void;
     putAccountSetting(args: PutAccountSettingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccountSettingCommandOutput) => void): void;
     /**
+     * @public
      * <p>Modifies an account setting for all users on an account for whom no individual
      * 			account setting has been specified. Account settings are set on a per-Region
      * 			basis.</p>
@@ -533,6 +569,7 @@ export declare class ECS extends ECSClient {
     putAccountSettingDefault(args: PutAccountSettingDefaultCommandInput, cb: (err: any, data?: PutAccountSettingDefaultCommandOutput) => void): void;
     putAccountSettingDefault(args: PutAccountSettingDefaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccountSettingDefaultCommandOutput) => void): void;
     /**
+     * @public
      * <p>Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist,
      * 			it's created. If the attribute exists, its value is replaced with the specified value.
      * 			To delete an attribute, use <a>DeleteAttributes</a>. For more information,
@@ -542,6 +579,7 @@ export declare class ECS extends ECSClient {
     putAttributes(args: PutAttributesCommandInput, cb: (err: any, data?: PutAttributesCommandOutput) => void): void;
     putAttributes(args: PutAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAttributesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Modifies the available capacity providers and the default capacity provider strategy
      * 			for a cluster.</p>
      *          <p>You must specify both the available capacity providers and a default capacity provider
@@ -561,6 +599,7 @@ export declare class ECS extends ECSClient {
     putClusterCapacityProviders(args: PutClusterCapacityProvidersCommandInput, cb: (err: any, data?: PutClusterCapacityProvidersCommandOutput) => void): void;
     putClusterCapacityProviders(args: PutClusterCapacityProvidersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutClusterCapacityProvidersCommandOutput) => void): void;
     /**
+     * @public
      * <note>
      *             <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
      *          </note>
@@ -571,6 +610,7 @@ export declare class ECS extends ECSClient {
     registerContainerInstance(args: RegisterContainerInstanceCommandInput, cb: (err: any, data?: RegisterContainerInstanceCommandOutput) => void): void;
     registerContainerInstance(args: RegisterContainerInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterContainerInstanceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Registers a new task definition from the supplied <code>family</code> and
      * 				<code>containerDefinitions</code>. Optionally, you can add data volumes to your
      * 			containers with the <code>volumes</code> parameter. For more information about task
@@ -594,6 +634,7 @@ export declare class ECS extends ECSClient {
     registerTaskDefinition(args: RegisterTaskDefinitionCommandInput, cb: (err: any, data?: RegisterTaskDefinitionCommandOutput) => void): void;
     registerTaskDefinition(args: RegisterTaskDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterTaskDefinitionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Starts a new task using the specified task definition.</p>
      *          <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places
      * 			tasks using placement constraints and placement strategies. For more information, see
@@ -627,6 +668,7 @@ export declare class ECS extends ECSClient {
     runTask(args: RunTaskCommandInput, cb: (err: any, data?: RunTaskCommandOutput) => void): void;
     runTask(args: RunTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RunTaskCommandOutput) => void): void;
     /**
+     * @public
      * <p>Starts a new task from the specified task definition on the specified container
      * 			instance or instances.</p>
      *          <p>Alternatively, you can use <a>RunTask</a> to place tasks for you. For more
@@ -636,6 +678,7 @@ export declare class ECS extends ECSClient {
     startTask(args: StartTaskCommandInput, cb: (err: any, data?: StartTaskCommandOutput) => void): void;
     startTask(args: StartTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTaskCommandOutput) => void): void;
     /**
+     * @public
      * <p>Stops a running task. Any tags associated with the task will be deleted.</p>
      *          <p>When <a>StopTask</a> is called on a task, the equivalent of <code>docker
      * 				stop</code> is issued to the containers running in the task. This results in a
@@ -654,6 +697,7 @@ export declare class ECS extends ECSClient {
     stopTask(args: StopTaskCommandInput, cb: (err: any, data?: StopTaskCommandOutput) => void): void;
     stopTask(args: StopTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopTaskCommandOutput) => void): void;
     /**
+     * @public
      * <note>
      *             <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
      *          </note>
@@ -663,6 +707,7 @@ export declare class ECS extends ECSClient {
     submitAttachmentStateChanges(args: SubmitAttachmentStateChangesCommandInput, cb: (err: any, data?: SubmitAttachmentStateChangesCommandOutput) => void): void;
     submitAttachmentStateChanges(args: SubmitAttachmentStateChangesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubmitAttachmentStateChangesCommandOutput) => void): void;
     /**
+     * @public
      * <note>
      *             <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
      *          </note>
@@ -672,6 +717,7 @@ export declare class ECS extends ECSClient {
     submitContainerStateChange(args: SubmitContainerStateChangeCommandInput, cb: (err: any, data?: SubmitContainerStateChangeCommandOutput) => void): void;
     submitContainerStateChange(args: SubmitContainerStateChangeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubmitContainerStateChangeCommandOutput) => void): void;
     /**
+     * @public
      * <note>
      *             <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
      *          </note>
@@ -681,6 +727,7 @@ export declare class ECS extends ECSClient {
     submitTaskStateChange(args: SubmitTaskStateChangeCommandInput, cb: (err: any, data?: SubmitTaskStateChangeCommandOutput) => void): void;
     submitTaskStateChange(args: SubmitTaskStateChangeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubmitTaskStateChangeCommandOutput) => void): void;
     /**
+     * @public
      * <p>Associates the specified tags to a resource with the specified
      * 				<code>resourceArn</code>. If existing tags on a resource aren't specified in the
      * 			request parameters, they aren't changed. When a resource is deleted, the tags that are
@@ -690,30 +737,35 @@ export declare class ECS extends ECSClient {
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes specified tags from a resource.</p>
      */
     untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
     untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Modifies the parameters for a capacity provider.</p>
      */
     updateCapacityProvider(args: UpdateCapacityProviderCommandInput, options?: __HttpHandlerOptions): Promise<UpdateCapacityProviderCommandOutput>;
     updateCapacityProvider(args: UpdateCapacityProviderCommandInput, cb: (err: any, data?: UpdateCapacityProviderCommandOutput) => void): void;
     updateCapacityProvider(args: UpdateCapacityProviderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCapacityProviderCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the cluster.</p>
      */
     updateCluster(args: UpdateClusterCommandInput, options?: __HttpHandlerOptions): Promise<UpdateClusterCommandOutput>;
     updateCluster(args: UpdateClusterCommandInput, cb: (err: any, data?: UpdateClusterCommandOutput) => void): void;
     updateCluster(args: UpdateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClusterCommandOutput) => void): void;
     /**
+     * @public
      * <p>Modifies the settings to use for a cluster.</p>
      */
     updateClusterSettings(args: UpdateClusterSettingsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateClusterSettingsCommandOutput>;
     updateClusterSettings(args: UpdateClusterSettingsCommandInput, cb: (err: any, data?: UpdateClusterSettingsCommandOutput) => void): void;
     updateClusterSettings(args: UpdateClusterSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClusterSettingsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the Amazon ECS container agent on a specified container instance. Updating the
      * 			Amazon ECS container agent doesn't interrupt running tasks or services on the container
      * 			instance. The process for updating the agent differs depending on whether your container
@@ -738,6 +790,7 @@ export declare class ECS extends ECSClient {
     updateContainerAgent(args: UpdateContainerAgentCommandInput, cb: (err: any, data?: UpdateContainerAgentCommandOutput) => void): void;
     updateContainerAgent(args: UpdateContainerAgentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContainerAgentCommandOutput) => void): void;
     /**
+     * @public
      * <p>Modifies the status of an Amazon ECS container instance.</p>
      *          <p>Once a container instance has reached an <code>ACTIVE</code> state, you can change the
      * 			status of a container instance to <code>DRAINING</code> to manually remove an instance
@@ -792,6 +845,7 @@ export declare class ECS extends ECSClient {
     updateContainerInstancesState(args: UpdateContainerInstancesStateCommandInput, cb: (err: any, data?: UpdateContainerInstancesStateCommandOutput) => void): void;
     updateContainerInstancesState(args: UpdateContainerInstancesStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContainerInstancesStateCommandOutput) => void): void;
     /**
+     * @public
      * <p>Modifies the parameters of a service.</p>
      *          <p>For services using the rolling update (<code>ECS</code>) you can update the desired
      * 			count, deployment configuration, network configuration, load balancers, service
@@ -920,6 +974,7 @@ export declare class ECS extends ECSClient {
     updateService(args: UpdateServiceCommandInput, cb: (err: any, data?: UpdateServiceCommandOutput) => void): void;
     updateService(args: UpdateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Modifies which task set in a service is the primary task set. Any parameters that are
      * 			updated on the primary task set in a service will transition to the service. This is
      * 			used when a service uses the <code>EXTERNAL</code> deployment controller type. For more
@@ -930,6 +985,7 @@ export declare class ECS extends ECSClient {
     updateServicePrimaryTaskSet(args: UpdateServicePrimaryTaskSetCommandInput, cb: (err: any, data?: UpdateServicePrimaryTaskSetCommandOutput) => void): void;
     updateServicePrimaryTaskSet(args: UpdateServicePrimaryTaskSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServicePrimaryTaskSetCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the protection status of a task. You can set <code>protectionEnabled</code> to
      * 				<code>true</code> to protect your task from termination during scale-in events from
      * 				<a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html">Service
@@ -962,6 +1018,7 @@ export declare class ECS extends ECSClient {
     updateTaskProtection(args: UpdateTaskProtectionCommandInput, cb: (err: any, data?: UpdateTaskProtectionCommandOutput) => void): void;
     updateTaskProtection(args: UpdateTaskProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTaskProtectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Modifies a task set. This is used when a service uses the <code>EXTERNAL</code>
      * 			deployment controller type. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS Deployment
      * 				Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>

package/dist-types/ECSClient.d.ts

@@ -64,15 +64,24 @@ import { UpdateServicePrimaryTaskSetCommandInput, UpdateServicePrimaryTaskSetCom
 import { UpdateTaskProtectionCommandInput, UpdateTaskProtectionCommandOutput } from "./commands/UpdateTaskProtectionCommand";
 import { UpdateTaskSetCommandInput, UpdateTaskSetCommandOutput } from "./commands/UpdateTaskSetCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = CreateCapacityProviderCommandInput | CreateClusterCommandInput | CreateServiceCommandInput | CreateTaskSetCommandInput | DeleteAccountSettingCommandInput | DeleteAttributesCommandInput | DeleteCapacityProviderCommandInput | DeleteClusterCommandInput | DeleteServiceCommandInput | DeleteTaskDefinitionsCommandInput | DeleteTaskSetCommandInput | DeregisterContainerInstanceCommandInput | DeregisterTaskDefinitionCommandInput | DescribeCapacityProvidersCommandInput | DescribeClustersCommandInput | DescribeContainerInstancesCommandInput | DescribeServicesCommandInput | DescribeTaskDefinitionCommandInput | DescribeTaskSetsCommandInput | DescribeTasksCommandInput | DiscoverPollEndpointCommandInput | ExecuteCommandCommandInput | GetTaskProtectionCommandInput | ListAccountSettingsCommandInput | ListAttributesCommandInput | ListClustersCommandInput | ListContainerInstancesCommandInput | ListServicesByNamespaceCommandInput | ListServicesCommandInput | ListTagsForResourceCommandInput | ListTaskDefinitionFamiliesCommandInput | ListTaskDefinitionsCommandInput | ListTasksCommandInput | PutAccountSettingCommandInput | PutAccountSettingDefaultCommandInput | PutAttributesCommandInput | PutClusterCapacityProvidersCommandInput | RegisterContainerInstanceCommandInput | RegisterTaskDefinitionCommandInput | RunTaskCommandInput | StartTaskCommandInput | StopTaskCommandInput | SubmitAttachmentStateChangesCommandInput | SubmitContainerStateChangeCommandInput | SubmitTaskStateChangeCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCapacityProviderCommandInput | UpdateClusterCommandInput | UpdateClusterSettingsCommandInput | UpdateContainerAgentCommandInput | UpdateContainerInstancesStateCommandInput | UpdateServiceCommandInput | UpdateServicePrimaryTaskSetCommandInput | UpdateTaskProtectionCommandInput | UpdateTaskSetCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = CreateCapacityProviderCommandOutput | CreateClusterCommandOutput | CreateServiceCommandOutput | CreateTaskSetCommandOutput | DeleteAccountSettingCommandOutput | DeleteAttributesCommandOutput | DeleteCapacityProviderCommandOutput | DeleteClusterCommandOutput | DeleteServiceCommandOutput | DeleteTaskDefinitionsCommandOutput | DeleteTaskSetCommandOutput | DeregisterContainerInstanceCommandOutput | DeregisterTaskDefinitionCommandOutput | DescribeCapacityProvidersCommandOutput | DescribeClustersCommandOutput | DescribeContainerInstancesCommandOutput | DescribeServicesCommandOutput | DescribeTaskDefinitionCommandOutput | DescribeTaskSetsCommandOutput | DescribeTasksCommandOutput | DiscoverPollEndpointCommandOutput | ExecuteCommandCommandOutput | GetTaskProtectionCommandOutput | ListAccountSettingsCommandOutput | ListAttributesCommandOutput | ListClustersCommandOutput | ListContainerInstancesCommandOutput | ListServicesByNamespaceCommandOutput | ListServicesCommandOutput | ListTagsForResourceCommandOutput | ListTaskDefinitionFamiliesCommandOutput | ListTaskDefinitionsCommandOutput | ListTasksCommandOutput | PutAccountSettingCommandOutput | PutAccountSettingDefaultCommandOutput | PutAttributesCommandOutput | PutClusterCapacityProvidersCommandOutput | RegisterContainerInstanceCommandOutput | RegisterTaskDefinitionCommandOutput | RunTaskCommandOutput | StartTaskCommandOutput | StopTaskCommandOutput | SubmitAttachmentStateChangesCommandOutput | SubmitContainerStateChangeCommandOutput | SubmitTaskStateChangeCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCapacityProviderCommandOutput | UpdateClusterCommandOutput | UpdateClusterSettingsCommandOutput | UpdateContainerAgentCommandOutput | UpdateContainerInstancesStateCommandOutput | UpdateServiceCommandOutput | UpdateServicePrimaryTaskSetCommandOutput | UpdateTaskProtectionCommandOutput | UpdateTaskSetCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -162,23 +171,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type ECSClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of ECSClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of ECSClient class constructor that set the region, credentials and other options.
  */
 export interface ECSClientConfig extends ECSClientConfigType {
 }
+/**
+ * @public
+ */
 type ECSClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of ECSClient class. This is resolved and normalized from the {@link ECSClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of ECSClient class. This is resolved and normalized from the {@link ECSClientConfig | constructor configuration interface}.
  */
 export interface ECSClientResolvedConfig extends ECSClientResolvedConfigType {
 }
 /**
+ * @public
  * <fullname>Amazon Elastic Container Service</fullname>
  *          <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes
  * 			it easy to run, stop, and manage Docker containers. You can host your cluster on a

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ECSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECSClient";
 import { CreateCapacityProviderRequest, CreateCapacityProviderResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateCapacityProviderCommand}.
  */
 export interface CreateCapacityProviderCommandInput extends CreateCapacityProviderRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateCapacityProviderCommand}.
  */
 export interface CreateCapacityProviderCommandOutput extends CreateCapacityProviderResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a new capacity provider. Capacity providers are associated with an Amazon ECS
  * 			cluster and are used in capacity provider strategies to facilitate cluster auto
  * 			scaling.</p>
@@ -31,6 +36,8 @@ export interface CreateCapacityProviderCommandOutput extends CreateCapacityProvi
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateCapacityProviderCommandInput - {@link CreateCapacityProviderCommandInput}
+ * @returns {@link CreateCapacityProviderCommandOutput}
  * @see {@link CreateCapacityProviderCommandInput} for command's `input` shape.
  * @see {@link CreateCapacityProviderCommandOutput} for command's `response` shape.
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
@@ -62,11 +69,20 @@ export interface CreateCapacityProviderCommandOutput extends CreateCapacityProvi
 export declare class CreateCapacityProviderCommand extends $Command<CreateCapacityProviderCommandInput, CreateCapacityProviderCommandOutput, ECSClientResolvedConfig> {
     readonly input: CreateCapacityProviderCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateCapacityProviderCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ECSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateCapacityProviderCommandInput, CreateCapacityProviderCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ECSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECSClient";
 import { CreateClusterRequest, CreateClusterResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateClusterCommand}.
  */
 export interface CreateClusterCommandInput extends CreateClusterRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateClusterCommand}.
  */
 export interface CreateClusterCommandOutput extends CreateClusterResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code>
  * 			cluster when you launch your first container instance. However, you can create your own
  * 			cluster with a unique name with the <code>CreateCluster</code> action.</p>
@@ -35,6 +40,8 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateClusterCommandInput - {@link CreateClusterCommandInput}
+ * @returns {@link CreateClusterCommandOutput}
  * @see {@link CreateClusterCommandInput} for command's `input` shape.
  * @see {@link CreateClusterCommandOutput} for command's `response` shape.
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
@@ -80,11 +87,20 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
 export declare class CreateClusterCommand extends $Command<CreateClusterCommandInput, CreateClusterCommandOutput, ECSClientResolvedConfig> {
     readonly input: CreateClusterCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateClusterCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ECSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateClusterCommandInput, CreateClusterCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }