ecs/aws.sdk.kotlin.services.ecs

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

createCapacityProvider

inline suspend fun EcsClient.createCapacityProvider(crossinline block: CreateCapacityProviderRequest.Builder.() -> Unit): CreateCapacityProviderResponse

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.

createCluster

inline suspend fun EcsClient.createCluster(crossinline block: CreateClusterRequest.Builder.() -> Unit): CreateClusterResponse

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.

createService

inline suspend fun EcsClient.createService(crossinline block: CreateServiceRequest.Builder.() -> Unit): CreateServiceResponse

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, use UpdateService.

createTaskSet

inline suspend fun EcsClient.createTaskSet(crossinline block: CreateTaskSetRequest.Builder.() -> Unit): CreateTaskSetResponse

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.

deleteAccountSetting

inline suspend fun EcsClient.deleteAccountSetting(crossinline block: DeleteAccountSettingRequest.Builder.() -> Unit): DeleteAccountSettingResponse

Disables an account setting for a specified user, role, or the root user for an account.

deleteAttributes

inline suspend fun EcsClient.deleteAttributes(crossinline block: DeleteAttributesRequest.Builder.() -> Unit): DeleteAttributesResponse

Deletes one or more custom attributes from an Amazon ECS resource.

deleteCapacityProvider

inline suspend fun EcsClient.deleteCapacityProvider(crossinline block: DeleteCapacityProviderRequest.Builder.() -> Unit): DeleteCapacityProviderResponse

Deletes the specified capacity provider.

deleteCluster

inline suspend fun EcsClient.deleteCluster(crossinline block: DeleteClusterRequest.Builder.() -> Unit): DeleteClusterResponse

Deletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters with an INACTIVE status might remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting.

deleteService

inline suspend fun EcsClient.deleteService(crossinline block: DeleteServiceRequest.Builder.() -> Unit): DeleteServiceResponse

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.

deleteTaskDefinitions

inline suspend fun EcsClient.deleteTaskDefinitions(crossinline block: DeleteTaskDefinitionsRequest.Builder.() -> Unit): DeleteTaskDefinitionsResponse

Deletes one or more task definitions.

deleteTaskSet

inline suspend fun EcsClient.deleteTaskSet(crossinline block: DeleteTaskSetRequest.Builder.() -> Unit): DeleteTaskSetResponse

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.

deregisterContainerInstance

inline suspend fun EcsClient.deregisterContainerInstance(crossinline block: DeregisterContainerInstanceRequest.Builder.() -> Unit): DeregisterContainerInstanceResponse

Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.

deregisterTaskDefinition

inline suspend fun EcsClient.deregisterTaskDefinition(crossinline block: DeregisterTaskDefinitionRequest.Builder.() -> Unit): DeregisterTaskDefinitionResponse

Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count. If you want to delete a task definition revision, you must first deregister the task definition revision.

describeCapacityProviders

inline suspend fun EcsClient.describeCapacityProviders(crossinline block: DescribeCapacityProvidersRequest.Builder.() -> Unit): DescribeCapacityProvidersResponse

Describes one or more of your capacity providers.

describeClusters

inline suspend fun EcsClient.describeClusters(crossinline block: DescribeClustersRequest.Builder.() -> Unit): DescribeClustersResponse

Describes one or more of your clusters.

describeContainerInstances

inline suspend fun EcsClient.describeContainerInstances(crossinline block: DescribeContainerInstancesRequest.Builder.() -> Unit): DescribeContainerInstancesResponse

Describes one or more container instances. Returns metadata about each container instance requested.

describeServiceDeployments

inline suspend fun EcsClient.describeServiceDeployments(crossinline block: DescribeServiceDeploymentsRequest.Builder.() -> Unit): DescribeServiceDeploymentsResponse

Describes one or more of your service deployments.

describeServiceRevisions

inline suspend fun EcsClient.describeServiceRevisions(crossinline block: DescribeServiceRevisionsRequest.Builder.() -> Unit): DescribeServiceRevisionsResponse

Describes one or more service revisions.

describeServices

inline suspend fun EcsClient.describeServices(crossinline block: DescribeServicesRequest.Builder.() -> Unit): DescribeServicesResponse

Describes the specified services running in your cluster.

describeTaskDefinition

inline suspend fun EcsClient.describeTaskDefinition(crossinline block: DescribeTaskDefinitionRequest.Builder.() -> Unit): DescribeTaskDefinitionResponse

Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.

describeTasks

inline suspend fun EcsClient.describeTasks(crossinline block: DescribeTasksRequest.Builder.() -> Unit): DescribeTasksResponse

Describes a specified task or tasks.

describeTaskSets

inline suspend fun EcsClient.describeTaskSets(crossinline block: DescribeTaskSetsRequest.Builder.() -> Unit): DescribeTaskSetsResponse

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.

discoverPollEndpoint

inline suspend fun EcsClient.discoverPollEndpoint(crossinline block: DiscoverPollEndpointRequest.Builder.() -> Unit): DiscoverPollEndpointResponse

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

executeCommand

inline suspend fun EcsClient.executeCommand(crossinline block: ExecuteCommandRequest.Builder.() -> Unit): ExecuteCommandResponse

Runs a command remotely on a container within a task.

getTaskProtection

inline suspend fun EcsClient.getTaskProtection(crossinline block: GetTaskProtectionRequest.Builder.() -> Unit): GetTaskProtectionResponse

Retrieves the protection status of tasks in an Amazon ECS service.

listAccountSettings

inline suspend fun EcsClient.listAccountSettings(crossinline block: ListAccountSettingsRequest.Builder.() -> Unit): ListAccountSettingsResponse

Lists the account settings for a specified principal.

listAttributes

inline suspend fun EcsClient.listAttributes(crossinline block: ListAttributesRequest.Builder.() -> Unit): ListAttributesResponse

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).

listClusters

inline suspend fun EcsClient.listClusters(crossinline block: ListClustersRequest.Builder.() -> Unit): ListClustersResponse

Returns a list of existing clusters.

listContainerInstances

inline suspend fun EcsClient.listContainerInstances(crossinline block: ListContainerInstancesRequest.Builder.() -> Unit): ListContainerInstancesResponse

Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

listServiceDeployments

inline suspend fun EcsClient.listServiceDeployments(crossinline block: ListServiceDeploymentsRequest.Builder.() -> Unit): ListServiceDeploymentsResponse

This operation lists all the service deployments that meet the specified filter criteria.

listServices

inline suspend fun EcsClient.listServices(crossinline block: ListServicesRequest.Builder.() -> Unit): ListServicesResponse

Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.

listServicesByNamespace

inline suspend fun EcsClient.listServicesByNamespace(crossinline block: ListServicesByNamespaceRequest.Builder.() -> Unit): ListServicesByNamespaceResponse

This operation lists all of the services that are associated with a Cloud Map namespace. This list might include services in different clusters. In contrast, ListServices can only list services in one cluster at a time. If you need to filter the list of services in a single cluster by various parameters, use ListServices. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

listTagsForResource

inline suspend fun EcsClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

List the tags for an Amazon ECS resource.

listTaskDefinitionFamilies

inline suspend fun EcsClient.listTaskDefinitionFamilies(crossinline block: ListTaskDefinitionFamiliesRequest.Builder.() -> Unit): ListTaskDefinitionFamiliesResponse

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.

listTaskDefinitions

inline suspend fun EcsClient.listTaskDefinitions(crossinline block: ListTaskDefinitionsRequest.Builder.() -> Unit): ListTaskDefinitionsResponse

Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.

listTasks

inline suspend fun EcsClient.listTasks(crossinline block: ListTasksRequest.Builder.() -> Unit): ListTasksResponse

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.

putAccountSetting

inline suspend fun EcsClient.putAccountSetting(crossinline block: PutAccountSettingRequest.Builder.() -> Unit): PutAccountSettingResponse

Modifies an account setting. Account settings are set on a per-Region basis.

putAccountSettingDefault

inline suspend fun EcsClient.putAccountSettingDefault(crossinline block: PutAccountSettingDefaultRequest.Builder.() -> Unit): PutAccountSettingDefaultResponse

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.

putAttributes

inline suspend fun EcsClient.putAttributes(crossinline block: PutAttributesRequest.Builder.() -> Unit): PutAttributesResponse

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.

putClusterCapacityProviders

inline suspend fun EcsClient.putClusterCapacityProviders(crossinline block: PutClusterCapacityProvidersRequest.Builder.() -> Unit): PutClusterCapacityProvidersResponse

Modifies the available capacity providers and the default capacity provider strategy for a cluster.

registerContainerInstance

inline suspend fun EcsClient.registerContainerInstance(crossinline block: RegisterContainerInstanceRequest.Builder.() -> Unit): RegisterContainerInstanceResponse

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

registerTaskDefinition

inline suspend fun EcsClient.registerTaskDefinition(crossinline block: RegisterTaskDefinitionRequest.Builder.() -> Unit): RegisterTaskDefinitionResponse

Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

runTask

inline suspend fun EcsClient.runTask(crossinline block: RunTaskRequest.Builder.() -> Unit): RunTaskResponse

Starts a new task using the specified task definition.

startTask

inline suspend fun EcsClient.startTask(crossinline block: StartTaskRequest.Builder.() -> Unit): StartTaskResponse

Starts a new task from the specified task definition on the specified container instance or instances.

stopServiceDeployment

inline suspend fun EcsClient.stopServiceDeployment(crossinline block: StopServiceDeploymentRequest.Builder.() -> Unit): StopServiceDeploymentResponse

Stops an ongoing service deployment.

stopTask

inline suspend fun EcsClient.stopTask(crossinline block: StopTaskRequest.Builder.() -> Unit): StopTaskResponse

Stops a running task. Any tags associated with the task will be deleted.

submitAttachmentStateChanges

inline suspend fun EcsClient.submitAttachmentStateChanges(crossinline block: SubmitAttachmentStateChangesRequest.Builder.() -> Unit): SubmitAttachmentStateChangesResponse

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

submitContainerStateChange

inline suspend fun EcsClient.submitContainerStateChange(crossinline block: SubmitContainerStateChangeRequest.Builder.() -> Unit): SubmitContainerStateChangeResponse

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

submitTaskStateChange

inline suspend fun EcsClient.submitTaskStateChange(crossinline block: SubmitTaskStateChangeRequest.Builder.() -> Unit): SubmitTaskStateChangeResponse

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

tagResource

inline suspend fun EcsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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.

untagResource

inline suspend fun EcsClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Deletes specified tags from a resource.

updateCapacityProvider

inline suspend fun EcsClient.updateCapacityProvider(crossinline block: UpdateCapacityProviderRequest.Builder.() -> Unit): UpdateCapacityProviderResponse

Modifies the parameters for a capacity provider.

updateCluster

inline suspend fun EcsClient.updateCluster(crossinline block: UpdateClusterRequest.Builder.() -> Unit): UpdateClusterResponse

Updates the cluster.

updateClusterSettings

inline suspend fun EcsClient.updateClusterSettings(crossinline block: UpdateClusterSettingsRequest.Builder.() -> Unit): UpdateClusterSettingsResponse

Modifies the settings to use for a cluster.

updateContainerAgent

inline suspend fun EcsClient.updateContainerAgent(crossinline block: UpdateContainerAgentRequest.Builder.() -> Unit): UpdateContainerAgentResponse

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.

updateContainerInstancesState

inline suspend fun EcsClient.updateContainerInstancesState(crossinline block: UpdateContainerInstancesStateRequest.Builder.() -> Unit): UpdateContainerInstancesStateResponse

Modifies the status of an Amazon ECS container instance.

updateService

inline suspend fun EcsClient.updateService(crossinline block: UpdateServiceRequest.Builder.() -> Unit): UpdateServiceResponse

Modifies the parameters of a service.

updateServicePrimaryTaskSet

inline suspend fun EcsClient.updateServicePrimaryTaskSet(crossinline block: UpdateServicePrimaryTaskSetRequest.Builder.() -> Unit): UpdateServicePrimaryTaskSetResponse

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.

updateTaskProtection

inline suspend fun EcsClient.updateTaskProtection(crossinline block: UpdateTaskProtectionRequest.Builder.() -> Unit): UpdateTaskProtectionResponse

Updates the protection status of a task. You can set protectionEnabled to true to protect your task from termination during scale-in events from Service Autoscaling or deployments.

updateTaskSet

inline suspend fun EcsClient.updateTaskSet(crossinline block: UpdateTaskSetRequest.Builder.() -> Unit): UpdateTaskSetResponse

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.

withConfig

fun EcsClient.withConfig(block: EcsClient.Config.Builder.() -> Unit): EcsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.