C# (CSharp) Amazon.ECS.Model Пространство имен

Классы

Имя Описание
Accessories
Accessory
Address
AlternateVersion
AlternateVersions
Argument
Arguments
AvailabilityAttributes
AvailableParameters
Bin
BrowseNode
BrowseNodeAncestors
BrowseNodeChildren
BrowseNodeLookup
BrowseNodeLookupRequest
BrowseNodeLookupResponse
BrowseNodeProperties
BrowseNodes
CartAdd
CartAddItem
CartAddItems
CartAddRequest
CartAddResponse
CartClear
CartClearRequest
CartClearResponse
CartCreateItem
CartCreateItems
CartGetResponse
CartItem
CartItemMetaData
CartItems
CartModify
CartModifyItem
CartModifyItems
CartModifyRequest
ClientException
Cluster A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
ClusterContainsContainerInstancesException
ClusterContainsServicesException
ClusterNotFoundException
CollectionParent
CollectionSummary
Collections
CollectionsCollection
ContainerDefinition Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
ContainerInstance An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
CorrectedQuery
CreateClusterResponse This is the response object from the CreateCluster operation.
CreateServiceRequest Container for the parameters to the CreateService operation. Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see UpdateService.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon EC2 Container Service Developer Guide.

You can optionally specify a deployment configuration for your service. During a deployment (which is triggered by changing the task definition or the desired count of a service with an UpdateService operation), the service scheduler uses the minimumHealthyPercent and maximumPercent parameters to determine the deployment strategy.

The minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance it is hosted on is reported as healthy by the load balancer. The default value for minimumHealthyPercent is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs.

The maximumPercent parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service has a desiredCount of four tasks and a maximumPercent 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 maximumPercent is 200%.

When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones 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).

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

CreateServiceResponse This is the response object from the CreateService operation.
Creator
CustomerContentLookup
CustomerContentLookupRequest
CustomerContentLookupResponse
CustomerContentSearch
CustomerContentSearchRequest
CustomerLocation
CustomerReviews
Customers
DecimalWithUnits
DefaultResponseGroups
DeleteClusterResponse Configuration for accessing Amazon DeleteCluster service
DeleteServiceResponse This is the response object from the DeleteService operation.
Deployment The details of an Amazon ECS service deployment.
DeploymentConfiguration Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
DeregisterContainerInstanceRequest Container for the parameters to the DeregisterContainerInstance operation. 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, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources.

Deregistering a container instance removes the instance from a cluster, but it does not 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 are not automatically deregistered when terminated).

DeregisterContainerInstanceResponse Configuration for accessing Amazon DeregisterContainerInstance service
DeregisterTaskDefinitionResponse Configuration for accessing Amazon DeregisterTaskDefinition service
DescribeClustersRequest Container for the parameters to the DescribeClusters operation. Describes one or more of your clusters.
DescribeClustersResponse This is the response object from the DescribeClusters operation.
DescribeServicesRequest Container for the parameters to the DescribeServices operation. Describes the specified services running in your cluster.
DescribeServicesResponse This is the response object from the DescribeServices operation.
DescribeTaskDefinitionResponse Configuration for accessing Amazon DescribeTaskDefinition service
DescribeTasksResponse This is the response object from the DescribeTasks operation.
Disc
EditorialReview
EditorialReviews
Feedback
FeedbackDateRange
Guide
HTTPHeaders
HelpRequest
HelpResponse
Image
ImageSet
ImageSets
Information
InvalidParameterException
Item
ItemAttributes
ItemDimensions
ItemLookupRequest
ItemLookupResponse
ItemSearchRequest
Items
Language
Languages
List
ListClustersRequest Container for the parameters to the ListClusters operation. Returns a list of existing clusters.
ListClustersResponse This is the response object from the ListClusters operation.
ListContainerInstancesRequest Container for the parameters to the ListContainerInstances operation. Returns a list of container instances in a specified cluster.
ListContainerInstancesResponse Configuration for accessing Amazon ListContainerInstances service
ListItem
ListLookup
ListLookupRequest
ListLookupResponse
ListSearch
ListSearchRequest
ListServicesRequest Container for the parameters to the ListServices operation. Lists the services that are running in a specified cluster.
ListServicesResponse This is the response object from the ListServices operation.
ListTaskDefinitionFamiliesRequest Container for the parameters to the ListTaskDefinitionFamilies operation. Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definition revisions).

You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.

ListTaskDefinitionFamiliesResponse This is the response object from the ListTaskDefinitionFamilies operation.
ListTaskDefinitionsRequest Container for the parameters to the ListTaskDefinitions operation. 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.
ListTaskDefinitionsResponse This is the response object from the ListTaskDefinitions operation.
ListTasksRequest Container for the parameters to the ListTasks operation. Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters.

Recently-stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.

ListTasksResponse This is the response object from the ListTasks operation.
ListmaniaList
ListmaniaLists
Lists
LoadBalancer Details on a load balancer that is used with a service.
LogConfiguration Log configuration options to send to a custom log driver for the container.
LoyaltyPoints
Merchant
MerchantItemAttributes
MetaData
MissingVersionException
NewRelease
NewReleases
NoUpdateAvailableException
NonNegativeIntegerWithUnits
Offer
OfferAttributes
OfferListing
Offers
OperationInformation
OtherCategoriesSimilarProduct
OtherCategoriesSimilarProducts
PackageDimensions
PortMapping Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
Price
Promotion
PromotionBenefit
PromotionBenefits
PromotionDetails
PromotionEligibilityRequirement
Promotions
Property
RegisterTaskDefinitionRequest Container for the parameters to the RegisterTaskDefinition operation. 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 EC2 Container Service Developer Guide.

You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon EC2 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.

RegisterTaskDefinitionResponse This is the response object from the RegisterTaskDefinition operation.
RequiredParameters
ResponseGroupElements
ResponseGroupInformation
ResponseGroupValidOperations
Review
Reviewer
RunTaskRequest Container for the parameters to the RunTask operation. Start a task using random placement and the default Amazon ECS scheduler. To use your own scheduler or place a task on a specific container instance, use StartTask instead.

The count parameter is limited to 10 tasks per call.

RunTaskResponse Configuration for accessing Amazon RunTask service
SavedForLaterItems
SearchBinSets
SearchInside
SearchResultsMap
SearchResultsMapSearchIndex
Seller
SellerFeedbackSummary
SellerListing
SellerListingLookup
SellerListingLookupRequest
SellerListingLookupResponse
SellerListingSearch
SellerListingSearchRequest
SellerListingSearchResponse
SellerListings
SellerLocation
SellerLookup
SellerLookupRequest
SellerLookupResponse
Sellers
ServerException
Service Details on a service within a cluster
ServiceEvent Details on an event associated with a service.
ServiceNotActiveException
ServiceNotFoundException
ShipmentItems
ShipmentPackage
ShipmentPackages
ShippingCharge
SimilarProduct
SimilarProducts
SimilarViewedProducts
SimilarityLookup
SimilarityLookupRequest
SimilarityLookupResponse
StartTaskRequest Container for the parameters to the StartTask operation. Starts a new task from the specified task definition on the specified container instance or instances. To use the default Amazon ECS scheduler to place your task, use RunTask instead.

The list of container instances to start tasks on is limited to 10.

StartTaskResponse Configuration for accessing Amazon StartTask service
StopTaskRequest Container for the parameters to the StopTask operation. Stops a running task.

When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.

StopTaskResponse Configuration for accessing Amazon StopTask service
StringWithUnits
Subjects
Tag
TagLookup
TagLookupRequest
TagLookupResponse
TaggedItems
TaggedListmaniaLists
Tagging
Tags
Task Details on a task in a cluster.
TaskDefinition Details of a task definition.
TaskOverride The overrides associated with a task.
TopSellers
Track
Tracks
Transaction
TransactionItem
TransactionItems
TransactionLookupResponse
TransactionTotals
UpdateContainerAgentRequest Container for the parameters to the UpdateContainerAgent operation. Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not 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.

UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon EC2 Container Service Developer Guide.

UpdateContainerAgentResponse This is the response object from the UpdateContainerAgent operation.
UpdateInProgressException
UpdateServiceRequest Container for the parameters to the UpdateService operation. Modifies the desired count, deployment configuration, or task definition used in a service.

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 use UpdateService to modify your task definition and deploy a new version of your service.

You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.

If the minimumHealthyPercent is below 100%, the scheduler can ignore the desiredCount temporarily during a deployment. For example, if your service has a desiredCount of four tasks, a minimumHealthyPercent of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance it is hosted on is reported as healthy by the load balancer.

The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a desiredCount of four tasks, a maximumPercent value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).

When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.

When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones 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).

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

UpdateServiceResponse This is the response object from the UpdateService operation.
VariationDimensions
VariationSummary
Variations
VendorRebate