/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the ecs-2014-11-13.normal.json service model. */ using System; using System.Runtime.ExceptionServices; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using System.Net; using Amazon.ECS.Model; using Amazon.ECS.Model.Internal.MarshallTransformations; using Amazon.ECS.Internal; using Amazon.Runtime; using Amazon.Runtime.Internal; using Amazon.Runtime.Internal.Auth; using Amazon.Runtime.Internal.Transform; namespace Amazon.ECS { /// /// Implementation for accessing ECS /// /// Amazon Elastic Container Service /// /// 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 serverless infrastructure that's managed by Amazon ECS /// by launching your services or tasks on Fargate. For more control, you can host your /// tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) /// instances that you manage. /// /// /// /// Amazon ECS makes it easy to launch and stop container-based applications with simple /// API calls. This makes it easy to get the state of your cluster from a centralized /// service, and gives you access to many familiar Amazon EC2 features. /// /// /// /// You can use Amazon ECS to schedule the placement of containers across your cluster /// based on your resource needs, isolation policies, and availability requirements. With /// Amazon ECS, you don't need to operate your own cluster management and configuration /// management systems. You also don't need to worry about scaling your management infrastructure. /// /// public partial class AmazonECSClient : AmazonServiceClient, IAmazonECS { private static IServiceMetadata serviceMetadata = new AmazonECSMetadata(); private IECSPaginatorFactory _paginators; /// /// Paginators for the service /// public IECSPaginatorFactory Paginators { get { if (this._paginators == null) { this._paginators = new ECSPaginatorFactory(this); } return this._paginators; } } #region Constructors /// /// Constructs AmazonECSClient with the credentials loaded from the application's /// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. /// /// Example App.config with credentials set. /// /// <?xml version="1.0" encoding="utf-8" ?> /// <configuration> /// <appSettings> /// <add key="AWSProfileName" value="AWS Default"/> /// </appSettings> /// </configuration> /// /// /// public AmazonECSClient() : base(FallbackCredentialsFactory.GetCredentials(), new AmazonECSConfig()) { } /// /// Constructs AmazonECSClient with the credentials loaded from the application's /// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. /// /// Example App.config with credentials set. /// /// <?xml version="1.0" encoding="utf-8" ?> /// <configuration> /// <appSettings> /// <add key="AWSProfileName" value="AWS Default"/> /// </appSettings> /// </configuration> /// /// /// /// The region to connect. public AmazonECSClient(RegionEndpoint region) : base(FallbackCredentialsFactory.GetCredentials(), new AmazonECSConfig{RegionEndpoint = region}) { } /// /// Constructs AmazonECSClient with the credentials loaded from the application's /// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. /// /// Example App.config with credentials set. /// /// <?xml version="1.0" encoding="utf-8" ?> /// <configuration> /// <appSettings> /// <add key="AWSProfileName" value="AWS Default"/> /// </appSettings> /// </configuration> /// /// /// /// The AmazonECSClient Configuration Object public AmazonECSClient(AmazonECSConfig config) : base(FallbackCredentialsFactory.GetCredentials(config), config){} /// /// Constructs AmazonECSClient with AWS Credentials /// /// AWS Credentials public AmazonECSClient(AWSCredentials credentials) : this(credentials, new AmazonECSConfig()) { } /// /// Constructs AmazonECSClient with AWS Credentials /// /// AWS Credentials /// The region to connect. public AmazonECSClient(AWSCredentials credentials, RegionEndpoint region) : this(credentials, new AmazonECSConfig{RegionEndpoint = region}) { } /// /// Constructs AmazonECSClient with AWS Credentials and an /// AmazonECSClient Configuration object. /// /// AWS Credentials /// The AmazonECSClient Configuration Object public AmazonECSClient(AWSCredentials credentials, AmazonECSConfig clientConfig) : base(credentials, clientConfig) { } /// /// Constructs AmazonECSClient with AWS Access Key ID and AWS Secret Key /// /// AWS Access Key ID /// AWS Secret Access Key public AmazonECSClient(string awsAccessKeyId, string awsSecretAccessKey) : this(awsAccessKeyId, awsSecretAccessKey, new AmazonECSConfig()) { } /// /// Constructs AmazonECSClient with AWS Access Key ID and AWS Secret Key /// /// AWS Access Key ID /// AWS Secret Access Key /// The region to connect. public AmazonECSClient(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region) : this(awsAccessKeyId, awsSecretAccessKey, new AmazonECSConfig() {RegionEndpoint=region}) { } /// /// Constructs AmazonECSClient with AWS Access Key ID, AWS Secret Key and an /// AmazonECSClient Configuration object. /// /// AWS Access Key ID /// AWS Secret Access Key /// The AmazonECSClient Configuration Object public AmazonECSClient(string awsAccessKeyId, string awsSecretAccessKey, AmazonECSConfig clientConfig) : base(awsAccessKeyId, awsSecretAccessKey, clientConfig) { } /// /// Constructs AmazonECSClient with AWS Access Key ID and AWS Secret Key /// /// AWS Access Key ID /// AWS Secret Access Key /// AWS Session Token public AmazonECSClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken) : this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonECSConfig()) { } /// /// Constructs AmazonECSClient with AWS Access Key ID and AWS Secret Key /// /// AWS Access Key ID /// AWS Secret Access Key /// AWS Session Token /// The region to connect. public AmazonECSClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region) : this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonECSConfig{RegionEndpoint = region}) { } /// /// Constructs AmazonECSClient with AWS Access Key ID, AWS Secret Key and an /// AmazonECSClient Configuration object. /// /// AWS Access Key ID /// AWS Secret Access Key /// AWS Session Token /// The AmazonECSClient Configuration Object public AmazonECSClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonECSConfig clientConfig) : base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, clientConfig) { } #endregion #region Overrides /// /// Creates the signer for the service. /// protected override AbstractAWSSigner CreateSigner() { return new AWS4Signer(); } /// /// Customize the pipeline /// /// protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline) { pipeline.RemoveHandler(); pipeline.AddHandlerAfter(new AmazonECSEndpointResolver()); } /// /// Capture metadata for the service. /// protected override IServiceMetadata ServiceMetadata { get { return serviceMetadata; } } #endregion #region Dispose /// /// Disposes the service client. /// protected override void Dispose(bool disposing) { base.Dispose(disposing); } #endregion #region CreateCapacityProvider /// /// 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. /// /// /// /// Only capacity providers that use an Auto Scaling group can be created. Amazon ECS /// tasks on Fargate use the FARGATE and FARGATE_SPOT capacity /// providers. These providers are available to all accounts in the Amazon Web Services /// Regions that Fargate supports. /// /// /// Container for the necessary parameters to execute the CreateCapacityProvider service method. /// /// The response from the CreateCapacityProvider service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The limit for the resource was exceeded. /// /// /// These errors are usually caused by a server issue. /// /// /// There's already a current Amazon ECS container agent update in progress on the container /// instance that's specified. If the container agent becomes disconnected while it's /// in a transitional stage, such as PENDING or STAGING, the /// update process can get stuck in that state. However, when the agent reconnects, it /// resumes where it stopped previously. /// /// REST API Reference for CreateCapacityProvider Operation public virtual CreateCapacityProviderResponse CreateCapacityProvider(CreateCapacityProviderRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = CreateCapacityProviderRequestMarshaller.Instance; options.ResponseUnmarshaller = CreateCapacityProviderResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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. /// /// /// /// Only capacity providers that use an Auto Scaling group can be created. Amazon ECS /// tasks on Fargate use the FARGATE and FARGATE_SPOT capacity /// providers. These providers are available to all accounts in the Amazon Web Services /// Regions that Fargate supports. /// /// /// Container for the necessary parameters to execute the CreateCapacityProvider service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateCapacityProvider service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The limit for the resource was exceeded. /// /// /// These errors are usually caused by a server issue. /// /// /// There's already a current Amazon ECS container agent update in progress on the container /// instance that's specified. If the container agent becomes disconnected while it's /// in a transitional stage, such as PENDING or STAGING, the /// update process can get stuck in that state. However, when the agent reconnects, it /// resumes where it stopped previously. /// /// REST API Reference for CreateCapacityProvider Operation public virtual Task CreateCapacityProviderAsync(CreateCapacityProviderRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = CreateCapacityProviderRequestMarshaller.Instance; options.ResponseUnmarshaller = CreateCapacityProviderResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region CreateCluster /// /// Creates a new Amazon ECS cluster. By default, your account receives a default /// cluster when you launch your first container instance. However, you can create your /// own cluster with a unique name with the CreateCluster action. /// /// /// /// When you call the CreateCluster API operation, Amazon ECS attempts to create /// the Amazon ECS service-linked role for your account. This is so that it can manage /// required resources in other Amazon Web Services services on your behalf. However, /// if the user that makes the call doesn't have permissions to create the service-linked /// role, it isn't created. For more information, see Using /// service-linked roles for Amazon ECS in the Amazon Elastic Container Service /// Developer Guide. /// /// /// /// Container for the necessary parameters to execute the CreateCluster service method. /// /// The response from the CreateCluster service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified namespace wasn't found. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for CreateCluster Operation public virtual CreateClusterResponse CreateCluster(CreateClusterRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = CreateClusterRequestMarshaller.Instance; options.ResponseUnmarshaller = CreateClusterResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Creates a new Amazon ECS cluster. By default, your account receives a default /// cluster when you launch your first container instance. However, you can create your /// own cluster with a unique name with the CreateCluster action. /// /// /// /// When you call the CreateCluster API operation, Amazon ECS attempts to create /// the Amazon ECS service-linked role for your account. This is so that it can manage /// required resources in other Amazon Web Services services on your behalf. However, /// if the user that makes the call doesn't have permissions to create the service-linked /// role, it isn't created. For more information, see Using /// service-linked roles for Amazon ECS in the Amazon Elastic Container Service /// Developer Guide. /// /// /// /// Container for the necessary parameters to execute the CreateCluster service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateCluster service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified namespace wasn't found. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for CreateCluster Operation public virtual Task CreateClusterAsync(CreateClusterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = CreateClusterRequestMarshaller.Instance; options.ResponseUnmarshaller = CreateClusterResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region CreateService /// /// 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 desiredCount, /// Amazon ECS runs another copy of the task in the specified cluster. To update an existing /// service, see the UpdateService action. /// /// /// /// Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon /// Elastic Inference (EI), and will help current customers migrate their workloads to /// options that offer better price and performance. After April 15, 2023, new customers /// will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, /// Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once /// during the past 30-day period are considered current customers and will be able to /// continue using the service. /// /// /// /// In addition to maintaining the desired count of tasks in your service, you can optionally /// run your service behind one or more load balancers. The load balancers distribute /// traffic across the tasks that are associated with the service. For more information, /// see Service /// load balancing in the Amazon Elastic Container Service Developer Guide. /// /// /// /// Tasks for services that don't use a load balancer are considered healthy if they're /// in the RUNNING state. Tasks for services that use a load balancer are /// considered healthy if they're in the RUNNING state and are reported as /// healthy by the load balancer. /// /// /// /// There are two service scheduler strategies available: /// ///
  • /// /// REPLICA - The replica scheduling strategy places and maintains your /// desired number of tasks across your cluster. By default, the service scheduler spreads /// tasks across Availability Zones. You can use task placement strategies and constraints /// to customize task placement decisions. For more information, see Service /// scheduler concepts in the Amazon Elastic Container Service Developer Guide. /// ///
  • /// /// DAEMON - The daemon scheduling strategy deploys exactly one task on /// each active container instance that meets all of the task placement constraints that /// you specify in your cluster. The service scheduler also evaluates the task placement /// constraints for running tasks. It also stops tasks that don't meet the placement constraints. /// When using this strategy, you don't need to specify a desired number of tasks, a task /// placement strategy, or use Service Auto Scaling policies. For more information, see /// Service /// scheduler concepts in the Amazon Elastic Container Service Developer Guide. /// ///
/// /// You can optionally specify a deployment configuration for your service. The deployment /// is initiated by changing properties. For example, the deployment might be initiated /// by the task definition or by your desired count of a service. This is done with an /// UpdateService operation. The default value for a replica service for minimumHealthyPercent /// is 100%. The default value for a daemon service for minimumHealthyPercent /// is 0%. /// /// /// /// If a service uses the ECS deployment controller, the minimum healthy /// percent represents a lower limit on the number of tasks in a service that must remain /// in the RUNNING state during a deployment. Specifically, it represents /// it as a percentage of your desired number of tasks (rounded up to the nearest integer). /// This happens when any of your container instances are in the DRAINING /// state if the service contains tasks using the EC2 launch type. Using this parameter, /// you can deploy without using additional cluster capacity. For example, if you set /// your service to have desired number of four tasks and a minimum healthy percent of /// 50%, the scheduler might stop two existing tasks to free up cluster capacity before /// starting two new tasks. If they're in the RUNNING state, tasks for services /// that don't use a load balancer are considered healthy . If they're in the RUNNING /// state and reported as healthy by the load balancer, tasks for services that do /// use a load balancer are considered healthy . The default value for minimum healthy /// percent is 100%. /// /// /// /// If a service uses the ECS deployment controller, the maximum percent /// parameter represents an upper limit on the number of tasks in a service that are allowed /// in the RUNNING or PENDING state during a deployment. Specifically, /// it represents it as a percentage of the desired number of tasks (rounded down to the /// nearest integer). This happens when any of your container instances are in the DRAINING /// state if the service contains tasks using the EC2 launch type. Using this parameter, /// you can define the deployment batch size. For example, if your service has a desired /// number of four tasks and a maximum percent value of 200%, the scheduler may start /// four new tasks before stopping the four older tasks (provided that the cluster resources /// required to do this are available). The default value for maximum percent is 200%. /// /// /// /// If a service uses either the CODE_DEPLOY or EXTERNAL deployment /// controller types and tasks that use the EC2 launch type, the minimum healthy percent /// and maximum percent values are used only to define the lower and upper limit /// on the number of the tasks in the service that remain in the RUNNING /// state. This is while the container instances are in the DRAINING state. /// If the tasks in the service use the Fargate launch type, the minimum healthy percent /// and maximum percent values aren't used. This is the case even if they're currently /// visible when describing your service. /// /// /// /// When creating a service that uses the EXTERNAL deployment controller, /// you can specify only parameters that aren't controlled at the task set level. The /// only required parameter is the service name. You control your services using the CreateTaskSet /// operation. For more information, see Amazon /// ECS deployment types in the Amazon Elastic Container Service Developer Guide. /// /// /// /// When the service scheduler launches new tasks, it determines task placement. For information /// about task placement and task placement strategies, see Amazon /// ECS task placement in the Amazon Elastic Container Service Developer Guide. /// ///
/// Container for the necessary parameters to execute the CreateService service method. /// /// The response from the CreateService service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified namespace wasn't found. /// /// /// The specified platform version doesn't satisfy the required capabilities of the task /// definition. /// /// /// The specified platform version doesn't exist. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified task isn't supported in this Region. /// /// REST API Reference for CreateService Operation public virtual CreateServiceResponse CreateService(CreateServiceRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = CreateServiceRequestMarshaller.Instance; options.ResponseUnmarshaller = CreateServiceResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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 desiredCount, /// Amazon ECS runs another copy of the task in the specified cluster. To update an existing /// service, see the UpdateService action. /// /// /// /// Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon /// Elastic Inference (EI), and will help current customers migrate their workloads to /// options that offer better price and performance. After April 15, 2023, new customers /// will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, /// Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once /// during the past 30-day period are considered current customers and will be able to /// continue using the service. /// /// /// /// In addition to maintaining the desired count of tasks in your service, you can optionally /// run your service behind one or more load balancers. The load balancers distribute /// traffic across the tasks that are associated with the service. For more information, /// see Service /// load balancing in the Amazon Elastic Container Service Developer Guide. /// /// /// /// Tasks for services that don't use a load balancer are considered healthy if they're /// in the RUNNING state. Tasks for services that use a load balancer are /// considered healthy if they're in the RUNNING state and are reported as /// healthy by the load balancer. /// /// /// /// There are two service scheduler strategies available: /// ///
  • /// /// REPLICA - The replica scheduling strategy places and maintains your /// desired number of tasks across your cluster. By default, the service scheduler spreads /// tasks across Availability Zones. You can use task placement strategies and constraints /// to customize task placement decisions. For more information, see Service /// scheduler concepts in the Amazon Elastic Container Service Developer Guide. /// ///
  • /// /// DAEMON - The daemon scheduling strategy deploys exactly one task on /// each active container instance that meets all of the task placement constraints that /// you specify in your cluster. The service scheduler also evaluates the task placement /// constraints for running tasks. It also stops tasks that don't meet the placement constraints. /// When using this strategy, you don't need to specify a desired number of tasks, a task /// placement strategy, or use Service Auto Scaling policies. For more information, see /// Service /// scheduler concepts in the Amazon Elastic Container Service Developer Guide. /// ///
/// /// You can optionally specify a deployment configuration for your service. The deployment /// is initiated by changing properties. For example, the deployment might be initiated /// by the task definition or by your desired count of a service. This is done with an /// UpdateService operation. The default value for a replica service for minimumHealthyPercent /// is 100%. The default value for a daemon service for minimumHealthyPercent /// is 0%. /// /// /// /// If a service uses the ECS deployment controller, the minimum healthy /// percent represents a lower limit on the number of tasks in a service that must remain /// in the RUNNING state during a deployment. Specifically, it represents /// it as a percentage of your desired number of tasks (rounded up to the nearest integer). /// This happens when any of your container instances are in the DRAINING /// state if the service contains tasks using the EC2 launch type. Using this parameter, /// you can deploy without using additional cluster capacity. For example, if you set /// your service to have desired number of four tasks and a minimum healthy percent of /// 50%, the scheduler might stop two existing tasks to free up cluster capacity before /// starting two new tasks. If they're in the RUNNING state, tasks for services /// that don't use a load balancer are considered healthy . If they're in the RUNNING /// state and reported as healthy by the load balancer, tasks for services that do /// use a load balancer are considered healthy . The default value for minimum healthy /// percent is 100%. /// /// /// /// If a service uses the ECS deployment controller, the maximum percent /// parameter represents an upper limit on the number of tasks in a service that are allowed /// in the RUNNING or PENDING state during a deployment. Specifically, /// it represents it as a percentage of the desired number of tasks (rounded down to the /// nearest integer). This happens when any of your container instances are in the DRAINING /// state if the service contains tasks using the EC2 launch type. Using this parameter, /// you can define the deployment batch size. For example, if your service has a desired /// number of four tasks and a maximum percent value of 200%, the scheduler may start /// four new tasks before stopping the four older tasks (provided that the cluster resources /// required to do this are available). The default value for maximum percent is 200%. /// /// /// /// If a service uses either the CODE_DEPLOY or EXTERNAL deployment /// controller types and tasks that use the EC2 launch type, the minimum healthy percent /// and maximum percent values are used only to define the lower and upper limit /// on the number of the tasks in the service that remain in the RUNNING /// state. This is while the container instances are in the DRAINING state. /// If the tasks in the service use the Fargate launch type, the minimum healthy percent /// and maximum percent values aren't used. This is the case even if they're currently /// visible when describing your service. /// /// /// /// When creating a service that uses the EXTERNAL deployment controller, /// you can specify only parameters that aren't controlled at the task set level. The /// only required parameter is the service name. You control your services using the CreateTaskSet /// operation. For more information, see Amazon /// ECS deployment types in the Amazon Elastic Container Service Developer Guide. /// /// /// /// When the service scheduler launches new tasks, it determines task placement. For information /// about task placement and task placement strategies, see Amazon /// ECS task placement in the Amazon Elastic Container Service Developer Guide. /// ///
/// Container for the necessary parameters to execute the CreateService service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateService service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified namespace wasn't found. /// /// /// The specified platform version doesn't satisfy the required capabilities of the task /// definition. /// /// /// The specified platform version doesn't exist. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified task isn't supported in this Region. /// /// REST API Reference for CreateService Operation public virtual Task CreateServiceAsync(CreateServiceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = CreateServiceRequestMarshaller.Instance; options.ResponseUnmarshaller = CreateServiceResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region CreateTaskSet /// /// Create a task set in the specified cluster and service. This is used when a service /// uses the EXTERNAL deployment controller type. For more information, see /// Amazon /// ECS deployment types in the Amazon Elastic Container Service Developer Guide. /// /// Container for the necessary parameters to execute the CreateTaskSet service method. /// /// The response from the CreateTaskSet service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified namespace wasn't found. /// /// /// The specified platform version doesn't satisfy the required capabilities of the task /// definition. /// /// /// The specified platform version doesn't exist. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified service isn't active. You can't update a service that's inactive. If /// you have previously deleted a service, you can re-create it with CreateService. /// /// /// The specified service wasn't found. You can view your available services with ListServices. /// Amazon ECS services are cluster specific and Region specific. /// /// /// The specified task isn't supported in this Region. /// /// REST API Reference for CreateTaskSet Operation public virtual CreateTaskSetResponse CreateTaskSet(CreateTaskSetRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = CreateTaskSetRequestMarshaller.Instance; options.ResponseUnmarshaller = CreateTaskSetResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Create a task set in the specified cluster and service. This is used when a service /// uses the EXTERNAL deployment controller type. For more information, see /// Amazon /// ECS deployment types in the Amazon Elastic Container Service Developer Guide. /// /// Container for the necessary parameters to execute the CreateTaskSet service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateTaskSet service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified namespace wasn't found. /// /// /// The specified platform version doesn't satisfy the required capabilities of the task /// definition. /// /// /// The specified platform version doesn't exist. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified service isn't active. You can't update a service that's inactive. If /// you have previously deleted a service, you can re-create it with CreateService. /// /// /// The specified service wasn't found. You can view your available services with ListServices. /// Amazon ECS services are cluster specific and Region specific. /// /// /// The specified task isn't supported in this Region. /// /// REST API Reference for CreateTaskSet Operation public virtual Task CreateTaskSetAsync(CreateTaskSetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = CreateTaskSetRequestMarshaller.Instance; options.ResponseUnmarshaller = CreateTaskSetResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region DeleteAccountSetting /// /// Disables an account setting for a specified user, role, or the root user for an account. /// /// Container for the necessary parameters to execute the DeleteAccountSetting service method. /// /// The response from the DeleteAccountSetting service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DeleteAccountSetting Operation public virtual DeleteAccountSettingResponse DeleteAccountSetting(DeleteAccountSettingRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = DeleteAccountSettingRequestMarshaller.Instance; options.ResponseUnmarshaller = DeleteAccountSettingResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Disables an account setting for a specified user, role, or the root user for an account. /// /// Container for the necessary parameters to execute the DeleteAccountSetting service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteAccountSetting service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DeleteAccountSetting Operation public virtual Task DeleteAccountSettingAsync(DeleteAccountSettingRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = DeleteAccountSettingRequestMarshaller.Instance; options.ResponseUnmarshaller = DeleteAccountSettingResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region DeleteAttributes /// /// Deletes one or more custom attributes from an Amazon ECS resource. /// /// Container for the necessary parameters to execute the DeleteAttributes service method. /// /// The response from the DeleteAttributes service method, as returned by ECS. /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified target wasn't found. You can view your available container instances /// with ListContainerInstances. Amazon ECS container instances are cluster-specific /// and Region-specific. /// /// REST API Reference for DeleteAttributes Operation public virtual DeleteAttributesResponse DeleteAttributes(DeleteAttributesRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = DeleteAttributesRequestMarshaller.Instance; options.ResponseUnmarshaller = DeleteAttributesResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Deletes one or more custom attributes from an Amazon ECS resource. /// /// Container for the necessary parameters to execute the DeleteAttributes service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteAttributes service method, as returned by ECS. /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified target wasn't found. You can view your available container instances /// with ListContainerInstances. Amazon ECS container instances are cluster-specific /// and Region-specific. /// /// REST API Reference for DeleteAttributes Operation public virtual Task DeleteAttributesAsync(DeleteAttributesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = DeleteAttributesRequestMarshaller.Instance; options.ResponseUnmarshaller = DeleteAttributesResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region DeleteCapacityProvider /// /// Deletes the specified capacity provider. /// /// /// /// The FARGATE and FARGATE_SPOT capacity providers are reserved /// and can't be deleted. You can disassociate them from a cluster using either the PutClusterCapacityProviders /// API or by deleting the cluster. /// /// /// /// Prior to a capacity provider being deleted, the capacity provider must be removed /// from the capacity provider strategy from all services. The UpdateService API /// can be used to remove a capacity provider from a service's capacity provider strategy. /// When updating a service, the forceNewDeployment option can be used to /// ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity /// provider are transitioned to use the capacity from the remaining capacity providers. /// Only capacity providers that aren't associated with a cluster can be deleted. To remove /// a capacity provider from a cluster, you can either use PutClusterCapacityProviders /// or delete the cluster. /// /// /// Container for the necessary parameters to execute the DeleteCapacityProvider service method. /// /// The response from the DeleteCapacityProvider service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DeleteCapacityProvider Operation public virtual DeleteCapacityProviderResponse DeleteCapacityProvider(DeleteCapacityProviderRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = DeleteCapacityProviderRequestMarshaller.Instance; options.ResponseUnmarshaller = DeleteCapacityProviderResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Deletes the specified capacity provider. /// /// /// /// The FARGATE and FARGATE_SPOT capacity providers are reserved /// and can't be deleted. You can disassociate them from a cluster using either the PutClusterCapacityProviders /// API or by deleting the cluster. /// /// /// /// Prior to a capacity provider being deleted, the capacity provider must be removed /// from the capacity provider strategy from all services. The UpdateService API /// can be used to remove a capacity provider from a service's capacity provider strategy. /// When updating a service, the forceNewDeployment option can be used to /// ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity /// provider are transitioned to use the capacity from the remaining capacity providers. /// Only capacity providers that aren't associated with a cluster can be deleted. To remove /// a capacity provider from a cluster, you can either use PutClusterCapacityProviders /// or delete the cluster. /// /// /// Container for the necessary parameters to execute the DeleteCapacityProvider service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteCapacityProvider service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DeleteCapacityProvider Operation public virtual Task DeleteCapacityProviderAsync(DeleteCapacityProviderRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = DeleteCapacityProviderRequestMarshaller.Instance; options.ResponseUnmarshaller = DeleteCapacityProviderResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region DeleteCluster /// /// Deletes the specified cluster. The cluster transitions to the INACTIVE /// state. Clusters with an INACTIVE status might remain discoverable in /// your account for a period of time. However, this behavior is subject to change in /// the future. We don't recommend that you rely on INACTIVE clusters persisting. /// /// /// /// You must deregister all container instances from this cluster before you may delete /// it. You can list the container instances in a cluster with ListContainerInstances /// and deregister them with DeregisterContainerInstance. /// /// /// Container for the necessary parameters to execute the DeleteCluster service method. /// /// The response from the DeleteCluster service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// You can't delete a cluster that has registered container instances. First, deregister /// the container instances before you can delete the cluster. For more information, see /// DeregisterContainerInstance. /// /// /// You can't delete a cluster that contains services. First, update the service to reduce /// its desired task count to 0, and then delete the service. For more information, see /// UpdateService and DeleteService. /// /// /// You can't delete a cluster that has active tasks. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// /// There's already a current Amazon ECS container agent update in progress on the container /// instance that's specified. If the container agent becomes disconnected while it's /// in a transitional stage, such as PENDING or STAGING, the /// update process can get stuck in that state. However, when the agent reconnects, it /// resumes where it stopped previously. /// /// REST API Reference for DeleteCluster Operation public virtual DeleteClusterResponse DeleteCluster(DeleteClusterRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = DeleteClusterRequestMarshaller.Instance; options.ResponseUnmarshaller = DeleteClusterResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Deletes the specified cluster. The cluster transitions to the INACTIVE /// state. Clusters with an INACTIVE status might remain discoverable in /// your account for a period of time. However, this behavior is subject to change in /// the future. We don't recommend that you rely on INACTIVE clusters persisting. /// /// /// /// You must deregister all container instances from this cluster before you may delete /// it. You can list the container instances in a cluster with ListContainerInstances /// and deregister them with DeregisterContainerInstance. /// /// /// Container for the necessary parameters to execute the DeleteCluster service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteCluster service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// You can't delete a cluster that has registered container instances. First, deregister /// the container instances before you can delete the cluster. For more information, see /// DeregisterContainerInstance. /// /// /// You can't delete a cluster that contains services. First, update the service to reduce /// its desired task count to 0, and then delete the service. For more information, see /// UpdateService and DeleteService. /// /// /// You can't delete a cluster that has active tasks. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// /// There's already a current Amazon ECS container agent update in progress on the container /// instance that's specified. If the container agent becomes disconnected while it's /// in a transitional stage, such as PENDING or STAGING, the /// update process can get stuck in that state. However, when the agent reconnects, it /// resumes where it stopped previously. /// /// REST API Reference for DeleteCluster Operation public virtual Task DeleteClusterAsync(DeleteClusterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = DeleteClusterRequestMarshaller.Instance; options.ResponseUnmarshaller = DeleteClusterResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region DeleteService /// /// 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 /// task count of zero. For more information, see UpdateService. /// /// /// /// When you delete a service, if there are still running tasks that require cleanup, /// the service status moves from ACTIVE to DRAINING, and the /// service is no longer visible in the console or in the ListServices API operation. /// After all tasks have transitioned to either STOPPING or STOPPED /// status, the service status moves from DRAINING to INACTIVE. /// Services in the DRAINING or INACTIVE status can still be /// viewed with the DescribeServices API operation. However, in the future, INACTIVE /// services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices /// calls on those services return a ServiceNotFoundException error. /// /// /// /// If you attempt to create a new service with the same name as an existing service in /// either ACTIVE or DRAINING status, you receive an error. /// /// /// /// Container for the necessary parameters to execute the DeleteService service method. /// /// The response from the DeleteService service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified service wasn't found. You can view your available services with ListServices. /// Amazon ECS services are cluster specific and Region specific. /// /// REST API Reference for DeleteService Operation public virtual DeleteServiceResponse DeleteService(DeleteServiceRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = DeleteServiceRequestMarshaller.Instance; options.ResponseUnmarshaller = DeleteServiceResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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 /// task count of zero. For more information, see UpdateService. /// /// /// /// When you delete a service, if there are still running tasks that require cleanup, /// the service status moves from ACTIVE to DRAINING, and the /// service is no longer visible in the console or in the ListServices API operation. /// After all tasks have transitioned to either STOPPING or STOPPED /// status, the service status moves from DRAINING to INACTIVE. /// Services in the DRAINING or INACTIVE status can still be /// viewed with the DescribeServices API operation. However, in the future, INACTIVE /// services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices /// calls on those services return a ServiceNotFoundException error. /// /// /// /// If you attempt to create a new service with the same name as an existing service in /// either ACTIVE or DRAINING status, you receive an error. /// /// /// /// Container for the necessary parameters to execute the DeleteService service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteService service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified service wasn't found. You can view your available services with ListServices. /// Amazon ECS services are cluster specific and Region specific. /// /// REST API Reference for DeleteService Operation public virtual Task DeleteServiceAsync(DeleteServiceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = DeleteServiceRequestMarshaller.Instance; options.ResponseUnmarshaller = DeleteServiceResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region DeleteTaskDefinitions /// /// Deletes one or more task definitions. /// /// /// /// You must deregister a task definition revision before you delete it. For more information, /// see DeregisterTaskDefinition. /// /// /// /// When you delete a task definition revision, it is immediately transitions from the /// INACTIVE to DELETE_IN_PROGRESS. Existing tasks and services /// that reference a DELETE_IN_PROGRESS task definition revision continue /// to run without disruption. Existing services that reference a DELETE_IN_PROGRESS /// task definition revision can still scale up or down by modifying the service's desired /// count. /// /// /// /// You can't use a DELETE_IN_PROGRESS task definition revision to run new /// tasks or create new services. You also can't update an existing service to reference /// a DELETE_IN_PROGRESS task definition revision. /// /// /// /// A task definition revision will stay in DELETE_IN_PROGRESS status until /// all the associated tasks and services have been terminated. /// /// /// /// When you delete all INACTIVE task definition revisions, the task definition /// name is not displayed in the console and not returned in the API. If a task definition /// revisions are in the DELETE_IN_PROGRESS state, the task definition name /// is displayed in the console and returned in the API. The task definition name is retained /// by Amazon ECS and the revision is incremented the next time you create a task definition /// with that name. /// /// /// Container for the necessary parameters to execute the DeleteTaskDefinitions service method. /// /// The response from the DeleteTaskDefinitions service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DeleteTaskDefinitions Operation public virtual DeleteTaskDefinitionsResponse DeleteTaskDefinitions(DeleteTaskDefinitionsRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = DeleteTaskDefinitionsRequestMarshaller.Instance; options.ResponseUnmarshaller = DeleteTaskDefinitionsResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Deletes one or more task definitions. /// /// /// /// You must deregister a task definition revision before you delete it. For more information, /// see DeregisterTaskDefinition. /// /// /// /// When you delete a task definition revision, it is immediately transitions from the /// INACTIVE to DELETE_IN_PROGRESS. Existing tasks and services /// that reference a DELETE_IN_PROGRESS task definition revision continue /// to run without disruption. Existing services that reference a DELETE_IN_PROGRESS /// task definition revision can still scale up or down by modifying the service's desired /// count. /// /// /// /// You can't use a DELETE_IN_PROGRESS task definition revision to run new /// tasks or create new services. You also can't update an existing service to reference /// a DELETE_IN_PROGRESS task definition revision. /// /// /// /// A task definition revision will stay in DELETE_IN_PROGRESS status until /// all the associated tasks and services have been terminated. /// /// /// /// When you delete all INACTIVE task definition revisions, the task definition /// name is not displayed in the console and not returned in the API. If a task definition /// revisions are in the DELETE_IN_PROGRESS state, the task definition name /// is displayed in the console and returned in the API. The task definition name is retained /// by Amazon ECS and the revision is incremented the next time you create a task definition /// with that name. /// /// /// Container for the necessary parameters to execute the DeleteTaskDefinitions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteTaskDefinitions service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DeleteTaskDefinitions Operation public virtual Task DeleteTaskDefinitionsAsync(DeleteTaskDefinitionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = DeleteTaskDefinitionsRequestMarshaller.Instance; options.ResponseUnmarshaller = DeleteTaskDefinitionsResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region DeleteTaskSet /// /// Deletes a specified task set within a service. This is used when a service uses the /// EXTERNAL deployment controller type. For more information, see Amazon /// ECS deployment types in the Amazon Elastic Container Service Developer Guide. /// /// Container for the necessary parameters to execute the DeleteTaskSet service method. /// /// The response from the DeleteTaskSet service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified service isn't active. You can't update a service that's inactive. If /// you have previously deleted a service, you can re-create it with CreateService. /// /// /// The specified service wasn't found. You can view your available services with ListServices. /// Amazon ECS services are cluster specific and Region specific. /// /// /// The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. /// Task sets are specific to each cluster, service and Region. /// /// /// The specified task isn't supported in this Region. /// /// REST API Reference for DeleteTaskSet Operation public virtual DeleteTaskSetResponse DeleteTaskSet(DeleteTaskSetRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = DeleteTaskSetRequestMarshaller.Instance; options.ResponseUnmarshaller = DeleteTaskSetResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Deletes a specified task set within a service. This is used when a service uses the /// EXTERNAL deployment controller type. For more information, see Amazon /// ECS deployment types in the Amazon Elastic Container Service Developer Guide. /// /// Container for the necessary parameters to execute the DeleteTaskSet service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteTaskSet service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified service isn't active. You can't update a service that's inactive. If /// you have previously deleted a service, you can re-create it with CreateService. /// /// /// The specified service wasn't found. You can view your available services with ListServices. /// Amazon ECS services are cluster specific and Region specific. /// /// /// The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. /// Task sets are specific to each cluster, service and Region. /// /// /// The specified task isn't supported in this Region. /// /// REST API Reference for DeleteTaskSet Operation public virtual Task DeleteTaskSetAsync(DeleteTaskSetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = DeleteTaskSetRequestMarshaller.Instance; options.ResponseUnmarshaller = DeleteTaskSetResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region DeregisterContainerInstance /// /// Deregisters an Amazon ECS container instance from the specified cluster. This instance /// is no longer available to run tasks. /// /// /// /// If you intend to use the container instance for some other purpose after deregistration, /// we recommend that you stop all of the tasks running on the container instance before /// deregistration. That prevents any orphaned tasks from consuming resources. /// /// /// /// Deregistering a container instance removes the instance from a cluster, but it doesn't /// terminate the EC2 instance. If you are finished using the instance, be sure to terminate /// it in the Amazon EC2 console to stop billing. /// /// /// /// If you terminate a running container instance, Amazon ECS automatically deregisters /// the instance from your cluster (stopped container instances or instances with disconnected /// agents aren't automatically deregistered when terminated). /// /// /// /// Container for the necessary parameters to execute the DeregisterContainerInstance service method. /// /// The response from the DeregisterContainerInstance service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DeregisterContainerInstance Operation public virtual DeregisterContainerInstanceResponse DeregisterContainerInstance(DeregisterContainerInstanceRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = DeregisterContainerInstanceRequestMarshaller.Instance; options.ResponseUnmarshaller = DeregisterContainerInstanceResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Deregisters an Amazon ECS container instance from the specified cluster. This instance /// is no longer available to run tasks. /// /// /// /// If you intend to use the container instance for some other purpose after deregistration, /// we recommend that you stop all of the tasks running on the container instance before /// deregistration. That prevents any orphaned tasks from consuming resources. /// /// /// /// Deregistering a container instance removes the instance from a cluster, but it doesn't /// terminate the EC2 instance. If you are finished using the instance, be sure to terminate /// it in the Amazon EC2 console to stop billing. /// /// /// /// If you terminate a running container instance, Amazon ECS automatically deregisters /// the instance from your cluster (stopped container instances or instances with disconnected /// agents aren't automatically deregistered when terminated). /// /// /// /// Container for the necessary parameters to execute the DeregisterContainerInstance service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeregisterContainerInstance service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DeregisterContainerInstance Operation public virtual Task DeregisterContainerInstanceAsync(DeregisterContainerInstanceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = DeregisterContainerInstanceRequestMarshaller.Instance; options.ResponseUnmarshaller = DeregisterContainerInstanceResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region DeregisterTaskDefinition /// /// Deregisters the specified task definition by family and revision. Upon deregistration, /// the task definition is marked as INACTIVE. Existing tasks and services /// that reference an INACTIVE task definition continue to run without disruption. /// Existing services that reference an INACTIVE task definition can still /// scale up or down by modifying the service's desired count. If you want to delete a /// task definition revision, you must first deregister the task definition revision. /// /// /// /// You can't use an INACTIVE task definition to run new tasks or create /// new services, and you can't update an existing service to reference an INACTIVE /// task definition. However, there may be up to a 10-minute window following deregistration /// where these restrictions have not yet taken effect. /// /// /// /// At this time, INACTIVE task definitions remain discoverable in your account /// indefinitely. However, this behavior is subject to change in the future. We don't /// recommend that you rely on INACTIVE task definitions persisting beyond /// the lifecycle of any associated tasks and services. /// /// /// /// You must deregister a task definition revision before you delete it. For more information, /// see DeleteTaskDefinitions. /// /// /// Container for the necessary parameters to execute the DeregisterTaskDefinition service method. /// /// The response from the DeregisterTaskDefinition service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DeregisterTaskDefinition Operation public virtual DeregisterTaskDefinitionResponse DeregisterTaskDefinition(DeregisterTaskDefinitionRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = DeregisterTaskDefinitionRequestMarshaller.Instance; options.ResponseUnmarshaller = DeregisterTaskDefinitionResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Deregisters the specified task definition by family and revision. Upon deregistration, /// the task definition is marked as INACTIVE. Existing tasks and services /// that reference an INACTIVE task definition continue to run without disruption. /// Existing services that reference an INACTIVE task definition can still /// scale up or down by modifying the service's desired count. If you want to delete a /// task definition revision, you must first deregister the task definition revision. /// /// /// /// You can't use an INACTIVE task definition to run new tasks or create /// new services, and you can't update an existing service to reference an INACTIVE /// task definition. However, there may be up to a 10-minute window following deregistration /// where these restrictions have not yet taken effect. /// /// /// /// At this time, INACTIVE task definitions remain discoverable in your account /// indefinitely. However, this behavior is subject to change in the future. We don't /// recommend that you rely on INACTIVE task definitions persisting beyond /// the lifecycle of any associated tasks and services. /// /// /// /// You must deregister a task definition revision before you delete it. For more information, /// see DeleteTaskDefinitions. /// /// /// Container for the necessary parameters to execute the DeregisterTaskDefinition service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeregisterTaskDefinition service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DeregisterTaskDefinition Operation public virtual Task DeregisterTaskDefinitionAsync(DeregisterTaskDefinitionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = DeregisterTaskDefinitionRequestMarshaller.Instance; options.ResponseUnmarshaller = DeregisterTaskDefinitionResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region DescribeCapacityProviders /// /// Describes one or more of your capacity providers. /// /// Container for the necessary parameters to execute the DescribeCapacityProviders service method. /// /// The response from the DescribeCapacityProviders service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DescribeCapacityProviders Operation public virtual DescribeCapacityProvidersResponse DescribeCapacityProviders(DescribeCapacityProvidersRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = DescribeCapacityProvidersRequestMarshaller.Instance; options.ResponseUnmarshaller = DescribeCapacityProvidersResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Describes one or more of your capacity providers. /// /// Container for the necessary parameters to execute the DescribeCapacityProviders service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeCapacityProviders service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DescribeCapacityProviders Operation public virtual Task DescribeCapacityProvidersAsync(DescribeCapacityProvidersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = DescribeCapacityProvidersRequestMarshaller.Instance; options.ResponseUnmarshaller = DescribeCapacityProvidersResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region DescribeClusters /// /// Describes one or more of your clusters. /// /// Container for the necessary parameters to execute the DescribeClusters service method. /// /// The response from the DescribeClusters service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DescribeClusters Operation public virtual DescribeClustersResponse DescribeClusters(DescribeClustersRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = DescribeClustersRequestMarshaller.Instance; options.ResponseUnmarshaller = DescribeClustersResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Describes one or more of your clusters. /// /// Container for the necessary parameters to execute the DescribeClusters service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeClusters service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DescribeClusters Operation public virtual Task DescribeClustersAsync(DescribeClustersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = DescribeClustersRequestMarshaller.Instance; options.ResponseUnmarshaller = DescribeClustersResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region DescribeContainerInstances /// /// Describes one or more container instances. Returns metadata about each container instance /// requested. /// /// Container for the necessary parameters to execute the DescribeContainerInstances service method. /// /// The response from the DescribeContainerInstances service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DescribeContainerInstances Operation public virtual DescribeContainerInstancesResponse DescribeContainerInstances(DescribeContainerInstancesRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = DescribeContainerInstancesRequestMarshaller.Instance; options.ResponseUnmarshaller = DescribeContainerInstancesResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Describes one or more container instances. Returns metadata about each container instance /// requested. /// /// Container for the necessary parameters to execute the DescribeContainerInstances service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeContainerInstances service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DescribeContainerInstances Operation public virtual Task DescribeContainerInstancesAsync(DescribeContainerInstancesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = DescribeContainerInstancesRequestMarshaller.Instance; options.ResponseUnmarshaller = DescribeContainerInstancesResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region DescribeServices /// /// Describes the specified services running in your cluster. /// /// Container for the necessary parameters to execute the DescribeServices service method. /// /// The response from the DescribeServices service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DescribeServices Operation public virtual DescribeServicesResponse DescribeServices(DescribeServicesRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = DescribeServicesRequestMarshaller.Instance; options.ResponseUnmarshaller = DescribeServicesResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Describes the specified services running in your cluster. /// /// Container for the necessary parameters to execute the DescribeServices service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeServices service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DescribeServices Operation public virtual Task DescribeServicesAsync(DescribeServicesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = DescribeServicesRequestMarshaller.Instance; options.ResponseUnmarshaller = DescribeServicesResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region DescribeTaskDefinition /// /// Describes a task definition. You can specify a family and revision /// to find information about a specific task definition, or you can simply specify the /// family to find the latest ACTIVE revision in that family. /// /// /// /// You can only describe INACTIVE task definitions while an active task /// or service references them. /// /// /// /// Container for the necessary parameters to execute the DescribeTaskDefinition service method. /// /// The response from the DescribeTaskDefinition service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DescribeTaskDefinition Operation public virtual DescribeTaskDefinitionResponse DescribeTaskDefinition(DescribeTaskDefinitionRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = DescribeTaskDefinitionRequestMarshaller.Instance; options.ResponseUnmarshaller = DescribeTaskDefinitionResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Describes a task definition. You can specify a family and revision /// to find information about a specific task definition, or you can simply specify the /// family to find the latest ACTIVE revision in that family. /// /// /// /// You can only describe INACTIVE task definitions while an active task /// or service references them. /// /// /// /// Container for the necessary parameters to execute the DescribeTaskDefinition service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeTaskDefinition service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DescribeTaskDefinition Operation public virtual Task DescribeTaskDefinitionAsync(DescribeTaskDefinitionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = DescribeTaskDefinitionRequestMarshaller.Instance; options.ResponseUnmarshaller = DescribeTaskDefinitionResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region DescribeTasks /// /// Describes a specified task or tasks. /// /// /// /// Currently, stopped tasks appear in the returned results for at least one hour. /// /// /// Container for the necessary parameters to execute the DescribeTasks service method. /// /// The response from the DescribeTasks service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DescribeTasks Operation public virtual DescribeTasksResponse DescribeTasks(DescribeTasksRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = DescribeTasksRequestMarshaller.Instance; options.ResponseUnmarshaller = DescribeTasksResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Describes a specified task or tasks. /// /// /// /// Currently, stopped tasks appear in the returned results for at least one hour. /// /// /// Container for the necessary parameters to execute the DescribeTasks service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeTasks service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DescribeTasks Operation public virtual Task DescribeTasksAsync(DescribeTasksRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = DescribeTasksRequestMarshaller.Instance; options.ResponseUnmarshaller = DescribeTasksResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region DescribeTaskSets /// /// Describes the task sets in the specified cluster and service. This is used when a /// service uses the EXTERNAL deployment controller type. For more information, /// see Amazon /// ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. /// /// Container for the necessary parameters to execute the DescribeTaskSets service method. /// /// The response from the DescribeTaskSets service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified service isn't active. You can't update a service that's inactive. If /// you have previously deleted a service, you can re-create it with CreateService. /// /// /// The specified service wasn't found. You can view your available services with ListServices. /// Amazon ECS services are cluster specific and Region specific. /// /// /// The specified task isn't supported in this Region. /// /// REST API Reference for DescribeTaskSets Operation public virtual DescribeTaskSetsResponse DescribeTaskSets(DescribeTaskSetsRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = DescribeTaskSetsRequestMarshaller.Instance; options.ResponseUnmarshaller = DescribeTaskSetsResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Describes the task sets in the specified cluster and service. This is used when a /// service uses the EXTERNAL deployment controller type. For more information, /// see Amazon /// ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. /// /// Container for the necessary parameters to execute the DescribeTaskSets service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeTaskSets service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified service isn't active. You can't update a service that's inactive. If /// you have previously deleted a service, you can re-create it with CreateService. /// /// /// The specified service wasn't found. You can view your available services with ListServices. /// Amazon ECS services are cluster specific and Region specific. /// /// /// The specified task isn't supported in this Region. /// /// REST API Reference for DescribeTaskSets Operation public virtual Task DescribeTaskSetsAsync(DescribeTaskSetsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = DescribeTaskSetsRequestMarshaller.Instance; options.ResponseUnmarshaller = DescribeTaskSetsResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region ExecuteCommand /// /// Runs a command remotely on a container within a task. /// /// /// /// 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 AccessDeniedException /// when there is a mismatch between the condition key value and the corresponding parameter /// value. /// /// /// /// For information about required permissions and considerations, see Using /// Amazon ECS Exec for debugging in the Amazon ECS Developer Guide. /// /// /// Container for the necessary parameters to execute the ExecuteCommand service method. /// /// The response from the ExecuteCommand service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// /// The execute command cannot run. This error can be caused by any of the following configuration /// issues: /// ///
  • /// /// Incorrect IAM permissions /// ///
  • /// /// The SSM agent is not installed or is not running /// ///
  • /// /// There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for /// Systems Manager Session Manager /// ///
/// /// For information about how to troubleshoot the issues, see Troubleshooting /// issues with ECS Exec in the Amazon Elastic Container Service Developer Guide. /// ///
/// REST API Reference for ExecuteCommand Operation public virtual ExecuteCommandResponse ExecuteCommand(ExecuteCommandRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = ExecuteCommandRequestMarshaller.Instance; options.ResponseUnmarshaller = ExecuteCommandResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Runs a command remotely on a container within a task. /// /// /// /// 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 AccessDeniedException /// when there is a mismatch between the condition key value and the corresponding parameter /// value. /// /// /// /// For information about required permissions and considerations, see Using /// Amazon ECS Exec for debugging in the Amazon ECS Developer Guide. /// /// /// Container for the necessary parameters to execute the ExecuteCommand service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ExecuteCommand service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// /// The execute command cannot run. This error can be caused by any of the following configuration /// issues: /// ///
  • /// /// Incorrect IAM permissions /// ///
  • /// /// The SSM agent is not installed or is not running /// ///
  • /// /// There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for /// Systems Manager Session Manager /// ///
/// /// For information about how to troubleshoot the issues, see Troubleshooting /// issues with ECS Exec in the Amazon Elastic Container Service Developer Guide. /// ///
/// REST API Reference for ExecuteCommand Operation public virtual Task ExecuteCommandAsync(ExecuteCommandRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = ExecuteCommandRequestMarshaller.Instance; options.ResponseUnmarshaller = ExecuteCommandResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region GetTaskProtection /// /// Retrieves the protection status of tasks in an Amazon ECS service. /// /// Container for the necessary parameters to execute the GetTaskProtection service method. /// /// The response from the GetTaskProtection service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified resource wasn't found. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified task isn't supported in this Region. /// /// REST API Reference for GetTaskProtection Operation public virtual GetTaskProtectionResponse GetTaskProtection(GetTaskProtectionRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = GetTaskProtectionRequestMarshaller.Instance; options.ResponseUnmarshaller = GetTaskProtectionResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Retrieves the protection status of tasks in an Amazon ECS service. /// /// Container for the necessary parameters to execute the GetTaskProtection service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetTaskProtection service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified resource wasn't found. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified task isn't supported in this Region. /// /// REST API Reference for GetTaskProtection Operation public virtual Task GetTaskProtectionAsync(GetTaskProtectionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = GetTaskProtectionRequestMarshaller.Instance; options.ResponseUnmarshaller = GetTaskProtectionResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region ListAccountSettings /// /// Lists the account settings for a specified principal. /// /// Container for the necessary parameters to execute the ListAccountSettings service method. /// /// The response from the ListAccountSettings service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListAccountSettings Operation public virtual ListAccountSettingsResponse ListAccountSettings(ListAccountSettingsRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = ListAccountSettingsRequestMarshaller.Instance; options.ResponseUnmarshaller = ListAccountSettingsResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Lists the account settings for a specified principal. /// /// Container for the necessary parameters to execute the ListAccountSettings service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListAccountSettings service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListAccountSettings Operation public virtual Task ListAccountSettingsAsync(ListAccountSettingsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = ListAccountSettingsRequestMarshaller.Instance; options.ResponseUnmarshaller = ListAccountSettingsResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region ListAttributes /// /// Lists the attributes for Amazon ECS resources within a specified target type and cluster. /// When you specify a target type and cluster, ListAttributes returns a /// list of attribute objects, one for each attribute on each resource. You can filter /// the list of results to a single attribute name to only return results that have that /// name. You can also filter the results by attribute name and value. You can do this, /// for example, to see which container instances in a cluster are running a Linux AMI /// (ecs.os-type=linux). /// /// Container for the necessary parameters to execute the ListAttributes service method. /// /// The response from the ListAttributes service method, as returned by ECS. /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// REST API Reference for ListAttributes Operation public virtual ListAttributesResponse ListAttributes(ListAttributesRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = ListAttributesRequestMarshaller.Instance; options.ResponseUnmarshaller = ListAttributesResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Lists the attributes for Amazon ECS resources within a specified target type and cluster. /// When you specify a target type and cluster, ListAttributes returns a /// list of attribute objects, one for each attribute on each resource. You can filter /// the list of results to a single attribute name to only return results that have that /// name. You can also filter the results by attribute name and value. You can do this, /// for example, to see which container instances in a cluster are running a Linux AMI /// (ecs.os-type=linux). /// /// Container for the necessary parameters to execute the ListAttributes service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListAttributes service method, as returned by ECS. /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// REST API Reference for ListAttributes Operation public virtual Task ListAttributesAsync(ListAttributesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = ListAttributesRequestMarshaller.Instance; options.ResponseUnmarshaller = ListAttributesResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region ListClusters /// /// Returns a list of existing clusters. /// /// Container for the necessary parameters to execute the ListClusters service method. /// /// The response from the ListClusters service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListClusters Operation public virtual ListClustersResponse ListClusters(ListClustersRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = ListClustersRequestMarshaller.Instance; options.ResponseUnmarshaller = ListClustersResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Returns a list of existing clusters. /// /// Container for the necessary parameters to execute the ListClusters service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListClusters service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListClusters Operation public virtual Task ListClustersAsync(ListClustersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = ListClustersRequestMarshaller.Instance; options.ResponseUnmarshaller = ListClustersResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region ListContainerInstances /// /// Returns a list of container instances in a specified cluster. You can filter the results /// of a ListContainerInstances operation with cluster query language statements /// inside the filter parameter. For more information, see Cluster /// Query Language in the Amazon Elastic Container Service Developer Guide. /// /// Container for the necessary parameters to execute the ListContainerInstances service method. /// /// The response from the ListContainerInstances service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListContainerInstances Operation public virtual ListContainerInstancesResponse ListContainerInstances(ListContainerInstancesRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = ListContainerInstancesRequestMarshaller.Instance; options.ResponseUnmarshaller = ListContainerInstancesResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Returns a list of container instances in a specified cluster. You can filter the results /// of a ListContainerInstances operation with cluster query language statements /// inside the filter parameter. For more information, see Cluster /// Query Language in the Amazon Elastic Container Service Developer Guide. /// /// Container for the necessary parameters to execute the ListContainerInstances service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListContainerInstances service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListContainerInstances Operation public virtual Task ListContainerInstancesAsync(ListContainerInstancesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = ListContainerInstancesRequestMarshaller.Instance; options.ResponseUnmarshaller = ListContainerInstancesResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region ListServices /// /// Returns a list of services. You can filter the results by cluster, launch type, and /// scheduling strategy. /// /// Container for the necessary parameters to execute the ListServices service method. /// /// The response from the ListServices service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListServices Operation public virtual ListServicesResponse ListServices(ListServicesRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = ListServicesRequestMarshaller.Instance; options.ResponseUnmarshaller = ListServicesResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Returns a list of services. You can filter the results by cluster, launch type, and /// scheduling strategy. /// /// Container for the necessary parameters to execute the ListServices service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListServices service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListServices Operation public virtual Task ListServicesAsync(ListServicesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = ListServicesRequestMarshaller.Instance; options.ResponseUnmarshaller = ListServicesResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region ListServicesByNamespace /// /// 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, ListServices /// can only list services in one cluster at a time. If you need to filter the list of /// services in a single cluster by various parameters, use ListServices. /// For more information, see Service /// Connect in the Amazon Elastic Container Service Developer Guide. /// /// Container for the necessary parameters to execute the ListServicesByNamespace service method. /// /// The response from the ListServicesByNamespace service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified namespace wasn't found. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListServicesByNamespace Operation public virtual ListServicesByNamespaceResponse ListServicesByNamespace(ListServicesByNamespaceRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = ListServicesByNamespaceRequestMarshaller.Instance; options.ResponseUnmarshaller = ListServicesByNamespaceResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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, ListServices /// can only list services in one cluster at a time. If you need to filter the list of /// services in a single cluster by various parameters, use ListServices. /// For more information, see Service /// Connect in the Amazon Elastic Container Service Developer Guide. /// /// Container for the necessary parameters to execute the ListServicesByNamespace service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListServicesByNamespace service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified namespace wasn't found. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListServicesByNamespace Operation public virtual Task ListServicesByNamespaceAsync(ListServicesByNamespaceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = ListServicesByNamespaceRequestMarshaller.Instance; options.ResponseUnmarshaller = ListServicesByNamespaceResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region ListTagsForResource /// /// List the tags for an Amazon ECS resource. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// The response from the ListTagsForResource service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListTagsForResource Operation public virtual ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance; options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// List the tags for an Amazon ECS resource. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListTagsForResource service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListTagsForResource Operation public virtual Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance; options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region ListTaskDefinitionFamilies /// /// Returns a list of task definition families that are registered to your account. This /// list includes task definition families that no longer have any ACTIVE /// task definition revisions. /// /// /// /// You can filter out task definition families that don't contain any ACTIVE /// task definition revisions by setting the status parameter to ACTIVE. /// You can also filter the results with the familyPrefix parameter. /// /// /// Container for the necessary parameters to execute the ListTaskDefinitionFamilies service method. /// /// The response from the ListTaskDefinitionFamilies service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListTaskDefinitionFamilies Operation public virtual ListTaskDefinitionFamiliesResponse ListTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = ListTaskDefinitionFamiliesRequestMarshaller.Instance; options.ResponseUnmarshaller = ListTaskDefinitionFamiliesResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Returns a list of task definition families that are registered to your account. This /// list includes task definition families that no longer have any ACTIVE /// task definition revisions. /// /// /// /// You can filter out task definition families that don't contain any ACTIVE /// task definition revisions by setting the status parameter to ACTIVE. /// You can also filter the results with the familyPrefix parameter. /// /// /// Container for the necessary parameters to execute the ListTaskDefinitionFamilies service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListTaskDefinitionFamilies service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListTaskDefinitionFamilies Operation public virtual Task ListTaskDefinitionFamiliesAsync(ListTaskDefinitionFamiliesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = ListTaskDefinitionFamiliesRequestMarshaller.Instance; options.ResponseUnmarshaller = ListTaskDefinitionFamiliesResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region ListTaskDefinitions /// /// Returns a list of task definitions that are registered to your account. You can filter /// the results by family name with the familyPrefix parameter or by status /// with the status parameter. /// /// Container for the necessary parameters to execute the ListTaskDefinitions service method. /// /// The response from the ListTaskDefinitions service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListTaskDefinitions Operation public virtual ListTaskDefinitionsResponse ListTaskDefinitions(ListTaskDefinitionsRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = ListTaskDefinitionsRequestMarshaller.Instance; options.ResponseUnmarshaller = ListTaskDefinitionsResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Returns a list of task definitions that are registered to your account. You can filter /// the results by family name with the familyPrefix parameter or by status /// with the status parameter. /// /// Container for the necessary parameters to execute the ListTaskDefinitions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListTaskDefinitions service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListTaskDefinitions Operation public virtual Task ListTaskDefinitionsAsync(ListTaskDefinitionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = ListTaskDefinitionsRequestMarshaller.Instance; options.ResponseUnmarshaller = ListTaskDefinitionsResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region ListTasks /// /// 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. /// /// /// /// Recently stopped tasks might appear in the returned results. Currently, stopped tasks /// appear in the returned results for at least one hour. /// /// /// Container for the necessary parameters to execute the ListTasks service method. /// /// The response from the ListTasks service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified service wasn't found. You can view your available services with ListServices. /// Amazon ECS services are cluster specific and Region specific. /// /// REST API Reference for ListTasks Operation public virtual ListTasksResponse ListTasks(ListTasksRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = ListTasksRequestMarshaller.Instance; options.ResponseUnmarshaller = ListTasksResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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. /// /// /// /// Recently stopped tasks might appear in the returned results. Currently, stopped tasks /// appear in the returned results for at least one hour. /// /// /// Container for the necessary parameters to execute the ListTasks service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListTasks service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified service wasn't found. You can view your available services with ListServices. /// Amazon ECS services are cluster specific and Region specific. /// /// REST API Reference for ListTasks Operation public virtual Task ListTasksAsync(ListTasksRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = ListTasksRequestMarshaller.Instance; options.ResponseUnmarshaller = ListTasksResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region PutAccountSetting /// /// Modifies an account setting. Account settings are set on a per-Region basis. /// /// /// /// If you change the root user account setting, the default settings are reset for users /// and roles that do not have specified individual account settings. For more information, /// see Account /// Settings in the Amazon Elastic Container Service Developer Guide. /// /// /// /// When serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat /// are specified, the Amazon Resource Name (ARN) and resource ID format of the resource /// type for a specified user, role, or the root user for an account is affected. The /// opt-in and opt-out account setting must be set for each Amazon ECS resource separately. /// The ARN and resource ID format of a resource is defined by the opt-in status of the /// user or role that created the resource. You must turn on this setting to use Amazon /// ECS features such as resource tagging. /// /// /// /// When awsvpcTrunking is specified, the elastic network interface (ENI) /// limit for any new container instances that support the feature is changed. If awsvpcTrunking /// is turned on, any new container instances that support the feature are launched have /// the increased ENI limits available to them. For more information, see Elastic /// Network Interface Trunking in the Amazon Elastic Container Service Developer /// Guide. /// /// /// /// When containerInsights is specified, the default setting indicating whether /// Amazon Web Services CloudWatch Container Insights is turned on for your clusters is /// changed. If containerInsights is turned on, any new clusters that are /// created will have Container Insights turned on unless you disable it during cluster /// creation. For more information, see CloudWatch /// Container Insights in the Amazon Elastic Container Service Developer Guide. /// /// /// /// Amazon ECS is introducing tagging authorization for resource creation. Users must /// have permissions for actions that create the resource, such as ecsCreateCluster. /// If tags are specified when you create a resource, Amazon Web Services performs additional /// authorization to verify if users or roles have permissions to create tags. Therefore, /// you must grant explicit permissions to use the ecs:TagResource action. /// For more information, see Grant /// permission to tag resources on creation in the Amazon ECS Developer Guide. /// /// /// Container for the necessary parameters to execute the PutAccountSetting service method. /// /// The response from the PutAccountSetting service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for PutAccountSetting Operation public virtual PutAccountSettingResponse PutAccountSetting(PutAccountSettingRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = PutAccountSettingRequestMarshaller.Instance; options.ResponseUnmarshaller = PutAccountSettingResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Modifies an account setting. Account settings are set on a per-Region basis. /// /// /// /// If you change the root user account setting, the default settings are reset for users /// and roles that do not have specified individual account settings. For more information, /// see Account /// Settings in the Amazon Elastic Container Service Developer Guide. /// /// /// /// When serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat /// are specified, the Amazon Resource Name (ARN) and resource ID format of the resource /// type for a specified user, role, or the root user for an account is affected. The /// opt-in and opt-out account setting must be set for each Amazon ECS resource separately. /// The ARN and resource ID format of a resource is defined by the opt-in status of the /// user or role that created the resource. You must turn on this setting to use Amazon /// ECS features such as resource tagging. /// /// /// /// When awsvpcTrunking is specified, the elastic network interface (ENI) /// limit for any new container instances that support the feature is changed. If awsvpcTrunking /// is turned on, any new container instances that support the feature are launched have /// the increased ENI limits available to them. For more information, see Elastic /// Network Interface Trunking in the Amazon Elastic Container Service Developer /// Guide. /// /// /// /// When containerInsights is specified, the default setting indicating whether /// Amazon Web Services CloudWatch Container Insights is turned on for your clusters is /// changed. If containerInsights is turned on, any new clusters that are /// created will have Container Insights turned on unless you disable it during cluster /// creation. For more information, see CloudWatch /// Container Insights in the Amazon Elastic Container Service Developer Guide. /// /// /// /// Amazon ECS is introducing tagging authorization for resource creation. Users must /// have permissions for actions that create the resource, such as ecsCreateCluster. /// If tags are specified when you create a resource, Amazon Web Services performs additional /// authorization to verify if users or roles have permissions to create tags. Therefore, /// you must grant explicit permissions to use the ecs:TagResource action. /// For more information, see Grant /// permission to tag resources on creation in the Amazon ECS Developer Guide. /// /// /// Container for the necessary parameters to execute the PutAccountSetting service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutAccountSetting service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for PutAccountSetting Operation public virtual Task PutAccountSettingAsync(PutAccountSettingRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = PutAccountSettingRequestMarshaller.Instance; options.ResponseUnmarshaller = PutAccountSettingResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region PutAccountSettingDefault /// /// 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. /// /// Container for the necessary parameters to execute the PutAccountSettingDefault service method. /// /// The response from the PutAccountSettingDefault service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for PutAccountSettingDefault Operation public virtual PutAccountSettingDefaultResponse PutAccountSettingDefault(PutAccountSettingDefaultRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = PutAccountSettingDefaultRequestMarshaller.Instance; options.ResponseUnmarshaller = PutAccountSettingDefaultResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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. /// /// Container for the necessary parameters to execute the PutAccountSettingDefault service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutAccountSettingDefault service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for PutAccountSettingDefault Operation public virtual Task PutAccountSettingDefaultAsync(PutAccountSettingDefaultRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = PutAccountSettingDefaultRequestMarshaller.Instance; options.ResponseUnmarshaller = PutAccountSettingDefaultResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region PutAttributes /// /// 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 DeleteAttributes. For more information, /// see Attributes /// in the Amazon Elastic Container Service Developer Guide. /// /// Container for the necessary parameters to execute the PutAttributes service method. /// /// The response from the PutAttributes service method, as returned by ECS. /// /// You can apply up to 10 custom attributes for each resource. You can view the attributes /// of a resource with ListAttributes. You can remove existing attributes on a /// resource with DeleteAttributes. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified target wasn't found. You can view your available container instances /// with ListContainerInstances. Amazon ECS container instances are cluster-specific /// and Region-specific. /// /// REST API Reference for PutAttributes Operation public virtual PutAttributesResponse PutAttributes(PutAttributesRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = PutAttributesRequestMarshaller.Instance; options.ResponseUnmarshaller = PutAttributesResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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 DeleteAttributes. For more information, /// see Attributes /// in the Amazon Elastic Container Service Developer Guide. /// /// Container for the necessary parameters to execute the PutAttributes service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutAttributes service method, as returned by ECS. /// /// You can apply up to 10 custom attributes for each resource. You can view the attributes /// of a resource with ListAttributes. You can remove existing attributes on a /// resource with DeleteAttributes. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified target wasn't found. You can view your available container instances /// with ListContainerInstances. Amazon ECS container instances are cluster-specific /// and Region-specific. /// /// REST API Reference for PutAttributes Operation public virtual Task PutAttributesAsync(PutAttributesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = PutAttributesRequestMarshaller.Instance; options.ResponseUnmarshaller = PutAttributesResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region PutClusterCapacityProviders /// /// Modifies the available capacity providers and the default capacity provider strategy /// for a cluster. /// /// /// /// You must specify both the available capacity providers and a default capacity provider /// strategy for the cluster. If the specified cluster has existing capacity providers /// associated with it, you must specify all existing capacity providers in addition to /// any new ones you want to add. Any existing capacity providers that are associated /// with a cluster that are omitted from a PutClusterCapacityProviders API call /// will be disassociated with the cluster. You can only disassociate an existing capacity /// provider from a cluster if it's not being used by any existing tasks. /// /// /// /// When creating a service or running a task on a cluster, if no capacity provider or /// launch type is specified, then the cluster's default capacity provider strategy is /// used. We recommend that you define a default capacity provider strategy for your cluster. /// However, you must specify an empty array ([]) to bypass defining a default /// strategy. /// /// /// Container for the necessary parameters to execute the PutClusterCapacityProviders service method. /// /// The response from the PutClusterCapacityProviders service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified resource is in-use and can't be removed. /// /// /// These errors are usually caused by a server issue. /// /// /// There's already a current Amazon ECS container agent update in progress on the container /// instance that's specified. If the container agent becomes disconnected while it's /// in a transitional stage, such as PENDING or STAGING, the /// update process can get stuck in that state. However, when the agent reconnects, it /// resumes where it stopped previously. /// /// REST API Reference for PutClusterCapacityProviders Operation public virtual PutClusterCapacityProvidersResponse PutClusterCapacityProviders(PutClusterCapacityProvidersRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = PutClusterCapacityProvidersRequestMarshaller.Instance; options.ResponseUnmarshaller = PutClusterCapacityProvidersResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Modifies the available capacity providers and the default capacity provider strategy /// for a cluster. /// /// /// /// You must specify both the available capacity providers and a default capacity provider /// strategy for the cluster. If the specified cluster has existing capacity providers /// associated with it, you must specify all existing capacity providers in addition to /// any new ones you want to add. Any existing capacity providers that are associated /// with a cluster that are omitted from a PutClusterCapacityProviders API call /// will be disassociated with the cluster. You can only disassociate an existing capacity /// provider from a cluster if it's not being used by any existing tasks. /// /// /// /// When creating a service or running a task on a cluster, if no capacity provider or /// launch type is specified, then the cluster's default capacity provider strategy is /// used. We recommend that you define a default capacity provider strategy for your cluster. /// However, you must specify an empty array ([]) to bypass defining a default /// strategy. /// /// /// Container for the necessary parameters to execute the PutClusterCapacityProviders service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutClusterCapacityProviders service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified resource is in-use and can't be removed. /// /// /// These errors are usually caused by a server issue. /// /// /// There's already a current Amazon ECS container agent update in progress on the container /// instance that's specified. If the container agent becomes disconnected while it's /// in a transitional stage, such as PENDING or STAGING, the /// update process can get stuck in that state. However, when the agent reconnects, it /// resumes where it stopped previously. /// /// REST API Reference for PutClusterCapacityProviders Operation public virtual Task PutClusterCapacityProvidersAsync(PutClusterCapacityProvidersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = PutClusterCapacityProvidersRequestMarshaller.Instance; options.ResponseUnmarshaller = PutClusterCapacityProvidersResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region RegisterTaskDefinition /// /// Registers a new task definition from the supplied family and containerDefinitions. /// Optionally, you can add data volumes to your containers with the volumes /// parameter. For more information about task definition parameters and defaults, see /// Amazon /// ECS Task Definitions in the Amazon Elastic Container Service Developer Guide. /// /// /// /// You can specify a role for your task with the taskRoleArn parameter. /// When you specify a role for a task, its containers can then use the latest versions /// of the CLI or SDKs to make API requests to the Amazon Web Services services that are /// specified in the policy that's associated with the role. For more information, see /// IAM /// Roles for Tasks in the Amazon Elastic Container Service Developer Guide. /// /// /// /// You can specify a Docker networking mode for the containers in your task definition /// with the networkMode parameter. The available network modes correspond /// to those described in Network /// settings in the Docker run reference. If you specify the awsvpc network /// mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration /// when you create a service or run a task with the task definition. For more information, /// see Task /// Networking in the Amazon Elastic Container Service Developer Guide. /// /// /// Container for the necessary parameters to execute the RegisterTaskDefinition service method. /// /// The response from the RegisterTaskDefinition service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for RegisterTaskDefinition Operation public virtual RegisterTaskDefinitionResponse RegisterTaskDefinition(RegisterTaskDefinitionRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = RegisterTaskDefinitionRequestMarshaller.Instance; options.ResponseUnmarshaller = RegisterTaskDefinitionResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Registers a new task definition from the supplied family and containerDefinitions. /// Optionally, you can add data volumes to your containers with the volumes /// parameter. For more information about task definition parameters and defaults, see /// Amazon /// ECS Task Definitions in the Amazon Elastic Container Service Developer Guide. /// /// /// /// You can specify a role for your task with the taskRoleArn parameter. /// When you specify a role for a task, its containers can then use the latest versions /// of the CLI or SDKs to make API requests to the Amazon Web Services services that are /// specified in the policy that's associated with the role. For more information, see /// IAM /// Roles for Tasks in the Amazon Elastic Container Service Developer Guide. /// /// /// /// You can specify a Docker networking mode for the containers in your task definition /// with the networkMode parameter. The available network modes correspond /// to those described in Network /// settings in the Docker run reference. If you specify the awsvpc network /// mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration /// when you create a service or run a task with the task definition. For more information, /// see Task /// Networking in the Amazon Elastic Container Service Developer Guide. /// /// /// Container for the necessary parameters to execute the RegisterTaskDefinition service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RegisterTaskDefinition service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for RegisterTaskDefinition Operation public virtual Task RegisterTaskDefinitionAsync(RegisterTaskDefinitionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = RegisterTaskDefinitionRequestMarshaller.Instance; options.ResponseUnmarshaller = RegisterTaskDefinitionResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region RunTask /// /// Starts a new task using the specified task definition. /// /// /// /// 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 Scheduling /// Tasks in the Amazon Elastic Container Service Developer Guide. /// /// /// /// Alternatively, you can use StartTask to use your own scheduler or place tasks /// manually on specific container instances. /// /// /// /// Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon /// Elastic Inference (EI), and will help current customers migrate their workloads to /// options that offer better price and performance. After April 15, 2023, new customers /// will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, /// Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once /// during the past 30-day period are considered current customers and will be able to /// continue using the service. /// /// /// /// The Amazon ECS API follows an eventual consistency model. This is because of the distributed /// nature of the system supporting the API. This means that the result of an API command /// you run that affects your Amazon ECS resources might not be immediately visible to /// all subsequent commands you run. Keep this in mind when you carry out an API command /// that immediately follows a previous API command. /// /// /// /// To manage eventual consistency, you can do the following: /// ///
  • /// /// Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks /// command using an exponential backoff algorithm to ensure that you allow enough time /// for the previous command to propagate through the system. To do this, run the DescribeTasks /// command repeatedly, starting with a couple of seconds of wait time and increasing /// gradually up to five minutes of wait time. /// ///
  • /// /// Add wait time between subsequent commands, even if the DescribeTasks command returns /// an accurate response. Apply an exponential backoff algorithm starting with a couple /// of seconds of wait time, and increase gradually up to about five minutes of wait time. /// ///
///
/// Container for the necessary parameters to execute the RunTask service method. /// /// The response from the RunTask service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// Your Amazon Web Services account was blocked. For more information, contact /// Amazon Web Services Support. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified platform version doesn't satisfy the required capabilities of the task /// definition. /// /// /// The specified platform version doesn't exist. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified task isn't supported in this Region. /// /// REST API Reference for RunTask Operation public virtual RunTaskResponse RunTask(RunTaskRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = RunTaskRequestMarshaller.Instance; options.ResponseUnmarshaller = RunTaskResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Starts a new task using the specified task definition. /// /// /// /// 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 Scheduling /// Tasks in the Amazon Elastic Container Service Developer Guide. /// /// /// /// Alternatively, you can use StartTask to use your own scheduler or place tasks /// manually on specific container instances. /// /// /// /// Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon /// Elastic Inference (EI), and will help current customers migrate their workloads to /// options that offer better price and performance. After April 15, 2023, new customers /// will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, /// Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once /// during the past 30-day period are considered current customers and will be able to /// continue using the service. /// /// /// /// The Amazon ECS API follows an eventual consistency model. This is because of the distributed /// nature of the system supporting the API. This means that the result of an API command /// you run that affects your Amazon ECS resources might not be immediately visible to /// all subsequent commands you run. Keep this in mind when you carry out an API command /// that immediately follows a previous API command. /// /// /// /// To manage eventual consistency, you can do the following: /// ///
  • /// /// Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks /// command using an exponential backoff algorithm to ensure that you allow enough time /// for the previous command to propagate through the system. To do this, run the DescribeTasks /// command repeatedly, starting with a couple of seconds of wait time and increasing /// gradually up to five minutes of wait time. /// ///
  • /// /// Add wait time between subsequent commands, even if the DescribeTasks command returns /// an accurate response. Apply an exponential backoff algorithm starting with a couple /// of seconds of wait time, and increase gradually up to about five minutes of wait time. /// ///
///
/// Container for the necessary parameters to execute the RunTask service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RunTask service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// Your Amazon Web Services account was blocked. For more information, contact /// Amazon Web Services Support. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified platform version doesn't satisfy the required capabilities of the task /// definition. /// /// /// The specified platform version doesn't exist. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified task isn't supported in this Region. /// /// REST API Reference for RunTask Operation public virtual Task RunTaskAsync(RunTaskRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = RunTaskRequestMarshaller.Instance; options.ResponseUnmarshaller = RunTaskResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region StartTask /// /// Starts a new task from the specified task definition on the specified container instance /// or instances. /// /// /// /// Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon /// Elastic Inference (EI), and will help current customers migrate their workloads to /// options that offer better price and performance. After April 15, 2023, new customers /// will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, /// Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once /// during the past 30-day period are considered current customers and will be able to /// continue using the service. /// /// /// /// Alternatively, you can use RunTask to place tasks for you. For more information, /// see Scheduling /// Tasks in the Amazon Elastic Container Service Developer Guide. /// /// /// Container for the necessary parameters to execute the StartTask service method. /// /// The response from the StartTask service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for StartTask Operation public virtual StartTaskResponse StartTask(StartTaskRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = StartTaskRequestMarshaller.Instance; options.ResponseUnmarshaller = StartTaskResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Starts a new task from the specified task definition on the specified container instance /// or instances. /// /// /// /// Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon /// Elastic Inference (EI), and will help current customers migrate their workloads to /// options that offer better price and performance. After April 15, 2023, new customers /// will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, /// Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once /// during the past 30-day period are considered current customers and will be able to /// continue using the service. /// /// /// /// Alternatively, you can use RunTask to place tasks for you. For more information, /// see Scheduling /// Tasks in the Amazon Elastic Container Service Developer Guide. /// /// /// Container for the necessary parameters to execute the StartTask service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the StartTask service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for StartTask Operation public virtual Task StartTaskAsync(StartTaskRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = StartTaskRequestMarshaller.Instance; options.ResponseUnmarshaller = StartTaskResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region StopTask /// /// Stops a running task. Any tags associated with the task will be deleted. /// /// /// /// When StopTask is called on a task, the equivalent of docker stop /// is issued to the containers running in the task. This results in a SIGTERM /// value and a default 30-second timeout, after which the SIGKILL value /// is sent and the containers are forcibly stopped. If the container handles the SIGTERM /// value gracefully and exits within 30 seconds from receiving it, no SIGKILL /// value is sent. /// /// /// /// The default 30-second timeout can be configured on the Amazon ECS container agent /// with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see /// Amazon /// ECS Container Agent Configuration in the Amazon Elastic Container Service Developer /// Guide. /// /// /// /// Container for the necessary parameters to execute the StopTask service method. /// /// The response from the StopTask service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for StopTask Operation public virtual StopTaskResponse StopTask(StopTaskRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = StopTaskRequestMarshaller.Instance; options.ResponseUnmarshaller = StopTaskResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Stops a running task. Any tags associated with the task will be deleted. /// /// /// /// When StopTask is called on a task, the equivalent of docker stop /// is issued to the containers running in the task. This results in a SIGTERM /// value and a default 30-second timeout, after which the SIGKILL value /// is sent and the containers are forcibly stopped. If the container handles the SIGTERM /// value gracefully and exits within 30 seconds from receiving it, no SIGKILL /// value is sent. /// /// /// /// The default 30-second timeout can be configured on the Amazon ECS container agent /// with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see /// Amazon /// ECS Container Agent Configuration in the Amazon Elastic Container Service Developer /// Guide. /// /// /// /// Container for the necessary parameters to execute the StopTask service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the StopTask service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for StopTask Operation public virtual Task StopTaskAsync(StopTaskRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = StopTaskRequestMarshaller.Instance; options.ResponseUnmarshaller = StopTaskResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region SubmitAttachmentStateChanges /// /// /// /// This action is only used by the Amazon ECS agent, and it is not intended for use outside /// of the agent. /// /// /// /// Sent to acknowledge that an attachment changed states. /// /// /// Container for the necessary parameters to execute the SubmitAttachmentStateChanges service method. /// /// The response from the SubmitAttachmentStateChanges service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for SubmitAttachmentStateChanges Operation public virtual SubmitAttachmentStateChangesResponse SubmitAttachmentStateChanges(SubmitAttachmentStateChangesRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = SubmitAttachmentStateChangesRequestMarshaller.Instance; options.ResponseUnmarshaller = SubmitAttachmentStateChangesResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// /// /// This action is only used by the Amazon ECS agent, and it is not intended for use outside /// of the agent. /// /// /// /// Sent to acknowledge that an attachment changed states. /// /// /// Container for the necessary parameters to execute the SubmitAttachmentStateChanges service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the SubmitAttachmentStateChanges service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for SubmitAttachmentStateChanges Operation public virtual Task SubmitAttachmentStateChangesAsync(SubmitAttachmentStateChangesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = SubmitAttachmentStateChangesRequestMarshaller.Instance; options.ResponseUnmarshaller = SubmitAttachmentStateChangesResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region TagResource /// /// Associates the specified tags to a resource with the specified resourceArn. /// 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 associated with that resource /// are deleted as well. /// /// Container for the necessary parameters to execute the TagResource service method. /// /// The response from the TagResource service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified resource wasn't found. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for TagResource Operation public virtual TagResourceResponse TagResource(TagResourceRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = TagResourceRequestMarshaller.Instance; options.ResponseUnmarshaller = TagResourceResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Associates the specified tags to a resource with the specified resourceArn. /// 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 associated with that resource /// are deleted as well. /// /// Container for the necessary parameters to execute the TagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the TagResource service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified resource wasn't found. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for TagResource Operation public virtual Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = TagResourceRequestMarshaller.Instance; options.ResponseUnmarshaller = TagResourceResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region UntagResource /// /// Deletes specified tags from a resource. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// The response from the UntagResource service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified resource wasn't found. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for UntagResource Operation public virtual UntagResourceResponse UntagResource(UntagResourceRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = UntagResourceRequestMarshaller.Instance; options.ResponseUnmarshaller = UntagResourceResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Deletes specified tags from a resource. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UntagResource service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified resource wasn't found. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for UntagResource Operation public virtual Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = UntagResourceRequestMarshaller.Instance; options.ResponseUnmarshaller = UntagResourceResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region UpdateCapacityProvider /// /// Modifies the parameters for a capacity provider. /// /// Container for the necessary parameters to execute the UpdateCapacityProvider service method. /// /// The response from the UpdateCapacityProvider service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for UpdateCapacityProvider Operation public virtual UpdateCapacityProviderResponse UpdateCapacityProvider(UpdateCapacityProviderRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = UpdateCapacityProviderRequestMarshaller.Instance; options.ResponseUnmarshaller = UpdateCapacityProviderResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Modifies the parameters for a capacity provider. /// /// Container for the necessary parameters to execute the UpdateCapacityProvider service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateCapacityProvider service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for UpdateCapacityProvider Operation public virtual Task UpdateCapacityProviderAsync(UpdateCapacityProviderRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = UpdateCapacityProviderRequestMarshaller.Instance; options.ResponseUnmarshaller = UpdateCapacityProviderResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region UpdateCluster /// /// Updates the cluster. /// /// Container for the necessary parameters to execute the UpdateCluster service method. /// /// The response from the UpdateCluster service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified namespace wasn't found. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for UpdateCluster Operation public virtual UpdateClusterResponse UpdateCluster(UpdateClusterRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = UpdateClusterRequestMarshaller.Instance; options.ResponseUnmarshaller = UpdateClusterResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Updates the cluster. /// /// Container for the necessary parameters to execute the UpdateCluster service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateCluster service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified namespace wasn't found. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for UpdateCluster Operation public virtual Task UpdateClusterAsync(UpdateClusterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = UpdateClusterRequestMarshaller.Instance; options.ResponseUnmarshaller = UpdateClusterResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region UpdateClusterSettings /// /// Modifies the settings to use for a cluster. /// /// Container for the necessary parameters to execute the UpdateClusterSettings service method. /// /// The response from the UpdateClusterSettings service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for UpdateClusterSettings Operation public virtual UpdateClusterSettingsResponse UpdateClusterSettings(UpdateClusterSettingsRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = UpdateClusterSettingsRequestMarshaller.Instance; options.ResponseUnmarshaller = UpdateClusterSettingsResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Modifies the settings to use for a cluster. /// /// Container for the necessary parameters to execute the UpdateClusterSettings service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateClusterSettings service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for UpdateClusterSettings Operation public virtual Task UpdateClusterSettingsAsync(UpdateClusterSettingsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = UpdateClusterSettingsRequestMarshaller.Instance; options.ResponseUnmarshaller = UpdateClusterSettingsResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region UpdateContainerAgent /// /// 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 instance was launched with the Amazon ECS-optimized AMI or another /// operating system. /// /// /// /// The UpdateContainerAgent API isn't supported for container instances /// using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container /// agent, you can update the ecs-init package. This updates the agent. For /// more information, see Updating /// the Amazon ECS container agent in the Amazon Elastic Container Service Developer /// Guide. /// /// /// /// Agent updates with the UpdateContainerAgent API operation do not apply /// to Windows container instances. We recommend that you launch new container instances /// to update the agent version in your Windows clusters. /// /// /// /// The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or /// Amazon Linux AMI with the ecs-init service installed and running. For /// help updating the Amazon ECS container agent on other operating systems, see Manually /// updating the Amazon ECS container agent in the Amazon Elastic Container Service /// Developer Guide. /// /// /// Container for the necessary parameters to execute the UpdateContainerAgent service method. /// /// The response from the UpdateContainerAgent service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// Amazon ECS can't determine the current version of the Amazon ECS container agent on /// the container instance and doesn't have enough information to proceed with an update. /// This could be because the agent running on the container instance is a previous or /// custom version that doesn't use our version information. /// /// /// There's no update available for this Amazon ECS container agent. This might be because /// the agent is already running the latest version or because it's so old that there's /// no update path to the current version. /// /// /// These errors are usually caused by a server issue. /// /// /// There's already a current Amazon ECS container agent update in progress on the container /// instance that's specified. If the container agent becomes disconnected while it's /// in a transitional stage, such as PENDING or STAGING, the /// update process can get stuck in that state. However, when the agent reconnects, it /// resumes where it stopped previously. /// /// REST API Reference for UpdateContainerAgent Operation public virtual UpdateContainerAgentResponse UpdateContainerAgent(UpdateContainerAgentRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = UpdateContainerAgentRequestMarshaller.Instance; options.ResponseUnmarshaller = UpdateContainerAgentResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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 instance was launched with the Amazon ECS-optimized AMI or another /// operating system. /// /// /// /// The UpdateContainerAgent API isn't supported for container instances /// using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container /// agent, you can update the ecs-init package. This updates the agent. For /// more information, see Updating /// the Amazon ECS container agent in the Amazon Elastic Container Service Developer /// Guide. /// /// /// /// Agent updates with the UpdateContainerAgent API operation do not apply /// to Windows container instances. We recommend that you launch new container instances /// to update the agent version in your Windows clusters. /// /// /// /// The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or /// Amazon Linux AMI with the ecs-init service installed and running. For /// help updating the Amazon ECS container agent on other operating systems, see Manually /// updating the Amazon ECS container agent in the Amazon Elastic Container Service /// Developer Guide. /// /// /// Container for the necessary parameters to execute the UpdateContainerAgent service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateContainerAgent service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// Amazon ECS can't determine the current version of the Amazon ECS container agent on /// the container instance and doesn't have enough information to proceed with an update. /// This could be because the agent running on the container instance is a previous or /// custom version that doesn't use our version information. /// /// /// There's no update available for this Amazon ECS container agent. This might be because /// the agent is already running the latest version or because it's so old that there's /// no update path to the current version. /// /// /// These errors are usually caused by a server issue. /// /// /// There's already a current Amazon ECS container agent update in progress on the container /// instance that's specified. If the container agent becomes disconnected while it's /// in a transitional stage, such as PENDING or STAGING, the /// update process can get stuck in that state. However, when the agent reconnects, it /// resumes where it stopped previously. /// /// REST API Reference for UpdateContainerAgent Operation public virtual Task UpdateContainerAgentAsync(UpdateContainerAgentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = UpdateContainerAgentRequestMarshaller.Instance; options.ResponseUnmarshaller = UpdateContainerAgentResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region UpdateContainerInstancesState /// /// Modifies the status of an Amazon ECS container instance. /// /// /// /// Once a container instance has reached an ACTIVE state, you can change /// the status of a container instance to DRAINING to manually remove an /// instance from a cluster, for example to perform system updates, update the Docker /// daemon, or scale down the cluster size. /// /// /// /// A container instance can't be changed to DRAINING until it has reached /// an ACTIVE status. If the instance is in any other status, an error will /// be received. /// /// /// /// When you set a container instance to DRAINING, Amazon ECS prevents new /// tasks from being scheduled for placement on the container instance and replacement /// service tasks are started on other container instances in the cluster if the resources /// are available. Service tasks on the container instance that are in the PENDING /// state are stopped immediately. /// /// /// /// Service tasks on the container instance that are in the RUNNING state /// are stopped and replaced according to the service's deployment configuration parameters, /// minimumHealthyPercent and maximumPercent. You can change /// the deployment configuration of your service using UpdateService. /// ///
  • /// /// If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount /// temporarily during task replacement. For example, desiredCount is four /// tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting /// two new tasks. If the minimum is 100%, the service scheduler can't remove existing /// tasks until the replacement tasks are considered healthy. Tasks for services that /// do not use a load balancer are considered healthy if they're in the RUNNING /// state. Tasks for services that use a load balancer are considered healthy if they're /// in the RUNNING state and are reported as healthy by the load balancer. /// ///
  • /// /// The maximumPercent parameter represents an upper limit on the number /// of running tasks during task replacement. You can use this to define the replacement /// batch size. For example, if desiredCount is four tasks, a maximum of /// 200% starts four new tasks before stopping the four tasks to be drained, provided /// that the cluster resources required to do this are available. If the maximum is 100%, /// then replacement tasks can't start until the draining tasks have stopped. /// ///
/// /// Any PENDING or RUNNING tasks that do not belong to a service /// aren't affected. You must wait for them to finish or stop them manually. /// /// /// /// A container instance has completed draining when it has no more RUNNING /// tasks. You can verify this using ListTasks. /// /// /// /// When a container instance has been drained, you can set a container instance to ACTIVE /// status and once it has reached that status the Amazon ECS scheduler can begin scheduling /// tasks on the instance again. /// ///
/// Container for the necessary parameters to execute the UpdateContainerInstancesState service method. /// /// The response from the UpdateContainerInstancesState service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for UpdateContainerInstancesState Operation public virtual UpdateContainerInstancesStateResponse UpdateContainerInstancesState(UpdateContainerInstancesStateRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = UpdateContainerInstancesStateRequestMarshaller.Instance; options.ResponseUnmarshaller = UpdateContainerInstancesStateResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Modifies the status of an Amazon ECS container instance. /// /// /// /// Once a container instance has reached an ACTIVE state, you can change /// the status of a container instance to DRAINING to manually remove an /// instance from a cluster, for example to perform system updates, update the Docker /// daemon, or scale down the cluster size. /// /// /// /// A container instance can't be changed to DRAINING until it has reached /// an ACTIVE status. If the instance is in any other status, an error will /// be received. /// /// /// /// When you set a container instance to DRAINING, Amazon ECS prevents new /// tasks from being scheduled for placement on the container instance and replacement /// service tasks are started on other container instances in the cluster if the resources /// are available. Service tasks on the container instance that are in the PENDING /// state are stopped immediately. /// /// /// /// Service tasks on the container instance that are in the RUNNING state /// are stopped and replaced according to the service's deployment configuration parameters, /// minimumHealthyPercent and maximumPercent. You can change /// the deployment configuration of your service using UpdateService. /// ///
  • /// /// If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount /// temporarily during task replacement. For example, desiredCount is four /// tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting /// two new tasks. If the minimum is 100%, the service scheduler can't remove existing /// tasks until the replacement tasks are considered healthy. Tasks for services that /// do not use a load balancer are considered healthy if they're in the RUNNING /// state. Tasks for services that use a load balancer are considered healthy if they're /// in the RUNNING state and are reported as healthy by the load balancer. /// ///
  • /// /// The maximumPercent parameter represents an upper limit on the number /// of running tasks during task replacement. You can use this to define the replacement /// batch size. For example, if desiredCount is four tasks, a maximum of /// 200% starts four new tasks before stopping the four tasks to be drained, provided /// that the cluster resources required to do this are available. If the maximum is 100%, /// then replacement tasks can't start until the draining tasks have stopped. /// ///
/// /// Any PENDING or RUNNING tasks that do not belong to a service /// aren't affected. You must wait for them to finish or stop them manually. /// /// /// /// A container instance has completed draining when it has no more RUNNING /// tasks. You can verify this using ListTasks. /// /// /// /// When a container instance has been drained, you can set a container instance to ACTIVE /// status and once it has reached that status the Amazon ECS scheduler can begin scheduling /// tasks on the instance again. /// ///
/// Container for the necessary parameters to execute the UpdateContainerInstancesState service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateContainerInstancesState service method, as returned by ECS. /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for UpdateContainerInstancesState Operation public virtual Task UpdateContainerInstancesStateAsync(UpdateContainerInstancesStateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = UpdateContainerInstancesStateRequestMarshaller.Instance; options.ResponseUnmarshaller = UpdateContainerInstancesStateResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region UpdateService /// /// Modifies the parameters of a service. /// /// /// /// For services using the rolling update (ECS) you can update the desired /// count, deployment configuration, network configuration, load balancers, service registries, /// enable ECS managed tags option, propagate tags option, task placement constraints /// and strategies, and task definition. When you update any of these parameters, Amazon /// ECS starts new tasks with the new configuration. /// /// /// /// For services using the blue/green (CODE_DEPLOY) deployment controller, /// only the desired count, deployment configuration, health check grace period, task /// placement constraints and strategies, enable ECS managed tags option, and propagate /// tags can be updated using this API. If the network configuration, platform version, /// task definition, or load balancer need to be updated, create a new CodeDeploy deployment. /// For more information, see CreateDeployment /// in the CodeDeploy API Reference. /// /// /// /// For services using an external deployment controller, you can update only the desired /// count, task placement constraints and strategies, health check grace period, enable /// ECS managed tags option, and propagate tags option, using this API. If the launch /// type, load balancer, network configuration, platform version, or task definition need /// to be updated, create a new task set For more information, see CreateTaskSet. /// /// /// /// You can add to or subtract from the number of instantiations of a task definition /// in a service by specifying the cluster that the service is running in and a new desiredCount /// parameter. /// /// /// /// If you have updated the Docker image of your application, you can create a new task /// definition with that image and deploy it to your service. The service scheduler uses /// the minimum healthy percent and maximum percent parameters (in the service's deployment /// configuration) to determine the deployment strategy. /// /// /// /// If your updated Docker image uses the same tag as what is in the existing task definition /// for your service (for example, my_image:latest), you don't need to create /// a new revision of your task definition. You can update the service using the forceNewDeployment /// option. The new tasks launched by the deployment pull the current image/tag combination /// from your repository when they start. /// /// /// /// You can also update the deployment configuration of a service. When a deployment is /// triggered by updating the task definition of a service, the service scheduler uses /// the deployment configuration parameters, minimumHealthyPercent and maximumPercent, /// to determine the deployment strategy. /// ///
  • /// /// If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount /// temporarily during a deployment. For example, if desiredCount is four /// tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting /// two new tasks. Tasks for services that don't use a load balancer are considered healthy /// if they're in the RUNNING state. Tasks for services that use a load balancer /// are considered healthy if they're in the RUNNING state and are reported /// as healthy by the load balancer. /// ///
  • /// /// The maximumPercent parameter represents an upper limit on the number /// of running tasks during a deployment. You can use it to define the deployment batch /// size. For example, if desiredCount is four tasks, a maximum of 200% starts /// four new tasks before stopping the four older tasks (provided that the cluster resources /// required to do this are available). /// ///
/// /// When UpdateService stops a task during a deployment, the equivalent of docker /// stop is issued to the containers running in the task. This results in a SIGTERM /// and a 30-second timeout. After this, SIGKILL is sent and the containers /// are forcibly stopped. If the container handles the SIGTERM gracefully /// and exits within 30 seconds from receiving it, no SIGKILL is sent. /// /// /// /// When the service scheduler launches new tasks, it determines task placement in your /// cluster with the following logic. /// ///
  • /// /// Determine which of the container instances in your cluster can support your service's /// task definition. For example, they have the required CPU, memory, ports, and container /// instance attributes. /// ///
  • /// /// By default, the service scheduler attempts to balance tasks across Availability Zones /// in this manner even though you can choose a different placement strategy. /// ///
    • /// /// Sort the valid container instances by the fewest number of running tasks for this /// service in the same Availability Zone as the instance. For example, if zone A has /// one running service task and zones B and C each have zero, valid container instances /// in either zone B or C are considered optimal for placement. /// ///
    • /// /// Place the new service task on a valid container instance in an optimal Availability /// Zone (based on the previous steps), favoring container instances with the fewest number /// of running tasks for this service. /// ///
/// /// When the service scheduler stops running tasks, it attempts to maintain balance across /// the Availability Zones in your cluster using the following logic: /// ///
  • /// /// Sort the container instances by the largest number of running tasks for this service /// in the same Availability Zone as the instance. For example, if zone A has one running /// service task and zones B and C each have two, container instances in either zone B /// or C are considered optimal for termination. /// ///
  • /// /// Stop the task on a container instance in an optimal Availability Zone (based on the /// previous steps), favoring container instances with the largest number of running tasks /// for this service. /// ///
/// /// You must have a service-linked role when you update any of the following service properties. /// If you specified a custom role when you created the service, Amazon ECS automatically /// replaces the roleARN /// associated with the service with the ARN of your service-linked role. For more information, /// see Service-linked /// roles in the Amazon Elastic Container Service Developer Guide. /// ///
  • /// /// loadBalancers, /// ///
  • /// /// serviceRegistries /// ///
///
/// Container for the necessary parameters to execute the UpdateService service method. /// /// The response from the UpdateService service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified namespace wasn't found. /// /// /// The specified platform version doesn't satisfy the required capabilities of the task /// definition. /// /// /// The specified platform version doesn't exist. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified service isn't active. You can't update a service that's inactive. If /// you have previously deleted a service, you can re-create it with CreateService. /// /// /// The specified service wasn't found. You can view your available services with ListServices. /// Amazon ECS services are cluster specific and Region specific. /// /// REST API Reference for UpdateService Operation public virtual UpdateServiceResponse UpdateService(UpdateServiceRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = UpdateServiceRequestMarshaller.Instance; options.ResponseUnmarshaller = UpdateServiceResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Modifies the parameters of a service. /// /// /// /// For services using the rolling update (ECS) you can update the desired /// count, deployment configuration, network configuration, load balancers, service registries, /// enable ECS managed tags option, propagate tags option, task placement constraints /// and strategies, and task definition. When you update any of these parameters, Amazon /// ECS starts new tasks with the new configuration. /// /// /// /// For services using the blue/green (CODE_DEPLOY) deployment controller, /// only the desired count, deployment configuration, health check grace period, task /// placement constraints and strategies, enable ECS managed tags option, and propagate /// tags can be updated using this API. If the network configuration, platform version, /// task definition, or load balancer need to be updated, create a new CodeDeploy deployment. /// For more information, see CreateDeployment /// in the CodeDeploy API Reference. /// /// /// /// For services using an external deployment controller, you can update only the desired /// count, task placement constraints and strategies, health check grace period, enable /// ECS managed tags option, and propagate tags option, using this API. If the launch /// type, load balancer, network configuration, platform version, or task definition need /// to be updated, create a new task set For more information, see CreateTaskSet. /// /// /// /// You can add to or subtract from the number of instantiations of a task definition /// in a service by specifying the cluster that the service is running in and a new desiredCount /// parameter. /// /// /// /// If you have updated the Docker image of your application, you can create a new task /// definition with that image and deploy it to your service. The service scheduler uses /// the minimum healthy percent and maximum percent parameters (in the service's deployment /// configuration) to determine the deployment strategy. /// /// /// /// If your updated Docker image uses the same tag as what is in the existing task definition /// for your service (for example, my_image:latest), you don't need to create /// a new revision of your task definition. You can update the service using the forceNewDeployment /// option. The new tasks launched by the deployment pull the current image/tag combination /// from your repository when they start. /// /// /// /// You can also update the deployment configuration of a service. When a deployment is /// triggered by updating the task definition of a service, the service scheduler uses /// the deployment configuration parameters, minimumHealthyPercent and maximumPercent, /// to determine the deployment strategy. /// ///
  • /// /// If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount /// temporarily during a deployment. For example, if desiredCount is four /// tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting /// two new tasks. Tasks for services that don't use a load balancer are considered healthy /// if they're in the RUNNING state. Tasks for services that use a load balancer /// are considered healthy if they're in the RUNNING state and are reported /// as healthy by the load balancer. /// ///
  • /// /// The maximumPercent parameter represents an upper limit on the number /// of running tasks during a deployment. You can use it to define the deployment batch /// size. For example, if desiredCount is four tasks, a maximum of 200% starts /// four new tasks before stopping the four older tasks (provided that the cluster resources /// required to do this are available). /// ///
/// /// When UpdateService stops a task during a deployment, the equivalent of docker /// stop is issued to the containers running in the task. This results in a SIGTERM /// and a 30-second timeout. After this, SIGKILL is sent and the containers /// are forcibly stopped. If the container handles the SIGTERM gracefully /// and exits within 30 seconds from receiving it, no SIGKILL is sent. /// /// /// /// When the service scheduler launches new tasks, it determines task placement in your /// cluster with the following logic. /// ///
  • /// /// Determine which of the container instances in your cluster can support your service's /// task definition. For example, they have the required CPU, memory, ports, and container /// instance attributes. /// ///
  • /// /// By default, the service scheduler attempts to balance tasks across Availability Zones /// in this manner even though you can choose a different placement strategy. /// ///
    • /// /// Sort the valid container instances by the fewest number of running tasks for this /// service in the same Availability Zone as the instance. For example, if zone A has /// one running service task and zones B and C each have zero, valid container instances /// in either zone B or C are considered optimal for placement. /// ///
    • /// /// Place the new service task on a valid container instance in an optimal Availability /// Zone (based on the previous steps), favoring container instances with the fewest number /// of running tasks for this service. /// ///
/// /// When the service scheduler stops running tasks, it attempts to maintain balance across /// the Availability Zones in your cluster using the following logic: /// ///
  • /// /// Sort the container instances by the largest number of running tasks for this service /// in the same Availability Zone as the instance. For example, if zone A has one running /// service task and zones B and C each have two, container instances in either zone B /// or C are considered optimal for termination. /// ///
  • /// /// Stop the task on a container instance in an optimal Availability Zone (based on the /// previous steps), favoring container instances with the largest number of running tasks /// for this service. /// ///
/// /// You must have a service-linked role when you update any of the following service properties. /// If you specified a custom role when you created the service, Amazon ECS automatically /// replaces the roleARN /// associated with the service with the ARN of your service-linked role. For more information, /// see Service-linked /// roles in the Amazon Elastic Container Service Developer Guide. /// ///
  • /// /// loadBalancers, /// ///
  • /// /// serviceRegistries /// ///
///
/// Container for the necessary parameters to execute the UpdateService service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateService service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified namespace wasn't found. /// /// /// The specified platform version doesn't satisfy the required capabilities of the task /// definition. /// /// /// The specified platform version doesn't exist. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified service isn't active. You can't update a service that's inactive. If /// you have previously deleted a service, you can re-create it with CreateService. /// /// /// The specified service wasn't found. You can view your available services with ListServices. /// Amazon ECS services are cluster specific and Region specific. /// /// REST API Reference for UpdateService Operation public virtual Task UpdateServiceAsync(UpdateServiceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = UpdateServiceRequestMarshaller.Instance; options.ResponseUnmarshaller = UpdateServiceResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region UpdateServicePrimaryTaskSet /// /// 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 EXTERNAL deployment controller type. /// For more information, see Amazon /// ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. /// /// Container for the necessary parameters to execute the UpdateServicePrimaryTaskSet service method. /// /// The response from the UpdateServicePrimaryTaskSet service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified service isn't active. You can't update a service that's inactive. If /// you have previously deleted a service, you can re-create it with CreateService. /// /// /// The specified service wasn't found. You can view your available services with ListServices. /// Amazon ECS services are cluster specific and Region specific. /// /// /// The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. /// Task sets are specific to each cluster, service and Region. /// /// /// The specified task isn't supported in this Region. /// /// REST API Reference for UpdateServicePrimaryTaskSet Operation public virtual UpdateServicePrimaryTaskSetResponse UpdateServicePrimaryTaskSet(UpdateServicePrimaryTaskSetRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = UpdateServicePrimaryTaskSetRequestMarshaller.Instance; options.ResponseUnmarshaller = UpdateServicePrimaryTaskSetResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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 EXTERNAL deployment controller type. /// For more information, see Amazon /// ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. /// /// Container for the necessary parameters to execute the UpdateServicePrimaryTaskSet service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateServicePrimaryTaskSet service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified service isn't active. You can't update a service that's inactive. If /// you have previously deleted a service, you can re-create it with CreateService. /// /// /// The specified service wasn't found. You can view your available services with ListServices. /// Amazon ECS services are cluster specific and Region specific. /// /// /// The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. /// Task sets are specific to each cluster, service and Region. /// /// /// The specified task isn't supported in this Region. /// /// REST API Reference for UpdateServicePrimaryTaskSet Operation public virtual Task UpdateServicePrimaryTaskSetAsync(UpdateServicePrimaryTaskSetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = UpdateServicePrimaryTaskSetRequestMarshaller.Instance; options.ResponseUnmarshaller = UpdateServicePrimaryTaskSetResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region UpdateTaskProtection /// /// Updates the protection status of a task. You can set protectionEnabled /// to true to protect your task from termination during scale-in events /// from Service /// Autoscaling or deployments. /// /// /// /// Task-protection, by default, expires after 2 hours at which point Amazon ECS clears /// the protectionEnabled property making the task eligible for termination /// by a subsequent scale-in event. /// /// /// /// You can specify a custom expiration period for task protection from 1 minute to up /// to 2,880 minutes (48 hours). To specify the custom expiration period, set the expiresInMinutes /// property. The expiresInMinutes property is always reset when you invoke /// this operation for a task that already has protectionEnabled set to true. /// You can keep extending the protection expiration period of a task by invoking this /// operation repeatedly. /// /// /// /// To learn more about Amazon ECS task protection, see Task /// scale-in protection in the Amazon Elastic Container Service Developer Guide /// . /// /// /// /// This operation is only supported for tasks belonging to an Amazon ECS service. Invoking /// this operation for a standalone task will result in an TASK_NOT_VALID /// failure. For more information, see API /// failure reasons. /// /// /// /// If you prefer to set task protection from within the container, we recommend using /// the Task /// scale-in protection endpoint. /// /// /// /// Container for the necessary parameters to execute the UpdateTaskProtection service method. /// /// The response from the UpdateTaskProtection service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified resource wasn't found. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified task isn't supported in this Region. /// /// REST API Reference for UpdateTaskProtection Operation public virtual UpdateTaskProtectionResponse UpdateTaskProtection(UpdateTaskProtectionRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = UpdateTaskProtectionRequestMarshaller.Instance; options.ResponseUnmarshaller = UpdateTaskProtectionResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Updates the protection status of a task. You can set protectionEnabled /// to true to protect your task from termination during scale-in events /// from Service /// Autoscaling or deployments. /// /// /// /// Task-protection, by default, expires after 2 hours at which point Amazon ECS clears /// the protectionEnabled property making the task eligible for termination /// by a subsequent scale-in event. /// /// /// /// You can specify a custom expiration period for task protection from 1 minute to up /// to 2,880 minutes (48 hours). To specify the custom expiration period, set the expiresInMinutes /// property. The expiresInMinutes property is always reset when you invoke /// this operation for a task that already has protectionEnabled set to true. /// You can keep extending the protection expiration period of a task by invoking this /// operation repeatedly. /// /// /// /// To learn more about Amazon ECS task protection, see Task /// scale-in protection in the Amazon Elastic Container Service Developer Guide /// . /// /// /// /// This operation is only supported for tasks belonging to an Amazon ECS service. Invoking /// this operation for a standalone task will result in an TASK_NOT_VALID /// failure. For more information, see API /// failure reasons. /// /// /// /// If you prefer to set task protection from within the container, we recommend using /// the Task /// scale-in protection endpoint. /// /// /// /// Container for the necessary parameters to execute the UpdateTaskProtection service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateTaskProtection service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// The specified resource wasn't found. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified task isn't supported in this Region. /// /// REST API Reference for UpdateTaskProtection Operation public virtual Task UpdateTaskProtectionAsync(UpdateTaskProtectionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = UpdateTaskProtectionRequestMarshaller.Instance; options.ResponseUnmarshaller = UpdateTaskProtectionResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region UpdateTaskSet /// /// Modifies a task set. This is used when a service uses the EXTERNAL deployment /// controller type. For more information, see Amazon /// ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. /// /// Container for the necessary parameters to execute the UpdateTaskSet service method. /// /// The response from the UpdateTaskSet service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified service isn't active. You can't update a service that's inactive. If /// you have previously deleted a service, you can re-create it with CreateService. /// /// /// The specified service wasn't found. You can view your available services with ListServices. /// Amazon ECS services are cluster specific and Region specific. /// /// /// The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. /// Task sets are specific to each cluster, service and Region. /// /// /// The specified task isn't supported in this Region. /// /// REST API Reference for UpdateTaskSet Operation public virtual UpdateTaskSetResponse UpdateTaskSet(UpdateTaskSetRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = UpdateTaskSetRequestMarshaller.Instance; options.ResponseUnmarshaller = UpdateTaskSetResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Modifies a task set. This is used when a service uses the EXTERNAL deployment /// controller type. For more information, see Amazon /// ECS Deployment Types in the Amazon Elastic Container Service Developer Guide. /// /// Container for the necessary parameters to execute the UpdateTaskSet service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateTaskSet service method, as returned by ECS. /// /// You don't have authorization to perform the requested action. /// /// /// These errors are usually caused by a client action. This client action might be using /// an action or resource on behalf of a user that doesn't have permissions to use the /// action or resource,. Or, it might be specifying an identifier that isn't valid. /// /// /// The specified cluster wasn't found. You can view your available clusters with ListClusters. /// Amazon ECS clusters are Region specific. /// /// /// The specified parameter isn't valid. Review the available parameters for the API request. /// /// /// These errors are usually caused by a server issue. /// /// /// The specified service isn't active. You can't update a service that's inactive. If /// you have previously deleted a service, you can re-create it with CreateService. /// /// /// The specified service wasn't found. You can view your available services with ListServices. /// Amazon ECS services are cluster specific and Region specific. /// /// /// The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. /// Task sets are specific to each cluster, service and Region. /// /// /// The specified task isn't supported in this Region. /// /// REST API Reference for UpdateTaskSet Operation public virtual Task UpdateTaskSetAsync(UpdateTaskSetRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = UpdateTaskSetRequestMarshaller.Instance; options.ResponseUnmarshaller = UpdateTaskSetResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion } }