Interface EcsClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic EcsClientBuilder
builder()
Create a builder that can be used to configure and create aEcsClient
.static EcsClient
create()
Create aEcsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateCapacityProviderResponse
createCapacityProvider
(Consumer<CreateCapacityProviderRequest.Builder> createCapacityProviderRequest) Creates a new capacity provider.default CreateCapacityProviderResponse
createCapacityProvider
(CreateCapacityProviderRequest createCapacityProviderRequest) Creates a new capacity provider.default CreateClusterResponse
Creates a new Amazon ECS cluster.default CreateClusterResponse
createCluster
(Consumer<CreateClusterRequest.Builder> createClusterRequest) Creates a new Amazon ECS cluster.default CreateClusterResponse
createCluster
(CreateClusterRequest createClusterRequest) Creates a new Amazon ECS cluster.default CreateServiceResponse
createService
(Consumer<CreateServiceRequest.Builder> createServiceRequest) Runs and maintains your desired number of tasks from a specified task definition.default CreateServiceResponse
createService
(CreateServiceRequest createServiceRequest) Runs and maintains your desired number of tasks from a specified task definition.default CreateTaskSetResponse
createTaskSet
(Consumer<CreateTaskSetRequest.Builder> createTaskSetRequest) Create a task set in the specified cluster and service.default CreateTaskSetResponse
createTaskSet
(CreateTaskSetRequest createTaskSetRequest) Create a task set in the specified cluster and service.default DeleteAccountSettingResponse
deleteAccountSetting
(Consumer<DeleteAccountSettingRequest.Builder> deleteAccountSettingRequest) Disables an account setting for a specified user, role, or the root user for an account.default DeleteAccountSettingResponse
deleteAccountSetting
(DeleteAccountSettingRequest deleteAccountSettingRequest) Disables an account setting for a specified user, role, or the root user for an account.default DeleteAttributesResponse
deleteAttributes
(Consumer<DeleteAttributesRequest.Builder> deleteAttributesRequest) Deletes one or more custom attributes from an Amazon ECS resource.default DeleteAttributesResponse
deleteAttributes
(DeleteAttributesRequest deleteAttributesRequest) Deletes one or more custom attributes from an Amazon ECS resource.default DeleteCapacityProviderResponse
deleteCapacityProvider
(Consumer<DeleteCapacityProviderRequest.Builder> deleteCapacityProviderRequest) Deletes the specified capacity provider.default DeleteCapacityProviderResponse
deleteCapacityProvider
(DeleteCapacityProviderRequest deleteCapacityProviderRequest) Deletes the specified capacity provider.default DeleteClusterResponse
deleteCluster
(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) Deletes the specified cluster.default DeleteClusterResponse
deleteCluster
(DeleteClusterRequest deleteClusterRequest) Deletes the specified cluster.default DeleteServiceResponse
deleteService
(Consumer<DeleteServiceRequest.Builder> deleteServiceRequest) Deletes a specified service within a cluster.default DeleteServiceResponse
deleteService
(DeleteServiceRequest deleteServiceRequest) Deletes a specified service within a cluster.default DeleteTaskDefinitionsResponse
deleteTaskDefinitions
(Consumer<DeleteTaskDefinitionsRequest.Builder> deleteTaskDefinitionsRequest) Deletes one or more task definitions.default DeleteTaskDefinitionsResponse
deleteTaskDefinitions
(DeleteTaskDefinitionsRequest deleteTaskDefinitionsRequest) Deletes one or more task definitions.default DeleteTaskSetResponse
deleteTaskSet
(Consumer<DeleteTaskSetRequest.Builder> deleteTaskSetRequest) Deletes a specified task set within a service.default DeleteTaskSetResponse
deleteTaskSet
(DeleteTaskSetRequest deleteTaskSetRequest) Deletes a specified task set within a service.deregisterContainerInstance
(Consumer<DeregisterContainerInstanceRequest.Builder> deregisterContainerInstanceRequest) Deregisters an Amazon ECS container instance from the specified cluster.deregisterContainerInstance
(DeregisterContainerInstanceRequest deregisterContainerInstanceRequest) Deregisters an Amazon ECS container instance from the specified cluster.default DeregisterTaskDefinitionResponse
deregisterTaskDefinition
(Consumer<DeregisterTaskDefinitionRequest.Builder> deregisterTaskDefinitionRequest) Deregisters the specified task definition by family and revision.default DeregisterTaskDefinitionResponse
deregisterTaskDefinition
(DeregisterTaskDefinitionRequest deregisterTaskDefinitionRequest) Deregisters the specified task definition by family and revision.describeCapacityProviders
(Consumer<DescribeCapacityProvidersRequest.Builder> describeCapacityProvidersRequest) Describes one or more of your capacity providers.describeCapacityProviders
(DescribeCapacityProvidersRequest describeCapacityProvidersRequest) Describes one or more of your capacity providers.default DescribeClustersResponse
Describes one or more of your clusters.default DescribeClustersResponse
describeClusters
(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) Describes one or more of your clusters.default DescribeClustersResponse
describeClusters
(DescribeClustersRequest describeClustersRequest) Describes one or more of your clusters.describeContainerInstances
(Consumer<DescribeContainerInstancesRequest.Builder> describeContainerInstancesRequest) Describes one or more container instances.describeContainerInstances
(DescribeContainerInstancesRequest describeContainerInstancesRequest) Describes one or more container instances.default DescribeServicesResponse
describeServices
(Consumer<DescribeServicesRequest.Builder> describeServicesRequest) Describes the specified services running in your cluster.default DescribeServicesResponse
describeServices
(DescribeServicesRequest describeServicesRequest) Describes the specified services running in your cluster.default DescribeTaskDefinitionResponse
describeTaskDefinition
(Consumer<DescribeTaskDefinitionRequest.Builder> describeTaskDefinitionRequest) Describes a task definition.default DescribeTaskDefinitionResponse
describeTaskDefinition
(DescribeTaskDefinitionRequest describeTaskDefinitionRequest) Describes a task definition.default DescribeTasksResponse
describeTasks
(Consumer<DescribeTasksRequest.Builder> describeTasksRequest) Describes a specified task or tasks.default DescribeTasksResponse
describeTasks
(DescribeTasksRequest describeTasksRequest) Describes a specified task or tasks.default DescribeTaskSetsResponse
describeTaskSets
(Consumer<DescribeTaskSetsRequest.Builder> describeTaskSetsRequest) Describes the task sets in the specified cluster and service.default DescribeTaskSetsResponse
describeTaskSets
(DescribeTaskSetsRequest describeTaskSetsRequest) Describes the task sets in the specified cluster and service.default DiscoverPollEndpointResponse
discoverPollEndpoint
(Consumer<DiscoverPollEndpointRequest.Builder> discoverPollEndpointRequest) default DiscoverPollEndpointResponse
discoverPollEndpoint
(DiscoverPollEndpointRequest discoverPollEndpointRequest) default ExecuteCommandResponse
executeCommand
(Consumer<ExecuteCommandRequest.Builder> executeCommandRequest) Runs a command remotely on a container within a task.default ExecuteCommandResponse
executeCommand
(ExecuteCommandRequest executeCommandRequest) Runs a command remotely on a container within a task.default GetTaskProtectionResponse
getTaskProtection
(Consumer<GetTaskProtectionRequest.Builder> getTaskProtectionRequest) Retrieves the protection status of tasks in an Amazon ECS service.default GetTaskProtectionResponse
getTaskProtection
(GetTaskProtectionRequest getTaskProtectionRequest) Retrieves the protection status of tasks in an Amazon ECS service.default ListAccountSettingsResponse
Lists the account settings for a specified principal.default ListAccountSettingsResponse
listAccountSettings
(Consumer<ListAccountSettingsRequest.Builder> listAccountSettingsRequest) Lists the account settings for a specified principal.default ListAccountSettingsResponse
listAccountSettings
(ListAccountSettingsRequest listAccountSettingsRequest) Lists the account settings for a specified principal.default ListAccountSettingsIterable
This is a variant oflistAccountSettings(software.amazon.awssdk.services.ecs.model.ListAccountSettingsRequest)
operation.default ListAccountSettingsIterable
listAccountSettingsPaginator
(Consumer<ListAccountSettingsRequest.Builder> listAccountSettingsRequest) This is a variant oflistAccountSettings(software.amazon.awssdk.services.ecs.model.ListAccountSettingsRequest)
operation.default ListAccountSettingsIterable
listAccountSettingsPaginator
(ListAccountSettingsRequest listAccountSettingsRequest) This is a variant oflistAccountSettings(software.amazon.awssdk.services.ecs.model.ListAccountSettingsRequest)
operation.default ListAttributesResponse
listAttributes
(Consumer<ListAttributesRequest.Builder> listAttributesRequest) Lists the attributes for Amazon ECS resources within a specified target type and cluster.default ListAttributesResponse
listAttributes
(ListAttributesRequest listAttributesRequest) Lists the attributes for Amazon ECS resources within a specified target type and cluster.default ListAttributesIterable
listAttributesPaginator
(Consumer<ListAttributesRequest.Builder> listAttributesRequest) This is a variant oflistAttributes(software.amazon.awssdk.services.ecs.model.ListAttributesRequest)
operation.default ListAttributesIterable
listAttributesPaginator
(ListAttributesRequest listAttributesRequest) This is a variant oflistAttributes(software.amazon.awssdk.services.ecs.model.ListAttributesRequest)
operation.default ListClustersResponse
Returns a list of existing clusters.default ListClustersResponse
listClusters
(Consumer<ListClustersRequest.Builder> listClustersRequest) Returns a list of existing clusters.default ListClustersResponse
listClusters
(ListClustersRequest listClustersRequest) Returns a list of existing clusters.default ListClustersIterable
This is a variant oflistClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation.default ListClustersIterable
listClustersPaginator
(Consumer<ListClustersRequest.Builder> listClustersRequest) This is a variant oflistClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation.default ListClustersIterable
listClustersPaginator
(ListClustersRequest listClustersRequest) This is a variant oflistClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation.default ListContainerInstancesResponse
Returns a list of container instances in a specified cluster.default ListContainerInstancesResponse
listContainerInstances
(Consumer<ListContainerInstancesRequest.Builder> listContainerInstancesRequest) Returns a list of container instances in a specified cluster.default ListContainerInstancesResponse
listContainerInstances
(ListContainerInstancesRequest listContainerInstancesRequest) Returns a list of container instances in a specified cluster.default ListContainerInstancesIterable
This is a variant oflistContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation.default ListContainerInstancesIterable
listContainerInstancesPaginator
(Consumer<ListContainerInstancesRequest.Builder> listContainerInstancesRequest) This is a variant oflistContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation.default ListContainerInstancesIterable
listContainerInstancesPaginator
(ListContainerInstancesRequest listContainerInstancesRequest) This is a variant oflistContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation.default ListServicesResponse
Returns a list of services.default ListServicesResponse
listServices
(Consumer<ListServicesRequest.Builder> listServicesRequest) Returns a list of services.default ListServicesResponse
listServices
(ListServicesRequest listServicesRequest) Returns a list of services.default ListServicesByNamespaceResponse
listServicesByNamespace
(Consumer<ListServicesByNamespaceRequest.Builder> listServicesByNamespaceRequest) This operation lists all of the services that are associated with a Cloud Map namespace.default ListServicesByNamespaceResponse
listServicesByNamespace
(ListServicesByNamespaceRequest listServicesByNamespaceRequest) This operation lists all of the services that are associated with a Cloud Map namespace.default ListServicesByNamespaceIterable
listServicesByNamespacePaginator
(Consumer<ListServicesByNamespaceRequest.Builder> listServicesByNamespaceRequest) This is a variant oflistServicesByNamespace(software.amazon.awssdk.services.ecs.model.ListServicesByNamespaceRequest)
operation.default ListServicesByNamespaceIterable
listServicesByNamespacePaginator
(ListServicesByNamespaceRequest listServicesByNamespaceRequest) This is a variant oflistServicesByNamespace(software.amazon.awssdk.services.ecs.model.ListServicesByNamespaceRequest)
operation.default ListServicesIterable
This is a variant oflistServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation.default ListServicesIterable
listServicesPaginator
(Consumer<ListServicesRequest.Builder> listServicesRequest) This is a variant oflistServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation.default ListServicesIterable
listServicesPaginator
(ListServicesRequest listServicesRequest) This is a variant oflistServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List the tags for an Amazon ECS resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List the tags for an Amazon ECS resource.Returns a list of task definition families that are registered to your account.listTaskDefinitionFamilies
(Consumer<ListTaskDefinitionFamiliesRequest.Builder> listTaskDefinitionFamiliesRequest) Returns a list of task definition families that are registered to your account.listTaskDefinitionFamilies
(ListTaskDefinitionFamiliesRequest listTaskDefinitionFamiliesRequest) Returns a list of task definition families that are registered to your account.This is a variant oflistTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation.listTaskDefinitionFamiliesPaginator
(Consumer<ListTaskDefinitionFamiliesRequest.Builder> listTaskDefinitionFamiliesRequest) This is a variant oflistTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation.listTaskDefinitionFamiliesPaginator
(ListTaskDefinitionFamiliesRequest listTaskDefinitionFamiliesRequest) This is a variant oflistTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation.default ListTaskDefinitionsResponse
Returns a list of task definitions that are registered to your account.default ListTaskDefinitionsResponse
listTaskDefinitions
(Consumer<ListTaskDefinitionsRequest.Builder> listTaskDefinitionsRequest) Returns a list of task definitions that are registered to your account.default ListTaskDefinitionsResponse
listTaskDefinitions
(ListTaskDefinitionsRequest listTaskDefinitionsRequest) Returns a list of task definitions that are registered to your account.default ListTaskDefinitionsIterable
This is a variant oflistTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation.default ListTaskDefinitionsIterable
listTaskDefinitionsPaginator
(Consumer<ListTaskDefinitionsRequest.Builder> listTaskDefinitionsRequest) This is a variant oflistTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation.default ListTaskDefinitionsIterable
listTaskDefinitionsPaginator
(ListTaskDefinitionsRequest listTaskDefinitionsRequest) This is a variant oflistTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation.default ListTasksResponse
Returns a list of tasks.default ListTasksResponse
listTasks
(Consumer<ListTasksRequest.Builder> listTasksRequest) Returns a list of tasks.default ListTasksResponse
listTasks
(ListTasksRequest listTasksRequest) Returns a list of tasks.default ListTasksIterable
This is a variant oflistTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation.default ListTasksIterable
listTasksPaginator
(Consumer<ListTasksRequest.Builder> listTasksRequest) This is a variant oflistTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation.default ListTasksIterable
listTasksPaginator
(ListTasksRequest listTasksRequest) This is a variant oflistTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation.default PutAccountSettingResponse
putAccountSetting
(Consumer<PutAccountSettingRequest.Builder> putAccountSettingRequest) Modifies an account setting.default PutAccountSettingResponse
putAccountSetting
(PutAccountSettingRequest putAccountSettingRequest) Modifies an account setting.default PutAccountSettingDefaultResponse
putAccountSettingDefault
(Consumer<PutAccountSettingDefaultRequest.Builder> putAccountSettingDefaultRequest) Modifies an account setting for all users on an account for whom no individual account setting has been specified.default PutAccountSettingDefaultResponse
putAccountSettingDefault
(PutAccountSettingDefaultRequest putAccountSettingDefaultRequest) Modifies an account setting for all users on an account for whom no individual account setting has been specified.default PutAttributesResponse
putAttributes
(Consumer<PutAttributesRequest.Builder> putAttributesRequest) Create or update an attribute on an Amazon ECS resource.default PutAttributesResponse
putAttributes
(PutAttributesRequest putAttributesRequest) Create or update an attribute on an Amazon ECS resource.putClusterCapacityProviders
(Consumer<PutClusterCapacityProvidersRequest.Builder> putClusterCapacityProvidersRequest) Modifies the available capacity providers and the default capacity provider strategy for a cluster.putClusterCapacityProviders
(PutClusterCapacityProvidersRequest putClusterCapacityProvidersRequest) Modifies the available capacity providers and the default capacity provider strategy for a cluster.registerContainerInstance
(Consumer<RegisterContainerInstanceRequest.Builder> registerContainerInstanceRequest) registerContainerInstance
(RegisterContainerInstanceRequest registerContainerInstanceRequest) default RegisterTaskDefinitionResponse
registerTaskDefinition
(Consumer<RegisterTaskDefinitionRequest.Builder> registerTaskDefinitionRequest) Registers a new task definition from the suppliedfamily
andcontainerDefinitions
.default RegisterTaskDefinitionResponse
registerTaskDefinition
(RegisterTaskDefinitionRequest registerTaskDefinitionRequest) Registers a new task definition from the suppliedfamily
andcontainerDefinitions
.default RunTaskResponse
runTask
(Consumer<RunTaskRequest.Builder> runTaskRequest) Starts a new task using the specified task definition.default RunTaskResponse
runTask
(RunTaskRequest runTaskRequest) Starts a new task using the specified task definition.default EcsServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartTaskResponse
startTask
(Consumer<StartTaskRequest.Builder> startTaskRequest) Starts a new task from the specified task definition on the specified container instance or instances.default StartTaskResponse
startTask
(StartTaskRequest startTaskRequest) Starts a new task from the specified task definition on the specified container instance or instances.default StopTaskResponse
stopTask
(Consumer<StopTaskRequest.Builder> stopTaskRequest) Stops a running task.default StopTaskResponse
stopTask
(StopTaskRequest stopTaskRequest) Stops a running task.submitAttachmentStateChanges
(Consumer<SubmitAttachmentStateChangesRequest.Builder> submitAttachmentStateChangesRequest) submitAttachmentStateChanges
(SubmitAttachmentStateChangesRequest submitAttachmentStateChangesRequest) submitContainerStateChange
(Consumer<SubmitContainerStateChangeRequest.Builder> submitContainerStateChangeRequest) submitContainerStateChange
(SubmitContainerStateChangeRequest submitContainerStateChangeRequest) default SubmitTaskStateChangeResponse
submitTaskStateChange
(Consumer<SubmitTaskStateChangeRequest.Builder> submitTaskStateChangeRequest) default SubmitTaskStateChangeResponse
submitTaskStateChange
(SubmitTaskStateChangeRequest submitTaskStateChangeRequest) default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates the specified tags to a resource with the specifiedresourceArn
.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Associates the specified tags to a resource with the specifiedresourceArn
.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes specified tags from a resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Deletes specified tags from a resource.default UpdateCapacityProviderResponse
updateCapacityProvider
(Consumer<UpdateCapacityProviderRequest.Builder> updateCapacityProviderRequest) Modifies the parameters for a capacity provider.default UpdateCapacityProviderResponse
updateCapacityProvider
(UpdateCapacityProviderRequest updateCapacityProviderRequest) Modifies the parameters for a capacity provider.default UpdateClusterResponse
updateCluster
(Consumer<UpdateClusterRequest.Builder> updateClusterRequest) Updates the cluster.default UpdateClusterResponse
updateCluster
(UpdateClusterRequest updateClusterRequest) Updates the cluster.default UpdateClusterSettingsResponse
updateClusterSettings
(Consumer<UpdateClusterSettingsRequest.Builder> updateClusterSettingsRequest) Modifies the settings to use for a cluster.default UpdateClusterSettingsResponse
updateClusterSettings
(UpdateClusterSettingsRequest updateClusterSettingsRequest) Modifies the settings to use for a cluster.default UpdateContainerAgentResponse
updateContainerAgent
(Consumer<UpdateContainerAgentRequest.Builder> updateContainerAgentRequest) Updates the Amazon ECS container agent on a specified container instance.default UpdateContainerAgentResponse
updateContainerAgent
(UpdateContainerAgentRequest updateContainerAgentRequest) Updates the Amazon ECS container agent on a specified container instance.updateContainerInstancesState
(Consumer<UpdateContainerInstancesStateRequest.Builder> updateContainerInstancesStateRequest) Modifies the status of an Amazon ECS container instance.updateContainerInstancesState
(UpdateContainerInstancesStateRequest updateContainerInstancesStateRequest) Modifies the status of an Amazon ECS container instance.default UpdateServiceResponse
updateService
(Consumer<UpdateServiceRequest.Builder> updateServiceRequest) Modifies the parameters of a service.default UpdateServiceResponse
updateService
(UpdateServiceRequest updateServiceRequest) Modifies the parameters of a service.updateServicePrimaryTaskSet
(Consumer<UpdateServicePrimaryTaskSetRequest.Builder> updateServicePrimaryTaskSetRequest) Modifies which task set in a service is the primary task set.updateServicePrimaryTaskSet
(UpdateServicePrimaryTaskSetRequest updateServicePrimaryTaskSetRequest) Modifies which task set in a service is the primary task set.default UpdateTaskProtectionResponse
updateTaskProtection
(Consumer<UpdateTaskProtectionRequest.Builder> updateTaskProtectionRequest) Updates the protection status of a task.default UpdateTaskProtectionResponse
updateTaskProtection
(UpdateTaskProtectionRequest updateTaskProtectionRequest) Updates the protection status of a task.default UpdateTaskSetResponse
updateTaskSet
(Consumer<UpdateTaskSetRequest.Builder> updateTaskSetRequest) Modifies a task set.default UpdateTaskSetResponse
updateTaskSet
(UpdateTaskSetRequest updateTaskSetRequest) Modifies a task set.default EcsWaiter
waiter()
Create an instance ofEcsWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createCapacityProvider
default CreateCapacityProviderResponse createCapacityProvider(CreateCapacityProviderRequest createCapacityProviderRequest) throws ServerException, ClientException, InvalidParameterException, LimitExceededException, UpdateInProgressException, AwsServiceException, SdkClientException, EcsException 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
andFARGATE_SPOT
capacity providers. These providers are available to all accounts in the Amazon Web Services Regions that Fargate supports.- Parameters:
createCapacityProviderRequest
-- Returns:
- Result of the CreateCapacityProvider operation returned by the service.
- See Also:
-
createCapacityProvider
default CreateCapacityProviderResponse createCapacityProvider(Consumer<CreateCapacityProviderRequest.Builder> createCapacityProviderRequest) throws ServerException, ClientException, InvalidParameterException, LimitExceededException, UpdateInProgressException, AwsServiceException, SdkClientException, EcsException 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
andFARGATE_SPOT
capacity providers. These providers are available to all accounts in the Amazon Web Services Regions that Fargate supports.
This is a convenience which creates an instance of the
CreateCapacityProviderRequest.Builder
avoiding the need to create one manually viaCreateCapacityProviderRequest.builder()
- Parameters:
createCapacityProviderRequest
- AConsumer
that will call methods onCreateCapacityProviderRequest.Builder
to create a request.- Returns:
- Result of the CreateCapacityProvider operation returned by the service.
- See Also:
-
createCluster
default CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest) throws ServerException, ClientException, InvalidParameterException, NamespaceNotFoundException, AwsServiceException, SdkClientException, EcsException 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 theCreateCluster
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.
- Parameters:
createClusterRequest
-- Returns:
- Result of the CreateCluster operation returned by the service.
- See Also:
-
createCluster
default CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest) throws ServerException, ClientException, InvalidParameterException, NamespaceNotFoundException, AwsServiceException, SdkClientException, EcsException 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 theCreateCluster
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.
This is a convenience which creates an instance of the
CreateClusterRequest.Builder
avoiding the need to create one manually viaCreateClusterRequest.builder()
- Parameters:
createClusterRequest
- AConsumer
that will call methods onCreateClusterRequest.Builder
to create a request.- Returns:
- Result of the CreateCluster operation returned by the service.
- See Also:
-
createCluster
default CreateClusterResponse createCluster() throws ServerException, ClientException, InvalidParameterException, NamespaceNotFoundException, AwsServiceException, SdkClientException, EcsExceptionCreates 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 theCreateCluster
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.
- Returns:
- Result of the CreateCluster operation returned by the service.
- See Also:
-
createService
default CreateServiceResponse createService(CreateServiceRequest createServiceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, PlatformUnknownException, PlatformTaskDefinitionIncompatibilityException, AccessDeniedException, NamespaceNotFoundException, AwsServiceException, SdkClientException, EcsException 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.On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
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.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service.
volumeConfigurations
is only supported for REPLICA service and not DAEMON service. For more infomation, see Amazon EBS volumes 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 theRUNNING
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 forminimumHealthyPercent
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 theRUNNING
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 theDRAINING
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 theRUNNING
state, tasks for services that don't use a load balancer are considered healthy . If they're in theRUNNING
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 theRUNNING
orPENDING
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 theDRAINING
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
orEXTERNAL
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 theRUNNING
state. This is while the container instances are in theDRAINING
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
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.
- Parameters:
createServiceRequest
-- Returns:
- Result of the CreateService operation returned by the service.
- See Also:
-
-
createService
default CreateServiceResponse createService(Consumer<CreateServiceRequest.Builder> createServiceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, PlatformUnknownException, PlatformTaskDefinitionIncompatibilityException, AccessDeniedException, NamespaceNotFoundException, AwsServiceException, SdkClientException, EcsException 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.On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
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.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service.
volumeConfigurations
is only supported for REPLICA service and not DAEMON service. For more infomation, see Amazon EBS volumes 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 theRUNNING
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 forminimumHealthyPercent
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 theRUNNING
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 theDRAINING
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 theRUNNING
state, tasks for services that don't use a load balancer are considered healthy . If they're in theRUNNING
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 theRUNNING
orPENDING
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 theDRAINING
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
orEXTERNAL
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 theRUNNING
state. This is while the container instances are in theDRAINING
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
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.
This is a convenience which creates an instance of the
CreateServiceRequest.Builder
avoiding the need to create one manually viaCreateServiceRequest.builder()
- Parameters:
createServiceRequest
- AConsumer
that will call methods onCreateServiceRequest.Builder
to create a request.- Returns:
- Result of the CreateService operation returned by the service.
- See Also:
-
-
createTaskSet
default CreateTaskSetResponse createTaskSet(CreateTaskSetRequest createTaskSetRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, PlatformUnknownException, PlatformTaskDefinitionIncompatibilityException, AccessDeniedException, ServiceNotFoundException, ServiceNotActiveException, NamespaceNotFoundException, AwsServiceException, SdkClientException, EcsException 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.On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
For information about the maximum number of task sets and otther quotas, see Amazon ECS service quotas in the Amazon Elastic Container Service Developer Guide.
- Parameters:
createTaskSetRequest
-- Returns:
- Result of the CreateTaskSet operation returned by the service.
- See Also:
-
createTaskSet
default CreateTaskSetResponse createTaskSet(Consumer<CreateTaskSetRequest.Builder> createTaskSetRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, PlatformUnknownException, PlatformTaskDefinitionIncompatibilityException, AccessDeniedException, ServiceNotFoundException, ServiceNotActiveException, NamespaceNotFoundException, AwsServiceException, SdkClientException, EcsException 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.On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
For information about the maximum number of task sets and otther quotas, see Amazon ECS service quotas in the Amazon Elastic Container Service Developer Guide.
This is a convenience which creates an instance of the
CreateTaskSetRequest.Builder
avoiding the need to create one manually viaCreateTaskSetRequest.builder()
- Parameters:
createTaskSetRequest
- AConsumer
that will call methods onCreateTaskSetRequest.Builder
to create a request.- Returns:
- Result of the CreateTaskSet operation returned by the service.
- See Also:
-
deleteAccountSetting
default DeleteAccountSettingResponse deleteAccountSetting(DeleteAccountSettingRequest deleteAccountSettingRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Disables an account setting for a specified user, role, or the root user for an account.
- Parameters:
deleteAccountSettingRequest
-- Returns:
- Result of the DeleteAccountSetting operation returned by the service.
- See Also:
-
deleteAccountSetting
default DeleteAccountSettingResponse deleteAccountSetting(Consumer<DeleteAccountSettingRequest.Builder> deleteAccountSettingRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Disables an account setting for a specified user, role, or the root user for an account.
This is a convenience which creates an instance of the
DeleteAccountSettingRequest.Builder
avoiding the need to create one manually viaDeleteAccountSettingRequest.builder()
- Parameters:
deleteAccountSettingRequest
- AConsumer
that will call methods onDeleteAccountSettingRequest.Builder
to create a request.- Returns:
- Result of the DeleteAccountSetting operation returned by the service.
- See Also:
-
deleteAttributes
default DeleteAttributesResponse deleteAttributes(DeleteAttributesRequest deleteAttributesRequest) throws ClusterNotFoundException, TargetNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Deletes one or more custom attributes from an Amazon ECS resource.
- Parameters:
deleteAttributesRequest
-- Returns:
- Result of the DeleteAttributes operation returned by the service.
- See Also:
-
deleteAttributes
default DeleteAttributesResponse deleteAttributes(Consumer<DeleteAttributesRequest.Builder> deleteAttributesRequest) throws ClusterNotFoundException, TargetNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Deletes one or more custom attributes from an Amazon ECS resource.
This is a convenience which creates an instance of the
DeleteAttributesRequest.Builder
avoiding the need to create one manually viaDeleteAttributesRequest.builder()
- Parameters:
deleteAttributesRequest
- AConsumer
that will call methods onDeleteAttributesRequest.Builder
to create a request.- Returns:
- Result of the DeleteAttributes operation returned by the service.
- See Also:
-
deleteCapacityProvider
default DeleteCapacityProviderResponse deleteCapacityProvider(DeleteCapacityProviderRequest deleteCapacityProviderRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Deletes the specified capacity provider.
The
FARGATE
andFARGATE_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.- Parameters:
deleteCapacityProviderRequest
-- Returns:
- Result of the DeleteCapacityProvider operation returned by the service.
- See Also:
-
deleteCapacityProvider
default DeleteCapacityProviderResponse deleteCapacityProvider(Consumer<DeleteCapacityProviderRequest.Builder> deleteCapacityProviderRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Deletes the specified capacity provider.
The
FARGATE
andFARGATE_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.
This is a convenience which creates an instance of the
DeleteCapacityProviderRequest.Builder
avoiding the need to create one manually viaDeleteCapacityProviderRequest.builder()
- Parameters:
deleteCapacityProviderRequest
- AConsumer
that will call methods onDeleteCapacityProviderRequest.Builder
to create a request.- Returns:
- Result of the DeleteCapacityProvider operation returned by the service.
- See Also:
-
deleteCluster
default DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ClusterContainsContainerInstancesException, ClusterContainsServicesException, ClusterContainsTasksException, UpdateInProgressException, AwsServiceException, SdkClientException, EcsException Deletes the specified cluster. The cluster transitions to the
INACTIVE
state. Clusters with anINACTIVE
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 onINACTIVE
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.
- Parameters:
deleteClusterRequest
-- Returns:
- Result of the DeleteCluster operation returned by the service.
- See Also:
-
deleteCluster
default DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ClusterContainsContainerInstancesException, ClusterContainsServicesException, ClusterContainsTasksException, UpdateInProgressException, AwsServiceException, SdkClientException, EcsException Deletes the specified cluster. The cluster transitions to the
INACTIVE
state. Clusters with anINACTIVE
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 onINACTIVE
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.
This is a convenience which creates an instance of the
DeleteClusterRequest.Builder
avoiding the need to create one manually viaDeleteClusterRequest.builder()
- Parameters:
deleteClusterRequest
- AConsumer
that will call methods onDeleteClusterRequest.Builder
to create a request.- Returns:
- Result of the DeleteCluster operation returned by the service.
- See Also:
-
deleteService
default DeleteServiceResponse deleteService(DeleteServiceRequest deleteServiceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, AwsServiceException, SdkClientException, EcsException 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
toDRAINING
, and the service is no longer visible in the console or in the ListServices API operation. After all tasks have transitioned to eitherSTOPPING
orSTOPPED
status, the service status moves fromDRAINING
toINACTIVE
. Services in theDRAINING
orINACTIVE
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 aServiceNotFoundException
error.If you attempt to create a new service with the same name as an existing service in either
ACTIVE
orDRAINING
status, you receive an error.- Parameters:
deleteServiceRequest
-- Returns:
- Result of the DeleteService operation returned by the service.
- See Also:
-
deleteService
default DeleteServiceResponse deleteService(Consumer<DeleteServiceRequest.Builder> deleteServiceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, AwsServiceException, SdkClientException, EcsException 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
toDRAINING
, and the service is no longer visible in the console or in the ListServices API operation. After all tasks have transitioned to eitherSTOPPING
orSTOPPED
status, the service status moves fromDRAINING
toINACTIVE
. Services in theDRAINING
orINACTIVE
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 aServiceNotFoundException
error.If you attempt to create a new service with the same name as an existing service in either
ACTIVE
orDRAINING
status, you receive an error.
This is a convenience which creates an instance of the
DeleteServiceRequest.Builder
avoiding the need to create one manually viaDeleteServiceRequest.builder()
- Parameters:
deleteServiceRequest
- AConsumer
that will call methods onDeleteServiceRequest.Builder
to create a request.- Returns:
- Result of the DeleteService operation returned by the service.
- See Also:
-
deleteTaskDefinitions
default DeleteTaskDefinitionsResponse deleteTaskDefinitions(DeleteTaskDefinitionsRequest deleteTaskDefinitionsRequest) throws AccessDeniedException, ClientException, InvalidParameterException, ServerException, AwsServiceException, SdkClientException, EcsException 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
toDELETE_IN_PROGRESS
. Existing tasks and services that reference aDELETE_IN_PROGRESS
task definition revision continue to run without disruption. Existing services that reference aDELETE_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 aDELETE_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 theDELETE_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.- Parameters:
deleteTaskDefinitionsRequest
-- Returns:
- Result of the DeleteTaskDefinitions operation returned by the service.
- See Also:
-
deleteTaskDefinitions
default DeleteTaskDefinitionsResponse deleteTaskDefinitions(Consumer<DeleteTaskDefinitionsRequest.Builder> deleteTaskDefinitionsRequest) throws AccessDeniedException, ClientException, InvalidParameterException, ServerException, AwsServiceException, SdkClientException, EcsException 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
toDELETE_IN_PROGRESS
. Existing tasks and services that reference aDELETE_IN_PROGRESS
task definition revision continue to run without disruption. Existing services that reference aDELETE_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 aDELETE_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 theDELETE_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.
This is a convenience which creates an instance of the
DeleteTaskDefinitionsRequest.Builder
avoiding the need to create one manually viaDeleteTaskDefinitionsRequest.builder()
- Parameters:
deleteTaskDefinitionsRequest
- AConsumer
that will call methods onDeleteTaskDefinitionsRequest.Builder
to create a request.- Returns:
- Result of the DeleteTaskDefinitions operation returned by the service.
- See Also:
-
deleteTaskSet
default DeleteTaskSetResponse deleteTaskSet(DeleteTaskSetRequest deleteTaskSetRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, AccessDeniedException, ServiceNotFoundException, ServiceNotActiveException, TaskSetNotFoundException, AwsServiceException, SdkClientException, EcsException 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.- Parameters:
deleteTaskSetRequest
-- Returns:
- Result of the DeleteTaskSet operation returned by the service.
- See Also:
-
deleteTaskSet
default DeleteTaskSetResponse deleteTaskSet(Consumer<DeleteTaskSetRequest.Builder> deleteTaskSetRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, AccessDeniedException, ServiceNotFoundException, ServiceNotActiveException, TaskSetNotFoundException, AwsServiceException, SdkClientException, EcsException 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.
This is a convenience which creates an instance of the
DeleteTaskSetRequest.Builder
avoiding the need to create one manually viaDeleteTaskSetRequest.builder()
- Parameters:
deleteTaskSetRequest
- AConsumer
that will call methods onDeleteTaskSetRequest.Builder
to create a request.- Returns:
- Result of the DeleteTaskSet operation returned by the service.
- See Also:
-
deregisterContainerInstance
default DeregisterContainerInstanceResponse deregisterContainerInstance(DeregisterContainerInstanceRequest deregisterContainerInstanceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException 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).
- Parameters:
deregisterContainerInstanceRequest
-- Returns:
- Result of the DeregisterContainerInstance operation returned by the service.
- See Also:
-
deregisterContainerInstance
default DeregisterContainerInstanceResponse deregisterContainerInstance(Consumer<DeregisterContainerInstanceRequest.Builder> deregisterContainerInstanceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException 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).
This is a convenience which creates an instance of the
DeregisterContainerInstanceRequest.Builder
avoiding the need to create one manually viaDeregisterContainerInstanceRequest.builder()
- Parameters:
deregisterContainerInstanceRequest
- AConsumer
that will call methods onDeregisterContainerInstanceRequest.Builder
to create a request.- Returns:
- Result of the DeregisterContainerInstance operation returned by the service.
- See Also:
-
deregisterTaskDefinition
default DeregisterTaskDefinitionResponse deregisterTaskDefinition(DeregisterTaskDefinitionRequest deregisterTaskDefinitionRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as
INACTIVE
. Existing tasks and services that reference anINACTIVE
task definition continue to run without disruption. Existing services that reference anINACTIVE
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 anINACTIVE
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 onINACTIVE
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.
- Parameters:
deregisterTaskDefinitionRequest
-- Returns:
- Result of the DeregisterTaskDefinition operation returned by the service.
- See Also:
-
deregisterTaskDefinition
default DeregisterTaskDefinitionResponse deregisterTaskDefinition(Consumer<DeregisterTaskDefinitionRequest.Builder> deregisterTaskDefinitionRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as
INACTIVE
. Existing tasks and services that reference anINACTIVE
task definition continue to run without disruption. Existing services that reference anINACTIVE
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 anINACTIVE
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 onINACTIVE
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.
This is a convenience which creates an instance of the
DeregisterTaskDefinitionRequest.Builder
avoiding the need to create one manually viaDeregisterTaskDefinitionRequest.builder()
- Parameters:
deregisterTaskDefinitionRequest
- AConsumer
that will call methods onDeregisterTaskDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DeregisterTaskDefinition operation returned by the service.
- See Also:
-
describeCapacityProviders
default DescribeCapacityProvidersResponse describeCapacityProviders(DescribeCapacityProvidersRequest describeCapacityProvidersRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Describes one or more of your capacity providers.
- Parameters:
describeCapacityProvidersRequest
-- Returns:
- Result of the DescribeCapacityProviders operation returned by the service.
- See Also:
-
describeCapacityProviders
default DescribeCapacityProvidersResponse describeCapacityProviders(Consumer<DescribeCapacityProvidersRequest.Builder> describeCapacityProvidersRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Describes one or more of your capacity providers.
This is a convenience which creates an instance of the
DescribeCapacityProvidersRequest.Builder
avoiding the need to create one manually viaDescribeCapacityProvidersRequest.builder()
- Parameters:
describeCapacityProvidersRequest
- AConsumer
that will call methods onDescribeCapacityProvidersRequest.Builder
to create a request.- Returns:
- Result of the DescribeCapacityProviders operation returned by the service.
- See Also:
-
describeClusters
default DescribeClustersResponse describeClusters(DescribeClustersRequest describeClustersRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Describes one or more of your clusters.
- Parameters:
describeClustersRequest
-- Returns:
- Result of the DescribeClusters operation returned by the service.
- See Also:
-
describeClusters
default DescribeClustersResponse describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Describes one or more of your clusters.
This is a convenience which creates an instance of the
DescribeClustersRequest.Builder
avoiding the need to create one manually viaDescribeClustersRequest.builder()
- Parameters:
describeClustersRequest
- AConsumer
that will call methods onDescribeClustersRequest.Builder
to create a request.- Returns:
- Result of the DescribeClusters operation returned by the service.
- See Also:
-
describeClusters
default DescribeClustersResponse describeClusters() throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsExceptionDescribes one or more of your clusters.
- Returns:
- Result of the DescribeClusters operation returned by the service.
- See Also:
-
describeContainerInstances
default DescribeContainerInstancesResponse describeContainerInstances(DescribeContainerInstancesRequest describeContainerInstancesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException Describes one or more container instances. Returns metadata about each container instance requested.
- Parameters:
describeContainerInstancesRequest
-- Returns:
- Result of the DescribeContainerInstances operation returned by the service.
- See Also:
-
describeContainerInstances
default DescribeContainerInstancesResponse describeContainerInstances(Consumer<DescribeContainerInstancesRequest.Builder> describeContainerInstancesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException Describes one or more container instances. Returns metadata about each container instance requested.
This is a convenience which creates an instance of the
DescribeContainerInstancesRequest.Builder
avoiding the need to create one manually viaDescribeContainerInstancesRequest.builder()
- Parameters:
describeContainerInstancesRequest
- AConsumer
that will call methods onDescribeContainerInstancesRequest.Builder
to create a request.- Returns:
- Result of the DescribeContainerInstances operation returned by the service.
- See Also:
-
describeServices
default DescribeServicesResponse describeServices(DescribeServicesRequest describeServicesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException Describes the specified services running in your cluster.
- Parameters:
describeServicesRequest
-- Returns:
- Result of the DescribeServices operation returned by the service.
- See Also:
-
describeServices
default DescribeServicesResponse describeServices(Consumer<DescribeServicesRequest.Builder> describeServicesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException Describes the specified services running in your cluster.
This is a convenience which creates an instance of the
DescribeServicesRequest.Builder
avoiding the need to create one manually viaDescribeServicesRequest.builder()
- Parameters:
describeServicesRequest
- AConsumer
that will call methods onDescribeServicesRequest.Builder
to create a request.- Returns:
- Result of the DescribeServices operation returned by the service.
- See Also:
-
describeTaskDefinition
default DescribeTaskDefinitionResponse describeTaskDefinition(DescribeTaskDefinitionRequest describeTaskDefinitionRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Describes a task definition. You can specify a
family
andrevision
to find information about a specific task definition, or you can simply specify the family to find the latestACTIVE
revision in that family.You can only describe
INACTIVE
task definitions while an active task or service references them.- Parameters:
describeTaskDefinitionRequest
-- Returns:
- Result of the DescribeTaskDefinition operation returned by the service.
- See Also:
-
describeTaskDefinition
default DescribeTaskDefinitionResponse describeTaskDefinition(Consumer<DescribeTaskDefinitionRequest.Builder> describeTaskDefinitionRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Describes a task definition. You can specify a
family
andrevision
to find information about a specific task definition, or you can simply specify the family to find the latestACTIVE
revision in that family.You can only describe
INACTIVE
task definitions while an active task or service references them.
This is a convenience which creates an instance of the
DescribeTaskDefinitionRequest.Builder
avoiding the need to create one manually viaDescribeTaskDefinitionRequest.builder()
- Parameters:
describeTaskDefinitionRequest
- AConsumer
that will call methods onDescribeTaskDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DescribeTaskDefinition operation returned by the service.
- See Also:
-
describeTaskSets
default DescribeTaskSetsResponse describeTaskSets(DescribeTaskSetsRequest describeTaskSetsRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, AccessDeniedException, ServiceNotFoundException, ServiceNotActiveException, AwsServiceException, SdkClientException, EcsException 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.- Parameters:
describeTaskSetsRequest
-- Returns:
- Result of the DescribeTaskSets operation returned by the service.
- See Also:
-
describeTaskSets
default DescribeTaskSetsResponse describeTaskSets(Consumer<DescribeTaskSetsRequest.Builder> describeTaskSetsRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, AccessDeniedException, ServiceNotFoundException, ServiceNotActiveException, AwsServiceException, SdkClientException, EcsException 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.
This is a convenience which creates an instance of the
DescribeTaskSetsRequest.Builder
avoiding the need to create one manually viaDescribeTaskSetsRequest.builder()
- Parameters:
describeTaskSetsRequest
- AConsumer
that will call methods onDescribeTaskSetsRequest.Builder
to create a request.- Returns:
- Result of the DescribeTaskSets operation returned by the service.
- See Also:
-
describeTasks
default DescribeTasksResponse describeTasks(DescribeTasksRequest describeTasksRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException Describes a specified task or tasks.
Currently, stopped tasks appear in the returned results for at least one hour.
If you have tasks with tags, and then delete the cluster, the tagged tasks are returned in the response. If you create a new cluster with the same name as the deleted cluster, the tagged tasks are not included in the response.
- Parameters:
describeTasksRequest
-- Returns:
- Result of the DescribeTasks operation returned by the service.
- See Also:
-
describeTasks
default DescribeTasksResponse describeTasks(Consumer<DescribeTasksRequest.Builder> describeTasksRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException Describes a specified task or tasks.
Currently, stopped tasks appear in the returned results for at least one hour.
If you have tasks with tags, and then delete the cluster, the tagged tasks are returned in the response. If you create a new cluster with the same name as the deleted cluster, the tagged tasks are not included in the response.
This is a convenience which creates an instance of the
DescribeTasksRequest.Builder
avoiding the need to create one manually viaDescribeTasksRequest.builder()
- Parameters:
describeTasksRequest
- AConsumer
that will call methods onDescribeTasksRequest.Builder
to create a request.- Returns:
- Result of the DescribeTasks operation returned by the service.
- See Also:
-
discoverPollEndpoint
default DiscoverPollEndpointResponse discoverPollEndpoint(DiscoverPollEndpointRequest discoverPollEndpointRequest) throws ServerException, ClientException, AwsServiceException, SdkClientException, EcsException This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon ECS agent to poll for updates.
- Parameters:
discoverPollEndpointRequest
-- Returns:
- Result of the DiscoverPollEndpoint operation returned by the service.
- See Also:
-
discoverPollEndpoint
default DiscoverPollEndpointResponse discoverPollEndpoint(Consumer<DiscoverPollEndpointRequest.Builder> discoverPollEndpointRequest) throws ServerException, ClientException, AwsServiceException, SdkClientException, EcsException This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon ECS agent to poll for updates.
This is a convenience which creates an instance of the
DiscoverPollEndpointRequest.Builder
avoiding the need to create one manually viaDiscoverPollEndpointRequest.builder()
- Parameters:
discoverPollEndpointRequest
- AConsumer
that will call methods onDiscoverPollEndpointRequest.Builder
to create a request.- Returns:
- Result of the DiscoverPollEndpoint operation returned by the service.
- See Also:
-
executeCommand
default ExecuteCommandResponse executeCommand(ExecuteCommandRequest executeCommandRequest) throws ServerException, ClientException, InvalidParameterException, AccessDeniedException, ClusterNotFoundException, TargetNotConnectedException, AwsServiceException, SdkClientException, EcsException 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.
- Parameters:
executeCommandRequest
-- Returns:
- Result of the ExecuteCommand operation returned by the service.
- See Also:
-
executeCommand
default ExecuteCommandResponse executeCommand(Consumer<ExecuteCommandRequest.Builder> executeCommandRequest) throws ServerException, ClientException, InvalidParameterException, AccessDeniedException, ClusterNotFoundException, TargetNotConnectedException, AwsServiceException, SdkClientException, EcsException 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.
This is a convenience which creates an instance of the
ExecuteCommandRequest.Builder
avoiding the need to create one manually viaExecuteCommandRequest.builder()
- Parameters:
executeCommandRequest
- AConsumer
that will call methods onExecuteCommandRequest.Builder
to create a request.- Returns:
- Result of the ExecuteCommand operation returned by the service.
- See Also:
-
getTaskProtection
default GetTaskProtectionResponse getTaskProtection(GetTaskProtectionRequest getTaskProtectionRequest) throws AccessDeniedException, ClientException, ClusterNotFoundException, InvalidParameterException, ResourceNotFoundException, ServerException, UnsupportedFeatureException, AwsServiceException, SdkClientException, EcsException Retrieves the protection status of tasks in an Amazon ECS service.
- Parameters:
getTaskProtectionRequest
-- Returns:
- Result of the GetTaskProtection operation returned by the service.
- See Also:
-
getTaskProtection
default GetTaskProtectionResponse getTaskProtection(Consumer<GetTaskProtectionRequest.Builder> getTaskProtectionRequest) throws AccessDeniedException, ClientException, ClusterNotFoundException, InvalidParameterException, ResourceNotFoundException, ServerException, UnsupportedFeatureException, AwsServiceException, SdkClientException, EcsException Retrieves the protection status of tasks in an Amazon ECS service.
This is a convenience which creates an instance of the
GetTaskProtectionRequest.Builder
avoiding the need to create one manually viaGetTaskProtectionRequest.builder()
- Parameters:
getTaskProtectionRequest
- AConsumer
that will call methods onGetTaskProtectionRequest.Builder
to create a request.- Returns:
- Result of the GetTaskProtection operation returned by the service.
- See Also:
-
listAccountSettings
default ListAccountSettingsResponse listAccountSettings(ListAccountSettingsRequest listAccountSettingsRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Lists the account settings for a specified principal.
- Parameters:
listAccountSettingsRequest
-- Returns:
- Result of the ListAccountSettings operation returned by the service.
- See Also:
-
listAccountSettings
default ListAccountSettingsResponse listAccountSettings(Consumer<ListAccountSettingsRequest.Builder> listAccountSettingsRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Lists the account settings for a specified principal.
This is a convenience which creates an instance of the
ListAccountSettingsRequest.Builder
avoiding the need to create one manually viaListAccountSettingsRequest.builder()
- Parameters:
listAccountSettingsRequest
- AConsumer
that will call methods onListAccountSettingsRequest.Builder
to create a request.- Returns:
- Result of the ListAccountSettings operation returned by the service.
- See Also:
-
listAccountSettings
default ListAccountSettingsResponse listAccountSettings() throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsExceptionLists the account settings for a specified principal.
- Returns:
- Result of the ListAccountSettings operation returned by the service.
- See Also:
-
listAccountSettingsPaginator
default ListAccountSettingsIterable listAccountSettingsPaginator() throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsExceptionThis is a variant of
listAccountSettings(software.amazon.awssdk.services.ecs.model.ListAccountSettingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListAccountSettingsIterable responses = client.listAccountSettingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListAccountSettingsIterable responses = client .listAccountSettingsPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListAccountSettingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListAccountSettingsIterable responses = client.listAccountSettingsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccountSettings(software.amazon.awssdk.services.ecs.model.ListAccountSettingsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAccountSettingsPaginator
default ListAccountSettingsIterable listAccountSettingsPaginator(ListAccountSettingsRequest listAccountSettingsRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException This is a variant of
listAccountSettings(software.amazon.awssdk.services.ecs.model.ListAccountSettingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListAccountSettingsIterable responses = client.listAccountSettingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListAccountSettingsIterable responses = client .listAccountSettingsPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListAccountSettingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListAccountSettingsIterable responses = client.listAccountSettingsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccountSettings(software.amazon.awssdk.services.ecs.model.ListAccountSettingsRequest)
operation.- Parameters:
listAccountSettingsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAccountSettingsPaginator
default ListAccountSettingsIterable listAccountSettingsPaginator(Consumer<ListAccountSettingsRequest.Builder> listAccountSettingsRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException This is a variant of
listAccountSettings(software.amazon.awssdk.services.ecs.model.ListAccountSettingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListAccountSettingsIterable responses = client.listAccountSettingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListAccountSettingsIterable responses = client .listAccountSettingsPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListAccountSettingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListAccountSettingsIterable responses = client.listAccountSettingsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccountSettings(software.amazon.awssdk.services.ecs.model.ListAccountSettingsRequest)
operation.
This is a convenience which creates an instance of the
ListAccountSettingsRequest.Builder
avoiding the need to create one manually viaListAccountSettingsRequest.builder()
- Parameters:
listAccountSettingsRequest
- AConsumer
that will call methods onListAccountSettingsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAttributes
default ListAttributesResponse listAttributes(ListAttributesRequest listAttributesRequest) throws ClusterNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException 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
).- Parameters:
listAttributesRequest
-- Returns:
- Result of the ListAttributes operation returned by the service.
- See Also:
-
listAttributes
default ListAttributesResponse listAttributes(Consumer<ListAttributesRequest.Builder> listAttributesRequest) throws ClusterNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException 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
).
This is a convenience which creates an instance of the
ListAttributesRequest.Builder
avoiding the need to create one manually viaListAttributesRequest.builder()
- Parameters:
listAttributesRequest
- AConsumer
that will call methods onListAttributesRequest.Builder
to create a request.- Returns:
- Result of the ListAttributes operation returned by the service.
- See Also:
-
listAttributesPaginator
default ListAttributesIterable listAttributesPaginator(ListAttributesRequest listAttributesRequest) throws ClusterNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException This is a variant of
listAttributes(software.amazon.awssdk.services.ecs.model.ListAttributesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListAttributesIterable responses = client.listAttributesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListAttributesIterable responses = client.listAttributesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListAttributesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListAttributesIterable responses = client.listAttributesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttributes(software.amazon.awssdk.services.ecs.model.ListAttributesRequest)
operation.- Parameters:
listAttributesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAttributesPaginator
default ListAttributesIterable listAttributesPaginator(Consumer<ListAttributesRequest.Builder> listAttributesRequest) throws ClusterNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException This is a variant of
listAttributes(software.amazon.awssdk.services.ecs.model.ListAttributesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListAttributesIterable responses = client.listAttributesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListAttributesIterable responses = client.listAttributesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListAttributesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListAttributesIterable responses = client.listAttributesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttributes(software.amazon.awssdk.services.ecs.model.ListAttributesRequest)
operation.
This is a convenience which creates an instance of the
ListAttributesRequest.Builder
avoiding the need to create one manually viaListAttributesRequest.builder()
- Parameters:
listAttributesRequest
- AConsumer
that will call methods onListAttributesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listClusters
default ListClustersResponse listClusters(ListClustersRequest listClustersRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Returns a list of existing clusters.
- Parameters:
listClustersRequest
-- Returns:
- Result of the ListClusters operation returned by the service.
- See Also:
-
listClusters
default ListClustersResponse listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Returns a list of existing clusters.
This is a convenience which creates an instance of the
ListClustersRequest.Builder
avoiding the need to create one manually viaListClustersRequest.builder()
- Parameters:
listClustersRequest
- AConsumer
that will call methods onListClustersRequest.Builder
to create a request.- Returns:
- Result of the ListClusters operation returned by the service.
- See Also:
-
listClusters
default ListClustersResponse listClusters() throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsExceptionReturns a list of existing clusters.
- Returns:
- Result of the ListClusters operation returned by the service.
- See Also:
-
listClustersPaginator
default ListClustersIterable listClustersPaginator() throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsExceptionThis is a variant of
listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListClustersIterable responses = client.listClustersPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listClustersPaginator
default ListClustersIterable listClustersPaginator(ListClustersRequest listClustersRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException This is a variant of
listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListClustersIterable responses = client.listClustersPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation.- Parameters:
listClustersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listClustersPaginator
default ListClustersIterable listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException This is a variant of
listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListClustersIterable responses = client.listClustersPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation.
This is a convenience which creates an instance of the
ListClustersRequest.Builder
avoiding the need to create one manually viaListClustersRequest.builder()
- Parameters:
listClustersRequest
- AConsumer
that will call methods onListClustersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listContainerInstances
default ListContainerInstancesResponse listContainerInstances(ListContainerInstancesRequest listContainerInstancesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException 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 thefilter
parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.- Parameters:
listContainerInstancesRequest
-- Returns:
- Result of the ListContainerInstances operation returned by the service.
- See Also:
-
listContainerInstances
default ListContainerInstancesResponse listContainerInstances(Consumer<ListContainerInstancesRequest.Builder> listContainerInstancesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException 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 thefilter
parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
This is a convenience which creates an instance of the
ListContainerInstancesRequest.Builder
avoiding the need to create one manually viaListContainerInstancesRequest.builder()
- Parameters:
listContainerInstancesRequest
- AConsumer
that will call methods onListContainerInstancesRequest.Builder
to create a request.- Returns:
- Result of the ListContainerInstances operation returned by the service.
- See Also:
-
listContainerInstances
default ListContainerInstancesResponse listContainerInstances() throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsExceptionReturns a list of container instances in a specified cluster. You can filter the results of a
ListContainerInstances
operation with cluster query language statements inside thefilter
parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.- Returns:
- Result of the ListContainerInstances operation returned by the service.
- See Also:
-
listContainerInstancesPaginator
default ListContainerInstancesIterable listContainerInstancesPaginator() throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsExceptionThis is a variant of
listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListContainerInstancesIterable responses = client.listContainerInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesIterable responses = client .listContainerInstancesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListContainerInstancesIterable responses = client.listContainerInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listContainerInstancesPaginator
default ListContainerInstancesIterable listContainerInstancesPaginator(ListContainerInstancesRequest listContainerInstancesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException This is a variant of
listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListContainerInstancesIterable responses = client.listContainerInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesIterable responses = client .listContainerInstancesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListContainerInstancesIterable responses = client.listContainerInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation.- Parameters:
listContainerInstancesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listContainerInstancesPaginator
default ListContainerInstancesIterable listContainerInstancesPaginator(Consumer<ListContainerInstancesRequest.Builder> listContainerInstancesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException This is a variant of
listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListContainerInstancesIterable responses = client.listContainerInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesIterable responses = client .listContainerInstancesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListContainerInstancesIterable responses = client.listContainerInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation.
This is a convenience which creates an instance of the
ListContainerInstancesRequest.Builder
avoiding the need to create one manually viaListContainerInstancesRequest.builder()
- Parameters:
listContainerInstancesRequest
- AConsumer
that will call methods onListContainerInstancesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServices
default ListServicesResponse listServices(ListServicesRequest listServicesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.
- Parameters:
listServicesRequest
-- Returns:
- Result of the ListServices operation returned by the service.
- See Also:
-
listServices
default ListServicesResponse listServices(Consumer<ListServicesRequest.Builder> listServicesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.
This is a convenience which creates an instance of the
ListServicesRequest.Builder
avoiding the need to create one manually viaListServicesRequest.builder()
- Parameters:
listServicesRequest
- AConsumer
that will call methods onListServicesRequest.Builder
to create a request.- Returns:
- Result of the ListServices operation returned by the service.
- See Also:
-
listServices
default ListServicesResponse listServices() throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsExceptionReturns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.
- Returns:
- Result of the ListServices operation returned by the service.
- See Also:
-
listServicesPaginator
default ListServicesIterable listServicesPaginator() throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsExceptionThis is a variant of
listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListServicesIterable responses = client.listServicesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListServicesIterable responses = client.listServicesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListServicesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListServicesIterable responses = client.listServicesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServicesPaginator
default ListServicesIterable listServicesPaginator(ListServicesRequest listServicesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException This is a variant of
listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListServicesIterable responses = client.listServicesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListServicesIterable responses = client.listServicesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListServicesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListServicesIterable responses = client.listServicesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation.- Parameters:
listServicesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServicesPaginator
default ListServicesIterable listServicesPaginator(Consumer<ListServicesRequest.Builder> listServicesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException This is a variant of
listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListServicesIterable responses = client.listServicesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListServicesIterable responses = client.listServicesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListServicesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListServicesIterable responses = client.listServicesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation.
This is a convenience which creates an instance of the
ListServicesRequest.Builder
avoiding the need to create one manually viaListServicesRequest.builder()
- Parameters:
listServicesRequest
- AConsumer
that will call methods onListServicesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServicesByNamespace
default ListServicesByNamespaceResponse listServicesByNamespace(ListServicesByNamespaceRequest listServicesByNamespaceRequest) throws ServerException, ClientException, InvalidParameterException, NamespaceNotFoundException, AwsServiceException, SdkClientException, EcsException 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, useListServices
. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.- Parameters:
listServicesByNamespaceRequest
-- Returns:
- Result of the ListServicesByNamespace operation returned by the service.
- See Also:
-
listServicesByNamespace
default ListServicesByNamespaceResponse listServicesByNamespace(Consumer<ListServicesByNamespaceRequest.Builder> listServicesByNamespaceRequest) throws ServerException, ClientException, InvalidParameterException, NamespaceNotFoundException, AwsServiceException, SdkClientException, EcsException 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, useListServices
. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
This is a convenience which creates an instance of the
ListServicesByNamespaceRequest.Builder
avoiding the need to create one manually viaListServicesByNamespaceRequest.builder()
- Parameters:
listServicesByNamespaceRequest
- AConsumer
that will call methods onListServicesByNamespaceRequest.Builder
to create a request.- Returns:
- Result of the ListServicesByNamespace operation returned by the service.
- See Also:
-
listServicesByNamespacePaginator
default ListServicesByNamespaceIterable listServicesByNamespacePaginator(ListServicesByNamespaceRequest listServicesByNamespaceRequest) throws ServerException, ClientException, InvalidParameterException, NamespaceNotFoundException, AwsServiceException, SdkClientException, EcsException This is a variant of
listServicesByNamespace(software.amazon.awssdk.services.ecs.model.ListServicesByNamespaceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListServicesByNamespaceIterable responses = client.listServicesByNamespacePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListServicesByNamespaceIterable responses = client .listServicesByNamespacePaginator(request); for (software.amazon.awssdk.services.ecs.model.ListServicesByNamespaceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListServicesByNamespaceIterable responses = client.listServicesByNamespacePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServicesByNamespace(software.amazon.awssdk.services.ecs.model.ListServicesByNamespaceRequest)
operation.- Parameters:
listServicesByNamespaceRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServicesByNamespacePaginator
default ListServicesByNamespaceIterable listServicesByNamespacePaginator(Consumer<ListServicesByNamespaceRequest.Builder> listServicesByNamespaceRequest) throws ServerException, ClientException, InvalidParameterException, NamespaceNotFoundException, AwsServiceException, SdkClientException, EcsException This is a variant of
listServicesByNamespace(software.amazon.awssdk.services.ecs.model.ListServicesByNamespaceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListServicesByNamespaceIterable responses = client.listServicesByNamespacePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListServicesByNamespaceIterable responses = client .listServicesByNamespacePaginator(request); for (software.amazon.awssdk.services.ecs.model.ListServicesByNamespaceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListServicesByNamespaceIterable responses = client.listServicesByNamespacePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServicesByNamespace(software.amazon.awssdk.services.ecs.model.ListServicesByNamespaceRequest)
operation.
This is a convenience which creates an instance of the
ListServicesByNamespaceRequest.Builder
avoiding the need to create one manually viaListServicesByNamespaceRequest.builder()
- Parameters:
listServicesByNamespaceRequest
- AConsumer
that will call methods onListServicesByNamespaceRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ServerException, ClientException, ClusterNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException List the tags for an Amazon ECS resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ServerException, ClientException, ClusterNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException List the tags for an Amazon ECS resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTaskDefinitionFamilies
default ListTaskDefinitionFamiliesResponse listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest listTaskDefinitionFamiliesRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException 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 thestatus
parameter toACTIVE
. You can also filter the results with thefamilyPrefix
parameter.- Parameters:
listTaskDefinitionFamiliesRequest
-- Returns:
- Result of the ListTaskDefinitionFamilies operation returned by the service.
- See Also:
-
listTaskDefinitionFamilies
default ListTaskDefinitionFamiliesResponse listTaskDefinitionFamilies(Consumer<ListTaskDefinitionFamiliesRequest.Builder> listTaskDefinitionFamiliesRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException 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 thestatus
parameter toACTIVE
. You can also filter the results with thefamilyPrefix
parameter.
This is a convenience which creates an instance of the
ListTaskDefinitionFamiliesRequest.Builder
avoiding the need to create one manually viaListTaskDefinitionFamiliesRequest.builder()
- Parameters:
listTaskDefinitionFamiliesRequest
- AConsumer
that will call methods onListTaskDefinitionFamiliesRequest.Builder
to create a request.- Returns:
- Result of the ListTaskDefinitionFamilies operation returned by the service.
- See Also:
-
listTaskDefinitionFamilies
default ListTaskDefinitionFamiliesResponse listTaskDefinitionFamilies() throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsExceptionReturns 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 thestatus
parameter toACTIVE
. You can also filter the results with thefamilyPrefix
parameter.- Returns:
- Result of the ListTaskDefinitionFamilies operation returned by the service.
- See Also:
-
listTaskDefinitionFamiliesPaginator
default ListTaskDefinitionFamiliesIterable listTaskDefinitionFamiliesPaginator() throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsExceptionThis is a variant of
listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesIterable responses = client.listTaskDefinitionFamiliesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesIterable responses = client .listTaskDefinitionFamiliesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesIterable responses = client.listTaskDefinitionFamiliesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTaskDefinitionFamiliesPaginator
default ListTaskDefinitionFamiliesIterable listTaskDefinitionFamiliesPaginator(ListTaskDefinitionFamiliesRequest listTaskDefinitionFamiliesRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException This is a variant of
listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesIterable responses = client.listTaskDefinitionFamiliesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesIterable responses = client .listTaskDefinitionFamiliesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesIterable responses = client.listTaskDefinitionFamiliesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation.- Parameters:
listTaskDefinitionFamiliesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTaskDefinitionFamiliesPaginator
default ListTaskDefinitionFamiliesIterable listTaskDefinitionFamiliesPaginator(Consumer<ListTaskDefinitionFamiliesRequest.Builder> listTaskDefinitionFamiliesRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException This is a variant of
listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesIterable responses = client.listTaskDefinitionFamiliesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesIterable responses = client .listTaskDefinitionFamiliesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesIterable responses = client.listTaskDefinitionFamiliesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation.
This is a convenience which creates an instance of the
ListTaskDefinitionFamiliesRequest.Builder
avoiding the need to create one manually viaListTaskDefinitionFamiliesRequest.builder()
- Parameters:
listTaskDefinitionFamiliesRequest
- AConsumer
that will call methods onListTaskDefinitionFamiliesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTaskDefinitions
default ListTaskDefinitionsResponse listTaskDefinitions(ListTaskDefinitionsRequest listTaskDefinitionsRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException 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 thestatus
parameter.- Parameters:
listTaskDefinitionsRequest
-- Returns:
- Result of the ListTaskDefinitions operation returned by the service.
- See Also:
-
listTaskDefinitions
default ListTaskDefinitionsResponse listTaskDefinitions(Consumer<ListTaskDefinitionsRequest.Builder> listTaskDefinitionsRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException 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 thestatus
parameter.
This is a convenience which creates an instance of the
ListTaskDefinitionsRequest.Builder
avoiding the need to create one manually viaListTaskDefinitionsRequest.builder()
- Parameters:
listTaskDefinitionsRequest
- AConsumer
that will call methods onListTaskDefinitionsRequest.Builder
to create a request.- Returns:
- Result of the ListTaskDefinitions operation returned by the service.
- See Also:
-
listTaskDefinitions
default ListTaskDefinitionsResponse listTaskDefinitions() throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsExceptionReturns 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 thestatus
parameter.- Returns:
- Result of the ListTaskDefinitions operation returned by the service.
- See Also:
-
listTaskDefinitionsPaginator
default ListTaskDefinitionsIterable listTaskDefinitionsPaginator() throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsExceptionThis is a variant of
listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsIterable responses = client.listTaskDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsIterable responses = client .listTaskDefinitionsPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsIterable responses = client.listTaskDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTaskDefinitionsPaginator
default ListTaskDefinitionsIterable listTaskDefinitionsPaginator(ListTaskDefinitionsRequest listTaskDefinitionsRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException This is a variant of
listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsIterable responses = client.listTaskDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsIterable responses = client .listTaskDefinitionsPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsIterable responses = client.listTaskDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation.- Parameters:
listTaskDefinitionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTaskDefinitionsPaginator
default ListTaskDefinitionsIterable listTaskDefinitionsPaginator(Consumer<ListTaskDefinitionsRequest.Builder> listTaskDefinitionsRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException This is a variant of
listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsIterable responses = client.listTaskDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsIterable responses = client .listTaskDefinitionsPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsIterable responses = client.listTaskDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation.
This is a convenience which creates an instance of the
ListTaskDefinitionsRequest.Builder
avoiding the need to create one manually viaListTaskDefinitionsRequest.builder()
- Parameters:
listTaskDefinitionsRequest
- AConsumer
that will call methods onListTaskDefinitionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTasks
default ListTasksResponse listTasks(ListTasksRequest listTasksRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, AwsServiceException, SdkClientException, EcsException 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.
- Parameters:
listTasksRequest
-- Returns:
- Result of the ListTasks operation returned by the service.
- See Also:
-
listTasks
default ListTasksResponse listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, AwsServiceException, SdkClientException, EcsException 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.
This is a convenience which creates an instance of the
ListTasksRequest.Builder
avoiding the need to create one manually viaListTasksRequest.builder()
- Parameters:
listTasksRequest
- AConsumer
that will call methods onListTasksRequest.Builder
to create a request.- Returns:
- Result of the ListTasks operation returned by the service.
- See Also:
-
listTasks
default ListTasksResponse listTasks() throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, AwsServiceException, SdkClientException, EcsExceptionReturns 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.
- Returns:
- Result of the ListTasks operation returned by the service.
- See Also:
-
listTasksPaginator
default ListTasksIterable listTasksPaginator() throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, AwsServiceException, SdkClientException, EcsExceptionThis is a variant of
listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListTasksIterable responses = client.listTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListTasksIterable responses = client.listTasksPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListTasksIterable responses = client.listTasksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTasksPaginator
default ListTasksIterable listTasksPaginator(ListTasksRequest listTasksRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, AwsServiceException, SdkClientException, EcsException This is a variant of
listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListTasksIterable responses = client.listTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListTasksIterable responses = client.listTasksPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListTasksIterable responses = client.listTasksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation.- Parameters:
listTasksRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTasksPaginator
default ListTasksIterable listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, AwsServiceException, SdkClientException, EcsException This is a variant of
listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecs.paginators.ListTasksIterable responses = client.listTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecs.paginators.ListTasksIterable responses = client.listTasksPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecs.paginators.ListTasksIterable responses = client.listTasksPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation.
This is a convenience which creates an instance of the
ListTasksRequest.Builder
avoiding the need to create one manually viaListTasksRequest.builder()
- Parameters:
listTasksRequest
- AConsumer
that will call methods onListTasksRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
putAccountSetting
default PutAccountSettingResponse putAccountSetting(PutAccountSettingRequest putAccountSettingRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException 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.
- Parameters:
putAccountSettingRequest
-- Returns:
- Result of the PutAccountSetting operation returned by the service.
- See Also:
-
putAccountSetting
default PutAccountSettingResponse putAccountSetting(Consumer<PutAccountSettingRequest.Builder> putAccountSettingRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException 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.
This is a convenience which creates an instance of the
PutAccountSettingRequest.Builder
avoiding the need to create one manually viaPutAccountSettingRequest.builder()
- Parameters:
putAccountSettingRequest
- AConsumer
that will call methods onPutAccountSettingRequest.Builder
to create a request.- Returns:
- Result of the PutAccountSetting operation returned by the service.
- See Also:
-
putAccountSettingDefault
default PutAccountSettingDefaultResponse putAccountSettingDefault(PutAccountSettingDefaultRequest putAccountSettingDefaultRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException 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.
- Parameters:
putAccountSettingDefaultRequest
-- Returns:
- Result of the PutAccountSettingDefault operation returned by the service.
- See Also:
-
putAccountSettingDefault
default PutAccountSettingDefaultResponse putAccountSettingDefault(Consumer<PutAccountSettingDefaultRequest.Builder> putAccountSettingDefaultRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException 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.
This is a convenience which creates an instance of the
PutAccountSettingDefaultRequest.Builder
avoiding the need to create one manually viaPutAccountSettingDefaultRequest.builder()
- Parameters:
putAccountSettingDefaultRequest
- AConsumer
that will call methods onPutAccountSettingDefaultRequest.Builder
to create a request.- Returns:
- Result of the PutAccountSettingDefault operation returned by the service.
- See Also:
-
putAttributes
default PutAttributesResponse putAttributes(PutAttributesRequest putAttributesRequest) throws ClusterNotFoundException, TargetNotFoundException, AttributeLimitExceededException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException 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.
- Parameters:
putAttributesRequest
-- Returns:
- Result of the PutAttributes operation returned by the service.
- See Also:
-
putAttributes
default PutAttributesResponse putAttributes(Consumer<PutAttributesRequest.Builder> putAttributesRequest) throws ClusterNotFoundException, TargetNotFoundException, AttributeLimitExceededException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException 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.
This is a convenience which creates an instance of the
PutAttributesRequest.Builder
avoiding the need to create one manually viaPutAttributesRequest.builder()
- Parameters:
putAttributesRequest
- AConsumer
that will call methods onPutAttributesRequest.Builder
to create a request.- Returns:
- Result of the PutAttributes operation returned by the service.
- See Also:
-
putClusterCapacityProviders
default PutClusterCapacityProvidersResponse putClusterCapacityProviders(PutClusterCapacityProvidersRequest putClusterCapacityProvidersRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ResourceInUseException, UpdateInProgressException, AwsServiceException, SdkClientException, EcsException 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.- Parameters:
putClusterCapacityProvidersRequest
-- Returns:
- Result of the PutClusterCapacityProviders operation returned by the service.
- See Also:
-
putClusterCapacityProviders
default PutClusterCapacityProvidersResponse putClusterCapacityProviders(Consumer<PutClusterCapacityProvidersRequest.Builder> putClusterCapacityProvidersRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ResourceInUseException, UpdateInProgressException, AwsServiceException, SdkClientException, EcsException 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.
This is a convenience which creates an instance of the
PutClusterCapacityProvidersRequest.Builder
avoiding the need to create one manually viaPutClusterCapacityProvidersRequest.builder()
- Parameters:
putClusterCapacityProvidersRequest
- AConsumer
that will call methods onPutClusterCapacityProvidersRequest.Builder
to create a request.- Returns:
- Result of the PutClusterCapacityProviders operation returned by the service.
- See Also:
-
registerContainerInstance
default RegisterContainerInstanceResponse registerContainerInstance(RegisterContainerInstanceRequest registerContainerInstanceRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.
- Parameters:
registerContainerInstanceRequest
-- Returns:
- Result of the RegisterContainerInstance operation returned by the service.
- See Also:
-
registerContainerInstance
default RegisterContainerInstanceResponse registerContainerInstance(Consumer<RegisterContainerInstanceRequest.Builder> registerContainerInstanceRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.
This is a convenience which creates an instance of the
RegisterContainerInstanceRequest.Builder
avoiding the need to create one manually viaRegisterContainerInstanceRequest.builder()
- Parameters:
registerContainerInstanceRequest
- AConsumer
that will call methods onRegisterContainerInstanceRequest.Builder
to create a request.- Returns:
- Result of the RegisterContainerInstance operation returned by the service.
- See Also:
-
registerTaskDefinition
default RegisterTaskDefinitionResponse registerTaskDefinition(RegisterTaskDefinitionRequest registerTaskDefinitionRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Registers a new task definition from the supplied
family
andcontainerDefinitions
. Optionally, you can add data volumes to your containers with thevolumes
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 theawsvpc
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.- Parameters:
registerTaskDefinitionRequest
-- Returns:
- Result of the RegisterTaskDefinition operation returned by the service.
- See Also:
-
registerTaskDefinition
default RegisterTaskDefinitionResponse registerTaskDefinition(Consumer<RegisterTaskDefinitionRequest.Builder> registerTaskDefinitionRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Registers a new task definition from the supplied
family
andcontainerDefinitions
. Optionally, you can add data volumes to your containers with thevolumes
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 theawsvpc
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.
This is a convenience which creates an instance of the
RegisterTaskDefinitionRequest.Builder
avoiding the need to create one manually viaRegisterTaskDefinitionRequest.builder()
- Parameters:
registerTaskDefinitionRequest
- AConsumer
that will call methods onRegisterTaskDefinitionRequest.Builder
to create a request.- Returns:
- Result of the RegisterTaskDefinition operation returned by the service.
- See Also:
-
runTask
default RunTaskResponse runTask(RunTaskRequest runTaskRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, PlatformUnknownException, PlatformTaskDefinitionIncompatibilityException, AccessDeniedException, BlockedException, ConflictException, AwsServiceException, SdkClientException, EcsException Starts a new task using the specified task definition.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a 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.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
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.
- Parameters:
runTaskRequest
-- Returns:
- Result of the RunTask operation returned by the service.
- See Also:
-
-
runTask
default RunTaskResponse runTask(Consumer<RunTaskRequest.Builder> runTaskRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, PlatformUnknownException, PlatformTaskDefinitionIncompatibilityException, AccessDeniedException, BlockedException, ConflictException, AwsServiceException, SdkClientException, EcsException Starts a new task using the specified task definition.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a 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.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
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.
This is a convenience which creates an instance of the
RunTaskRequest.Builder
avoiding the need to create one manually viaRunTaskRequest.builder()
- Parameters:
runTaskRequest
- AConsumer
that will call methods onRunTaskRequest.Builder
to create a request.- Returns:
- Result of the RunTask operation returned by the service.
- See Also:
-
-
startTask
default StartTaskResponse startTask(StartTaskRequest startTaskRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, AwsServiceException, SdkClientException, EcsException Starts a new task from the specified task definition on the specified container instance or instances.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
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.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
- Parameters:
startTaskRequest
-- Returns:
- Result of the StartTask operation returned by the service.
- See Also:
-
startTask
default StartTaskResponse startTask(Consumer<StartTaskRequest.Builder> startTaskRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, AwsServiceException, SdkClientException, EcsException Starts a new task from the specified task definition on the specified container instance or instances.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
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.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
This is a convenience which creates an instance of the
StartTaskRequest.Builder
avoiding the need to create one manually viaStartTaskRequest.builder()
- Parameters:
startTaskRequest
- AConsumer
that will call methods onStartTaskRequest.Builder
to create a request.- Returns:
- Result of the StartTask operation returned by the service.
- See Also:
-
stopTask
default StopTaskResponse stopTask(StopTaskRequest stopTaskRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException 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 aSIGTERM
value and a default 30-second timeout, after which theSIGKILL
value is sent and the containers are forcibly stopped. If the container handles theSIGTERM
value gracefully and exits within 30 seconds from receiving it, noSIGKILL
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.- Parameters:
stopTaskRequest
-- Returns:
- Result of the StopTask operation returned by the service.
- See Also:
-
stopTask
default StopTaskResponse stopTask(Consumer<StopTaskRequest.Builder> stopTaskRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException 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 aSIGTERM
value and a default 30-second timeout, after which theSIGKILL
value is sent and the containers are forcibly stopped. If the container handles theSIGTERM
value gracefully and exits within 30 seconds from receiving it, noSIGKILL
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.
This is a convenience which creates an instance of the
StopTaskRequest.Builder
avoiding the need to create one manually viaStopTaskRequest.builder()
- Parameters:
stopTaskRequest
- AConsumer
that will call methods onStopTaskRequest.Builder
to create a request.- Returns:
- Result of the StopTask operation returned by the service.
- See Also:
-
submitAttachmentStateChanges
default SubmitAttachmentStateChangesResponse submitAttachmentStateChanges(SubmitAttachmentStateChangesRequest submitAttachmentStateChangesRequest) throws ServerException, ClientException, AccessDeniedException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException 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.
- Parameters:
submitAttachmentStateChangesRequest
-- Returns:
- Result of the SubmitAttachmentStateChanges operation returned by the service.
- See Also:
-
submitAttachmentStateChanges
default SubmitAttachmentStateChangesResponse submitAttachmentStateChanges(Consumer<SubmitAttachmentStateChangesRequest.Builder> submitAttachmentStateChangesRequest) throws ServerException, ClientException, AccessDeniedException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException 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.
This is a convenience which creates an instance of the
SubmitAttachmentStateChangesRequest.Builder
avoiding the need to create one manually viaSubmitAttachmentStateChangesRequest.builder()
- Parameters:
submitAttachmentStateChangesRequest
- AConsumer
that will call methods onSubmitAttachmentStateChangesRequest.Builder
to create a request.- Returns:
- Result of the SubmitAttachmentStateChanges operation returned by the service.
- See Also:
-
submitContainerStateChange
default SubmitContainerStateChangeResponse submitContainerStateChange(SubmitContainerStateChangeRequest submitContainerStateChangeRequest) throws ServerException, ClientException, AccessDeniedException, AwsServiceException, SdkClientException, EcsException 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 a container changed states.
- Parameters:
submitContainerStateChangeRequest
-- Returns:
- Result of the SubmitContainerStateChange operation returned by the service.
- See Also:
-
submitContainerStateChange
default SubmitContainerStateChangeResponse submitContainerStateChange(Consumer<SubmitContainerStateChangeRequest.Builder> submitContainerStateChangeRequest) throws ServerException, ClientException, AccessDeniedException, AwsServiceException, SdkClientException, EcsException 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 a container changed states.
This is a convenience which creates an instance of the
SubmitContainerStateChangeRequest.Builder
avoiding the need to create one manually viaSubmitContainerStateChangeRequest.builder()
- Parameters:
submitContainerStateChangeRequest
- AConsumer
that will call methods onSubmitContainerStateChangeRequest.Builder
to create a request.- Returns:
- Result of the SubmitContainerStateChange operation returned by the service.
- See Also:
-
submitTaskStateChange
default SubmitTaskStateChangeResponse submitTaskStateChange(SubmitTaskStateChangeRequest submitTaskStateChangeRequest) throws ServerException, ClientException, AccessDeniedException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException 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 a task changed states.
- Parameters:
submitTaskStateChangeRequest
-- Returns:
- Result of the SubmitTaskStateChange operation returned by the service.
- See Also:
-
submitTaskStateChange
default SubmitTaskStateChangeResponse submitTaskStateChange(Consumer<SubmitTaskStateChangeRequest.Builder> submitTaskStateChangeRequest) throws ServerException, ClientException, AccessDeniedException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException 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 a task changed states.
This is a convenience which creates an instance of the
SubmitTaskStateChangeRequest.Builder
avoiding the need to create one manually viaSubmitTaskStateChangeRequest.builder()
- Parameters:
submitTaskStateChangeRequest
- AConsumer
that will call methods onSubmitTaskStateChangeRequest.Builder
to create a request.- Returns:
- Result of the SubmitTaskStateChange operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ServerException, ClientException, ClusterNotFoundException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException 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.- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ServerException, ClientException, ClusterNotFoundException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ServerException, ClientException, ClusterNotFoundException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Deletes specified tags from a resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ServerException, ClientException, ClusterNotFoundException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Deletes specified tags from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateCapacityProvider
default UpdateCapacityProviderResponse updateCapacityProvider(UpdateCapacityProviderRequest updateCapacityProviderRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Modifies the parameters for a capacity provider.
- Parameters:
updateCapacityProviderRequest
-- Returns:
- Result of the UpdateCapacityProvider operation returned by the service.
- See Also:
-
updateCapacityProvider
default UpdateCapacityProviderResponse updateCapacityProvider(Consumer<UpdateCapacityProviderRequest.Builder> updateCapacityProviderRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Modifies the parameters for a capacity provider.
This is a convenience which creates an instance of the
UpdateCapacityProviderRequest.Builder
avoiding the need to create one manually viaUpdateCapacityProviderRequest.builder()
- Parameters:
updateCapacityProviderRequest
- AConsumer
that will call methods onUpdateCapacityProviderRequest.Builder
to create a request.- Returns:
- Result of the UpdateCapacityProvider operation returned by the service.
- See Also:
-
updateCluster
default UpdateClusterResponse updateCluster(UpdateClusterRequest updateClusterRequest) throws ServerException, ClientException, ClusterNotFoundException, InvalidParameterException, NamespaceNotFoundException, AwsServiceException, SdkClientException, EcsException Updates the cluster.
- Parameters:
updateClusterRequest
-- Returns:
- Result of the UpdateCluster operation returned by the service.
- See Also:
-
updateCluster
default UpdateClusterResponse updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest) throws ServerException, ClientException, ClusterNotFoundException, InvalidParameterException, NamespaceNotFoundException, AwsServiceException, SdkClientException, EcsException Updates the cluster.
This is a convenience which creates an instance of the
UpdateClusterRequest.Builder
avoiding the need to create one manually viaUpdateClusterRequest.builder()
- Parameters:
updateClusterRequest
- AConsumer
that will call methods onUpdateClusterRequest.Builder
to create a request.- Returns:
- Result of the UpdateCluster operation returned by the service.
- See Also:
-
updateClusterSettings
default UpdateClusterSettingsResponse updateClusterSettings(UpdateClusterSettingsRequest updateClusterSettingsRequest) throws ServerException, ClientException, ClusterNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Modifies the settings to use for a cluster.
- Parameters:
updateClusterSettingsRequest
-- Returns:
- Result of the UpdateClusterSettings operation returned by the service.
- See Also:
-
updateClusterSettings
default UpdateClusterSettingsResponse updateClusterSettings(Consumer<UpdateClusterSettingsRequest.Builder> updateClusterSettingsRequest) throws ServerException, ClientException, ClusterNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException Modifies the settings to use for a cluster.
This is a convenience which creates an instance of the
UpdateClusterSettingsRequest.Builder
avoiding the need to create one manually viaUpdateClusterSettingsRequest.builder()
- Parameters:
updateClusterSettingsRequest
- AConsumer
that will call methods onUpdateClusterSettingsRequest.Builder
to create a request.- Returns:
- Result of the UpdateClusterSettings operation returned by the service.
- See Also:
-
updateContainerAgent
default UpdateContainerAgentResponse updateContainerAgent(UpdateContainerAgentRequest updateContainerAgentRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UpdateInProgressException, NoUpdateAvailableException, MissingVersionException, AwsServiceException, SdkClientException, EcsException 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 theecs-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 theecs-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.- Parameters:
updateContainerAgentRequest
-- Returns:
- Result of the UpdateContainerAgent operation returned by the service.
- See Also:
-
updateContainerAgent
default UpdateContainerAgentResponse updateContainerAgent(Consumer<UpdateContainerAgentRequest.Builder> updateContainerAgentRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UpdateInProgressException, NoUpdateAvailableException, MissingVersionException, AwsServiceException, SdkClientException, EcsException 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 theecs-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 theecs-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.
This is a convenience which creates an instance of the
UpdateContainerAgentRequest.Builder
avoiding the need to create one manually viaUpdateContainerAgentRequest.builder()
- Parameters:
updateContainerAgentRequest
- AConsumer
that will call methods onUpdateContainerAgentRequest.Builder
to create a request.- Returns:
- Result of the UpdateContainerAgent operation returned by the service.
- See Also:
-
updateContainerInstancesState
default UpdateContainerInstancesStateResponse updateContainerInstancesState(UpdateContainerInstancesStateRequest updateContainerInstancesStateRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException 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 toDRAINING
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 anACTIVE
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 thePENDING
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
andmaximumPercent
. You can change the deployment configuration of your service using UpdateService.-
If
minimumHealthyPercent
is below 100%, the scheduler can ignoredesiredCount
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 theRUNNING
state. Tasks for services that use a load balancer are considered healthy if they're in theRUNNING
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, ifdesiredCount
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
orRUNNING
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.- Parameters:
updateContainerInstancesStateRequest
-- Returns:
- Result of the UpdateContainerInstancesState operation returned by the service.
- See Also:
-
-
updateContainerInstancesState
default UpdateContainerInstancesStateResponse updateContainerInstancesState(Consumer<UpdateContainerInstancesStateRequest.Builder> updateContainerInstancesStateRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException 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 toDRAINING
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 anACTIVE
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 thePENDING
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
andmaximumPercent
. You can change the deployment configuration of your service using UpdateService.-
If
minimumHealthyPercent
is below 100%, the scheduler can ignoredesiredCount
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 theRUNNING
state. Tasks for services that use a load balancer are considered healthy if they're in theRUNNING
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, ifdesiredCount
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
orRUNNING
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.
This is a convenience which creates an instance of the
UpdateContainerInstancesStateRequest.Builder
avoiding the need to create one manually viaUpdateContainerInstancesStateRequest.builder()
- Parameters:
updateContainerInstancesStateRequest
- AConsumer
that will call methods onUpdateContainerInstancesStateRequest.Builder
to create a request.- Returns:
- Result of the UpdateContainerInstancesState operation returned by the service.
- See Also:
-
-
updateService
default UpdateServiceResponse updateService(UpdateServiceRequest updateServiceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, ServiceNotActiveException, PlatformUnknownException, PlatformTaskDefinitionIncompatibilityException, AccessDeniedException, NamespaceNotFoundException, UnsupportedFeatureException, AwsServiceException, SdkClientException, EcsException Modifies the parameters of a service.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
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.You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. You can update your volume configurations and trigger a new deployment.
volumeConfigurations
is only supported for REPLICA service and not DAEMON service. If you leavevolumeConfigurations
null
, it doesn't trigger a new deployment. For more infomation on volumes, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.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.You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
If you have updated the container 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 theforceNewDeployment
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
andmaximumPercent
, to determine the deployment strategy.-
If
minimumHealthyPercent
is below 100%, the scheduler can ignoredesiredCount
temporarily during a deployment. For example, ifdesiredCount
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 theRUNNING
state. Tasks for services that use a load balancer are considered healthy if they're in theRUNNING
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, ifdesiredCount
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 aSIGTERM
and a 30-second timeout. After this,SIGKILL
is sent and the containers are forcibly stopped. If the container handles theSIGTERM
gracefully and exits within 30 seconds from receiving it, noSIGKILL
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:
-
loadBalancers
, -
serviceRegistries
For more information about the role see the
CreateService
request parameterrole
.- Parameters:
updateServiceRequest
-- Returns:
- Result of the UpdateService operation returned by the service.
- See Also:
-
-
updateService
default UpdateServiceResponse updateService(Consumer<UpdateServiceRequest.Builder> updateServiceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, ServiceNotActiveException, PlatformUnknownException, PlatformTaskDefinitionIncompatibilityException, AccessDeniedException, NamespaceNotFoundException, UnsupportedFeatureException, AwsServiceException, SdkClientException, EcsException Modifies the parameters of a service.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
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.You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. You can update your volume configurations and trigger a new deployment.
volumeConfigurations
is only supported for REPLICA service and not DAEMON service. If you leavevolumeConfigurations
null
, it doesn't trigger a new deployment. For more infomation on volumes, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.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.You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
If you have updated the container 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 theforceNewDeployment
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
andmaximumPercent
, to determine the deployment strategy.-
If
minimumHealthyPercent
is below 100%, the scheduler can ignoredesiredCount
temporarily during a deployment. For example, ifdesiredCount
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 theRUNNING
state. Tasks for services that use a load balancer are considered healthy if they're in theRUNNING
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, ifdesiredCount
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 aSIGTERM
and a 30-second timeout. After this,SIGKILL
is sent and the containers are forcibly stopped. If the container handles theSIGTERM
gracefully and exits within 30 seconds from receiving it, noSIGKILL
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:
-
loadBalancers
, -
serviceRegistries
For more information about the role see the
CreateService
request parameterrole
.
This is a convenience which creates an instance of the
UpdateServiceRequest.Builder
avoiding the need to create one manually viaUpdateServiceRequest.builder()
- Parameters:
updateServiceRequest
- AConsumer
that will call methods onUpdateServiceRequest.Builder
to create a request.- Returns:
- Result of the UpdateService operation returned by the service.
- See Also:
-
-
updateServicePrimaryTaskSet
default UpdateServicePrimaryTaskSetResponse updateServicePrimaryTaskSet(UpdateServicePrimaryTaskSetRequest updateServicePrimaryTaskSetRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, ServiceNotFoundException, ServiceNotActiveException, TaskSetNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, EcsException 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.- Parameters:
updateServicePrimaryTaskSetRequest
-- Returns:
- Result of the UpdateServicePrimaryTaskSet operation returned by the service.
- See Also:
-
updateServicePrimaryTaskSet
default UpdateServicePrimaryTaskSetResponse updateServicePrimaryTaskSet(Consumer<UpdateServicePrimaryTaskSetRequest.Builder> updateServicePrimaryTaskSetRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, ServiceNotFoundException, ServiceNotActiveException, TaskSetNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, EcsException 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.
This is a convenience which creates an instance of the
UpdateServicePrimaryTaskSetRequest.Builder
avoiding the need to create one manually viaUpdateServicePrimaryTaskSetRequest.builder()
- Parameters:
updateServicePrimaryTaskSetRequest
- AConsumer
that will call methods onUpdateServicePrimaryTaskSetRequest.Builder
to create a request.- Returns:
- Result of the UpdateServicePrimaryTaskSet operation returned by the service.
- See Also:
-
updateTaskProtection
default UpdateTaskProtectionResponse updateTaskProtection(UpdateTaskProtectionRequest updateTaskProtectionRequest) throws AccessDeniedException, ClientException, ClusterNotFoundException, InvalidParameterException, ResourceNotFoundException, ServerException, UnsupportedFeatureException, AwsServiceException, SdkClientException, EcsException Updates the protection status of a task. You can set
protectionEnabled
totrue
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. TheexpiresInMinutes
property is always reset when you invoke this operation for a task that already hasprotectionEnabled
set totrue
. 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.
- Parameters:
updateTaskProtectionRequest
-- Returns:
- Result of the UpdateTaskProtection operation returned by the service.
- See Also:
-
updateTaskProtection
default UpdateTaskProtectionResponse updateTaskProtection(Consumer<UpdateTaskProtectionRequest.Builder> updateTaskProtectionRequest) throws AccessDeniedException, ClientException, ClusterNotFoundException, InvalidParameterException, ResourceNotFoundException, ServerException, UnsupportedFeatureException, AwsServiceException, SdkClientException, EcsException Updates the protection status of a task. You can set
protectionEnabled
totrue
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. TheexpiresInMinutes
property is always reset when you invoke this operation for a task that already hasprotectionEnabled
set totrue
. 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.
This is a convenience which creates an instance of the
UpdateTaskProtectionRequest.Builder
avoiding the need to create one manually viaUpdateTaskProtectionRequest.builder()
- Parameters:
updateTaskProtectionRequest
- AConsumer
that will call methods onUpdateTaskProtectionRequest.Builder
to create a request.- Returns:
- Result of the UpdateTaskProtection operation returned by the service.
- See Also:
-
updateTaskSet
default UpdateTaskSetResponse updateTaskSet(UpdateTaskSetRequest updateTaskSetRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, AccessDeniedException, ServiceNotFoundException, ServiceNotActiveException, TaskSetNotFoundException, AwsServiceException, SdkClientException, EcsException 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.- Parameters:
updateTaskSetRequest
-- Returns:
- Result of the UpdateTaskSet operation returned by the service.
- See Also:
-
updateTaskSet
default UpdateTaskSetResponse updateTaskSet(Consumer<UpdateTaskSetRequest.Builder> updateTaskSetRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, AccessDeniedException, ServiceNotFoundException, ServiceNotActiveException, TaskSetNotFoundException, AwsServiceException, SdkClientException, EcsException 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.
This is a convenience which creates an instance of the
UpdateTaskSetRequest.Builder
avoiding the need to create one manually viaUpdateTaskSetRequest.builder()
- Parameters:
updateTaskSetRequest
- AConsumer
that will call methods onUpdateTaskSetRequest.Builder
to create a request.- Returns:
- Result of the UpdateTaskSet operation returned by the service.
- See Also:
-
waiter
Create an instance ofEcsWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
EcsWaiter
-
create
Create aEcsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aEcsClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-