ecs

package
v1.14.29 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 18, 2018 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package ecs provides the client and types for making API requests to Amazon EC2 Container Service.

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see Amazon ECS Launch Types (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html).

Amazon ECS lets you launch and stop container-based applications with simple API calls, allows you 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. Amazon ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.

See https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13 for more information on this service.

See ecs package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/ecs/

Using the Client

To contact Amazon EC2 Container Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon EC2 Container Service client ECS for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/ecs/#New

Index

Examples

Constants

View Source 
const (
	// AgentUpdateStatusPending is a AgentUpdateStatus enum value
	AgentUpdateStatusPending = "PENDING"

	// AgentUpdateStatusStaging is a AgentUpdateStatus enum value
	AgentUpdateStatusStaging = "STAGING"

	// AgentUpdateStatusStaged is a AgentUpdateStatus enum value
	AgentUpdateStatusStaged = "STAGED"

	// AgentUpdateStatusUpdating is a AgentUpdateStatus enum value
	AgentUpdateStatusUpdating = "UPDATING"

	// AgentUpdateStatusUpdated is a AgentUpdateStatus enum value
	AgentUpdateStatusUpdated = "UPDATED"

	// AgentUpdateStatusFailed is a AgentUpdateStatus enum value
	AgentUpdateStatusFailed = "FAILED"
)
View Source 
const (
	// AssignPublicIpEnabled is a AssignPublicIp enum value
	AssignPublicIpEnabled = "ENABLED"

	// AssignPublicIpDisabled is a AssignPublicIp enum value
	AssignPublicIpDisabled = "DISABLED"
)
View Source 
const (
	// CompatibilityEc2 is a Compatibility enum value
	CompatibilityEc2 = "EC2"

	// CompatibilityFargate is a Compatibility enum value
	CompatibilityFargate = "FARGATE"
)
View Source 
const (
	// ConnectivityConnected is a Connectivity enum value
	ConnectivityConnected = "CONNECTED"

	// ConnectivityDisconnected is a Connectivity enum value
	ConnectivityDisconnected = "DISCONNECTED"
)
View Source 
const (
	// ContainerInstanceStatusActive is a ContainerInstanceStatus enum value
	ContainerInstanceStatusActive = "ACTIVE"

	// ContainerInstanceStatusDraining is a ContainerInstanceStatus enum value
	ContainerInstanceStatusDraining = "DRAINING"
)
View Source 
const (
	// DesiredStatusRunning is a DesiredStatus enum value
	DesiredStatusRunning = "RUNNING"

	// DesiredStatusPending is a DesiredStatus enum value
	DesiredStatusPending = "PENDING"

	// DesiredStatusStopped is a DesiredStatus enum value
	DesiredStatusStopped = "STOPPED"
)
View Source 
const (
	// DeviceCgroupPermissionRead is a DeviceCgroupPermission enum value
	DeviceCgroupPermissionRead = "read"

	// DeviceCgroupPermissionWrite is a DeviceCgroupPermission enum value
	DeviceCgroupPermissionWrite = "write"

	// DeviceCgroupPermissionMknod is a DeviceCgroupPermission enum value
	DeviceCgroupPermissionMknod = "mknod"
)
View Source 
const (
	// HealthStatusHealthy is a HealthStatus enum value
	HealthStatusHealthy = "HEALTHY"

	// HealthStatusUnhealthy is a HealthStatus enum value
	HealthStatusUnhealthy = "UNHEALTHY"

	// HealthStatusUnknown is a HealthStatus enum value
	HealthStatusUnknown = "UNKNOWN"
)
View Source 
const (
	// LaunchTypeEc2 is a LaunchType enum value
	LaunchTypeEc2 = "EC2"

	// LaunchTypeFargate is a LaunchType enum value
	LaunchTypeFargate = "FARGATE"
)
View Source 
const (
	// LogDriverJsonFile is a LogDriver enum value
	LogDriverJsonFile = "json-file"

	// LogDriverSyslog is a LogDriver enum value
	LogDriverSyslog = "syslog"

	// LogDriverJournald is a LogDriver enum value
	LogDriverJournald = "journald"

	// LogDriverGelf is a LogDriver enum value
	LogDriverGelf = "gelf"

	// LogDriverFluentd is a LogDriver enum value
	LogDriverFluentd = "fluentd"

	// LogDriverAwslogs is a LogDriver enum value
	LogDriverAwslogs = "awslogs"

	// LogDriverSplunk is a LogDriver enum value
	LogDriverSplunk = "splunk"
)
View Source 
const (
	// NetworkModeBridge is a NetworkMode enum value
	NetworkModeBridge = "bridge"

	// NetworkModeHost is a NetworkMode enum value
	NetworkModeHost = "host"

	// NetworkModeAwsvpc is a NetworkMode enum value
	NetworkModeAwsvpc = "awsvpc"

	// NetworkModeNone is a NetworkMode enum value
	NetworkModeNone = "none"
)
View Source 
const (
	// PlacementConstraintTypeDistinctInstance is a PlacementConstraintType enum value
	PlacementConstraintTypeDistinctInstance = "distinctInstance"

	// PlacementConstraintTypeMemberOf is a PlacementConstraintType enum value
	PlacementConstraintTypeMemberOf = "memberOf"
)
View Source 
const (
	// PlacementStrategyTypeRandom is a PlacementStrategyType enum value
	PlacementStrategyTypeRandom = "random"

	// PlacementStrategyTypeSpread is a PlacementStrategyType enum value
	PlacementStrategyTypeSpread = "spread"

	// PlacementStrategyTypeBinpack is a PlacementStrategyType enum value
	PlacementStrategyTypeBinpack = "binpack"
)
View Source 
const (
	// SchedulingStrategyReplica is a SchedulingStrategy enum value
	SchedulingStrategyReplica = "REPLICA"

	// SchedulingStrategyDaemon is a SchedulingStrategy enum value
	SchedulingStrategyDaemon = "DAEMON"
)
View Source 
const (
	// SortOrderAsc is a SortOrder enum value
	SortOrderAsc = "ASC"

	// SortOrderDesc is a SortOrder enum value
	SortOrderDesc = "DESC"
)
View Source 
const (
	// TaskDefinitionFamilyStatusActive is a TaskDefinitionFamilyStatus enum value
	TaskDefinitionFamilyStatusActive = "ACTIVE"

	// TaskDefinitionFamilyStatusInactive is a TaskDefinitionFamilyStatus enum value
	TaskDefinitionFamilyStatusInactive = "INACTIVE"

	// TaskDefinitionFamilyStatusAll is a TaskDefinitionFamilyStatus enum value
	TaskDefinitionFamilyStatusAll = "ALL"
)
View Source 
const (
	// TaskDefinitionStatusActive is a TaskDefinitionStatus enum value
	TaskDefinitionStatusActive = "ACTIVE"

	// TaskDefinitionStatusInactive is a TaskDefinitionStatus enum value
	TaskDefinitionStatusInactive = "INACTIVE"
)
View Source 
const (
	// TransportProtocolTcp is a TransportProtocol enum value
	TransportProtocolTcp = "tcp"

	// TransportProtocolUdp is a TransportProtocol enum value
	TransportProtocolUdp = "udp"
)
View Source 
const (
	// UlimitNameCore is a UlimitName enum value
	UlimitNameCore = "core"

	// UlimitNameCpu is a UlimitName enum value
	UlimitNameCpu = "cpu"

	// UlimitNameData is a UlimitName enum value
	UlimitNameData = "data"

	// UlimitNameFsize is a UlimitName enum value
	UlimitNameFsize = "fsize"

	// UlimitNameLocks is a UlimitName enum value
	UlimitNameLocks = "locks"

	// UlimitNameMemlock is a UlimitName enum value
	UlimitNameMemlock = "memlock"

	// UlimitNameMsgqueue is a UlimitName enum value
	UlimitNameMsgqueue = "msgqueue"

	// UlimitNameNice is a UlimitName enum value
	UlimitNameNice = "nice"

	// UlimitNameNofile is a UlimitName enum value
	UlimitNameNofile = "nofile"

	// UlimitNameNproc is a UlimitName enum value
	UlimitNameNproc = "nproc"

	// UlimitNameRss is a UlimitName enum value
	UlimitNameRss = "rss"

	// UlimitNameRtprio is a UlimitName enum value
	UlimitNameRtprio = "rtprio"

	// UlimitNameRttime is a UlimitName enum value
	UlimitNameRttime = "rttime"

	// UlimitNameSigpending is a UlimitName enum value
	UlimitNameSigpending = "sigpending"

	// UlimitNameStack is a UlimitName enum value
	UlimitNameStack = "stack"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have authorization to perform the requested action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeAttributeLimitExceededException for service response error code
	// "AttributeLimitExceededException".
	//
	// You can apply up to 10 custom attributes per resource. You can view the attributes
	// of a resource with ListAttributes. You can remove existing attributes on
	// a resource with DeleteAttributes.
	ErrCodeAttributeLimitExceededException = "AttributeLimitExceededException"

	// ErrCodeBlockedException for service response error code
	// "BlockedException".
	//
	// Your AWS account has been blocked. Contact AWS Support (http://aws.amazon.com/contact-us/)
	// for more information.
	ErrCodeBlockedException = "BlockedException"

	// ErrCodeClientException for service response error code
	// "ClientException".
	//
	// These errors are usually caused by a client action, such as using an action
	// or resource on behalf of a user that doesn't have permissions to use the
	// action or resource, or specifying an identifier that is not valid.
	ErrCodeClientException = "ClientException"

	// ErrCodeClusterContainsContainerInstancesException for service response error code
	// "ClusterContainsContainerInstancesException".
	//
	// You cannot delete a cluster that has registered container instances. You
	// must first deregister the container instances before you can delete the cluster.
	// For more information, see DeregisterContainerInstance.
	ErrCodeClusterContainsContainerInstancesException = "ClusterContainsContainerInstancesException"

	// ErrCodeClusterContainsServicesException for service response error code
	// "ClusterContainsServicesException".
	//
	// You cannot delete a cluster that contains services. You must first update
	// the service to reduce its desired task count to 0 and then delete the service.
	// For more information, see UpdateService and DeleteService.
	ErrCodeClusterContainsServicesException = "ClusterContainsServicesException"

	// ErrCodeClusterContainsTasksException for service response error code
	// "ClusterContainsTasksException".
	//
	// You cannot delete a cluster that has active tasks.
	ErrCodeClusterContainsTasksException = "ClusterContainsTasksException"

	// ErrCodeClusterNotFoundException for service response error code
	// "ClusterNotFoundException".
	//
	// The specified cluster could not be found. You can view your available clusters
	// with ListClusters. Amazon ECS clusters are region-specific.
	ErrCodeClusterNotFoundException = "ClusterNotFoundException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// The specified parameter is invalid. Review the available parameters for the
	// API request.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeMissingVersionException for service response error code
	// "MissingVersionException".
	//
	// Amazon ECS is unable to determine the current version of the Amazon ECS container
	// agent on the container instance and does not have enough information to proceed
	// with an update. This could be because the agent running on the container
	// instance is an older or custom version that does not use our version information.
	ErrCodeMissingVersionException = "MissingVersionException"

	// ErrCodeNoUpdateAvailableException for service response error code
	// "NoUpdateAvailableException".
	//
	// There is no update available for this Amazon ECS container agent. This could
	// be because the agent is already running the latest version, or it is so old
	// that there is no update path to the current version.
	ErrCodeNoUpdateAvailableException = "NoUpdateAvailableException"

	// ErrCodePlatformTaskDefinitionIncompatibilityException for service response error code
	// "PlatformTaskDefinitionIncompatibilityException".
	//
	// The specified platform version does not satisfy the task definition’s required
	// capabilities.
	ErrCodePlatformTaskDefinitionIncompatibilityException = "PlatformTaskDefinitionIncompatibilityException"

	// ErrCodePlatformUnknownException for service response error code
	// "PlatformUnknownException".
	//
	// The specified platform version does not exist.
	ErrCodePlatformUnknownException = "PlatformUnknownException"

	// ErrCodeServerException for service response error code
	// "ServerException".
	//
	// These errors are usually caused by a server issue.
	ErrCodeServerException = "ServerException"

	// ErrCodeServiceNotActiveException for service response error code
	// "ServiceNotActiveException".
	//
	// The specified service is not active. You can't update a service that is inactive.
	// If you have previously deleted a service, you can re-create it with CreateService.
	ErrCodeServiceNotActiveException = "ServiceNotActiveException"

	// ErrCodeServiceNotFoundException for service response error code
	// "ServiceNotFoundException".
	//
	// The specified service could not be found. You can view your available services
	// with ListServices. Amazon ECS services are cluster-specific and region-specific.
	ErrCodeServiceNotFoundException = "ServiceNotFoundException"

	// ErrCodeTargetNotFoundException for service response error code
	// "TargetNotFoundException".
	//
	// The specified target could not be found. You can view your available container
	// instances with ListContainerInstances. Amazon ECS container instances are
	// cluster-specific and region-specific.
	ErrCodeTargetNotFoundException = "TargetNotFoundException"

	// ErrCodeUnsupportedFeatureException for service response error code
	// "UnsupportedFeatureException".
	//
	// The specified task is not supported in this region.
	ErrCodeUnsupportedFeatureException = "UnsupportedFeatureException"

	// ErrCodeUpdateInProgressException for service response error code
	// "UpdateInProgressException".
	//
	// There is already a current Amazon ECS container agent update in progress
	// on the specified container instance. If the container agent becomes disconnected
	// while it is in a transitional stage, such as PENDING or STAGING, the update
	// process can get stuck in that state. However, when the agent reconnects,
	// it resumes where it stopped previously.
	ErrCodeUpdateInProgressException = "UpdateInProgressException"
)
View Source 
const (
	ServiceName = "ecs"       // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "ECS"       // ServiceID is a unique identifer of a specific service.
)

Service information constants

View Source 
const (
	// ClusterFieldStatistics is a ClusterField enum value
	ClusterFieldStatistics = "STATISTICS"
)
View Source 
const (
	// TargetTypeContainerInstance is a TargetType enum value
	TargetTypeContainerInstance = "container-instance"
)
View Source 
const (
	// TaskDefinitionPlacementConstraintTypeMemberOf is a TaskDefinitionPlacementConstraintType enum value
	TaskDefinitionPlacementConstraintTypeMemberOf = "memberOf"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Attachment added in v1.12.27 

type Attachment struct {

	// Details of the attachment. For Elastic Network Interfaces, this includes
	// the network interface ID, the MAC address, the subnet ID, and the private
	// IPv4 address.
	Details []*KeyValuePair `locationName:"details" type:"list"`

	// The unique identifier for the attachment.
	Id *string `locationName:"id" type:"string"`

	// The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING,
	// ATTACHED, DETACHING, DETACHED, and DELETED.
	Status *string `locationName:"status" type:"string"`

	// The type of the attachment, such as ElasticNetworkInterface.
	Type *string `locationName:"type" type:"string"`
	// contains filtered or unexported fields
}

An object representing a container instance or task attachment.

func (Attachment) GoString added in v1.12.27 

func (s Attachment) GoString() string

GoString returns the string representation

func (*Attachment) SetDetails added in v1.12.27 

func (s *Attachment) SetDetails(v []*KeyValuePair) *Attachment

SetDetails sets the Details field's value.

func (*Attachment) SetId added in v1.12.27 

func (s *Attachment) SetId(v string) *Attachment

SetId sets the Id field's value.

func (*Attachment) SetStatus added in v1.12.27 

func (s *Attachment) SetStatus(v string) *Attachment

SetStatus sets the Status field's value.

func (*Attachment) SetType added in v1.12.27 

func (s *Attachment) SetType(v string) *Attachment

SetType sets the Type field's value.

func (Attachment) String added in v1.12.27 

func (s Attachment) String() string

String returns the string representation

type AttachmentStateChange added in v1.12.27 

type AttachmentStateChange struct {

	// The Amazon Resource Name (ARN) of the attachment.
	//
	// AttachmentArn is a required field
	AttachmentArn *string `locationName:"attachmentArn" type:"string" required:"true"`

	// The status of the attachment.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true"`
	// contains filtered or unexported fields
}

An object representing a change in state for a task attachment.

func (AttachmentStateChange) GoString added in v1.12.27 

func (s AttachmentStateChange) GoString() string

GoString returns the string representation

func (*AttachmentStateChange) SetAttachmentArn added in v1.12.27 

func (s *AttachmentStateChange) SetAttachmentArn(v string) *AttachmentStateChange

SetAttachmentArn sets the AttachmentArn field's value.

func (*AttachmentStateChange) SetStatus added in v1.12.27 

func (s *AttachmentStateChange) SetStatus(v string) *AttachmentStateChange

SetStatus sets the Status field's value.

func (AttachmentStateChange) String added in v1.12.27 

func (s AttachmentStateChange) String() string

String returns the string representation

func (*AttachmentStateChange) Validate added in v1.12.27 

func (s *AttachmentStateChange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Attribute added in v0.9.14 

type Attribute struct {

	// The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers,
	// hyphens, underscores, and periods are allowed.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The ID of the target. You can specify the short form ID for a resource or
	// the full Amazon Resource Name (ARN).
	TargetId *string `locationName:"targetId" type:"string"`

	// The type of the target with which to attach the attribute. This parameter
	// is required if you use the short form ID for a resource instead of the full
	// ARN.
	TargetType *string `locationName:"targetType" type:"string" enum:"TargetType"`

	// The value of the attribute. Up to 128 letters (uppercase and lowercase),
	// numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons,
	// and spaces are allowed.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes) in the Amazon Elastic Container Service Developer Guide.

func (Attribute) GoString added in v0.9.14 

func (s Attribute) GoString() string

GoString returns the string representation

func (*Attribute) SetName added in v1.5.0 

func (s *Attribute) SetName(v string) *Attribute

SetName sets the Name field's value.

func (*Attribute) SetTargetId added in v1.6.9 

func (s *Attribute) SetTargetId(v string) *Attribute

SetTargetId sets the TargetId field's value.

func (*Attribute) SetTargetType added in v1.6.9 

func (s *Attribute) SetTargetType(v string) *Attribute

SetTargetType sets the TargetType field's value.

func (*Attribute) SetValue added in v1.5.0 

func (s *Attribute) SetValue(v string) *Attribute

SetValue sets the Value field's value.

func (Attribute) String added in v0.9.14 

func (s Attribute) String() string

String returns the string representation

func (*Attribute) Validate added in v1.1.21 

func (s *Attribute) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AwsVpcConfiguration added in v1.12.27 

type AwsVpcConfiguration struct {

	// Whether the task's elastic network interface receives a public IP address.
	AssignPublicIp *string `locationName:"assignPublicIp" type:"string" enum:"AssignPublicIp"`

	// The security groups associated with the task or service. If you do not specify
	// a security group, the default security group for the VPC is used. There is
	// a limit of 5 security groups able to be specified per AwsVpcConfiguration.
	SecurityGroups []*string `locationName:"securityGroups" type:"list"`

	// The subnets associated with the task or service. There is a limit of 10 subnets
	// able to be specified per AwsVpcConfiguration.
	//
	// Subnets is a required field
	Subnets []*string `locationName:"subnets" type:"list" required:"true"`
	// contains filtered or unexported fields
}

An object representing the networking details for a task or service.

func (AwsVpcConfiguration) GoString added in v1.12.27 

func (s AwsVpcConfiguration) GoString() string

GoString returns the string representation

func (*AwsVpcConfiguration) SetAssignPublicIp added in v1.12.36 

func (s *AwsVpcConfiguration) SetAssignPublicIp(v string) *AwsVpcConfiguration

SetAssignPublicIp sets the AssignPublicIp field's value.

func (*AwsVpcConfiguration) SetSecurityGroups added in v1.12.27 

func (s *AwsVpcConfiguration) SetSecurityGroups(v []*string) *AwsVpcConfiguration

SetSecurityGroups sets the SecurityGroups field's value.

func (*AwsVpcConfiguration) SetSubnets added in v1.12.27 

func (s *AwsVpcConfiguration) SetSubnets(v []*string) *AwsVpcConfiguration

SetSubnets sets the Subnets field's value.

func (AwsVpcConfiguration) String added in v1.12.27 

func (s AwsVpcConfiguration) String() string

String returns the string representation

func (*AwsVpcConfiguration) Validate added in v1.12.27 

func (s *AwsVpcConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Cluster 

type Cluster struct {

	// The number of services that are running on the cluster in an ACTIVE state.
	// You can view these services with ListServices.
	ActiveServicesCount *int64 `locationName:"activeServicesCount" type:"integer"`

	// The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains
	// the arn:aws:ecs namespace, followed by the region of the cluster, the AWS
	// account ID of the cluster owner, the cluster namespace, and then the cluster
	// name. For example, arn:aws:ecs:region:012345678910:cluster/test..
	ClusterArn *string `locationName:"clusterArn" type:"string"`

	// A user-generated string that you use to identify your cluster.
	ClusterName *string `locationName:"clusterName" type:"string"`

	// The number of tasks in the cluster that are in the PENDING state.
	PendingTasksCount *int64 `locationName:"pendingTasksCount" type:"integer"`

	// The number of container instances registered into the cluster.
	RegisteredContainerInstancesCount *int64 `locationName:"registeredContainerInstancesCount" type:"integer"`

	// The number of tasks in the cluster that are in the RUNNING state.
	RunningTasksCount *int64 `locationName:"runningTasksCount" type:"integer"`

	// Additional information about your clusters that are separated by launch type,
	// including:
	//
	//    * runningEC2TasksCount
	//
	//    * RunningFargateTasksCount
	//
	//    * pendingEC2TasksCount
	//
	//    * pendingFargateTasksCount
	//
	//    * activeEC2ServiceCount
	//
	//    * activeFargateServiceCount
	//
	//    * drainingEC2ServiceCount
	//
	//    * drainingFargateServiceCount
	Statistics []*KeyValuePair `locationName:"statistics" type:"list"`

	// The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE
	// indicates that you can register container instances with the cluster and
	// the associated instances can accept tasks.
	Status *string `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

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.

func (Cluster) GoString added in v0.6.5 

func (s Cluster) GoString() string

GoString returns the string representation

func (*Cluster) SetActiveServicesCount added in v1.5.0 

func (s *Cluster) SetActiveServicesCount(v int64) *Cluster

SetActiveServicesCount sets the ActiveServicesCount field's value.

func (*Cluster) SetClusterArn added in v1.5.0 

func (s *Cluster) SetClusterArn(v string) *Cluster

SetClusterArn sets the ClusterArn field's value.

func (*Cluster) SetClusterName added in v1.5.0 

func (s *Cluster) SetClusterName(v string) *Cluster

SetClusterName sets the ClusterName field's value.

func (*Cluster) SetPendingTasksCount added in v1.5.0 

func (s *Cluster) SetPendingTasksCount(v int64) *Cluster

SetPendingTasksCount sets the PendingTasksCount field's value.

func (*Cluster) SetRegisteredContainerInstancesCount added in v1.5.0 

func (s *Cluster) SetRegisteredContainerInstancesCount(v int64) *Cluster

SetRegisteredContainerInstancesCount sets the RegisteredContainerInstancesCount field's value.

func (*Cluster) SetRunningTasksCount added in v1.5.0 

func (s *Cluster) SetRunningTasksCount(v int64) *Cluster

SetRunningTasksCount sets the RunningTasksCount field's value.

func (*Cluster) SetStatistics added in v1.12.36 

func (s *Cluster) SetStatistics(v []*KeyValuePair) *Cluster

SetStatistics sets the Statistics field's value.

func (*Cluster) SetStatus added in v1.5.0 

func (s *Cluster) SetStatus(v string) *Cluster

SetStatus sets the Status field's value.

func (Cluster) String added in v0.6.5 

func (s Cluster) String() string

String returns the string representation

type Container 

type Container struct {

	// The Amazon Resource Name (ARN) of the container.
	ContainerArn *string `locationName:"containerArn" type:"string"`

	// The exit code returned from the container.
	ExitCode *int64 `locationName:"exitCode" type:"integer"`

	// The health status of the container. If health checks are not configured for
	// this container in its task definition, then it reports health status as UNKNOWN.
	HealthStatus *string `locationName:"healthStatus" type:"string" enum:"HealthStatus"`

	// The last known status of the container.
	LastStatus *string `locationName:"lastStatus" type:"string"`

	// The name of the container.
	Name *string `locationName:"name" type:"string"`

	// The network bindings associated with the container.
	NetworkBindings []*NetworkBinding `locationName:"networkBindings" type:"list"`

	// The network interfaces associated with the container.
	NetworkInterfaces []*NetworkInterface `locationName:"networkInterfaces" type:"list"`

	// A short (255 max characters) human-readable string to provide additional
	// details about a running or stopped container.
	Reason *string `locationName:"reason" type:"string"`

	// The ARN of the task.
	TaskArn *string `locationName:"taskArn" type:"string"`
	// contains filtered or unexported fields
}

A Docker container that is part of a task.

func (Container) GoString added in v0.6.5 

func (s Container) GoString() string

GoString returns the string representation

func (*Container) SetContainerArn added in v1.5.0 

func (s *Container) SetContainerArn(v string) *Container

SetContainerArn sets the ContainerArn field's value.

func (*Container) SetExitCode added in v1.5.0 

func (s *Container) SetExitCode(v int64) *Container

SetExitCode sets the ExitCode field's value.

func (*Container) SetHealthStatus added in v1.13.11 

func (s *Container) SetHealthStatus(v string) *Container

SetHealthStatus sets the HealthStatus field's value.

func (*Container) SetLastStatus added in v1.5.0 

func (s *Container) SetLastStatus(v string) *Container

SetLastStatus sets the LastStatus field's value.

func (*Container) SetName added in v1.5.0 

func (s *Container) SetName(v string) *Container

SetName sets the Name field's value.

func (*Container) SetNetworkBindings added in v1.5.0 

func (s *Container) SetNetworkBindings(v []*NetworkBinding) *Container

SetNetworkBindings sets the NetworkBindings field's value.

func (*Container) SetNetworkInterfaces added in v1.12.27 

func (s *Container) SetNetworkInterfaces(v []*NetworkInterface) *Container

SetNetworkInterfaces sets the NetworkInterfaces field's value.

func (*Container) SetReason added in v1.5.0 

func (s *Container) SetReason(v string) *Container

SetReason sets the Reason field's value.

func (*Container) SetTaskArn added in v1.5.0 

func (s *Container) SetTaskArn(v string) *Container

SetTaskArn sets the TaskArn field's value.

func (Container) String added in v0.6.5 

func (s Container) String() string

String returns the string representation

type ContainerDefinition 

type ContainerDefinition struct {

	// The command that is passed to the container. This parameter maps to Cmd in
	// the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the COMMAND parameter to docker run (https://docs.docker.com/engine/reference/run/).
	// For more information, see https://docs.docker.com/engine/reference/builder/#cmd
	// (https://docs.docker.com/engine/reference/builder/#cmd).
	Command []*string `locationName:"command" type:"list"`

	// The number of cpu units reserved for the container. This parameter maps to
	// CpuShares in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --cpu-shares option to docker run (https://docs.docker.com/engine/reference/run/).
	//
	// This field is optional for tasks using the Fargate launch type, and the only
	// requirement is that the total amount of CPU reserved for all containers within
	// a task be lower than the task-level cpu value.
	//
	// You can determine the number of CPU units that are available per EC2 instance
	// type by multiplying the vCPUs listed for that instance type on the Amazon
	// EC2 Instances (http://aws.amazon.com/ec2/instance-types/) detail page by
	// 1,024.
	//
	// For example, if you run a single-container task on a single-core instance
	// type with 512 CPU units specified for that container, and that is the only
	// task running on the container instance, that container could use the full
	// 1,024 CPU unit share at any given time. However, if you launched another
	// copy of the same task on that container instance, each task would be guaranteed
	// a minimum of 512 CPU units when needed, and each container could float to
	// higher CPU usage if the other container was not using it, but if both tasks
	// were 100% active all of the time, they would be limited to 512 CPU units.
	//
	// Linux containers share unallocated CPU units with other containers on the
	// container instance with the same ratio as their allocated amount. For example,
	// if you run a single-container task on a single-core instance type with 512
	// CPU units specified for that container, and that is the only task running
	// on the container instance, that container could use the full 1,024 CPU unit
	// share at any given time. However, if you launched another copy of the same
	// task on that container instance, each task would be guaranteed a minimum
	// of 512 CPU units when needed, and each container could float to higher CPU
	// usage if the other container was not using it, but if both tasks were 100%
	// active all of the time, they would be limited to 512 CPU units.
	//
	// On Linux container instances, the Docker daemon on the container instance
	// uses the CPU value to calculate the relative CPU share ratios for running
	// containers. For more information, see CPU share constraint (https://docs.docker.com/engine/reference/run/#cpu-share-constraint)
	// in the Docker documentation. The minimum valid CPU share value that the Linux
	// kernel allows is 2; however, the CPU parameter is not required, and you can
	// use CPU values below 2 in your container definitions. For CPU values below
	// 2 (including null), the behavior varies based on your Amazon ECS container
	// agent version:
	//
	//    * Agent versions less than or equal to 1.1.0: Null and zero CPU values
	//    are passed to Docker as 0, which Docker then converts to 1,024 CPU shares.
	//    CPU values of 1 are passed to Docker as 1, which the Linux kernel converts
	//    to 2 CPU shares.
	//
	//    * Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values
	//    of 1 are passed to Docker as 2.
	//
	// On Windows container instances, the CPU limit is enforced as an absolute
	// limit, or a quota. Windows containers only have access to the specified amount
	// of CPU that is described in the task definition.
	Cpu *int64 `locationName:"cpu" type:"integer"`

	// When this parameter is true, networking is disabled within the container.
	// This parameter maps to NetworkDisabled in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/).
	//
	// This parameter is not supported for Windows containers.
	DisableNetworking *bool `locationName:"disableNetworking" type:"boolean"`

	// A list of DNS search domains that are presented to the container. This parameter
	// maps to DnsSearch in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --dns-search option to docker run (https://docs.docker.com/engine/reference/run/).
	//
	// This parameter is not supported for Windows containers.
	DnsSearchDomains []*string `locationName:"dnsSearchDomains" type:"list"`

	// A list of DNS servers that are presented to the container. This parameter
	// maps to Dns in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --dns option to docker run (https://docs.docker.com/engine/reference/run/).
	//
	// This parameter is not supported for Windows containers.
	DnsServers []*string `locationName:"dnsServers" type:"list"`

	// A key/value map of labels to add to the container. This parameter maps to
	// Labels in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --label option to docker run (https://docs.docker.com/engine/reference/run/).
	// This parameter requires version 1.18 of the Docker Remote API or greater
	// on your container instance. To check the Docker Remote API version on your
	// container instance, log in to your container instance and run the following
	// command: sudo docker version | grep "Server API version"
	DockerLabels map[string]*string `locationName:"dockerLabels" type:"map"`

	// A list of strings to provide custom labels for SELinux and AppArmor multi-level
	// security systems. This field is not valid for containers in tasks using the
	// Fargate launch type.
	//
	// This parameter maps to SecurityOpt in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --security-opt option to docker run (https://docs.docker.com/engine/reference/run/).
	//
	// The Amazon ECS container agent running on a container instance must register
	// with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment
	// variables before containers placed on that instance can use these security
	// options. For more information, see Amazon ECS Container Agent Configuration
	// (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// This parameter is not supported for Windows containers.
	DockerSecurityOptions []*string `locationName:"dockerSecurityOptions" type:"list"`

	// Early versions of the Amazon ECS container agent do not properly handle entryPoint
	// parameters. If you have problems using entryPoint, update your container
	// agent or enter your commands and arguments as command array items instead.
	//
	// The entry point that is passed to the container. This parameter maps to Entrypoint
	// in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --entrypoint option to docker run (https://docs.docker.com/engine/reference/run/).
	// For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint
	// (https://docs.docker.com/engine/reference/builder/#entrypoint).
	EntryPoint []*string `locationName:"entryPoint" type:"list"`

	// The environment variables to pass to a container. This parameter maps to
	// Env in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --env option to docker run (https://docs.docker.com/engine/reference/run/).
	//
	// We do not recommend using plaintext environment variables for sensitive information,
	// such as credential data.
	Environment []*KeyValuePair `locationName:"environment" type:"list"`

	// If the essential parameter of a container is marked as true, and that container
	// fails or stops for any reason, all other containers that are part of the
	// task are stopped. If the essential parameter of a container is marked as
	// false, then its failure does not affect the rest of the containers in a task.
	// If this parameter is omitted, a container is assumed to be essential.
	//
	// All tasks must have at least one essential container. If you have an application
	// that is composed of multiple containers, you should group containers that
	// are used for a common purpose into components, and separate the different
	// components into multiple task definitions. For more information, see Application
	// Architecture (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html)
	// in the Amazon Elastic Container Service Developer Guide.
	Essential *bool `locationName:"essential" type:"boolean"`

	// A list of hostnames and IP address mappings to append to the /etc/hosts file
	// on the container. If using the Fargate launch type, this may be used to list
	// non-Fargate hosts you want the container to talk to. This parameter maps
	// to ExtraHosts in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --add-host option to docker run (https://docs.docker.com/engine/reference/run/).
	//
	// This parameter is not supported for Windows containers.
	ExtraHosts []*HostEntry `locationName:"extraHosts" type:"list"`

	// The health check command and associated configuration parameters for the
	// container. This parameter maps to HealthCheck in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the HEALTHCHECK parameter of docker run (https://docs.docker.com/engine/reference/run/).
	HealthCheck *HealthCheck `locationName:"healthCheck" type:"structure"`

	// The hostname to use for your container. This parameter maps to Hostname in
	// the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --hostname option to docker run (https://docs.docker.com/engine/reference/run/).
	//
	// The hostname parameter is not supported if using the awsvpc networkMode.
	Hostname *string `locationName:"hostname" type:"string"`

	// The image used to start a container. This string is passed directly to the
	// Docker daemon. Images in the Docker Hub registry are available by default.
	// Other repositories are specified with either repository-url/image:tag or
	// repository-url/image@digest. Up to 255 letters (uppercase and lowercase),
	// numbers, hyphens, underscores, colons, periods, forward slashes, and number
	// signs are allowed. This parameter maps to Image in the Create a container
	// (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the IMAGE parameter of docker run (https://docs.docker.com/engine/reference/run/).
	//
	//    * When a new task starts, the Amazon ECS container agent pulls the latest
	//    version of the specified image and tag for the container to use. However,
	//    subsequent updates to a repository image are not propagated to already
	//    running tasks.
	//
	//    * Images in Amazon ECR repositories can be specified by either using the
	//    full registry/repository:tag or registry/repository@digest. For example,
	//    012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest
	//    or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.
	//
	//
	//    * Images in official repositories on Docker Hub use a single name (for
	//    example, ubuntu or mongo).
	//
	//    * Images in other repositories on Docker Hub are qualified with an organization
	//    name (for example, amazon/amazon-ecs-agent).
	//
	//    * Images in other online repositories are qualified further by a domain
	//    name (for example, quay.io/assemblyline/ubuntu).
	Image *string `locationName:"image" type:"string"`

	// The link parameter allows containers to communicate with each other without
	// the need for port mappings. Only supported if the network mode of a task
	// definition is set to bridge. The name:internalName construct is analogous
	// to name:alias in Docker links. Up to 255 letters (uppercase and lowercase),
	// numbers, hyphens, and underscores are allowed. For more information about
	// linking Docker containers, go to https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/
	// (https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/).
	// This parameter maps to Links in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --link option to docker run (https://docs.docker.com/engine/reference/commandline/run/).
	//
	// This parameter is not supported for Windows containers.
	//
	// Containers that are collocated on a single container instance may be able
	// to communicate with each other without requiring links or host port mappings.
	// Network isolation is achieved on the container instance using security groups
	// and VPC settings.
	Links []*string `locationName:"links" type:"list"`

	// Linux-specific modifications that are applied to the container, such as Linux
	// KernelCapabilities.
	//
	// This parameter is not supported for Windows containers.
	LinuxParameters *LinuxParameters `locationName:"linuxParameters" type:"structure"`

	// The log configuration specification for the container.
	//
	// If using the Fargate launch type, the only supported value is awslogs.
	//
	// This parameter maps to LogConfig in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --log-driver option to docker run (https://docs.docker.com/engine/reference/run/).
	// By default, containers use the same logging driver that the Docker daemon
	// uses; however the container may use a different logging driver than the Docker
	// daemon by specifying a log driver with this parameter in the container definition.
	// To use a different logging driver for a container, the log system must be
	// configured properly on the container instance (or on a different log server
	// for remote logging options). For more information on the options for different
	// supported log drivers, see Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/)
	// in the Docker documentation.
	//
	// Amazon ECS currently supports a subset of the logging drivers available to
	// the Docker daemon (shown in the LogConfiguration data type). Additional log
	// drivers may be available in future releases of the Amazon ECS container agent.
	//
	// This parameter requires version 1.18 of the Docker Remote API or greater
	// on your container instance. To check the Docker Remote API version on your
	// container instance, log in to your container instance and run the following
	// command: sudo docker version | grep "Server API version"
	//
	// The Amazon ECS container agent running on a container instance must register
	// the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS
	// environment variable before containers placed on that instance can use these
	// log configuration options. For more information, see Amazon ECS Container
	// Agent Configuration (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)
	// in the Amazon Elastic Container Service Developer Guide.
	LogConfiguration *LogConfiguration `locationName:"logConfiguration" type:"structure"`

	// The hard limit (in MiB) of memory to present to the container. If your container
	// attempts to exceed the memory specified here, the container is killed. This
	// parameter maps to Memory in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --memory option to docker run (https://docs.docker.com/engine/reference/run/).
	//
	// If your containers are part of a task using the Fargate launch type, this
	// field is optional and the only requirement is that the total amount of memory
	// reserved for all containers within a task be lower than the task memory value.
	//
	// For containers that are part of a task using the EC2 launch type, you must
	// specify a non-zero integer for one or both of memory or memoryReservation
	// in container definitions. If you specify both, memory must be greater than
	// memoryReservation. If you specify memoryReservation, then that value is subtracted
	// from the available memory resources for the container instance on which the
	// container is placed; otherwise, the value of memory is used.
	//
	// The Docker daemon reserves a minimum of 4 MiB of memory for a container,
	// so you should not specify fewer than 4 MiB of memory for your containers.
	Memory *int64 `locationName:"memory" type:"integer"`

	// The soft limit (in MiB) of memory to reserve for the container. When system
	// memory is under heavy contention, Docker attempts to keep the container memory
	// to this soft limit; however, your container can consume more memory when
	// it needs to, up to either the hard limit specified with the memory parameter
	// (if applicable), or all of the available memory on the container instance,
	// whichever comes first. This parameter maps to MemoryReservation in the Create
	// a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --memory-reservation option to docker run (https://docs.docker.com/engine/reference/run/).
	//
	// You must specify a non-zero integer for one or both of memory or memoryReservation
	// in container definitions. If you specify both, memory must be greater than
	// memoryReservation. If you specify memoryReservation, then that value is subtracted
	// from the available memory resources for the container instance on which the
	// container is placed; otherwise, the value of memory is used.
	//
	// For example, if your container normally uses 128 MiB of memory, but occasionally
	// bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation
	// of 128 MiB, and a memory hard limit of 300 MiB. This configuration would
	// allow the container to only reserve 128 MiB of memory from the remaining
	// resources on the container instance, but also allow the container to consume
	// more memory resources when needed.
	//
	// The Docker daemon reserves a minimum of 4 MiB of memory for a container,
	// so you should not specify fewer than 4 MiB of memory for your containers.
	MemoryReservation *int64 `locationName:"memoryReservation" type:"integer"`

	// The mount points for data volumes in your container.
	//
	// This parameter maps to Volumes in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --volume option to docker run (https://docs.docker.com/engine/reference/run/).
	//
	// Windows containers can mount whole directories on the same drive as $env:ProgramData.
	// Windows containers cannot mount directories on a different drive, and mount
	// point cannot be across drives.
	MountPoints []*MountPoint `locationName:"mountPoints" type:"list"`

	// The name of a container. If you are linking multiple containers together
	// in a task definition, the name of one container can be entered in the links
	// of another container to connect the containers. Up to 255 letters (uppercase
	// and lowercase), numbers, hyphens, and underscores are allowed. This parameter
	// maps to name in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --name option to docker run (https://docs.docker.com/engine/reference/run/).
	Name *string `locationName:"name" type:"string"`

	// The list of port mappings for the container. Port mappings allow containers
	// to access ports on the host container instance to send or receive traffic.
	//
	// For task definitions that use the awsvpc network mode, you should only specify
	// the containerPort. The hostPort can be left blank or it must be the same
	// value as the containerPort.
	//
	// Port mappings on Windows use the NetNAT gateway address rather than localhost.
	// There is no loopback for port mappings on Windows, so you cannot access a
	// container's mapped port from the host itself.
	//
	// This parameter maps to PortBindings in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --publish option to docker run (https://docs.docker.com/engine/reference/run/).
	// If the network mode of a task definition is set to none, then you can't specify
	// port mappings. If the network mode of a task definition is set to host, then
	// host ports must either be undefined or they must match the container port
	// in the port mapping.
	//
	// After a task reaches the RUNNING status, manual and automatic host and container
	// port assignments are visible in the Network Bindings section of a container
	// description for a selected task in the Amazon ECS console, or the networkBindings
	// section DescribeTasks responses.
	PortMappings []*PortMapping `locationName:"portMappings" type:"list"`

	// When this parameter is true, the container is given elevated privileges on
	// the host container instance (similar to the root user). This parameter maps
	// to Privileged in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --privileged option to docker run (https://docs.docker.com/engine/reference/run/).
	//
	// This parameter is not supported for Windows containers or tasks using the
	// Fargate launch type.
	Privileged *bool `locationName:"privileged" type:"boolean"`

	// When this parameter is true, the container is given read-only access to its
	// root file system. This parameter maps to ReadonlyRootfs in the Create a container
	// (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --read-only option to docker run.
	//
	// This parameter is not supported for Windows containers.
	ReadonlyRootFilesystem *bool `locationName:"readonlyRootFilesystem" type:"boolean"`

	// A list of ulimits to set in the container. This parameter maps to Ulimits
	// in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --ulimit option to docker run (https://docs.docker.com/engine/reference/run/).
	// Valid naming values are displayed in the Ulimit data type. This parameter
	// requires version 1.18 of the Docker Remote API or greater on your container
	// instance. To check the Docker Remote API version on your container instance,
	// log in to your container instance and run the following command: sudo docker
	// version | grep "Server API version"
	//
	// This parameter is not supported for Windows containers.
	Ulimits []*Ulimit `locationName:"ulimits" type:"list"`

	// The user name to use inside the container. This parameter maps to User in
	// the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --user option to docker run (https://docs.docker.com/engine/reference/run/).
	//
	// This parameter is not supported for Windows containers.
	User *string `locationName:"user" type:"string"`

	// Data volumes to mount from another container. This parameter maps to VolumesFrom
	// in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --volumes-from option to docker run (https://docs.docker.com/engine/reference/run/).
	VolumesFrom []*VolumeFrom `locationName:"volumesFrom" type:"list"`

	// The working directory in which to run commands inside the container. This
	// parameter maps to WorkingDir in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --workdir option to docker run (https://docs.docker.com/engine/reference/run/).
	WorkingDirectory *string `locationName:"workingDirectory" type:"string"`
	// contains filtered or unexported fields
}

Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

func (ContainerDefinition) GoString added in v0.6.5 

func (s ContainerDefinition) GoString() string

GoString returns the string representation

func (*ContainerDefinition) SetCommand added in v1.5.0 

func (s *ContainerDefinition) SetCommand(v []*string) *ContainerDefinition

SetCommand sets the Command field's value.

func (*ContainerDefinition) SetCpu added in v1.5.0 

func (s *ContainerDefinition) SetCpu(v int64) *ContainerDefinition

SetCpu sets the Cpu field's value.

func (*ContainerDefinition) SetDisableNetworking added in v1.5.0 

func (s *ContainerDefinition) SetDisableNetworking(v bool) *ContainerDefinition

SetDisableNetworking sets the DisableNetworking field's value.

func (*ContainerDefinition) SetDnsSearchDomains added in v1.5.0 

func (s *ContainerDefinition) SetDnsSearchDomains(v []*string) *ContainerDefinition

SetDnsSearchDomains sets the DnsSearchDomains field's value.

func (*ContainerDefinition) SetDnsServers added in v1.5.0 

func (s *ContainerDefinition) SetDnsServers(v []*string) *ContainerDefinition

SetDnsServers sets the DnsServers field's value.

func (*ContainerDefinition) SetDockerLabels added in v1.5.0 

func (s *ContainerDefinition) SetDockerLabels(v map[string]*string) *ContainerDefinition

SetDockerLabels sets the DockerLabels field's value.

func (*ContainerDefinition) SetDockerSecurityOptions added in v1.5.0 

func (s *ContainerDefinition) SetDockerSecurityOptions(v []*string) *ContainerDefinition

SetDockerSecurityOptions sets the DockerSecurityOptions field's value.

func (*ContainerDefinition) SetEntryPoint added in v1.5.0 

func (s *ContainerDefinition) SetEntryPoint(v []*string) *ContainerDefinition

SetEntryPoint sets the EntryPoint field's value.

func (*ContainerDefinition) SetEnvironment added in v1.5.0 

func (s *ContainerDefinition) SetEnvironment(v []*KeyValuePair) *ContainerDefinition

SetEnvironment sets the Environment field's value.

func (*ContainerDefinition) SetEssential added in v1.5.0 

func (s *ContainerDefinition) SetEssential(v bool) *ContainerDefinition

SetEssential sets the Essential field's value.

func (*ContainerDefinition) SetExtraHosts added in v1.5.0 

func (s *ContainerDefinition) SetExtraHosts(v []*HostEntry) *ContainerDefinition

SetExtraHosts sets the ExtraHosts field's value.

func (*ContainerDefinition) SetHealthCheck added in v1.13.11 

func (s *ContainerDefinition) SetHealthCheck(v *HealthCheck) *ContainerDefinition

SetHealthCheck sets the HealthCheck field's value.

func (*ContainerDefinition) SetHostname added in v1.5.0 

func (s *ContainerDefinition) SetHostname(v string) *ContainerDefinition

SetHostname sets the Hostname field's value.

func (*ContainerDefinition) SetImage added in v1.5.0 

func (s *ContainerDefinition) SetImage(v string) *ContainerDefinition

SetImage sets the Image field's value. 

func (s *ContainerDefinition) SetLinks(v []*string) *ContainerDefinition

SetLinks sets the Links field's value.

func (*ContainerDefinition) SetLinuxParameters added in v1.10.51 

func (s *ContainerDefinition) SetLinuxParameters(v *LinuxParameters) *ContainerDefinition

SetLinuxParameters sets the LinuxParameters field's value.

func (*ContainerDefinition) SetLogConfiguration added in v1.5.0 

func (s *ContainerDefinition) SetLogConfiguration(v *LogConfiguration) *ContainerDefinition

SetLogConfiguration sets the LogConfiguration field's value.

func (*ContainerDefinition) SetMemory added in v1.5.0 

func (s *ContainerDefinition) SetMemory(v int64) *ContainerDefinition

SetMemory sets the Memory field's value.

func (*ContainerDefinition) SetMemoryReservation added in v1.5.0 

func (s *ContainerDefinition) SetMemoryReservation(v int64) *ContainerDefinition

SetMemoryReservation sets the MemoryReservation field's value.

func (*ContainerDefinition) SetMountPoints added in v1.5.0 

func (s *ContainerDefinition) SetMountPoints(v []*MountPoint) *ContainerDefinition

SetMountPoints sets the MountPoints field's value.

func (*ContainerDefinition) SetName added in v1.5.0 

func (s *ContainerDefinition) SetName(v string) *ContainerDefinition

SetName sets the Name field's value.

func (*ContainerDefinition) SetPortMappings added in v1.5.0 

func (s *ContainerDefinition) SetPortMappings(v []*PortMapping) *ContainerDefinition

SetPortMappings sets the PortMappings field's value.

func (*ContainerDefinition) SetPrivileged added in v1.5.0 

func (s *ContainerDefinition) SetPrivileged(v bool) *ContainerDefinition

SetPrivileged sets the Privileged field's value.

func (*ContainerDefinition) SetReadonlyRootFilesystem added in v1.5.0 

func (s *ContainerDefinition) SetReadonlyRootFilesystem(v bool) *ContainerDefinition

SetReadonlyRootFilesystem sets the ReadonlyRootFilesystem field's value.

func (*ContainerDefinition) SetUlimits added in v1.5.0 

func (s *ContainerDefinition) SetUlimits(v []*Ulimit) *ContainerDefinition

SetUlimits sets the Ulimits field's value.

func (*ContainerDefinition) SetUser added in v1.5.0 

func (s *ContainerDefinition) SetUser(v string) *ContainerDefinition

SetUser sets the User field's value.

func (*ContainerDefinition) SetVolumesFrom added in v1.5.0 

func (s *ContainerDefinition) SetVolumesFrom(v []*VolumeFrom) *ContainerDefinition

SetVolumesFrom sets the VolumesFrom field's value.

func (*ContainerDefinition) SetWorkingDirectory added in v1.5.0 

func (s *ContainerDefinition) SetWorkingDirectory(v string) *ContainerDefinition

SetWorkingDirectory sets the WorkingDirectory field's value.

func (ContainerDefinition) String added in v0.6.5 

func (s ContainerDefinition) String() string

String returns the string representation

func (*ContainerDefinition) Validate added in v1.1.21 

func (s *ContainerDefinition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ContainerInstance 

type ContainerInstance struct {

	// This parameter returns true if the agent is connected to Amazon ECS. Registered
	// instances with an agent that may be unhealthy or stopped return false. Instances
	// without a connected agent can't accept placement requests.
	AgentConnected *bool `locationName:"agentConnected" type:"boolean"`

	// The status of the most recent agent update. If an update has never been requested,
	// this value is NULL.
	AgentUpdateStatus *string `locationName:"agentUpdateStatus" type:"string" enum:"AgentUpdateStatus"`

	// The Elastic Network Interfaces associated with the container instance.
	Attachments []*Attachment `locationName:"attachments" type:"list"`

	// The attributes set for the container instance, either by the Amazon ECS container
	// agent at instance registration or manually with the PutAttributes operation.
	Attributes []*Attribute `locationName:"attributes" type:"list"`

	// The Amazon Resource Name (ARN) of the container instance. The ARN contains
	// the arn:aws:ecs namespace, followed by the region of the container instance,
	// the AWS account ID of the container instance owner, the container-instance
	// namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
	ContainerInstanceArn *string `locationName:"containerInstanceArn" type:"string"`

	// The EC2 instance ID of the container instance.
	Ec2InstanceId *string `locationName:"ec2InstanceId" type:"string"`

	// The number of tasks on the container instance that are in the PENDING status.
	PendingTasksCount *int64 `locationName:"pendingTasksCount" type:"integer"`

	// The Unix time stamp for when the container instance was registered.
	RegisteredAt *time.Time `locationName:"registeredAt" type:"timestamp" timestampFormat:"unix"`

	// For CPU and memory resource types, this parameter describes the amount of
	// each resource that was available on the container instance when the container
	// agent registered it with Amazon ECS; this value represents the total amount
	// of CPU and memory that can be allocated on this container instance to tasks.
	// For port resource types, this parameter describes the ports that were reserved
	// by the Amazon ECS container agent when it registered the container instance
	// with Amazon ECS.
	RegisteredResources []*Resource `locationName:"registeredResources" type:"list"`

	// For CPU and memory resource types, this parameter describes the remaining
	// CPU and memory that has not already been allocated to tasks and is therefore
	// available for new tasks. For port resource types, this parameter describes
	// the ports that were reserved by the Amazon ECS container agent (at instance
	// registration time) and any task containers that have reserved port mappings
	// on the host (with the host or bridge network mode). Any port that is not
	// specified here is available for new tasks.
	RemainingResources []*Resource `locationName:"remainingResources" type:"list"`

	// The number of tasks on the container instance that are in the RUNNING status.
	RunningTasksCount *int64 `locationName:"runningTasksCount" type:"integer"`

	// The status of the container instance. The valid values are ACTIVE, INACTIVE,
	// or DRAINING. ACTIVE indicates that the container instance can accept tasks.
	// DRAINING indicates that new tasks are not placed on the container instance
	// and any service tasks running on the container instance are removed if possible.
	// For more information, see Container Instance Draining (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-draining.html)
	// in the Amazon Elastic Container Service Developer Guide.
	Status *string `locationName:"status" type:"string"`

	// The version counter for the container instance. Every time a container instance
	// experiences a change that triggers a CloudWatch event, the version counter
	// is incremented. If you are replicating your Amazon ECS container instance
	// state with CloudWatch Events, you can compare the version of a container
	// instance reported by the Amazon ECS APIs with the version reported in CloudWatch
	// Events for the container instance (inside the detail object) to verify that
	// the version in your event stream is current.
	Version *int64 `locationName:"version" type:"long"`

	// The version information for the Amazon ECS container agent and Docker daemon
	// running on the container instance.
	VersionInfo *VersionInfo `locationName:"versionInfo" type:"structure"`
	// contains filtered or unexported fields
}

An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.

func (ContainerInstance) GoString added in v0.6.5 

func (s ContainerInstance) GoString() string

GoString returns the string representation

func (*ContainerInstance) SetAgentConnected added in v1.5.0 

func (s *ContainerInstance) SetAgentConnected(v bool) *ContainerInstance

SetAgentConnected sets the AgentConnected field's value.

func (*ContainerInstance) SetAgentUpdateStatus added in v1.5.0 

func (s *ContainerInstance) SetAgentUpdateStatus(v string) *ContainerInstance

SetAgentUpdateStatus sets the AgentUpdateStatus field's value.

func (*ContainerInstance) SetAttachments added in v1.12.27 

func (s *ContainerInstance) SetAttachments(v []*Attachment) *ContainerInstance

SetAttachments sets the Attachments field's value.

func (*ContainerInstance) SetAttributes added in v1.5.0 

func (s *ContainerInstance) SetAttributes(v []*Attribute) *ContainerInstance

SetAttributes sets the Attributes field's value.

func (*ContainerInstance) SetContainerInstanceArn added in v1.5.0 

func (s *ContainerInstance) SetContainerInstanceArn(v string) *ContainerInstance

SetContainerInstanceArn sets the ContainerInstanceArn field's value.

func (*ContainerInstance) SetEc2InstanceId added in v1.5.0 

func (s *ContainerInstance) SetEc2InstanceId(v string) *ContainerInstance

SetEc2InstanceId sets the Ec2InstanceId field's value.

func (*ContainerInstance) SetPendingTasksCount added in v1.5.0 

func (s *ContainerInstance) SetPendingTasksCount(v int64) *ContainerInstance

SetPendingTasksCount sets the PendingTasksCount field's value.

func (*ContainerInstance) SetRegisteredAt added in v1.8.20 

func (s *ContainerInstance) SetRegisteredAt(v time.Time) *ContainerInstance

SetRegisteredAt sets the RegisteredAt field's value.

func (*ContainerInstance) SetRegisteredResources added in v1.5.0 

func (s *ContainerInstance) SetRegisteredResources(v []*Resource) *ContainerInstance

SetRegisteredResources sets the RegisteredResources field's value.

func (*ContainerInstance) SetRemainingResources added in v1.5.0 

func (s *ContainerInstance) SetRemainingResources(v []*Resource) *ContainerInstance

SetRemainingResources sets the RemainingResources field's value.

func (*ContainerInstance) SetRunningTasksCount added in v1.5.0 

func (s *ContainerInstance) SetRunningTasksCount(v int64) *ContainerInstance

SetRunningTasksCount sets the RunningTasksCount field's value.

func (*ContainerInstance) SetStatus added in v1.5.0 

func (s *ContainerInstance) SetStatus(v string) *ContainerInstance

SetStatus sets the Status field's value.

func (*ContainerInstance) SetVersion added in v1.5.9 

func (s *ContainerInstance) SetVersion(v int64) *ContainerInstance

SetVersion sets the Version field's value.

func (*ContainerInstance) SetVersionInfo added in v1.5.0 

func (s *ContainerInstance) SetVersionInfo(v *VersionInfo) *ContainerInstance

SetVersionInfo sets the VersionInfo field's value.

func (ContainerInstance) String added in v0.6.5 

func (s ContainerInstance) String() string

String returns the string representation

type ContainerOverride 

type ContainerOverride struct {

	// The command to send to the container that overrides the default command from
	// the Docker image or the task definition. You must also specify a container
	// name.
	Command []*string `locationName:"command" type:"list"`

	// The number of cpu units reserved for the container, instead of the default
	// value from the task definition. You must also specify a container name.
	Cpu *int64 `locationName:"cpu" type:"integer"`

	// The environment variables to send to the container. You can add new environment
	// variables, which are added to the container at launch, or you can override
	// the existing environment variables from the Docker image or the task definition.
	// You must also specify a container name.
	Environment []*KeyValuePair `locationName:"environment" type:"list"`

	// The hard limit (in MiB) of memory to present to the container, instead of
	// the default value from the task definition. If your container attempts to
	// exceed the memory specified here, the container is killed. You must also
	// specify a container name.
	Memory *int64 `locationName:"memory" type:"integer"`

	// The soft limit (in MiB) of memory to reserve for the container, instead of
	// the default value from the task definition. You must also specify a container
	// name.
	MemoryReservation *int64 `locationName:"memoryReservation" type:"integer"`

	// The name of the container that receives the override. This parameter is required
	// if any override is specified.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

The overrides that should be sent to a container.

func (ContainerOverride) GoString added in v0.6.5 

func (s ContainerOverride) GoString() string

GoString returns the string representation

func (*ContainerOverride) SetCommand added in v1.5.0 

func (s *ContainerOverride) SetCommand(v []*string) *ContainerOverride

SetCommand sets the Command field's value.

func (*ContainerOverride) SetCpu added in v1.8.43 

func (s *ContainerOverride) SetCpu(v int64) *ContainerOverride

SetCpu sets the Cpu field's value.

func (*ContainerOverride) SetEnvironment added in v1.5.0 

func (s *ContainerOverride) SetEnvironment(v []*KeyValuePair) *ContainerOverride

SetEnvironment sets the Environment field's value.

func (*ContainerOverride) SetMemory added in v1.8.43 

func (s *ContainerOverride) SetMemory(v int64) *ContainerOverride

SetMemory sets the Memory field's value.

func (*ContainerOverride) SetMemoryReservation added in v1.8.43 

func (s *ContainerOverride) SetMemoryReservation(v int64) *ContainerOverride

SetMemoryReservation sets the MemoryReservation field's value.

func (*ContainerOverride) SetName added in v1.5.0 

func (s *ContainerOverride) SetName(v string) *ContainerOverride

SetName sets the Name field's value.

func (ContainerOverride) String added in v0.6.5 

func (s ContainerOverride) String() string

String returns the string representation

type ContainerStateChange added in v1.12.27 

type ContainerStateChange struct {

	// The name of the container.
	ContainerName *string `locationName:"containerName" type:"string"`

	// The exit code for the container, if the state change is a result of the container
	// exiting.
	ExitCode *int64 `locationName:"exitCode" type:"integer"`

	// Any network bindings associated with the container.
	NetworkBindings []*NetworkBinding `locationName:"networkBindings" type:"list"`

	// The reason for the state change.
	Reason *string `locationName:"reason" type:"string"`

	// The status of the container.
	Status *string `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

An object representing a change in state for a container.

func (ContainerStateChange) GoString added in v1.12.27 

func (s ContainerStateChange) GoString() string

GoString returns the string representation

func (*ContainerStateChange) SetContainerName added in v1.12.27 

func (s *ContainerStateChange) SetContainerName(v string) *ContainerStateChange

SetContainerName sets the ContainerName field's value.

func (*ContainerStateChange) SetExitCode added in v1.12.27 

func (s *ContainerStateChange) SetExitCode(v int64) *ContainerStateChange

SetExitCode sets the ExitCode field's value.

func (*ContainerStateChange) SetNetworkBindings added in v1.12.27 

func (s *ContainerStateChange) SetNetworkBindings(v []*NetworkBinding) *ContainerStateChange

SetNetworkBindings sets the NetworkBindings field's value.

func (*ContainerStateChange) SetReason added in v1.12.27 

func (s *ContainerStateChange) SetReason(v string) *ContainerStateChange

SetReason sets the Reason field's value.

func (*ContainerStateChange) SetStatus added in v1.12.27 

func (s *ContainerStateChange) SetStatus(v string) *ContainerStateChange

SetStatus sets the Status field's value.

func (ContainerStateChange) String added in v1.12.27 

func (s ContainerStateChange) String() string

String returns the string representation

type CreateClusterInput 

type CreateClusterInput struct {

	// The name of your cluster. If you do not specify a name for your cluster,
	// you create a cluster named default. Up to 255 letters (uppercase and lowercase),
	// numbers, hyphens, and underscores are allowed.
	ClusterName *string `locationName:"clusterName" type:"string"`
	// contains filtered or unexported fields
}

func (CreateClusterInput) GoString added in v0.6.5 

func (s CreateClusterInput) GoString() string

GoString returns the string representation

func (*CreateClusterInput) SetClusterName added in v1.5.0 

func (s *CreateClusterInput) SetClusterName(v string) *CreateClusterInput

SetClusterName sets the ClusterName field's value.

func (CreateClusterInput) String added in v0.6.5 

func (s CreateClusterInput) String() string

String returns the string representation

type CreateClusterOutput 

type CreateClusterOutput struct {

	// The full description of your new cluster.
	Cluster *Cluster `locationName:"cluster" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateClusterOutput) GoString added in v0.6.5 

func (s CreateClusterOutput) GoString() string

GoString returns the string representation

func (*CreateClusterOutput) SetCluster added in v1.5.0 

func (s *CreateClusterOutput) SetCluster(v *Cluster) *CreateClusterOutput

SetCluster sets the Cluster field's value.

func (CreateClusterOutput) String added in v0.6.5 

func (s CreateClusterOutput) String() string

String returns the string representation

type CreateServiceInput 

type CreateServiceInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. Up to 32 ASCII characters are allowed.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// The short name or full Amazon Resource Name (ARN) of the cluster on which
	// to run your service. If you do not specify a cluster, the default cluster
	// is assumed.
	Cluster *string `locationName:"cluster" type:"string"`

	// Optional deployment parameters that control how many tasks run during the
	// deployment and the ordering of stopping and starting tasks.
	DeploymentConfiguration *DeploymentConfiguration `locationName:"deploymentConfiguration" type:"structure"`

	// The number of instantiations of the specified task definition to place and
	// keep running on your cluster.
	DesiredCount *int64 `locationName:"desiredCount" type:"integer"`

	// The period of time, in seconds, that the Amazon ECS service scheduler should
	// ignore unhealthy Elastic Load Balancing target health checks after a task
	// has first started. This is only valid if your service is configured to use
	// a load balancer. If your service's tasks take a while to start and respond
	// to Elastic Load Balancing health checks, you can specify a health check grace
	// period of up to 1,800 seconds during which the ECS service scheduler ignores
	// health check status. This grace period can prevent the ECS service scheduler
	// from marking tasks as unhealthy and stopping them before they have time to
	// come up.
	HealthCheckGracePeriodSeconds *int64 `locationName:"healthCheckGracePeriodSeconds" type:"integer"`

	// The launch type on which to run your service.
	LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"`

	// A load balancer object representing the load balancer to use with your service.
	// Currently, you are limited to one load balancer or target group per service.
	// After you create a service, the load balancer name or target group ARN, container
	// name, and container port specified in the service definition are immutable.
	//
	// For Classic Load Balancers, this object must contain the load balancer name,
	// the container name (as it appears in a container definition), and the container
	// port to access from the load balancer. When a task from this service is placed
	// on a container instance, the container instance is registered with the load
	// balancer specified here.
	//
	// For Application Load Balancers and Network Load Balancers, this object must
	// contain the load balancer target group ARN, the container name (as it appears
	// in a container definition), and the container port to access from the load
	// balancer. When a task from this service is placed on a container instance,
	// the container instance and port combination is registered as a target in
	// the target group specified here.
	//
	// Services with tasks that use the awsvpc network mode (for example, those
	// with the Fargate launch type) only support Application Load Balancers and
	// Network Load Balancers; Classic Load Balancers are not supported. Also, when
	// you create any target groups for these services, you must choose ip as the
	// target type, not instance, because tasks that use the awsvpc network mode
	// are associated with an elastic network interface, not an Amazon EC2 instance.
	LoadBalancers []*LoadBalancer `locationName:"loadBalancers" type:"list"`

	// The network configuration for the service. This parameter is required for
	// task definitions that use the awsvpc network mode to receive their own Elastic
	// Network Interface, and it is not supported for other network modes. For more
	// information, see Task Networking (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html)
	// in the Amazon Elastic Container Service Developer Guide.
	NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"`

	// An array of placement constraint objects to use for tasks in your service.
	// You can specify a maximum of 10 constraints per task (this limit includes
	// constraints in the task definition and those specified at run time).
	PlacementConstraints []*PlacementConstraint `locationName:"placementConstraints" type:"list"`

	// The placement strategy objects to use for tasks in your service. You can
	// specify a maximum of five strategy rules per service.
	PlacementStrategy []*PlacementStrategy `locationName:"placementStrategy" type:"list"`

	// The platform version on which to run your service. If one is not specified,
	// the latest version is used by default.
	PlatformVersion *string `locationName:"platformVersion" type:"string"`

	// The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon
	// ECS to make calls to your load balancer on your behalf. This parameter is
	// only permitted if you are using a load balancer with your service and your
	// task definition does not use the awsvpc network mode. If you specify the
	// role parameter, you must also specify a load balancer object with the loadBalancers
	// parameter.
	//
	// If your account has already created the Amazon ECS service-linked role, that
	// role is used by default for your service unless you specify a role here.
	// The service-linked role is required if your task definition uses the awsvpc
	// network mode, in which case you should not specify a role here. For more
	// information, see Using Service-Linked Roles for Amazon ECS (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// If your specified role has a path other than /, then you must either specify
	// the full role ARN (this is recommended) or prefix the role name with the
	// path. For example, if a role with the name bar has a path of /foo/ then you
	// would specify /foo/bar as the role name. For more information, see Friendly
	// Names and Paths (http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names)
	// in the IAM User Guide.
	Role *string `locationName:"role" type:"string"`

	// The scheduling strategy to use for the service. For more information, see
	// Services (http://docs.aws.amazon.com/AmazonECS/latest/developerguideecs_services.html).
	//
	// There are two service scheduler strategies available:
	//
	//    * REPLICA-The replica scheduling strategy places and maintains the 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.
	//
	//    * 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. When using this strategy, there is no
	//    need to specify a desired number of tasks, a task placement strategy,
	//    or use Service Auto Scaling policies.
	//
	// Fargate tasks do not support the DAEMON scheduling strategy.
	SchedulingStrategy *string `locationName:"schedulingStrategy" type:"string" enum:"SchedulingStrategy"`

	// The name of your service. Up to 255 letters (uppercase and lowercase), numbers,
	// hyphens, and underscores are allowed. Service names must be unique within
	// a cluster, but you can have similarly named services in multiple clusters
	// within a region or across multiple regions.
	//
	// ServiceName is a required field
	ServiceName *string `locationName:"serviceName" type:"string" required:"true"`

	// The details of the service discovery registries you want to assign to this
	// service. For more information, see Service Discovery (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).
	//
	// Service discovery is supported for Fargate tasks if using platform version
	// v1.1.0 or later. For more information, see AWS Fargate Platform Versions
	// (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html).
	ServiceRegistries []*ServiceRegistry `locationName:"serviceRegistries" type:"list"`

	// The family and revision (family:revision) or full ARN of the task definition
	// to run in your service. If a revision is not specified, the latest ACTIVE
	// revision is used.
	//
	// TaskDefinition is a required field
	TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateServiceInput) GoString added in v0.6.5 

func (s CreateServiceInput) GoString() string

GoString returns the string representation

func (*CreateServiceInput) SetClientToken added in v1.5.0 

func (s *CreateServiceInput) SetClientToken(v string) *CreateServiceInput

SetClientToken sets the ClientToken field's value.

func (*CreateServiceInput) SetCluster added in v1.5.0 

func (s *CreateServiceInput) SetCluster(v string) *CreateServiceInput

SetCluster sets the Cluster field's value.

func (*CreateServiceInput) SetDeploymentConfiguration added in v1.5.0 

func (s *CreateServiceInput) SetDeploymentConfiguration(v *DeploymentConfiguration) *CreateServiceInput

SetDeploymentConfiguration sets the DeploymentConfiguration field's value.

func (*CreateServiceInput) SetDesiredCount added in v1.5.0 

func (s *CreateServiceInput) SetDesiredCount(v int64) *CreateServiceInput

SetDesiredCount sets the DesiredCount field's value.

func (*CreateServiceInput) SetHealthCheckGracePeriodSeconds added in v1.12.53 

func (s *CreateServiceInput) SetHealthCheckGracePeriodSeconds(v int64) *CreateServiceInput

SetHealthCheckGracePeriodSeconds sets the HealthCheckGracePeriodSeconds field's value.

func (*CreateServiceInput) SetLaunchType added in v1.12.36 

func (s *CreateServiceInput) SetLaunchType(v string) *CreateServiceInput

SetLaunchType sets the LaunchType field's value.

func (*CreateServiceInput) SetLoadBalancers added in v1.5.0 

func (s *CreateServiceInput) SetLoadBalancers(v []*LoadBalancer) *CreateServiceInput

SetLoadBalancers sets the LoadBalancers field's value.

func (*CreateServiceInput) SetNetworkConfiguration added in v1.12.27 

func (s *CreateServiceInput) SetNetworkConfiguration(v *NetworkConfiguration) *CreateServiceInput

SetNetworkConfiguration sets the NetworkConfiguration field's value.

func (*CreateServiceInput) SetPlacementConstraints added in v1.6.9 

func (s *CreateServiceInput) SetPlacementConstraints(v []*PlacementConstraint) *CreateServiceInput

SetPlacementConstraints sets the PlacementConstraints field's value.

func (*CreateServiceInput) SetPlacementStrategy added in v1.6.9 

func (s *CreateServiceInput) SetPlacementStrategy(v []*PlacementStrategy) *CreateServiceInput

SetPlacementStrategy sets the PlacementStrategy field's value.

func (*CreateServiceInput) SetPlatformVersion added in v1.12.36 

func (s *CreateServiceInput) SetPlatformVersion(v string) *CreateServiceInput

SetPlatformVersion sets the PlatformVersion field's value.

func (*CreateServiceInput) SetRole added in v1.5.0 

func (s *CreateServiceInput) SetRole(v string) *CreateServiceInput

SetRole sets the Role field's value.

func (*CreateServiceInput) SetSchedulingStrategy added in v1.14.5 

func (s *CreateServiceInput) SetSchedulingStrategy(v string) *CreateServiceInput

SetSchedulingStrategy sets the SchedulingStrategy field's value.

func (*CreateServiceInput) SetServiceName added in v1.5.0 

func (s *CreateServiceInput) SetServiceName(v string) *CreateServiceInput

SetServiceName sets the ServiceName field's value.

func (*CreateServiceInput) SetServiceRegistries added in v1.13.19 

func (s *CreateServiceInput) SetServiceRegistries(v []*ServiceRegistry) *CreateServiceInput

SetServiceRegistries sets the ServiceRegistries field's value.

func (*CreateServiceInput) SetTaskDefinition added in v1.5.0 

func (s *CreateServiceInput) SetTaskDefinition(v string) *CreateServiceInput

SetTaskDefinition sets the TaskDefinition field's value.

func (CreateServiceInput) String added in v0.6.5 

func (s CreateServiceInput) String() string

String returns the string representation

func (*CreateServiceInput) Validate added in v1.1.21 

func (s *CreateServiceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateServiceOutput 

type CreateServiceOutput struct {

	// The full description of your service following the create call.
	Service *Service `locationName:"service" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateServiceOutput) GoString added in v0.6.5 

func (s CreateServiceOutput) GoString() string

GoString returns the string representation

func (*CreateServiceOutput) SetService added in v1.5.0 

func (s *CreateServiceOutput) SetService(v *Service) *CreateServiceOutput

SetService sets the Service field's value.

func (CreateServiceOutput) String added in v0.6.5 

func (s CreateServiceOutput) String() string

String returns the string representation

type DeleteAttributesInput added in v1.6.9 

type DeleteAttributesInput struct {

	// The attributes to delete from your resource. You can specify up to 10 attributes
	// per request. For custom attributes, specify the attribute name and target
	// ID, but do not specify the value. If you specify the target ID using the
	// short form, you must also specify the target type.
	//
	// Attributes is a required field
	Attributes []*Attribute `locationName:"attributes" type:"list" required:"true"`

	// The short name or full Amazon Resource Name (ARN) of the cluster that contains
	// the resource to delete attributes. If you do not specify a cluster, the default
	// cluster is assumed.
	Cluster *string `locationName:"cluster" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteAttributesInput) GoString added in v1.6.9 

func (s DeleteAttributesInput) GoString() string

GoString returns the string representation

func (*DeleteAttributesInput) SetAttributes added in v1.6.9 

func (s *DeleteAttributesInput) SetAttributes(v []*Attribute) *DeleteAttributesInput

SetAttributes sets the Attributes field's value.

func (*DeleteAttributesInput) SetCluster added in v1.6.9 

func (s *DeleteAttributesInput) SetCluster(v string) *DeleteAttributesInput

SetCluster sets the Cluster field's value.

func (DeleteAttributesInput) String added in v1.6.9 

func (s DeleteAttributesInput) String() string

String returns the string representation

func (*DeleteAttributesInput) Validate added in v1.6.9 

func (s *DeleteAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAttributesOutput added in v1.6.9 

type DeleteAttributesOutput struct {

	// A list of attribute objects that were successfully deleted from your resource.
	Attributes []*Attribute `locationName:"attributes" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteAttributesOutput) GoString added in v1.6.9 

func (s DeleteAttributesOutput) GoString() string

GoString returns the string representation

func (*DeleteAttributesOutput) SetAttributes added in v1.6.9 

func (s *DeleteAttributesOutput) SetAttributes(v []*Attribute) *DeleteAttributesOutput

SetAttributes sets the Attributes field's value.

func (DeleteAttributesOutput) String added in v1.6.9 

func (s DeleteAttributesOutput) String() string

String returns the string representation

type DeleteClusterInput 

type DeleteClusterInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster to delete.
	//
	// Cluster is a required field
	Cluster *string `locationName:"cluster" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteClusterInput) GoString added in v0.6.5 

func (s DeleteClusterInput) GoString() string

GoString returns the string representation

func (*DeleteClusterInput) SetCluster added in v1.5.0 

func (s *DeleteClusterInput) SetCluster(v string) *DeleteClusterInput

SetCluster sets the Cluster field's value.

func (DeleteClusterInput) String added in v0.6.5 

func (s DeleteClusterInput) String() string

String returns the string representation

func (*DeleteClusterInput) Validate added in v1.1.21 

func (s *DeleteClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteClusterOutput 

type DeleteClusterOutput struct {

	// The full description of the deleted cluster.
	Cluster *Cluster `locationName:"cluster" type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteClusterOutput) GoString added in v0.6.5 

func (s DeleteClusterOutput) GoString() string

GoString returns the string representation

func (*DeleteClusterOutput) SetCluster added in v1.5.0 

func (s *DeleteClusterOutput) SetCluster(v *Cluster) *DeleteClusterOutput

SetCluster sets the Cluster field's value.

func (DeleteClusterOutput) String added in v0.6.5 

func (s DeleteClusterOutput) String() string

String returns the string representation

type DeleteServiceInput 

type DeleteServiceInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts
	// the service to delete. If you do not specify a cluster, the default cluster
	// is assumed.
	Cluster *string `locationName:"cluster" type:"string"`

	// If true, allows you to delete a service even if it has not been scaled down
	// to zero tasks. It is only necessary to use this if the service is using the
	// REPLICA scheduling strategy.
	Force *bool `locationName:"force" type:"boolean"`

	// The name of the service to delete.
	//
	// Service is a required field
	Service *string `locationName:"service" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteServiceInput) GoString added in v0.6.5 

func (s DeleteServiceInput) GoString() string

GoString returns the string representation

func (*DeleteServiceInput) SetCluster added in v1.5.0 

func (s *DeleteServiceInput) SetCluster(v string) *DeleteServiceInput

SetCluster sets the Cluster field's value.

func (*DeleteServiceInput) SetForce added in v1.14.5 

func (s *DeleteServiceInput) SetForce(v bool) *DeleteServiceInput

SetForce sets the Force field's value.

func (*DeleteServiceInput) SetService added in v1.5.0 

func (s *DeleteServiceInput) SetService(v string) *DeleteServiceInput

SetService sets the Service field's value.

func (DeleteServiceInput) String added in v0.6.5 

func (s DeleteServiceInput) String() string

String returns the string representation

func (*DeleteServiceInput) Validate added in v1.1.21 

func (s *DeleteServiceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteServiceOutput 

type DeleteServiceOutput struct {

	// The full description of the deleted service.
	Service *Service `locationName:"service" type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteServiceOutput) GoString added in v0.6.5 

func (s DeleteServiceOutput) GoString() string

GoString returns the string representation

func (*DeleteServiceOutput) SetService added in v1.5.0 

func (s *DeleteServiceOutput) SetService(v *Service) *DeleteServiceOutput

SetService sets the Service field's value.

func (DeleteServiceOutput) String added in v0.6.5 

func (s DeleteServiceOutput) String() string

String returns the string representation

type Deployment 

type Deployment struct {

	// The Unix time stamp for when the service was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"unix"`

	// The most recent desired count of tasks that was specified for the service
	// to deploy or maintain.
	DesiredCount *int64 `locationName:"desiredCount" type:"integer"`

	// The ID of the deployment.
	Id *string `locationName:"id" type:"string"`

	// The launch type on which your service is running.
	LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"`

	// The VPC subnet and security group configuration for tasks that receive their
	// own Elastic Network Interface by using the awsvpc networking mode.
	NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"`

	// The number of tasks in the deployment that are in the PENDING status.
	PendingCount *int64 `locationName:"pendingCount" type:"integer"`

	// The platform version on which your service is running.
	PlatformVersion *string `locationName:"platformVersion" type:"string"`

	// The number of tasks in the deployment that are in the RUNNING status.
	RunningCount *int64 `locationName:"runningCount" type:"integer"`

	// The status of the deployment. Valid values are PRIMARY (for the most recent
	// deployment), ACTIVE (for previous deployments that still have tasks running,
	// but are being replaced with the PRIMARY deployment), and INACTIVE (for deployments
	// that have been completely replaced).
	Status *string `locationName:"status" type:"string"`

	// The most recent task definition that was specified for the service to use.
	TaskDefinition *string `locationName:"taskDefinition" type:"string"`

	// The Unix time stamp for when the service was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

The details of an Amazon ECS service deployment.

func (Deployment) GoString added in v0.6.5 

func (s Deployment) GoString() string

GoString returns the string representation

func (*Deployment) SetCreatedAt added in v1.5.0 

func (s *Deployment) SetCreatedAt(v time.Time) *Deployment

SetCreatedAt sets the CreatedAt field's value.

func (*Deployment) SetDesiredCount added in v1.5.0 

func (s *Deployment) SetDesiredCount(v int64) *Deployment

SetDesiredCount sets the DesiredCount field's value.

func (*Deployment) SetId added in v1.5.0 

func (s *Deployment) SetId(v string) *Deployment

SetId sets the Id field's value.

func (*Deployment) SetLaunchType added in v1.12.36 

func (s *Deployment) SetLaunchType(v string) *Deployment

SetLaunchType sets the LaunchType field's value.

func (*Deployment) SetNetworkConfiguration added in v1.12.27 

func (s *Deployment) SetNetworkConfiguration(v *NetworkConfiguration) *Deployment

SetNetworkConfiguration sets the NetworkConfiguration field's value.

func (*Deployment) SetPendingCount added in v1.5.0 

func (s *Deployment) SetPendingCount(v int64) *Deployment

SetPendingCount sets the PendingCount field's value.

func (*Deployment) SetPlatformVersion added in v1.12.36 

func (s *Deployment) SetPlatformVersion(v string) *Deployment

SetPlatformVersion sets the PlatformVersion field's value.

func (*Deployment) SetRunningCount added in v1.5.0 

func (s *Deployment) SetRunningCount(v int64) *Deployment

SetRunningCount sets the RunningCount field's value.

func (*Deployment) SetStatus added in v1.5.0 

func (s *Deployment) SetStatus(v string) *Deployment

SetStatus sets the Status field's value.

func (*Deployment) SetTaskDefinition added in v1.5.0 

func (s *Deployment) SetTaskDefinition(v string) *Deployment

SetTaskDefinition sets the TaskDefinition field's value.

func (*Deployment) SetUpdatedAt added in v1.5.0 

func (s *Deployment) SetUpdatedAt(v time.Time) *Deployment

SetUpdatedAt sets the UpdatedAt field's value.

func (Deployment) String added in v0.6.5 

func (s Deployment) String() string

String returns the string representation

type DeploymentConfiguration added in v1.0.7 

type DeploymentConfiguration struct {

	// The upper limit (as a percentage of the service's desiredCount) of the number
	// of tasks that are allowed in the RUNNING or PENDING state in a service during
	// a deployment. The maximum number of tasks during a deployment is the desiredCount
	// multiplied by maximumPercent/100, rounded down to the nearest integer value.
	MaximumPercent *int64 `locationName:"maximumPercent" type:"integer"`

	// The lower limit (as a percentage of the service's desiredCount) of the number
	// of running tasks that must remain in the RUNNING state in a service during
	// a deployment. The minimum number of healthy tasks during a deployment is
	// the desiredCount multiplied by minimumHealthyPercent/100, rounded up to the
	// nearest integer value.
	MinimumHealthyPercent *int64 `locationName:"minimumHealthyPercent" type:"integer"`
	// contains filtered or unexported fields
}

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

func (DeploymentConfiguration) GoString added in v1.0.7 

func (s DeploymentConfiguration) GoString() string

GoString returns the string representation

func (*DeploymentConfiguration) SetMaximumPercent added in v1.5.0 

func (s *DeploymentConfiguration) SetMaximumPercent(v int64) *DeploymentConfiguration

SetMaximumPercent sets the MaximumPercent field's value.

func (*DeploymentConfiguration) SetMinimumHealthyPercent added in v1.5.0 

func (s *DeploymentConfiguration) SetMinimumHealthyPercent(v int64) *DeploymentConfiguration

SetMinimumHealthyPercent sets the MinimumHealthyPercent field's value.

func (DeploymentConfiguration) String added in v1.0.7 

func (s DeploymentConfiguration) String() string

String returns the string representation

type DeregisterContainerInstanceInput 

type DeregisterContainerInstanceInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts
	// the container instance to deregister. If you do not specify a cluster, the
	// default cluster is assumed.
	Cluster *string `locationName:"cluster" type:"string"`

	// The container instance ID or full ARN of the container instance to deregister.
	// The ARN contains the arn:aws:ecs namespace, followed by the region of the
	// container instance, the AWS account ID of the container instance owner, the
	// container-instance namespace, and then the container instance ID. For example,
	// arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
	//
	// ContainerInstance is a required field
	ContainerInstance *string `locationName:"containerInstance" type:"string" required:"true"`

	// Forces the deregistration of the container instance. If you have tasks running
	// on the container instance when you deregister it with the force option, these
	// tasks remain running until you terminate the instance or the tasks stop through
	// some other means, but they are orphaned (no longer monitored or accounted
	// for by Amazon ECS). If an orphaned task on your container instance is part
	// of an Amazon ECS service, then the service scheduler starts another copy
	// of that task, on a different container instance if possible.
	//
	// Any containers in orphaned service tasks that are registered with a Classic
	// Load Balancer or an Application Load Balancer target group are deregistered.
	// They begin connection draining according to the settings on the load balancer
	// or target group.
	Force *bool `locationName:"force" type:"boolean"`
	// contains filtered or unexported fields
}

func (DeregisterContainerInstanceInput) GoString added in v0.6.5 

func (s DeregisterContainerInstanceInput) GoString() string

GoString returns the string representation

func (*DeregisterContainerInstanceInput) SetCluster added in v1.5.0 

func (s *DeregisterContainerInstanceInput) SetCluster(v string) *DeregisterContainerInstanceInput

SetCluster sets the Cluster field's value.

func (*DeregisterContainerInstanceInput) SetContainerInstance added in v1.5.0 

func (s *DeregisterContainerInstanceInput) SetContainerInstance(v string) *DeregisterContainerInstanceInput

SetContainerInstance sets the ContainerInstance field's value.

func (*DeregisterContainerInstanceInput) SetForce added in v1.5.0 

func (s *DeregisterContainerInstanceInput) SetForce(v bool) *DeregisterContainerInstanceInput

SetForce sets the Force field's value.

func (DeregisterContainerInstanceInput) String added in v0.6.5 

func (s DeregisterContainerInstanceInput) String() string

String returns the string representation

func (*DeregisterContainerInstanceInput) Validate added in v1.1.21 

func (s *DeregisterContainerInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeregisterContainerInstanceOutput 

type DeregisterContainerInstanceOutput struct {

	// The container instance that was deregistered.
	ContainerInstance *ContainerInstance `locationName:"containerInstance" type:"structure"`
	// contains filtered or unexported fields
}

func (DeregisterContainerInstanceOutput) GoString added in v0.6.5 

func (s DeregisterContainerInstanceOutput) GoString() string

GoString returns the string representation

func (*DeregisterContainerInstanceOutput) SetContainerInstance added in v1.5.0 

func (s *DeregisterContainerInstanceOutput) SetContainerInstance(v *ContainerInstance) *DeregisterContainerInstanceOutput

SetContainerInstance sets the ContainerInstance field's value.

func (DeregisterContainerInstanceOutput) String added in v0.6.5 

func (s DeregisterContainerInstanceOutput) String() string

String returns the string representation

type DeregisterTaskDefinitionInput 

type DeregisterTaskDefinitionInput struct {

	// The family and revision (family:revision) or full Amazon Resource Name (ARN)
	// of the task definition to deregister. You must specify a revision.
	//
	// TaskDefinition is a required field
	TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeregisterTaskDefinitionInput) GoString added in v0.6.5 

func (s DeregisterTaskDefinitionInput) GoString() string

GoString returns the string representation

func (*DeregisterTaskDefinitionInput) SetTaskDefinition added in v1.5.0 

func (s *DeregisterTaskDefinitionInput) SetTaskDefinition(v string) *DeregisterTaskDefinitionInput

SetTaskDefinition sets the TaskDefinition field's value.

func (DeregisterTaskDefinitionInput) String added in v0.6.5 

func (s DeregisterTaskDefinitionInput) String() string

String returns the string representation

func (*DeregisterTaskDefinitionInput) Validate added in v1.1.21 

func (s *DeregisterTaskDefinitionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeregisterTaskDefinitionOutput 

type DeregisterTaskDefinitionOutput struct {

	// The full description of the deregistered task.
	TaskDefinition *TaskDefinition `locationName:"taskDefinition" type:"structure"`
	// contains filtered or unexported fields
}

func (DeregisterTaskDefinitionOutput) GoString added in v0.6.5 

func (s DeregisterTaskDefinitionOutput) GoString() string

GoString returns the string representation

func (*DeregisterTaskDefinitionOutput) SetTaskDefinition added in v1.5.0 

func (s *DeregisterTaskDefinitionOutput) SetTaskDefinition(v *TaskDefinition) *DeregisterTaskDefinitionOutput

SetTaskDefinition sets the TaskDefinition field's value.

func (DeregisterTaskDefinitionOutput) String added in v0.6.5 

func (s DeregisterTaskDefinitionOutput) String() string

String returns the string representation

type DescribeClustersInput 

type DescribeClustersInput struct {

	// A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN)
	// entries. If you do not specify a cluster, the default cluster is assumed.
	Clusters []*string `locationName:"clusters" type:"list"`

	// Additional information about your clusters to be separated by launch type,
	// including:
	//
	//    * runningEC2TasksCount
	//
	//    * runningFargateTasksCount
	//
	//    * pendingEC2TasksCount
	//
	//    * pendingFargateTasksCount
	//
	//    * activeEC2ServiceCount
	//
	//    * activeFargateServiceCount
	//
	//    * drainingEC2ServiceCount
	//
	//    * drainingFargateServiceCount
	Include []*string `locationName:"include" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeClustersInput) GoString added in v0.6.5 

func (s DescribeClustersInput) GoString() string

GoString returns the string representation

func (*DescribeClustersInput) SetClusters added in v1.5.0 

func (s *DescribeClustersInput) SetClusters(v []*string) *DescribeClustersInput

SetClusters sets the Clusters field's value.

func (*DescribeClustersInput) SetInclude added in v1.12.36 

func (s *DescribeClustersInput) SetInclude(v []*string) *DescribeClustersInput

SetInclude sets the Include field's value.

func (DescribeClustersInput) String added in v0.6.5 

func (s DescribeClustersInput) String() string

String returns the string representation

type DescribeClustersOutput 

type DescribeClustersOutput struct {

	// The list of clusters.
	Clusters []*Cluster `locationName:"clusters" type:"list"`

	// Any failures associated with the call.
	Failures []*Failure `locationName:"failures" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeClustersOutput) GoString added in v0.6.5 

func (s DescribeClustersOutput) GoString() string

GoString returns the string representation

func (*DescribeClustersOutput) SetClusters added in v1.5.0 

func (s *DescribeClustersOutput) SetClusters(v []*Cluster) *DescribeClustersOutput

SetClusters sets the Clusters field's value.

func (*DescribeClustersOutput) SetFailures added in v1.5.0 

func (s *DescribeClustersOutput) SetFailures(v []*Failure) *DescribeClustersOutput

SetFailures sets the Failures field's value.

func (DescribeClustersOutput) String added in v0.6.5 

func (s DescribeClustersOutput) String() string

String returns the string representation

type DescribeContainerInstancesInput 

type DescribeContainerInstancesInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts
	// the container instances to describe. If you do not specify a cluster, the
	// default cluster is assumed.
	Cluster *string `locationName:"cluster" type:"string"`

	// A list of up to 100 container instance IDs or full Amazon Resource Name (ARN)
	// entries.
	//
	// ContainerInstances is a required field
	ContainerInstances []*string `locationName:"containerInstances" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeContainerInstancesInput) GoString added in v0.6.5 

func (s DescribeContainerInstancesInput) GoString() string

GoString returns the string representation

func (*DescribeContainerInstancesInput) SetCluster added in v1.5.0 

func (s *DescribeContainerInstancesInput) SetCluster(v string) *DescribeContainerInstancesInput

SetCluster sets the Cluster field's value.

func (*DescribeContainerInstancesInput) SetContainerInstances added in v1.5.0 

func (s *DescribeContainerInstancesInput) SetContainerInstances(v []*string) *DescribeContainerInstancesInput

SetContainerInstances sets the ContainerInstances field's value.

func (DescribeContainerInstancesInput) String added in v0.6.5 

func (s DescribeContainerInstancesInput) String() string

String returns the string representation

func (*DescribeContainerInstancesInput) Validate added in v1.1.21 

func (s *DescribeContainerInstancesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeContainerInstancesOutput 

type DescribeContainerInstancesOutput struct {

	// The list of container instances.
	ContainerInstances []*ContainerInstance `locationName:"containerInstances" type:"list"`

	// Any failures associated with the call.
	Failures []*Failure `locationName:"failures" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeContainerInstancesOutput) GoString added in v0.6.5 

func (s DescribeContainerInstancesOutput) GoString() string

GoString returns the string representation

func (*DescribeContainerInstancesOutput) SetContainerInstances added in v1.5.0 

func (s *DescribeContainerInstancesOutput) SetContainerInstances(v []*ContainerInstance) *DescribeContainerInstancesOutput

SetContainerInstances sets the ContainerInstances field's value.

func (*DescribeContainerInstancesOutput) SetFailures added in v1.5.0 

func (s *DescribeContainerInstancesOutput) SetFailures(v []*Failure) *DescribeContainerInstancesOutput

SetFailures sets the Failures field's value.

func (DescribeContainerInstancesOutput) String added in v0.6.5 

func (s DescribeContainerInstancesOutput) String() string

String returns the string representation

type DescribeServicesInput 

type DescribeServicesInput struct {

	// The short name or full Amazon Resource Name (ARN)the cluster that hosts the
	// service to describe. If you do not specify a cluster, the default cluster
	// is assumed.
	Cluster *string `locationName:"cluster" type:"string"`

	// A list of services to describe. You may specify up to 10 services to describe
	// in a single operation.
	//
	// Services is a required field
	Services []*string `locationName:"services" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeServicesInput) GoString added in v0.6.5 

func (s DescribeServicesInput) GoString() string

GoString returns the string representation

func (*DescribeServicesInput) SetCluster added in v1.5.0 

func (s *DescribeServicesInput) SetCluster(v string) *DescribeServicesInput

SetCluster sets the Cluster field's value.

func (*DescribeServicesInput) SetServices added in v1.5.0 

func (s *DescribeServicesInput) SetServices(v []*string) *DescribeServicesInput

SetServices sets the Services field's value.

func (DescribeServicesInput) String added in v0.6.5 

func (s DescribeServicesInput) String() string

String returns the string representation

func (*DescribeServicesInput) Validate added in v1.1.21 

func (s *DescribeServicesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeServicesOutput 

type DescribeServicesOutput struct {

	// Any failures associated with the call.
	Failures []*Failure `locationName:"failures" type:"list"`

	// The list of services described.
	Services []*Service `locationName:"services" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeServicesOutput) GoString added in v0.6.5 

func (s DescribeServicesOutput) GoString() string

GoString returns the string representation

func (*DescribeServicesOutput) SetFailures added in v1.5.0 

func (s *DescribeServicesOutput) SetFailures(v []*Failure) *DescribeServicesOutput

SetFailures sets the Failures field's value.

func (*DescribeServicesOutput) SetServices added in v1.5.0 

func (s *DescribeServicesOutput) SetServices(v []*Service) *DescribeServicesOutput

SetServices sets the Services field's value.

func (DescribeServicesOutput) String added in v0.6.5 

func (s DescribeServicesOutput) String() string

String returns the string representation

type DescribeTaskDefinitionInput 

type DescribeTaskDefinitionInput struct {

	// The family for the latest ACTIVE revision, family and revision (family:revision)
	// for a specific revision in the family, or full Amazon Resource Name (ARN)
	// of the task definition to describe.
	//
	// TaskDefinition is a required field
	TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTaskDefinitionInput) GoString added in v0.6.5 

func (s DescribeTaskDefinitionInput) GoString() string

GoString returns the string representation

func (*DescribeTaskDefinitionInput) SetTaskDefinition added in v1.5.0 

func (s *DescribeTaskDefinitionInput) SetTaskDefinition(v string) *DescribeTaskDefinitionInput

SetTaskDefinition sets the TaskDefinition field's value.

func (DescribeTaskDefinitionInput) String added in v0.6.5 

func (s DescribeTaskDefinitionInput) String() string

String returns the string representation

func (*DescribeTaskDefinitionInput) Validate added in v1.1.21 

func (s *DescribeTaskDefinitionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeTaskDefinitionOutput 

type DescribeTaskDefinitionOutput struct {

	// The full task definition description.
	TaskDefinition *TaskDefinition `locationName:"taskDefinition" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeTaskDefinitionOutput) GoString added in v0.6.5 

func (s DescribeTaskDefinitionOutput) GoString() string

GoString returns the string representation

func (*DescribeTaskDefinitionOutput) SetTaskDefinition added in v1.5.0 

func (s *DescribeTaskDefinitionOutput) SetTaskDefinition(v *TaskDefinition) *DescribeTaskDefinitionOutput

SetTaskDefinition sets the TaskDefinition field's value.

func (DescribeTaskDefinitionOutput) String added in v0.6.5 

func (s DescribeTaskDefinitionOutput) String() string

String returns the string representation

type DescribeTasksInput 

type DescribeTasksInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts
	// the task to describe. If you do not specify a cluster, the default cluster
	// is assumed.
	Cluster *string `locationName:"cluster" type:"string"`

	// A list of up to 100 task IDs or full ARN entries.
	//
	// Tasks is a required field
	Tasks []*string `locationName:"tasks" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTasksInput) GoString added in v0.6.5 

func (s DescribeTasksInput) GoString() string

GoString returns the string representation

func (*DescribeTasksInput) SetCluster added in v1.5.0 

func (s *DescribeTasksInput) SetCluster(v string) *DescribeTasksInput

SetCluster sets the Cluster field's value.

func (*DescribeTasksInput) SetTasks added in v1.5.0 

func (s *DescribeTasksInput) SetTasks(v []*string) *DescribeTasksInput

SetTasks sets the Tasks field's value.

func (DescribeTasksInput) String added in v0.6.5 

func (s DescribeTasksInput) String() string

String returns the string representation

func (*DescribeTasksInput) Validate added in v1.1.21 

func (s *DescribeTasksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeTasksOutput 

type DescribeTasksOutput struct {

	// Any failures associated with the call.
	Failures []*Failure `locationName:"failures" type:"list"`

	// The list of tasks.
	Tasks []*Task `locationName:"tasks" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeTasksOutput) GoString added in v0.6.5 

func (s DescribeTasksOutput) GoString() string

GoString returns the string representation

func (*DescribeTasksOutput) SetFailures added in v1.5.0 

func (s *DescribeTasksOutput) SetFailures(v []*Failure) *DescribeTasksOutput

SetFailures sets the Failures field's value.

func (*DescribeTasksOutput) SetTasks added in v1.5.0 

func (s *DescribeTasksOutput) SetTasks(v []*Task) *DescribeTasksOutput

SetTasks sets the Tasks field's value.

func (DescribeTasksOutput) String added in v0.6.5 

func (s DescribeTasksOutput) String() string

String returns the string representation

type Device added in v1.12.22 

type Device struct {

	// The path inside the container at which to expose the host device.
	ContainerPath *string `locationName:"containerPath" type:"string"`

	// The path for the device on the host container instance.
	//
	// HostPath is a required field
	HostPath *string `locationName:"hostPath" type:"string" required:"true"`

	// The explicit permissions to provide to the container for the device. By default,
	// the container has permissions for read, write, and mknod for the device.
	Permissions []*string `locationName:"permissions" type:"list"`
	// contains filtered or unexported fields
}

An object representing a container instance host device.

func (Device) GoString added in v1.12.22 

func (s Device) GoString() string

GoString returns the string representation

func (*Device) SetContainerPath added in v1.12.22 

func (s *Device) SetContainerPath(v string) *Device

SetContainerPath sets the ContainerPath field's value.

func (*Device) SetHostPath added in v1.12.22 

func (s *Device) SetHostPath(v string) *Device

SetHostPath sets the HostPath field's value.

func (*Device) SetPermissions added in v1.12.22 

func (s *Device) SetPermissions(v []*string) *Device

SetPermissions sets the Permissions field's value.

func (Device) String added in v1.12.22 

func (s Device) String() string

String returns the string representation

func (*Device) Validate added in v1.12.22 

func (s *Device) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DiscoverPollEndpointInput 

type DiscoverPollEndpointInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that the
	// container instance belongs to.
	Cluster *string `locationName:"cluster" type:"string"`

	// The container instance ID or full ARN of the container instance. The ARN
	// contains the arn:aws:ecs namespace, followed by the region of the container
	// instance, the AWS account ID of the container instance owner, the container-instance
	// namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
	ContainerInstance *string `locationName:"containerInstance" type:"string"`
	// contains filtered or unexported fields
}

func (DiscoverPollEndpointInput) GoString added in v0.6.5 

func (s DiscoverPollEndpointInput) GoString() string

GoString returns the string representation

func (*DiscoverPollEndpointInput) SetCluster added in v1.5.0 

func (s *DiscoverPollEndpointInput) SetCluster(v string) *DiscoverPollEndpointInput

SetCluster sets the Cluster field's value.

func (*DiscoverPollEndpointInput) SetContainerInstance added in v1.5.0 

func (s *DiscoverPollEndpointInput) SetContainerInstance(v string) *DiscoverPollEndpointInput

SetContainerInstance sets the ContainerInstance field's value.

func (DiscoverPollEndpointInput) String added in v0.6.5 

func (s DiscoverPollEndpointInput) String() string

String returns the string representation

type DiscoverPollEndpointOutput 

type DiscoverPollEndpointOutput struct {

	// The endpoint for the Amazon ECS agent to poll.
	Endpoint *string `locationName:"endpoint" type:"string"`

	// The telemetry endpoint for the Amazon ECS agent.
	TelemetryEndpoint *string `locationName:"telemetryEndpoint" type:"string"`
	// contains filtered or unexported fields
}

func (DiscoverPollEndpointOutput) GoString added in v0.6.5 

func (s DiscoverPollEndpointOutput) GoString() string

GoString returns the string representation

func (*DiscoverPollEndpointOutput) SetEndpoint added in v1.5.0 

func (s *DiscoverPollEndpointOutput) SetEndpoint(v string) *DiscoverPollEndpointOutput

SetEndpoint sets the Endpoint field's value.

func (*DiscoverPollEndpointOutput) SetTelemetryEndpoint added in v1.5.0 

func (s *DiscoverPollEndpointOutput) SetTelemetryEndpoint(v string) *DiscoverPollEndpointOutput

SetTelemetryEndpoint sets the TelemetryEndpoint field's value.

func (DiscoverPollEndpointOutput) String added in v0.6.5 

func (s DiscoverPollEndpointOutput) String() string

String returns the string representation

type ECS 

type ECS struct {
	*client.Client
}

ECS provides the API operation methods for making requests to Amazon EC2 Container Service. See this package's package overview docs for details on the service.

ECS methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *ECS

New creates a new instance of the ECS client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a ECS client from just a session.
svc := ecs.New(mySession)

// Create a ECS client with additional configuration
svc := ecs.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*ECS) CreateCluster 

func (c *ECS) CreateCluster(input *CreateClusterInput) (*CreateClusterOutput, error)

CreateCluster API operation for Amazon EC2 Container Service.

Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.

When you call the CreateCluster API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the Amazon Elastic Container Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation CreateCluster for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateCluster

Example (Shared00)

To create a new cluster

This example creates a cluster in your default region. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.CreateClusterInput{
		ClusterName: aws.String("my_cluster"),
	}

	result, err := svc.CreateCluster(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) CreateClusterRequest 

func (c *ECS) CreateClusterRequest(input *CreateClusterInput) (req *request.Request, output *CreateClusterOutput)

CreateClusterRequest generates a "aws/request.Request" representing the client's request for the CreateCluster operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCluster for more information on using the CreateCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateClusterRequest method.
req, resp := client.CreateClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateCluster

func (*ECS) CreateClusterWithContext added in v1.8.0 

func (c *ECS) CreateClusterWithContext(ctx aws.Context, input *CreateClusterInput, opts ...request.Option) (*CreateClusterOutput, error)

CreateClusterWithContext is the same as CreateCluster with the addition of the ability to pass a context and additional request options.

See CreateCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) CreateService 

func (c *ECS) CreateService(input *CreateServiceInput) (*CreateServiceOutput, error)

CreateService API operation for Amazon EC2 Container Service.

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 (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the Amazon Elastic Container Service Developer Guide.

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

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 can 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 they are hosted on is reported as healthy by the load balancer. The default value for a replica service for minimumHealthyPercent is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs. The default value for a daemon service for minimumHealthyPercent is 0% for the AWS CLI, the AWS SDKs, and the APIs and 50% for the console.

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 replica service has a desiredCount of four tasks and a maximumPercent value of 200%, the scheduler can 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 a replica service for maximumPercent is 200%. If you are using a daemon service type, the maximumPercent should remain at 100%, which is the default value.

When the service scheduler launches new tasks, it determines task placement in your cluster using 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 (although you can choose a different placement strategy) with the placementStrategy parameter):

Sort the valid container instances, giving priority to instances that have 

the fewest number of running tasks for this service in their respective
Availability Zone. 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation CreateService for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

  • ErrCodeUnsupportedFeatureException "UnsupportedFeatureException" The specified task is not supported in this region.

  • ErrCodePlatformUnknownException "PlatformUnknownException" The specified platform version does not exist.

  • ErrCodePlatformTaskDefinitionIncompatibilityException "PlatformTaskDefinitionIncompatibilityException" The specified platform version does not satisfy the task definition’s required capabilities.

  • ErrCodeAccessDeniedException "AccessDeniedException" You do not have authorization to perform the requested action.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateService

Example (Shared00)

To create a new service

This example creates a service in your default region called “ecs-simple-service“. The service uses the “hello_world“ task definition and it maintains 10 copies of that task. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.CreateServiceInput{
		DesiredCount:   aws.Int64(10),
		ServiceName:    aws.String("ecs-simple-service"),
		TaskDefinition: aws.String("hello_world"),
	}

	result, err := svc.CreateService(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			case ecs.ErrCodeUnsupportedFeatureException:
				fmt.Println(ecs.ErrCodeUnsupportedFeatureException, aerr.Error())
			case ecs.ErrCodePlatformUnknownException:
				fmt.Println(ecs.ErrCodePlatformUnknownException, aerr.Error())
			case ecs.ErrCodePlatformTaskDefinitionIncompatibilityException:
				fmt.Println(ecs.ErrCodePlatformTaskDefinitionIncompatibilityException, aerr.Error())
			case ecs.ErrCodeAccessDeniedException:
				fmt.Println(ecs.ErrCodeAccessDeniedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:
Example (Shared01)

To create a new service behind a load balancer

This example creates a service in your default region called “ecs-simple-service-elb“. The service uses the “ecs-demo“ task definition and it maintains 10 copies of that task. You must reference an existing load balancer in the same region by its name. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.CreateServiceInput{
		DesiredCount: aws.Int64(10),
		LoadBalancers: []*ecs.LoadBalancer{
			{
				ContainerName:    aws.String("simple-app"),
				ContainerPort:    aws.Int64(80),
				LoadBalancerName: aws.String("EC2Contai-EcsElast-15DCDAURT3ZO2"),
			},
		},
		Role:           aws.String("ecsServiceRole"),
		ServiceName:    aws.String("ecs-simple-service-elb"),
		TaskDefinition: aws.String("console-sample-app-static"),
	}

	result, err := svc.CreateService(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			case ecs.ErrCodeUnsupportedFeatureException:
				fmt.Println(ecs.ErrCodeUnsupportedFeatureException, aerr.Error())
			case ecs.ErrCodePlatformUnknownException:
				fmt.Println(ecs.ErrCodePlatformUnknownException, aerr.Error())
			case ecs.ErrCodePlatformTaskDefinitionIncompatibilityException:
				fmt.Println(ecs.ErrCodePlatformTaskDefinitionIncompatibilityException, aerr.Error())
			case ecs.ErrCodeAccessDeniedException:
				fmt.Println(ecs.ErrCodeAccessDeniedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) CreateServiceRequest 

func (c *ECS) CreateServiceRequest(input *CreateServiceInput) (req *request.Request, output *CreateServiceOutput)

CreateServiceRequest generates a "aws/request.Request" representing the client's request for the CreateService operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateService for more information on using the CreateService API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateServiceRequest method.
req, resp := client.CreateServiceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateService

func (*ECS) CreateServiceWithContext added in v1.8.0 

func (c *ECS) CreateServiceWithContext(ctx aws.Context, input *CreateServiceInput, opts ...request.Option) (*CreateServiceOutput, error)

CreateServiceWithContext is the same as CreateService with the addition of the ability to pass a context and additional request options.

See CreateService for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) DeleteAttributes added in v1.6.9 

func (c *ECS) DeleteAttributes(input *DeleteAttributesInput) (*DeleteAttributesOutput, error)

DeleteAttributes API operation for Amazon EC2 Container Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation DeleteAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

  • ErrCodeTargetNotFoundException "TargetNotFoundException" The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and region-specific.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteAttributes

func (*ECS) DeleteAttributesRequest added in v1.6.9 

func (c *ECS) DeleteAttributesRequest(input *DeleteAttributesInput) (req *request.Request, output *DeleteAttributesOutput)

DeleteAttributesRequest generates a "aws/request.Request" representing the client's request for the DeleteAttributes operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAttributes for more information on using the DeleteAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteAttributesRequest method.
req, resp := client.DeleteAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteAttributes

func (*ECS) DeleteAttributesWithContext added in v1.8.0 

func (c *ECS) DeleteAttributesWithContext(ctx aws.Context, input *DeleteAttributesInput, opts ...request.Option) (*DeleteAttributesOutput, error)

DeleteAttributesWithContext is the same as DeleteAttributes with the addition of the ability to pass a context and additional request options.

See DeleteAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) DeleteCluster 

func (c *ECS) DeleteCluster(input *DeleteClusterInput) (*DeleteClusterOutput, error)

DeleteCluster API operation for Amazon EC2 Container Service.

Deletes the specified cluster. 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation DeleteCluster for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

  • ErrCodeClusterContainsContainerInstancesException "ClusterContainsContainerInstancesException" You cannot delete a cluster that has registered container instances. You must first deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.

  • ErrCodeClusterContainsServicesException "ClusterContainsServicesException" You cannot delete a cluster that contains services. You must first update the service to reduce its desired task count to 0 and then delete the service. For more information, see UpdateService and DeleteService.

  • ErrCodeClusterContainsTasksException "ClusterContainsTasksException" You cannot delete a cluster that has active tasks.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteCluster

Example (Shared00)

To delete an empty cluster

This example deletes an empty cluster in your default region. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.DeleteClusterInput{
		Cluster: aws.String("my_cluster"),
	}

	result, err := svc.DeleteCluster(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			case ecs.ErrCodeClusterContainsContainerInstancesException:
				fmt.Println(ecs.ErrCodeClusterContainsContainerInstancesException, aerr.Error())
			case ecs.ErrCodeClusterContainsServicesException:
				fmt.Println(ecs.ErrCodeClusterContainsServicesException, aerr.Error())
			case ecs.ErrCodeClusterContainsTasksException:
				fmt.Println(ecs.ErrCodeClusterContainsTasksException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) DeleteClusterRequest 

func (c *ECS) DeleteClusterRequest(input *DeleteClusterInput) (req *request.Request, output *DeleteClusterOutput)

DeleteClusterRequest generates a "aws/request.Request" representing the client's request for the DeleteCluster operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCluster for more information on using the DeleteCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteClusterRequest method.
req, resp := client.DeleteClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteCluster

func (*ECS) DeleteClusterWithContext added in v1.8.0 

func (c *ECS) DeleteClusterWithContext(ctx aws.Context, input *DeleteClusterInput, opts ...request.Option) (*DeleteClusterOutput, error)

DeleteClusterWithContext is the same as DeleteCluster with the addition of the ability to pass a context and additional request options.

See DeleteCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) DeleteService 

func (c *ECS) DeleteService(input *DeleteServiceInput) (*DeleteServiceOutput, error)

DeleteService API operation for Amazon EC2 Container Service.

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 cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.

When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in ListServices API operations. After the tasks have stopped, then the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with DescribeServices API operations. However, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices API operations on those services return a ServiceNotFoundException error.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation DeleteService for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

  • ErrCodeServiceNotFoundException "ServiceNotFoundException" The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and region-specific.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteService

Example (Shared00)

To delete a service

This example deletes the my-http-service service. The service must have a desired count and running count of 0 before you can delete it. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.DeleteServiceInput{
		Service: aws.String("my-http-service"),
	}

	result, err := svc.DeleteService(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			case ecs.ErrCodeServiceNotFoundException:
				fmt.Println(ecs.ErrCodeServiceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) DeleteServiceRequest 

func (c *ECS) DeleteServiceRequest(input *DeleteServiceInput) (req *request.Request, output *DeleteServiceOutput)

DeleteServiceRequest generates a "aws/request.Request" representing the client's request for the DeleteService operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteService for more information on using the DeleteService API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteServiceRequest method.
req, resp := client.DeleteServiceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteService

func (*ECS) DeleteServiceWithContext added in v1.8.0 

func (c *ECS) DeleteServiceWithContext(ctx aws.Context, input *DeleteServiceInput, opts ...request.Option) (*DeleteServiceOutput, error)

DeleteServiceWithContext is the same as DeleteService with the addition of the ability to pass a context and additional request options.

See DeleteService for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) DeregisterContainerInstance 

func (c *ECS) DeregisterContainerInstance(input *DeregisterContainerInstanceInput) (*DeregisterContainerInstanceOutput, error)

DeregisterContainerInstance API operation for Amazon EC2 Container Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation DeregisterContainerInstance for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterContainerInstance

Example (Shared00)

To deregister a container instance from a cluster

This example deregisters a container instance from the specified cluster in your default region. If there are still tasks running on the container instance, you must either stop those tasks before deregistering, or use the force option. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.DeregisterContainerInstanceInput{
		Cluster:           aws.String("default"),
		ContainerInstance: aws.String("container_instance_UUID"),
		Force:             aws.Bool(true),
	}

	result, err := svc.DeregisterContainerInstance(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) DeregisterContainerInstanceRequest 

func (c *ECS) DeregisterContainerInstanceRequest(input *DeregisterContainerInstanceInput) (req *request.Request, output *DeregisterContainerInstanceOutput)

DeregisterContainerInstanceRequest generates a "aws/request.Request" representing the client's request for the DeregisterContainerInstance operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterContainerInstance for more information on using the DeregisterContainerInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeregisterContainerInstanceRequest method.
req, resp := client.DeregisterContainerInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterContainerInstance

func (*ECS) DeregisterContainerInstanceWithContext added in v1.8.0 

func (c *ECS) DeregisterContainerInstanceWithContext(ctx aws.Context, input *DeregisterContainerInstanceInput, opts ...request.Option) (*DeregisterContainerInstanceOutput, error)

DeregisterContainerInstanceWithContext is the same as DeregisterContainerInstance with the addition of the ability to pass a context and additional request options.

See DeregisterContainerInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) DeregisterTaskDefinition 

func (c *ECS) DeregisterTaskDefinition(input *DeregisterTaskDefinitionInput) (*DeregisterTaskDefinitionOutput, error)

DeregisterTaskDefinition API operation for Amazon EC2 Container Service.

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.

You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition (although 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, so you should not rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation DeregisterTaskDefinition for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterTaskDefinition

func (*ECS) DeregisterTaskDefinitionRequest 

func (c *ECS) DeregisterTaskDefinitionRequest(input *DeregisterTaskDefinitionInput) (req *request.Request, output *DeregisterTaskDefinitionOutput)

DeregisterTaskDefinitionRequest generates a "aws/request.Request" representing the client's request for the DeregisterTaskDefinition operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterTaskDefinition for more information on using the DeregisterTaskDefinition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeregisterTaskDefinitionRequest method.
req, resp := client.DeregisterTaskDefinitionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterTaskDefinition

func (*ECS) DeregisterTaskDefinitionWithContext added in v1.8.0 

func (c *ECS) DeregisterTaskDefinitionWithContext(ctx aws.Context, input *DeregisterTaskDefinitionInput, opts ...request.Option) (*DeregisterTaskDefinitionOutput, error)

DeregisterTaskDefinitionWithContext is the same as DeregisterTaskDefinition with the addition of the ability to pass a context and additional request options.

See DeregisterTaskDefinition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) DescribeClusters 

func (c *ECS) DescribeClusters(input *DescribeClustersInput) (*DescribeClustersOutput, error)

DescribeClusters API operation for Amazon EC2 Container Service.

Describes one or more of your clusters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation DescribeClusters for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeClusters

Example (Shared00)

To describe a cluster

This example provides a description of the specified cluster in your default region. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.DescribeClustersInput{
		Clusters: []*string{
			aws.String("default"),
		},
	}

	result, err := svc.DescribeClusters(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) DescribeClustersRequest 

func (c *ECS) DescribeClustersRequest(input *DescribeClustersInput) (req *request.Request, output *DescribeClustersOutput)

DescribeClustersRequest generates a "aws/request.Request" representing the client's request for the DescribeClusters operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeClusters for more information on using the DescribeClusters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeClustersRequest method.
req, resp := client.DescribeClustersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeClusters

func (*ECS) DescribeClustersWithContext added in v1.8.0 

func (c *ECS) DescribeClustersWithContext(ctx aws.Context, input *DescribeClustersInput, opts ...request.Option) (*DescribeClustersOutput, error)

DescribeClustersWithContext is the same as DescribeClusters with the addition of the ability to pass a context and additional request options.

See DescribeClusters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) DescribeContainerInstances 

func (c *ECS) DescribeContainerInstances(input *DescribeContainerInstancesInput) (*DescribeContainerInstancesOutput, error)

DescribeContainerInstances API operation for Amazon EC2 Container Service.

Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation DescribeContainerInstances for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeContainerInstances

Example (Shared00)

To describe container instance

This example provides a description of the specified container instance in your default region, using the container instance UUID as an identifier. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.DescribeContainerInstancesInput{
		Cluster: aws.String("default"),
		ContainerInstances: []*string{
			aws.String("f2756532-8f13-4d53-87c9-aed50dc94cd7"),
		},
	}

	result, err := svc.DescribeContainerInstances(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) DescribeContainerInstancesRequest 

func (c *ECS) DescribeContainerInstancesRequest(input *DescribeContainerInstancesInput) (req *request.Request, output *DescribeContainerInstancesOutput)

DescribeContainerInstancesRequest generates a "aws/request.Request" representing the client's request for the DescribeContainerInstances operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeContainerInstances for more information on using the DescribeContainerInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeContainerInstancesRequest method.
req, resp := client.DescribeContainerInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeContainerInstances

func (*ECS) DescribeContainerInstancesWithContext added in v1.8.0 

func (c *ECS) DescribeContainerInstancesWithContext(ctx aws.Context, input *DescribeContainerInstancesInput, opts ...request.Option) (*DescribeContainerInstancesOutput, error)

DescribeContainerInstancesWithContext is the same as DescribeContainerInstances with the addition of the ability to pass a context and additional request options.

See DescribeContainerInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) DescribeServices 

func (c *ECS) DescribeServices(input *DescribeServicesInput) (*DescribeServicesOutput, error)

DescribeServices API operation for Amazon EC2 Container Service.

Describes the specified services running in your cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation DescribeServices for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServices

Example (Shared00)

To describe a service

This example provides descriptive information about the service named “ecs-simple-service“. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.DescribeServicesInput{
		Services: []*string{
			aws.String("ecs-simple-service"),
		},
	}

	result, err := svc.DescribeServices(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) DescribeServicesRequest 

func (c *ECS) DescribeServicesRequest(input *DescribeServicesInput) (req *request.Request, output *DescribeServicesOutput)

DescribeServicesRequest generates a "aws/request.Request" representing the client's request for the DescribeServices operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeServices for more information on using the DescribeServices API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeServicesRequest method.
req, resp := client.DescribeServicesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServices

func (*ECS) DescribeServicesWithContext added in v1.8.0 

func (c *ECS) DescribeServicesWithContext(ctx aws.Context, input *DescribeServicesInput, opts ...request.Option) (*DescribeServicesOutput, error)

DescribeServicesWithContext is the same as DescribeServices with the addition of the ability to pass a context and additional request options.

See DescribeServices for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) DescribeTaskDefinition 

func (c *ECS) DescribeTaskDefinition(input *DescribeTaskDefinitionInput) (*DescribeTaskDefinitionOutput, error)

DescribeTaskDefinition API operation for Amazon EC2 Container Service.

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

You can only describe INACTIVE task definitions while an active task or service references them.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation DescribeTaskDefinition for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskDefinition

Example (Shared00)

To describe a task definition

This example provides a description of the specified task definition. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.DescribeTaskDefinitionInput{
		TaskDefinition: aws.String("hello_world:8"),
	}

	result, err := svc.DescribeTaskDefinition(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) DescribeTaskDefinitionRequest 

func (c *ECS) DescribeTaskDefinitionRequest(input *DescribeTaskDefinitionInput) (req *request.Request, output *DescribeTaskDefinitionOutput)

DescribeTaskDefinitionRequest generates a "aws/request.Request" representing the client's request for the DescribeTaskDefinition operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTaskDefinition for more information on using the DescribeTaskDefinition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeTaskDefinitionRequest method.
req, resp := client.DescribeTaskDefinitionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskDefinition

func (*ECS) DescribeTaskDefinitionWithContext added in v1.8.0 

func (c *ECS) DescribeTaskDefinitionWithContext(ctx aws.Context, input *DescribeTaskDefinitionInput, opts ...request.Option) (*DescribeTaskDefinitionOutput, error)

DescribeTaskDefinitionWithContext is the same as DescribeTaskDefinition with the addition of the ability to pass a context and additional request options.

See DescribeTaskDefinition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) DescribeTasks 

func (c *ECS) DescribeTasks(input *DescribeTasksInput) (*DescribeTasksOutput, error)

DescribeTasks API operation for Amazon EC2 Container Service.

Describes a specified task or tasks.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation DescribeTasks for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTasks

Example (Shared00)

To describe a task

This example provides a description of the specified task, using the task UUID as an identifier. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.DescribeTasksInput{
		Tasks: []*string{
			aws.String("c5cba4eb-5dad-405e-96db-71ef8eefe6a8"),
		},
	}

	result, err := svc.DescribeTasks(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) DescribeTasksRequest 

func (c *ECS) DescribeTasksRequest(input *DescribeTasksInput) (req *request.Request, output *DescribeTasksOutput)

DescribeTasksRequest generates a "aws/request.Request" representing the client's request for the DescribeTasks operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTasks for more information on using the DescribeTasks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeTasksRequest method.
req, resp := client.DescribeTasksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTasks

func (*ECS) DescribeTasksWithContext added in v1.8.0 

func (c *ECS) DescribeTasksWithContext(ctx aws.Context, input *DescribeTasksInput, opts ...request.Option) (*DescribeTasksOutput, error)

DescribeTasksWithContext is the same as DescribeTasks with the addition of the ability to pass a context and additional request options.

See DescribeTasks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) DiscoverPollEndpoint 

func (c *ECS) DiscoverPollEndpoint(input *DiscoverPollEndpointInput) (*DiscoverPollEndpointOutput, error)

DiscoverPollEndpoint API operation for Amazon EC2 Container Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation DiscoverPollEndpoint for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DiscoverPollEndpoint

func (*ECS) DiscoverPollEndpointRequest 

func (c *ECS) DiscoverPollEndpointRequest(input *DiscoverPollEndpointInput) (req *request.Request, output *DiscoverPollEndpointOutput)

DiscoverPollEndpointRequest generates a "aws/request.Request" representing the client's request for the DiscoverPollEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DiscoverPollEndpoint for more information on using the DiscoverPollEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DiscoverPollEndpointRequest method.
req, resp := client.DiscoverPollEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DiscoverPollEndpoint

func (*ECS) DiscoverPollEndpointWithContext added in v1.8.0 

func (c *ECS) DiscoverPollEndpointWithContext(ctx aws.Context, input *DiscoverPollEndpointInput, opts ...request.Option) (*DiscoverPollEndpointOutput, error)

DiscoverPollEndpointWithContext is the same as DiscoverPollEndpoint with the addition of the ability to pass a context and additional request options.

See DiscoverPollEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) ListAttributes added in v1.6.9 

func (c *ECS) ListAttributes(input *ListAttributesInput) (*ListAttributesOutput, error)

ListAttributes API operation for Amazon EC2 Container Service.

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, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation ListAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListAttributes

func (*ECS) ListAttributesRequest added in v1.6.9 

func (c *ECS) ListAttributesRequest(input *ListAttributesInput) (req *request.Request, output *ListAttributesOutput)

ListAttributesRequest generates a "aws/request.Request" representing the client's request for the ListAttributes operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAttributes for more information on using the ListAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListAttributesRequest method.
req, resp := client.ListAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListAttributes

func (*ECS) ListAttributesWithContext added in v1.8.0 

func (c *ECS) ListAttributesWithContext(ctx aws.Context, input *ListAttributesInput, opts ...request.Option) (*ListAttributesOutput, error)

ListAttributesWithContext is the same as ListAttributes with the addition of the ability to pass a context and additional request options.

See ListAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) ListClusters 

func (c *ECS) ListClusters(input *ListClustersInput) (*ListClustersOutput, error)

ListClusters API operation for Amazon EC2 Container Service.

Returns a list of existing clusters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation ListClusters for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListClusters

Example (Shared00)

To list your available clusters

This example lists all of your available clusters in your default region. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.ListClustersInput{}

	result, err := svc.ListClusters(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) ListClustersPages added in v0.6.2 

func (c *ECS) ListClustersPages(input *ListClustersInput, fn func(*ListClustersOutput, bool) bool) error

ListClustersPages iterates over the pages of a ListClusters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListClusters method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListClusters operation.
pageNum := 0
err := client.ListClustersPages(params,
    func(page *ListClustersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ECS) ListClustersPagesWithContext added in v1.8.0 

func (c *ECS) ListClustersPagesWithContext(ctx aws.Context, input *ListClustersInput, fn func(*ListClustersOutput, bool) bool, opts ...request.Option) error

ListClustersPagesWithContext same as ListClustersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) ListClustersRequest 

func (c *ECS) ListClustersRequest(input *ListClustersInput) (req *request.Request, output *ListClustersOutput)

ListClustersRequest generates a "aws/request.Request" representing the client's request for the ListClusters operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListClusters for more information on using the ListClusters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListClustersRequest method.
req, resp := client.ListClustersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListClusters

func (*ECS) ListClustersWithContext added in v1.8.0 

func (c *ECS) ListClustersWithContext(ctx aws.Context, input *ListClustersInput, opts ...request.Option) (*ListClustersOutput, error)

ListClustersWithContext is the same as ListClusters with the addition of the ability to pass a context and additional request options.

See ListClusters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) ListContainerInstances 

func (c *ECS) ListContainerInstances(input *ListContainerInstancesInput) (*ListContainerInstancesOutput, error)

ListContainerInstances API operation for Amazon EC2 Container Service.

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 (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the Amazon Elastic Container Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation ListContainerInstances for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListContainerInstances

Example (Shared00)

To list your available container instances in a cluster

This example lists all of your available container instances in the specified cluster in your default region. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.ListContainerInstancesInput{
		Cluster: aws.String("default"),
	}

	result, err := svc.ListContainerInstances(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) ListContainerInstancesPages added in v0.6.2 

func (c *ECS) ListContainerInstancesPages(input *ListContainerInstancesInput, fn func(*ListContainerInstancesOutput, bool) bool) error

ListContainerInstancesPages iterates over the pages of a ListContainerInstances operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListContainerInstances method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListContainerInstances operation.
pageNum := 0
err := client.ListContainerInstancesPages(params,
    func(page *ListContainerInstancesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ECS) ListContainerInstancesPagesWithContext added in v1.8.0 

func (c *ECS) ListContainerInstancesPagesWithContext(ctx aws.Context, input *ListContainerInstancesInput, fn func(*ListContainerInstancesOutput, bool) bool, opts ...request.Option) error

ListContainerInstancesPagesWithContext same as ListContainerInstancesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) ListContainerInstancesRequest 

func (c *ECS) ListContainerInstancesRequest(input *ListContainerInstancesInput) (req *request.Request, output *ListContainerInstancesOutput)

ListContainerInstancesRequest generates a "aws/request.Request" representing the client's request for the ListContainerInstances operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListContainerInstances for more information on using the ListContainerInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListContainerInstancesRequest method.
req, resp := client.ListContainerInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListContainerInstances

func (*ECS) ListContainerInstancesWithContext added in v1.8.0 

func (c *ECS) ListContainerInstancesWithContext(ctx aws.Context, input *ListContainerInstancesInput, opts ...request.Option) (*ListContainerInstancesOutput, error)

ListContainerInstancesWithContext is the same as ListContainerInstances with the addition of the ability to pass a context and additional request options.

See ListContainerInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) ListServices 

func (c *ECS) ListServices(input *ListServicesInput) (*ListServicesOutput, error)

ListServices API operation for Amazon EC2 Container Service.

Lists the services that are running in a specified cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation ListServices for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListServices

Example (Shared00)

To list the services in a cluster

This example lists the services running in the default cluster for an account. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.ListServicesInput{}

	result, err := svc.ListServices(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) ListServicesPages added in v0.6.2 

func (c *ECS) ListServicesPages(input *ListServicesInput, fn func(*ListServicesOutput, bool) bool) error

ListServicesPages iterates over the pages of a ListServices operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListServices method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListServices operation.
pageNum := 0
err := client.ListServicesPages(params,
    func(page *ListServicesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ECS) ListServicesPagesWithContext added in v1.8.0 

func (c *ECS) ListServicesPagesWithContext(ctx aws.Context, input *ListServicesInput, fn func(*ListServicesOutput, bool) bool, opts ...request.Option) error

ListServicesPagesWithContext same as ListServicesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) ListServicesRequest 

func (c *ECS) ListServicesRequest(input *ListServicesInput) (req *request.Request, output *ListServicesOutput)

ListServicesRequest generates a "aws/request.Request" representing the client's request for the ListServices operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListServices for more information on using the ListServices API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListServicesRequest method.
req, resp := client.ListServicesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListServices

func (*ECS) ListServicesWithContext added in v1.8.0 

func (c *ECS) ListServicesWithContext(ctx aws.Context, input *ListServicesInput, opts ...request.Option) (*ListServicesOutput, error)

ListServicesWithContext is the same as ListServices with the addition of the ability to pass a context and additional request options.

See ListServices for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) ListTaskDefinitionFamilies 

func (c *ECS) ListTaskDefinitionFamilies(input *ListTaskDefinitionFamiliesInput) (*ListTaskDefinitionFamiliesOutput, error)

ListTaskDefinitionFamilies API operation for Amazon EC2 Container Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation ListTaskDefinitionFamilies for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTaskDefinitionFamilies

Example (Shared00)

To list your registered task definition families

This example lists all of your registered task definition families. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.ListTaskDefinitionFamiliesInput{}

	result, err := svc.ListTaskDefinitionFamilies(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:
Example (Shared01)

To filter your registered task definition families

This example lists the task definition revisions that start with "hpcc". 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.ListTaskDefinitionFamiliesInput{
		FamilyPrefix: aws.String("hpcc"),
	}

	result, err := svc.ListTaskDefinitionFamilies(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) ListTaskDefinitionFamiliesPages added in v0.6.2 

func (c *ECS) ListTaskDefinitionFamiliesPages(input *ListTaskDefinitionFamiliesInput, fn func(*ListTaskDefinitionFamiliesOutput, bool) bool) error

ListTaskDefinitionFamiliesPages iterates over the pages of a ListTaskDefinitionFamilies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTaskDefinitionFamilies method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTaskDefinitionFamilies operation.
pageNum := 0
err := client.ListTaskDefinitionFamiliesPages(params,
    func(page *ListTaskDefinitionFamiliesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ECS) ListTaskDefinitionFamiliesPagesWithContext added in v1.8.0 

func (c *ECS) ListTaskDefinitionFamiliesPagesWithContext(ctx aws.Context, input *ListTaskDefinitionFamiliesInput, fn func(*ListTaskDefinitionFamiliesOutput, bool) bool, opts ...request.Option) error

ListTaskDefinitionFamiliesPagesWithContext same as ListTaskDefinitionFamiliesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) ListTaskDefinitionFamiliesRequest 

func (c *ECS) ListTaskDefinitionFamiliesRequest(input *ListTaskDefinitionFamiliesInput) (req *request.Request, output *ListTaskDefinitionFamiliesOutput)

ListTaskDefinitionFamiliesRequest generates a "aws/request.Request" representing the client's request for the ListTaskDefinitionFamilies operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTaskDefinitionFamilies for more information on using the ListTaskDefinitionFamilies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTaskDefinitionFamiliesRequest method.
req, resp := client.ListTaskDefinitionFamiliesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTaskDefinitionFamilies

func (*ECS) ListTaskDefinitionFamiliesWithContext added in v1.8.0 

func (c *ECS) ListTaskDefinitionFamiliesWithContext(ctx aws.Context, input *ListTaskDefinitionFamiliesInput, opts ...request.Option) (*ListTaskDefinitionFamiliesOutput, error)

ListTaskDefinitionFamiliesWithContext is the same as ListTaskDefinitionFamilies with the addition of the ability to pass a context and additional request options.

See ListTaskDefinitionFamilies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) ListTaskDefinitions 

func (c *ECS) ListTaskDefinitions(input *ListTaskDefinitionsInput) (*ListTaskDefinitionsOutput, error)

ListTaskDefinitions API operation for Amazon EC2 Container Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation ListTaskDefinitions for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTaskDefinitions

Example (Shared00)

To list your registered task definitions

This example lists all of your registered task definitions. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.ListTaskDefinitionsInput{}

	result, err := svc.ListTaskDefinitions(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:
Example (Shared01)

To list the registered task definitions in a family

This example lists the task definition revisions of a specified family. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.ListTaskDefinitionsInput{
		FamilyPrefix: aws.String("wordpress"),
	}

	result, err := svc.ListTaskDefinitions(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) ListTaskDefinitionsPages added in v0.6.2 

func (c *ECS) ListTaskDefinitionsPages(input *ListTaskDefinitionsInput, fn func(*ListTaskDefinitionsOutput, bool) bool) error

ListTaskDefinitionsPages iterates over the pages of a ListTaskDefinitions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTaskDefinitions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTaskDefinitions operation.
pageNum := 0
err := client.ListTaskDefinitionsPages(params,
    func(page *ListTaskDefinitionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ECS) ListTaskDefinitionsPagesWithContext added in v1.8.0 

func (c *ECS) ListTaskDefinitionsPagesWithContext(ctx aws.Context, input *ListTaskDefinitionsInput, fn func(*ListTaskDefinitionsOutput, bool) bool, opts ...request.Option) error

ListTaskDefinitionsPagesWithContext same as ListTaskDefinitionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) ListTaskDefinitionsRequest 

func (c *ECS) ListTaskDefinitionsRequest(input *ListTaskDefinitionsInput) (req *request.Request, output *ListTaskDefinitionsOutput)

ListTaskDefinitionsRequest generates a "aws/request.Request" representing the client's request for the ListTaskDefinitions operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTaskDefinitions for more information on using the ListTaskDefinitions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTaskDefinitionsRequest method.
req, resp := client.ListTaskDefinitionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTaskDefinitions

func (*ECS) ListTaskDefinitionsWithContext added in v1.8.0 

func (c *ECS) ListTaskDefinitionsWithContext(ctx aws.Context, input *ListTaskDefinitionsInput, opts ...request.Option) (*ListTaskDefinitionsOutput, error)

ListTaskDefinitionsWithContext is the same as ListTaskDefinitions with the addition of the ability to pass a context and additional request options.

See ListTaskDefinitions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) ListTasks 

func (c *ECS) ListTasks(input *ListTasksInput) (*ListTasksOutput, error)

ListTasks API operation for Amazon EC2 Container Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation ListTasks for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

  • ErrCodeServiceNotFoundException "ServiceNotFoundException" The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and region-specific.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTasks

Example (Shared00)

To list the tasks in a cluster

This example lists all of the tasks in a cluster. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.ListTasksInput{
		Cluster: aws.String("default"),
	}

	result, err := svc.ListTasks(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			case ecs.ErrCodeServiceNotFoundException:
				fmt.Println(ecs.ErrCodeServiceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:
Example (Shared01)

To list the tasks on a particular container instance

This example lists the tasks of a specified container instance. Specifying a “containerInstance“ value limits the results to tasks that belong to that container instance. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.ListTasksInput{
		Cluster:           aws.String("default"),
		ContainerInstance: aws.String("f6bbb147-5370-4ace-8c73-c7181ded911f"),
	}

	result, err := svc.ListTasks(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			case ecs.ErrCodeServiceNotFoundException:
				fmt.Println(ecs.ErrCodeServiceNotFoundException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) ListTasksPages added in v0.6.2 

func (c *ECS) ListTasksPages(input *ListTasksInput, fn func(*ListTasksOutput, bool) bool) error

ListTasksPages iterates over the pages of a ListTasks operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTasks method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTasks operation.
pageNum := 0
err := client.ListTasksPages(params,
    func(page *ListTasksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ECS) ListTasksPagesWithContext added in v1.8.0 

func (c *ECS) ListTasksPagesWithContext(ctx aws.Context, input *ListTasksInput, fn func(*ListTasksOutput, bool) bool, opts ...request.Option) error

ListTasksPagesWithContext same as ListTasksPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) ListTasksRequest 

func (c *ECS) ListTasksRequest(input *ListTasksInput) (req *request.Request, output *ListTasksOutput)

ListTasksRequest generates a "aws/request.Request" representing the client's request for the ListTasks operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTasks for more information on using the ListTasks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTasksRequest method.
req, resp := client.ListTasksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTasks

func (*ECS) ListTasksWithContext added in v1.8.0 

func (c *ECS) ListTasksWithContext(ctx aws.Context, input *ListTasksInput, opts ...request.Option) (*ListTasksOutput, error)

ListTasksWithContext is the same as ListTasks with the addition of the ability to pass a context and additional request options.

See ListTasks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) PutAttributes added in v1.6.9 

func (c *ECS) PutAttributes(input *PutAttributesInput) (*PutAttributesOutput, error)

PutAttributes API operation for Amazon EC2 Container Service.

Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes) in the Amazon Elastic Container Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation PutAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

  • ErrCodeTargetNotFoundException "TargetNotFoundException" The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and region-specific.

  • ErrCodeAttributeLimitExceededException "AttributeLimitExceededException" You can apply up to 10 custom attributes per resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutAttributes

func (*ECS) PutAttributesRequest added in v1.6.9 

func (c *ECS) PutAttributesRequest(input *PutAttributesInput) (req *request.Request, output *PutAttributesOutput)

PutAttributesRequest generates a "aws/request.Request" representing the client's request for the PutAttributes operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutAttributes for more information on using the PutAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutAttributesRequest method.
req, resp := client.PutAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutAttributes

func (*ECS) PutAttributesWithContext added in v1.8.0 

func (c *ECS) PutAttributesWithContext(ctx aws.Context, input *PutAttributesInput, opts ...request.Option) (*PutAttributesOutput, error)

PutAttributesWithContext is the same as PutAttributes with the addition of the ability to pass a context and additional request options.

See PutAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) RegisterContainerInstance 

func (c *ECS) RegisterContainerInstance(input *RegisterContainerInstanceInput) (*RegisterContainerInstanceOutput, error)

RegisterContainerInstance API operation for Amazon EC2 Container Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation RegisterContainerInstance for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterContainerInstance

func (*ECS) RegisterContainerInstanceRequest 

func (c *ECS) RegisterContainerInstanceRequest(input *RegisterContainerInstanceInput) (req *request.Request, output *RegisterContainerInstanceOutput)

RegisterContainerInstanceRequest generates a "aws/request.Request" representing the client's request for the RegisterContainerInstance operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterContainerInstance for more information on using the RegisterContainerInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RegisterContainerInstanceRequest method.
req, resp := client.RegisterContainerInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterContainerInstance

func (*ECS) RegisterContainerInstanceWithContext added in v1.8.0 

func (c *ECS) RegisterContainerInstanceWithContext(ctx aws.Context, input *RegisterContainerInstanceInput, opts ...request.Option) (*RegisterContainerInstanceOutput, error)

RegisterContainerInstanceWithContext is the same as RegisterContainerInstance with the addition of the ability to pass a context and additional request options.

See RegisterContainerInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) RegisterTaskDefinition 

func (c *ECS) RegisterTaskDefinition(input *RegisterTaskDefinitionInput) (*RegisterTaskDefinitionOutput, error)

RegisterTaskDefinition API operation for Amazon EC2 Container Service.

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 (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the Amazon Elastic 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 (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) 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 (https://docs.docker.com/engine/reference/run/#/network-settings) in the Docker run reference. If you specify the awsvpc network mode, the task is allocated an Elastic Network Interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the Amazon Elastic Container Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation RegisterTaskDefinition for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterTaskDefinition

Example (Shared00)

To register a task definition

This example registers a task definition to the specified family. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.RegisterTaskDefinitionInput{
		ContainerDefinitions: []*ecs.ContainerDefinition{
			{
				Command: []*string{
					aws.String("sleep"),
					aws.String("360"),
				},
				Cpu:       aws.Int64(10),
				Essential: aws.Bool(true),
				Image:     aws.String("busybox"),
				Memory:    aws.Int64(10),
				Name:      aws.String("sleep"),
			},
		},
		Family:      aws.String("sleep360"),
		TaskRoleArn: aws.String(""),
	}

	result, err := svc.RegisterTaskDefinition(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) RegisterTaskDefinitionRequest 

func (c *ECS) RegisterTaskDefinitionRequest(input *RegisterTaskDefinitionInput) (req *request.Request, output *RegisterTaskDefinitionOutput)

RegisterTaskDefinitionRequest generates a "aws/request.Request" representing the client's request for the RegisterTaskDefinition operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterTaskDefinition for more information on using the RegisterTaskDefinition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RegisterTaskDefinitionRequest method.
req, resp := client.RegisterTaskDefinitionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterTaskDefinition

func (*ECS) RegisterTaskDefinitionWithContext added in v1.8.0 

func (c *ECS) RegisterTaskDefinitionWithContext(ctx aws.Context, input *RegisterTaskDefinitionInput, opts ...request.Option) (*RegisterTaskDefinitionOutput, error)

RegisterTaskDefinitionWithContext is the same as RegisterTaskDefinition with the addition of the ability to pass a context and additional request options.

See RegisterTaskDefinition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) RunTask 

func (c *ECS) RunTask(input *RunTaskInput) (*RunTaskOutput, error)

RunTask API operation for Amazon EC2 Container Service.

Starts a new task using the specified task definition.

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html) 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.

The Amazon ECS API follows an eventual consistency model, due to 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. You should 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation RunTask for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

  • ErrCodeUnsupportedFeatureException "UnsupportedFeatureException" The specified task is not supported in this region.

  • ErrCodePlatformUnknownException "PlatformUnknownException" The specified platform version does not exist.

  • ErrCodePlatformTaskDefinitionIncompatibilityException "PlatformTaskDefinitionIncompatibilityException" The specified platform version does not satisfy the task definition’s required capabilities.

  • ErrCodeAccessDeniedException "AccessDeniedException" You do not have authorization to perform the requested action.

  • ErrCodeBlockedException "BlockedException" Your AWS account has been blocked. Contact AWS Support (http://aws.amazon.com/contact-us/) for more information.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RunTask

Example (Shared00)

To run a task on your default cluster

This example runs the specified task definition on your default cluster. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.RunTaskInput{
		Cluster:        aws.String("default"),
		TaskDefinition: aws.String("sleep360:1"),
	}

	result, err := svc.RunTask(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			case ecs.ErrCodeUnsupportedFeatureException:
				fmt.Println(ecs.ErrCodeUnsupportedFeatureException, aerr.Error())
			case ecs.ErrCodePlatformUnknownException:
				fmt.Println(ecs.ErrCodePlatformUnknownException, aerr.Error())
			case ecs.ErrCodePlatformTaskDefinitionIncompatibilityException:
				fmt.Println(ecs.ErrCodePlatformTaskDefinitionIncompatibilityException, aerr.Error())
			case ecs.ErrCodeAccessDeniedException:
				fmt.Println(ecs.ErrCodeAccessDeniedException, aerr.Error())
			case ecs.ErrCodeBlockedException:
				fmt.Println(ecs.ErrCodeBlockedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) RunTaskRequest 

func (c *ECS) RunTaskRequest(input *RunTaskInput) (req *request.Request, output *RunTaskOutput)

RunTaskRequest generates a "aws/request.Request" representing the client's request for the RunTask operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RunTask for more information on using the RunTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RunTaskRequest method.
req, resp := client.RunTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RunTask

func (*ECS) RunTaskWithContext added in v1.8.0 

func (c *ECS) RunTaskWithContext(ctx aws.Context, input *RunTaskInput, opts ...request.Option) (*RunTaskOutput, error)

RunTaskWithContext is the same as RunTask with the addition of the ability to pass a context and additional request options.

See RunTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) StartTask 

func (c *ECS) StartTask(input *StartTaskInput) (*StartTaskOutput, error)

StartTask API operation for Amazon EC2 Container Service.

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

Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html) in the Amazon Elastic Container Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation StartTask for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StartTask

func (*ECS) StartTaskRequest 

func (c *ECS) StartTaskRequest(input *StartTaskInput) (req *request.Request, output *StartTaskOutput)

StartTaskRequest generates a "aws/request.Request" representing the client's request for the StartTask operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartTask for more information on using the StartTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartTaskRequest method.
req, resp := client.StartTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StartTask

func (*ECS) StartTaskWithContext added in v1.8.0 

func (c *ECS) StartTaskWithContext(ctx aws.Context, input *StartTaskInput, opts ...request.Option) (*StartTaskOutput, error)

StartTaskWithContext is the same as StartTask with the addition of the ability to pass a context and additional request options.

See StartTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) StopTask 

func (c *ECS) StopTask(input *StopTaskInput) (*StopTaskOutput, error)

StopTask API operation for Amazon EC2 Container Service.

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

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 (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the Amazon Elastic Container Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation StopTask for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StopTask

func (*ECS) StopTaskRequest 

func (c *ECS) StopTaskRequest(input *StopTaskInput) (req *request.Request, output *StopTaskOutput)

StopTaskRequest generates a "aws/request.Request" representing the client's request for the StopTask operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopTask for more information on using the StopTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopTaskRequest method.
req, resp := client.StopTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StopTask

func (*ECS) StopTaskWithContext added in v1.8.0 

func (c *ECS) StopTaskWithContext(ctx aws.Context, input *StopTaskInput, opts ...request.Option) (*StopTaskOutput, error)

StopTaskWithContext is the same as StopTask with the addition of the ability to pass a context and additional request options.

See StopTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) SubmitContainerStateChange 

func (c *ECS) SubmitContainerStateChange(input *SubmitContainerStateChangeInput) (*SubmitContainerStateChangeOutput, error)

SubmitContainerStateChange API operation for Amazon EC2 Container Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation SubmitContainerStateChange for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeAccessDeniedException "AccessDeniedException" You do not have authorization to perform the requested action.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitContainerStateChange

func (*ECS) SubmitContainerStateChangeRequest 

func (c *ECS) SubmitContainerStateChangeRequest(input *SubmitContainerStateChangeInput) (req *request.Request, output *SubmitContainerStateChangeOutput)

SubmitContainerStateChangeRequest generates a "aws/request.Request" representing the client's request for the SubmitContainerStateChange operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SubmitContainerStateChange for more information on using the SubmitContainerStateChange API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SubmitContainerStateChangeRequest method.
req, resp := client.SubmitContainerStateChangeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitContainerStateChange

func (*ECS) SubmitContainerStateChangeWithContext added in v1.8.0 

func (c *ECS) SubmitContainerStateChangeWithContext(ctx aws.Context, input *SubmitContainerStateChangeInput, opts ...request.Option) (*SubmitContainerStateChangeOutput, error)

SubmitContainerStateChangeWithContext is the same as SubmitContainerStateChange with the addition of the ability to pass a context and additional request options.

See SubmitContainerStateChange for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) SubmitTaskStateChange 

func (c *ECS) SubmitTaskStateChange(input *SubmitTaskStateChangeInput) (*SubmitTaskStateChangeOutput, error)

SubmitTaskStateChange API operation for Amazon EC2 Container Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation SubmitTaskStateChange for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeAccessDeniedException "AccessDeniedException" You do not have authorization to perform the requested action.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitTaskStateChange

func (*ECS) SubmitTaskStateChangeRequest 

func (c *ECS) SubmitTaskStateChangeRequest(input *SubmitTaskStateChangeInput) (req *request.Request, output *SubmitTaskStateChangeOutput)

SubmitTaskStateChangeRequest generates a "aws/request.Request" representing the client's request for the SubmitTaskStateChange operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SubmitTaskStateChange for more information on using the SubmitTaskStateChange API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SubmitTaskStateChangeRequest method.
req, resp := client.SubmitTaskStateChangeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitTaskStateChange

func (*ECS) SubmitTaskStateChangeWithContext added in v1.8.0 

func (c *ECS) SubmitTaskStateChangeWithContext(ctx aws.Context, input *SubmitTaskStateChangeInput, opts ...request.Option) (*SubmitTaskStateChangeOutput, error)

SubmitTaskStateChangeWithContext is the same as SubmitTaskStateChange with the addition of the ability to pass a context and additional request options.

See SubmitTaskStateChange for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) UpdateContainerAgent added in v0.6.2 

func (c *ECS) UpdateContainerAgent(input *UpdateContainerAgentInput) (*UpdateContainerAgentOutput, error)

UpdateContainerAgent API operation for Amazon EC2 Container Service.

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 (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent) in the Amazon Elastic Container Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation UpdateContainerAgent for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

  • ErrCodeUpdateInProgressException "UpdateInProgressException" There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.

  • ErrCodeNoUpdateAvailableException "NoUpdateAvailableException" There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version.

  • ErrCodeMissingVersionException "MissingVersionException" Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerAgent

func (*ECS) UpdateContainerAgentRequest added in v0.6.2 

func (c *ECS) UpdateContainerAgentRequest(input *UpdateContainerAgentInput) (req *request.Request, output *UpdateContainerAgentOutput)

UpdateContainerAgentRequest generates a "aws/request.Request" representing the client's request for the UpdateContainerAgent operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateContainerAgent for more information on using the UpdateContainerAgent API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateContainerAgentRequest method.
req, resp := client.UpdateContainerAgentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerAgent

func (*ECS) UpdateContainerAgentWithContext added in v1.8.0 

func (c *ECS) UpdateContainerAgentWithContext(ctx aws.Context, input *UpdateContainerAgentInput, opts ...request.Option) (*UpdateContainerAgentOutput, error)

UpdateContainerAgentWithContext is the same as UpdateContainerAgent with the addition of the ability to pass a context and additional request options.

See UpdateContainerAgent for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) UpdateContainerInstancesState added in v1.6.16 

func (c *ECS) UpdateContainerInstancesState(input *UpdateContainerInstancesStateInput) (*UpdateContainerInstancesStateOutput, error)

UpdateContainerInstancesState API operation for Amazon EC2 Container Service.

Modifies the status of an Amazon ECS container instance.

You can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.

When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately.

Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service's deployment configuration parameters, minimumHealthyPercent and maximumPercent. You can change the deployment configuration of your service using UpdateService.

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

  • The maximumPercent parameter represents an upper limit on the number of running tasks during task replacement, which enables you to define the replacement batch size. For example, if desiredCount of four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained (provided that the cluster resources required to do this are available). If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.

Any PENDING or RUNNING tasks that do not belong to a service are not 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 you set a container instance to ACTIVE, the Amazon ECS scheduler can begin scheduling tasks on the instance again.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation UpdateContainerInstancesState for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerInstancesState

func (*ECS) UpdateContainerInstancesStateRequest added in v1.6.16 

func (c *ECS) UpdateContainerInstancesStateRequest(input *UpdateContainerInstancesStateInput) (req *request.Request, output *UpdateContainerInstancesStateOutput)

UpdateContainerInstancesStateRequest generates a "aws/request.Request" representing the client's request for the UpdateContainerInstancesState operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateContainerInstancesState for more information on using the UpdateContainerInstancesState API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateContainerInstancesStateRequest method.
req, resp := client.UpdateContainerInstancesStateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerInstancesState

func (*ECS) UpdateContainerInstancesStateWithContext added in v1.8.0 

func (c *ECS) UpdateContainerInstancesStateWithContext(ctx aws.Context, input *UpdateContainerInstancesStateInput, opts ...request.Option) (*UpdateContainerInstancesStateOutput, error)

UpdateContainerInstancesStateWithContext is the same as UpdateContainerInstancesState with the addition of the ability to pass a context and additional request options.

See UpdateContainerInstancesState for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) UpdateService 

func (c *ECS) UpdateService(input *UpdateServiceInput) (*UpdateServiceOutput, error)

UpdateService API operation for Amazon EC2 Container Service.

Modifies the desired count, deployment configuration, network 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.

If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.

If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you do not need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.

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

  • If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are 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 desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).

When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after 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 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 (although 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon EC2 Container Service's API operation UpdateService for usage and error information.

Returned Error Codes:

  • ErrCodeServerException "ServerException" These errors are usually caused by a server issue.

  • ErrCodeClientException "ClientException" These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" The specified parameter is invalid. Review the available parameters for the API request.

  • ErrCodeClusterNotFoundException "ClusterNotFoundException" The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

  • ErrCodeServiceNotFoundException "ServiceNotFoundException" The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and region-specific.

  • ErrCodeServiceNotActiveException "ServiceNotActiveException" The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.

  • ErrCodePlatformUnknownException "PlatformUnknownException" The specified platform version does not exist.

  • ErrCodePlatformTaskDefinitionIncompatibilityException "PlatformTaskDefinitionIncompatibilityException" The specified platform version does not satisfy the task definition’s required capabilities.

  • ErrCodeAccessDeniedException "AccessDeniedException" You do not have authorization to perform the requested action.

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateService

Example (Shared00)

To change the task definition used in a service

This example updates the my-http-service service to use the amazon-ecs-sample task definition. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.UpdateServiceInput{
		Service:        aws.String("my-http-service"),
		TaskDefinition: aws.String("amazon-ecs-sample"),
	}

	result, err := svc.UpdateService(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			case ecs.ErrCodeServiceNotFoundException:
				fmt.Println(ecs.ErrCodeServiceNotFoundException, aerr.Error())
			case ecs.ErrCodeServiceNotActiveException:
				fmt.Println(ecs.ErrCodeServiceNotActiveException, aerr.Error())
			case ecs.ErrCodePlatformUnknownException:
				fmt.Println(ecs.ErrCodePlatformUnknownException, aerr.Error())
			case ecs.ErrCodePlatformTaskDefinitionIncompatibilityException:
				fmt.Println(ecs.ErrCodePlatformTaskDefinitionIncompatibilityException, aerr.Error())
			case ecs.ErrCodeAccessDeniedException:
				fmt.Println(ecs.ErrCodeAccessDeniedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:
Example (Shared01)

To change the number of tasks in a service

This example updates the desired count of the my-http-service service to 10. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ecs"
)

func main() {
	svc := ecs.New(session.New())
	input := &ecs.UpdateServiceInput{
		DesiredCount: aws.Int64(10),
		Service:      aws.String("my-http-service"),
	}

	result, err := svc.UpdateService(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			case ecs.ErrCodeServiceNotFoundException:
				fmt.Println(ecs.ErrCodeServiceNotFoundException, aerr.Error())
			case ecs.ErrCodeServiceNotActiveException:
				fmt.Println(ecs.ErrCodeServiceNotActiveException, aerr.Error())
			case ecs.ErrCodePlatformUnknownException:
				fmt.Println(ecs.ErrCodePlatformUnknownException, aerr.Error())
			case ecs.ErrCodePlatformTaskDefinitionIncompatibilityException:
				fmt.Println(ecs.ErrCodePlatformTaskDefinitionIncompatibilityException, aerr.Error())
			case ecs.ErrCodeAccessDeniedException:
				fmt.Println(ecs.ErrCodeAccessDeniedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ECS) UpdateServiceRequest 

func (c *ECS) UpdateServiceRequest(input *UpdateServiceInput) (req *request.Request, output *UpdateServiceOutput)

UpdateServiceRequest generates a "aws/request.Request" representing the client's request for the UpdateService operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateService for more information on using the UpdateService API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateServiceRequest method.
req, resp := client.UpdateServiceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateService

func (*ECS) UpdateServiceWithContext added in v1.8.0 

func (c *ECS) UpdateServiceWithContext(ctx aws.Context, input *UpdateServiceInput, opts ...request.Option) (*UpdateServiceOutput, error)

UpdateServiceWithContext is the same as UpdateService with the addition of the ability to pass a context and additional request options.

See UpdateService for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) WaitUntilServicesInactive added in v0.10.3 

func (c *ECS) WaitUntilServicesInactive(input *DescribeServicesInput) error

WaitUntilServicesInactive uses the Amazon ECS API operation DescribeServices to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*ECS) WaitUntilServicesInactiveWithContext added in v1.8.0 

func (c *ECS) WaitUntilServicesInactiveWithContext(ctx aws.Context, input *DescribeServicesInput, opts ...request.WaiterOption) error

WaitUntilServicesInactiveWithContext is an extended version of WaitUntilServicesInactive. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) WaitUntilServicesStable added in v0.10.3 

func (c *ECS) WaitUntilServicesStable(input *DescribeServicesInput) error

WaitUntilServicesStable uses the Amazon ECS API operation DescribeServices to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*ECS) WaitUntilServicesStableWithContext added in v1.8.0 

func (c *ECS) WaitUntilServicesStableWithContext(ctx aws.Context, input *DescribeServicesInput, opts ...request.WaiterOption) error

WaitUntilServicesStableWithContext is an extended version of WaitUntilServicesStable. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) WaitUntilTasksRunning added in v0.10.3 

func (c *ECS) WaitUntilTasksRunning(input *DescribeTasksInput) error

WaitUntilTasksRunning uses the Amazon ECS API operation DescribeTasks to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*ECS) WaitUntilTasksRunningWithContext added in v1.8.0 

func (c *ECS) WaitUntilTasksRunningWithContext(ctx aws.Context, input *DescribeTasksInput, opts ...request.WaiterOption) error

WaitUntilTasksRunningWithContext is an extended version of WaitUntilTasksRunning. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ECS) WaitUntilTasksStopped added in v0.10.3 

func (c *ECS) WaitUntilTasksStopped(input *DescribeTasksInput) error

WaitUntilTasksStopped uses the Amazon ECS API operation DescribeTasks to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*ECS) WaitUntilTasksStoppedWithContext added in v1.8.0 

func (c *ECS) WaitUntilTasksStoppedWithContext(ctx aws.Context, input *DescribeTasksInput, opts ...request.WaiterOption) error

WaitUntilTasksStoppedWithContext is an extended version of WaitUntilTasksStopped. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type Failure 

type Failure struct {

	// The Amazon Resource Name (ARN) of the failed resource.
	Arn *string `locationName:"arn" type:"string"`

	// The reason for the failure.
	Reason *string `locationName:"reason" type:"string"`
	// contains filtered or unexported fields
}

A failed resource.

func (Failure) GoString added in v0.6.5 

func (s Failure) GoString() string

GoString returns the string representation

func (*Failure) SetArn added in v1.5.0 

func (s *Failure) SetArn(v string) *Failure

SetArn sets the Arn field's value.

func (*Failure) SetReason added in v1.5.0 

func (s *Failure) SetReason(v string) *Failure

SetReason sets the Reason field's value.

func (Failure) String added in v0.6.5 

func (s Failure) String() string

String returns the string representation

type HealthCheck added in v1.13.11 

type HealthCheck struct {

	// A string array representing the command that the container runs to determine
	// if it is healthy. The string array must start with CMD to execute the command
	// arguments directly, or CMD-SHELL to run the command with the container's
	// default shell. For example:
	//
	// [ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
	//
	// An exit code of 0 indicates success, and non-zero exit code indicates failure.
	// For more information, see HealthCheck in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/).
	//
	// Command is a required field
	Command []*string `locationName:"command" type:"list" required:"true"`

	// The time period in seconds between each health check execution. You may specify
	// between 5 and 300 seconds. The default value is 30 seconds.
	Interval *int64 `locationName:"interval" type:"integer"`

	// The number of times to retry a failed health check before the container is
	// considered unhealthy. You may specify between 1 and 10 retries. The default
	// value is 3 retries.
	Retries *int64 `locationName:"retries" type:"integer"`

	// The optional grace period within which to provide containers time to bootstrap
	// before failed health checks count towards the maximum number of retries.
	// You may specify between 0 and 300 seconds. The startPeriod is disabled by
	// default.
	//
	// If a health check succeeds within the startPeriod, then the container is
	// considered healthy and any subsequent failures count toward the maximum number
	// of retries.
	StartPeriod *int64 `locationName:"startPeriod" type:"integer"`

	// The time period in seconds to wait for a health check to succeed before it
	// is considered a failure. You may specify between 2 and 60 seconds. The default
	// value is 5 seconds.
	Timeout *int64 `locationName:"timeout" type:"integer"`
	// contains filtered or unexported fields
}

An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).

func (HealthCheck) GoString added in v1.13.11 

func (s HealthCheck) GoString() string

GoString returns the string representation

func (*HealthCheck) SetCommand added in v1.13.11 

func (s *HealthCheck) SetCommand(v []*string) *HealthCheck

SetCommand sets the Command field's value.

func (*HealthCheck) SetInterval added in v1.13.11 

func (s *HealthCheck) SetInterval(v int64) *HealthCheck

SetInterval sets the Interval field's value.

func (*HealthCheck) SetRetries added in v1.13.11 

func (s *HealthCheck) SetRetries(v int64) *HealthCheck

SetRetries sets the Retries field's value.

func (*HealthCheck) SetStartPeriod added in v1.13.11 

func (s *HealthCheck) SetStartPeriod(v int64) *HealthCheck

SetStartPeriod sets the StartPeriod field's value.

func (*HealthCheck) SetTimeout added in v1.13.11 

func (s *HealthCheck) SetTimeout(v int64) *HealthCheck

SetTimeout sets the Timeout field's value.

func (HealthCheck) String added in v1.13.11 

func (s HealthCheck) String() string

String returns the string representation

func (*HealthCheck) Validate added in v1.13.11 

func (s *HealthCheck) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type HostEntry added in v0.9.14 

type HostEntry struct {

	// The hostname to use in the /etc/hosts entry.
	//
	// Hostname is a required field
	Hostname *string `locationName:"hostname" type:"string" required:"true"`

	// The IP address to use in the /etc/hosts entry.
	//
	// IpAddress is a required field
	IpAddress *string `locationName:"ipAddress" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.

func (HostEntry) GoString added in v0.9.14 

func (s HostEntry) GoString() string

GoString returns the string representation

func (*HostEntry) SetHostname added in v1.5.0 

func (s *HostEntry) SetHostname(v string) *HostEntry

SetHostname sets the Hostname field's value.

func (*HostEntry) SetIpAddress added in v1.5.0 

func (s *HostEntry) SetIpAddress(v string) *HostEntry

SetIpAddress sets the IpAddress field's value.

func (HostEntry) String added in v0.9.14 

func (s HostEntry) String() string

String returns the string representation

func (*HostEntry) Validate added in v1.1.21 

func (s *HostEntry) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type HostVolumeProperties 

type HostVolumeProperties struct {

	// The path on the host container instance that is presented to the container.
	// If this parameter is empty, then the Docker daemon has assigned a host path
	// for you. If the host parameter contains a sourcePath file location, then
	// the data volume persists at the specified location on the host container
	// instance until you delete it manually. If the sourcePath value does not exist
	// on the host container instance, the Docker daemon creates it. If the location
	// does exist, the contents of the source path folder are exported.
	//
	// If you are using the Fargate launch type, the sourcePath parameter is not
	// supported.
	SourcePath *string `locationName:"sourcePath" type:"string"`
	// contains filtered or unexported fields
}

Details on a container instance host volume.

func (HostVolumeProperties) GoString added in v0.6.5 

func (s HostVolumeProperties) GoString() string

GoString returns the string representation

func (*HostVolumeProperties) SetSourcePath added in v1.5.0 

func (s *HostVolumeProperties) SetSourcePath(v string) *HostVolumeProperties

SetSourcePath sets the SourcePath field's value.

func (HostVolumeProperties) String added in v0.6.5 

func (s HostVolumeProperties) String() string

String returns the string representation

type KernelCapabilities added in v1.10.51 

type KernelCapabilities struct {

	// The Linux capabilities for the container that have been added to the default
	// configuration provided by Docker. This parameter maps to CapAdd in the Create
	// a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --cap-add option to docker run (https://docs.docker.com/engine/reference/run/).
	//
	// If you are using tasks that use the Fargate launch type, the add parameter
	// is not supported.
	//
	// Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" |
	// "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK"
	// | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE"
	// | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW"
	// | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT"
	// | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" |
	// "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" |
	// "WAKE_ALARM"
	Add []*string `locationName:"add" type:"list"`

	// The Linux capabilities for the container that have been removed from the
	// default configuration provided by Docker. This parameter maps to CapDrop
	// in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --cap-drop option to docker run (https://docs.docker.com/engine/reference/run/).
	//
	// Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" |
	// "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK"
	// | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE"
	// | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW"
	// | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT"
	// | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" |
	// "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" |
	// "WAKE_ALARM"
	Drop []*string `locationName:"drop" type:"list"`
	// contains filtered or unexported fields
}

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities (https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) in the Docker run reference. For more detailed information on these Linux capabilities, see the capabilities(7) (http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page.

func (KernelCapabilities) GoString added in v1.10.51 

func (s KernelCapabilities) GoString() string

GoString returns the string representation

func (*KernelCapabilities) SetAdd added in v1.10.51 

func (s *KernelCapabilities) SetAdd(v []*string) *KernelCapabilities

SetAdd sets the Add field's value.

func (*KernelCapabilities) SetDrop added in v1.10.51 

func (s *KernelCapabilities) SetDrop(v []*string) *KernelCapabilities

SetDrop sets the Drop field's value.

func (KernelCapabilities) String added in v1.10.51 

func (s KernelCapabilities) String() string

String returns the string representation

type KeyValuePair 

type KeyValuePair struct {

	// The name of the key value pair. For environment variables, this is the name
	// of the environment variable.
	Name *string `locationName:"name" type:"string"`

	// The value of the key value pair. For environment variables, this is the value
	// of the environment variable.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

A key and value pair object.

func (KeyValuePair) GoString added in v0.6.5 

func (s KeyValuePair) GoString() string

GoString returns the string representation

func (*KeyValuePair) SetName added in v1.5.0 

func (s *KeyValuePair) SetName(v string) *KeyValuePair

SetName sets the Name field's value.

func (*KeyValuePair) SetValue added in v1.5.0 

func (s *KeyValuePair) SetValue(v string) *KeyValuePair

SetValue sets the Value field's value.

func (KeyValuePair) String added in v0.6.5 

func (s KeyValuePair) String() string

String returns the string representation

type LinuxParameters added in v1.10.51 

type LinuxParameters struct {

	// The Linux capabilities for the container that are added to or dropped from
	// the default configuration provided by Docker.
	//
	// If you are using tasks that use the Fargate launch type, capabilities is
	// supported but the add parameter is not supported.
	Capabilities *KernelCapabilities `locationName:"capabilities" type:"structure"`

	// Any host devices to expose to the container. This parameter maps to Devices
	// in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/)
	// and the --device option to docker run (https://docs.docker.com/engine/reference/run/).
	//
	// If you are using tasks that use the Fargate launch type, the devices parameter
	// is not supported.
	Devices []*Device `locationName:"devices" type:"list"`

	// Run an init process inside the container that forwards signals and reaps
	// processes. This parameter maps to the --init option to docker run (https://docs.docker.com/engine/reference/run/).
	// This parameter requires version 1.25 of the Docker Remote API or greater
	// on your container instance. To check the Docker Remote API version on your
	// container instance, log in to your container instance and run the following
	// command: sudo docker version | grep "Server API version"
	InitProcessEnabled *bool `locationName:"initProcessEnabled" type:"boolean"`

	// The value for the size (in MiB) of the /dev/shm volume. This parameter maps
	// to the --shm-size option to docker run (https://docs.docker.com/engine/reference/run/).
	//
	// If you are using tasks that use the Fargate launch type, the sharedMemorySize
	// parameter is not supported.
	SharedMemorySize *int64 `locationName:"sharedMemorySize" type:"integer"`

	// The container path, mount options, and size (in MiB) of the tmpfs mount.
	// This parameter maps to the --tmpfs option to docker run (https://docs.docker.com/engine/reference/run/).
	//
	// If you are using tasks that use the Fargate launch type, the tmpfs parameter
	// is not supported.
	Tmpfs []*Tmpfs `locationName:"tmpfs" type:"list"`
	// contains filtered or unexported fields
}

Linux-specific options that are applied to the container, such as Linux KernelCapabilities.

func (LinuxParameters) GoString added in v1.10.51 

func (s LinuxParameters) GoString() string

GoString returns the string representation

func (*LinuxParameters) SetCapabilities added in v1.10.51 

func (s *LinuxParameters) SetCapabilities(v *KernelCapabilities) *LinuxParameters

SetCapabilities sets the Capabilities field's value.

func (*LinuxParameters) SetDevices added in v1.12.22 

func (s *LinuxParameters) SetDevices(v []*Device) *LinuxParameters

SetDevices sets the Devices field's value.

func (*LinuxParameters) SetInitProcessEnabled added in v1.12.22 

func (s *LinuxParameters) SetInitProcessEnabled(v bool) *LinuxParameters

SetInitProcessEnabled sets the InitProcessEnabled field's value.

func (*LinuxParameters) SetSharedMemorySize added in v1.13.17 

func (s *LinuxParameters) SetSharedMemorySize(v int64) *LinuxParameters

SetSharedMemorySize sets the SharedMemorySize field's value.

func (*LinuxParameters) SetTmpfs added in v1.13.17 

func (s *LinuxParameters) SetTmpfs(v []*Tmpfs) *LinuxParameters

SetTmpfs sets the Tmpfs field's value.

func (LinuxParameters) String added in v1.10.51 

func (s LinuxParameters) String() string

String returns the string representation

func (*LinuxParameters) Validate added in v1.12.22 

func (s *LinuxParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAttributesInput added in v1.6.9 

type ListAttributesInput struct {

	// The name of the attribute with which to filter the results.
	AttributeName *string `locationName:"attributeName" type:"string"`

	// The value of the attribute with which to filter results. You must also specify
	// an attribute name to use this parameter.
	AttributeValue *string `locationName:"attributeValue" type:"string"`

	// The short name or full Amazon Resource Name (ARN) of the cluster to list
	// attributes. If you do not specify a cluster, the default cluster is assumed.
	Cluster *string `locationName:"cluster" type:"string"`

	// The maximum number of cluster results returned by ListAttributes in paginated
	// output. When this parameter is used, ListAttributes only returns maxResults
	// results in a single page along with a nextToken response element. The remaining
	// results of the initial request can be seen by sending another ListAttributes
	// request with the returned nextToken value. This value can be between 1 and
	// 100. If this parameter is not used, then ListAttributes returns up to 100
	// results and a nextToken value if applicable.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The nextToken value returned from a previous paginated ListAttributes request
	// where maxResults was used and the results exceeded the value of that parameter.
	// Pagination continues from the end of the previous results that returned the
	// nextToken value.
	//
	// This token should be treated as an opaque identifier that is only used to
	// retrieve the next items in a list and not for other programmatic purposes.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The type of the target with which to list attributes.
	//
	// TargetType is a required field
	TargetType *string `locationName:"targetType" type:"string" required:"true" enum:"TargetType"`
	// contains filtered or unexported fields
}

func (ListAttributesInput) GoString added in v1.6.9 

func (s ListAttributesInput) GoString() string

GoString returns the string representation

func (*ListAttributesInput) SetAttributeName added in v1.6.9 

func (s *ListAttributesInput) SetAttributeName(v string) *ListAttributesInput

SetAttributeName sets the AttributeName field's value.

func (*ListAttributesInput) SetAttributeValue added in v1.6.9 

func (s *ListAttributesInput) SetAttributeValue(v string) *ListAttributesInput

SetAttributeValue sets the AttributeValue field's value.

func (*ListAttributesInput) SetCluster added in v1.6.9 

func (s *ListAttributesInput) SetCluster(v string) *ListAttributesInput

SetCluster sets the Cluster field's value.

func (*ListAttributesInput) SetMaxResults added in v1.6.9 

func (s *ListAttributesInput) SetMaxResults(v int64) *ListAttributesInput

SetMaxResults sets the MaxResults field's value.

func (*ListAttributesInput) SetNextToken added in v1.6.9 

func (s *ListAttributesInput) SetNextToken(v string) *ListAttributesInput

SetNextToken sets the NextToken field's value.

func (*ListAttributesInput) SetTargetType added in v1.6.9 

func (s *ListAttributesInput) SetTargetType(v string) *ListAttributesInput

SetTargetType sets the TargetType field's value.

func (ListAttributesInput) String added in v1.6.9 

func (s ListAttributesInput) String() string

String returns the string representation

func (*ListAttributesInput) Validate added in v1.6.9 

func (s *ListAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAttributesOutput added in v1.6.9 

type ListAttributesOutput struct {

	// A list of attribute objects that meet the criteria of the request.
	Attributes []*Attribute `locationName:"attributes" type:"list"`

	// The nextToken value to include in a future ListAttributes request. When the
	// results of a ListAttributes request exceed maxResults, this value can be
	// used to retrieve the next page of results. This value is null when there
	// are no more results to return.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListAttributesOutput) GoString added in v1.6.9 

func (s ListAttributesOutput) GoString() string

GoString returns the string representation

func (*ListAttributesOutput) SetAttributes added in v1.6.9 

func (s *ListAttributesOutput) SetAttributes(v []*Attribute) *ListAttributesOutput

SetAttributes sets the Attributes field's value.

func (*ListAttributesOutput) SetNextToken added in v1.6.9 

func (s *ListAttributesOutput) SetNextToken(v string) *ListAttributesOutput

SetNextToken sets the NextToken field's value.

func (ListAttributesOutput) String added in v1.6.9 

func (s ListAttributesOutput) String() string

String returns the string representation

type ListClustersInput 

type ListClustersInput struct {

	// The maximum number of cluster results returned by ListClusters in paginated
	// output. When this parameter is used, ListClusters only returns maxResults
	// results in a single page along with a nextToken response element. The remaining
	// results of the initial request can be seen by sending another ListClusters
	// request with the returned nextToken value. This value can be between 1 and
	// 100. If this parameter is not used, then ListClusters returns up to 100 results
	// and a nextToken value if applicable.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The nextToken value returned from a previous paginated ListClusters request
	// where maxResults was used and the results exceeded the value of that parameter.
	// Pagination continues from the end of the previous results that returned the
	// nextToken value.
	//
	// This token should be treated as an opaque identifier that is only used to
	// retrieve the next items in a list and not for other programmatic purposes.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListClustersInput) GoString added in v0.6.5 

func (s ListClustersInput) GoString() string

GoString returns the string representation

func (*ListClustersInput) SetMaxResults added in v1.5.0 

func (s *ListClustersInput) SetMaxResults(v int64) *ListClustersInput

SetMaxResults sets the MaxResults field's value.

func (*ListClustersInput) SetNextToken added in v1.5.0 

func (s *ListClustersInput) SetNextToken(v string) *ListClustersInput

SetNextToken sets the NextToken field's value.

func (ListClustersInput) String added in v0.6.5 

func (s ListClustersInput) String() string

String returns the string representation

type ListClustersOutput 

type ListClustersOutput struct {

	// The list of full Amazon Resource Name (ARN) entries for each cluster associated
	// with your account.
	ClusterArns []*string `locationName:"clusterArns" type:"list"`

	// The nextToken value to include in a future ListClusters request. When the
	// results of a ListClusters request exceed maxResults, this value can be used
	// to retrieve the next page of results. This value is null when there are no
	// more results to return.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListClustersOutput) GoString added in v0.6.5 

func (s ListClustersOutput) GoString() string

GoString returns the string representation

func (*ListClustersOutput) SetClusterArns added in v1.5.0 

func (s *ListClustersOutput) SetClusterArns(v []*string) *ListClustersOutput

SetClusterArns sets the ClusterArns field's value.

func (*ListClustersOutput) SetNextToken added in v1.5.0 

func (s *ListClustersOutput) SetNextToken(v string) *ListClustersOutput

SetNextToken sets the NextToken field's value.

func (ListClustersOutput) String added in v0.6.5 

func (s ListClustersOutput) String() string

String returns the string representation

type ListContainerInstancesInput 

type ListContainerInstancesInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts
	// the container instances to list. If you do not specify a cluster, the default
	// cluster is assumed.
	Cluster *string `locationName:"cluster" type:"string"`

	// You can filter the results of a ListContainerInstances operation with cluster
	// query language statements. For more information, see Cluster Query Language
	// (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html)
	// in the Amazon Elastic Container Service Developer Guide.
	Filter *string `locationName:"filter" type:"string"`

	// The maximum number of container instance results returned by ListContainerInstances
	// in paginated output. When this parameter is used, ListContainerInstances
	// only returns maxResults results in a single page along with a nextToken response
	// element. The remaining results of the initial request can be seen by sending
	// another ListContainerInstances request with the returned nextToken value.
	// This value can be between 1 and 100. If this parameter is not used, then
	// ListContainerInstances returns up to 100 results and a nextToken value if
	// applicable.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The nextToken value returned from a previous paginated ListContainerInstances
	// request where maxResults was used and the results exceeded the value of that
	// parameter. Pagination continues from the end of the previous results that
	// returned the nextToken value.
	//
	// This token should be treated as an opaque identifier that is only used to
	// retrieve the next items in a list and not for other programmatic purposes.
	NextToken *string `locationName:"nextToken" type:"string"`

	// Filters the container instances by status. For example, if you specify the
	// DRAINING status, the results include only container instances that have been
	// set to DRAINING using UpdateContainerInstancesState. If you do not specify
	// this parameter, the default is to include container instances set to ACTIVE
	// and DRAINING.
	Status *string `locationName:"status" type:"string" enum:"ContainerInstanceStatus"`
	// contains filtered or unexported fields
}

func (ListContainerInstancesInput) GoString added in v0.6.5 

func (s ListContainerInstancesInput) GoString() string

GoString returns the string representation

func (*ListContainerInstancesInput) SetCluster added in v1.5.0 

func (s *ListContainerInstancesInput) SetCluster(v string) *ListContainerInstancesInput

SetCluster sets the Cluster field's value.

func (*ListContainerInstancesInput) SetFilter added in v1.6.9 

func (s *ListContainerInstancesInput) SetFilter(v string) *ListContainerInstancesInput

SetFilter sets the Filter field's value.

func (*ListContainerInstancesInput) SetMaxResults added in v1.5.0 

func (s *ListContainerInstancesInput) SetMaxResults(v int64) *ListContainerInstancesInput

SetMaxResults sets the MaxResults field's value.

func (*ListContainerInstancesInput) SetNextToken added in v1.5.0 

func (s *ListContainerInstancesInput) SetNextToken(v string) *ListContainerInstancesInput

SetNextToken sets the NextToken field's value.

func (*ListContainerInstancesInput) SetStatus added in v1.6.16 

func (s *ListContainerInstancesInput) SetStatus(v string) *ListContainerInstancesInput

SetStatus sets the Status field's value.

func (ListContainerInstancesInput) String added in v0.6.5 

func (s ListContainerInstancesInput) String() string

String returns the string representation

type ListContainerInstancesOutput 

type ListContainerInstancesOutput struct {

	// The list of container instances with full ARN entries for each container
	// instance associated with the specified cluster.
	ContainerInstanceArns []*string `locationName:"containerInstanceArns" type:"list"`

	// The nextToken value to include in a future ListContainerInstances request.
	// When the results of a ListContainerInstances request exceed maxResults, this
	// value can be used to retrieve the next page of results. This value is null
	// when there are no more results to return.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListContainerInstancesOutput) GoString added in v0.6.5 

func (s ListContainerInstancesOutput) GoString() string

GoString returns the string representation

func (*ListContainerInstancesOutput) SetContainerInstanceArns added in v1.5.0 

func (s *ListContainerInstancesOutput) SetContainerInstanceArns(v []*string) *ListContainerInstancesOutput

SetContainerInstanceArns sets the ContainerInstanceArns field's value.

func (*ListContainerInstancesOutput) SetNextToken added in v1.5.0 

func (s *ListContainerInstancesOutput) SetNextToken(v string) *ListContainerInstancesOutput

SetNextToken sets the NextToken field's value.

func (ListContainerInstancesOutput) String added in v0.6.5 

func (s ListContainerInstancesOutput) String() string

String returns the string representation

type ListServicesInput 

type ListServicesInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts
	// the services to list. If you do not specify a cluster, the default cluster
	// is assumed.
	Cluster *string `locationName:"cluster" type:"string"`

	// The launch type for services you want to list.
	LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"`

	// The maximum number of service results returned by ListServices in paginated
	// output. When this parameter is used, ListServices only returns maxResults
	// results in a single page along with a nextToken response element. The remaining
	// results of the initial request can be seen by sending another ListServices
	// request with the returned nextToken value. This value can be between 1 and
	// 10. If this parameter is not used, then ListServices returns up to 10 results
	// and a nextToken value if applicable.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The nextToken value returned from a previous paginated ListServices request
	// where maxResults was used and the results exceeded the value of that parameter.
	// Pagination continues from the end of the previous results that returned the
	// nextToken value.
	//
	// This token should be treated as an opaque identifier that is only used to
	// retrieve the next items in a list and not for other programmatic purposes.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The scheduling strategy for services to list.
	SchedulingStrategy *string `locationName:"schedulingStrategy" type:"string" enum:"SchedulingStrategy"`
	// contains filtered or unexported fields
}

func (ListServicesInput) GoString added in v0.6.5 

func (s ListServicesInput) GoString() string

GoString returns the string representation

func (*ListServicesInput) SetCluster added in v1.5.0 

func (s *ListServicesInput) SetCluster(v string) *ListServicesInput

SetCluster sets the Cluster field's value.

func (*ListServicesInput) SetLaunchType added in v1.12.36 

func (s *ListServicesInput) SetLaunchType(v string) *ListServicesInput

SetLaunchType sets the LaunchType field's value.

func (*ListServicesInput) SetMaxResults added in v1.5.0 

func (s *ListServicesInput) SetMaxResults(v int64) *ListServicesInput

SetMaxResults sets the MaxResults field's value.

func (*ListServicesInput) SetNextToken added in v1.5.0 

func (s *ListServicesInput) SetNextToken(v string) *ListServicesInput

SetNextToken sets the NextToken field's value.

func (*ListServicesInput) SetSchedulingStrategy added in v1.14.5 

func (s *ListServicesInput) SetSchedulingStrategy(v string) *ListServicesInput

SetSchedulingStrategy sets the SchedulingStrategy field's value.

func (ListServicesInput) String added in v0.6.5 

func (s ListServicesInput) String() string

String returns the string representation

type ListServicesOutput 

type ListServicesOutput struct {

	// The nextToken value to include in a future ListServices request. When the
	// results of a ListServices request exceed maxResults, this value can be used
	// to retrieve the next page of results. This value is null when there are no
	// more results to return.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The list of full ARN entries for each service associated with the specified
	// cluster.
	ServiceArns []*string `locationName:"serviceArns" type:"list"`
	// contains filtered or unexported fields
}

func (ListServicesOutput) GoString added in v0.6.5 

func (s ListServicesOutput) GoString() string

GoString returns the string representation

func (*ListServicesOutput) SetNextToken added in v1.5.0 

func (s *ListServicesOutput) SetNextToken(v string) *ListServicesOutput

SetNextToken sets the NextToken field's value.

func (*ListServicesOutput) SetServiceArns added in v1.5.0 

func (s *ListServicesOutput) SetServiceArns(v []*string) *ListServicesOutput

SetServiceArns sets the ServiceArns field's value.

func (ListServicesOutput) String added in v0.6.5 

func (s ListServicesOutput) String() string

String returns the string representation

type ListTaskDefinitionFamiliesInput 

type ListTaskDefinitionFamiliesInput struct {

	// The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies.
	// If you specify a familyPrefix, only task definition family names that begin
	// with the familyPrefix string are returned.
	FamilyPrefix *string `locationName:"familyPrefix" type:"string"`

	// The maximum number of task definition family results returned by ListTaskDefinitionFamilies
	// in paginated output. When this parameter is used, ListTaskDefinitions only
	// returns maxResults results in a single page along with a nextToken response
	// element. The remaining results of the initial request can be seen by sending
	// another ListTaskDefinitionFamilies request with the returned nextToken value.
	// This value can be between 1 and 100. If this parameter is not used, then
	// ListTaskDefinitionFamilies returns up to 100 results and a nextToken value
	// if applicable.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The nextToken value returned from a previous paginated ListTaskDefinitionFamilies
	// request where maxResults was used and the results exceeded the value of that
	// parameter. Pagination continues from the end of the previous results that
	// returned the nextToken value.
	//
	// This token should be treated as an opaque identifier that is only used to
	// retrieve the next items in a list and not for other programmatic purposes.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The task definition family status with which to filter the ListTaskDefinitionFamilies
	// results. By default, both ACTIVE and INACTIVE task definition families are
	// listed. If this parameter is set to ACTIVE, only task definition families
	// that have an ACTIVE task definition revision are returned. If this parameter
	// is set to INACTIVE, only task definition families that do not have any ACTIVE
	// task definition revisions are returned. If you paginate the resulting output,
	// be sure to keep the status value constant in each subsequent request.
	Status *string `locationName:"status" type:"string" enum:"TaskDefinitionFamilyStatus"`
	// contains filtered or unexported fields
}

func (ListTaskDefinitionFamiliesInput) GoString added in v0.6.5 

func (s ListTaskDefinitionFamiliesInput) GoString() string

GoString returns the string representation

func (*ListTaskDefinitionFamiliesInput) SetFamilyPrefix added in v1.5.0 

func (s *ListTaskDefinitionFamiliesInput) SetFamilyPrefix(v string) *ListTaskDefinitionFamiliesInput

SetFamilyPrefix sets the FamilyPrefix field's value.

func (*ListTaskDefinitionFamiliesInput) SetMaxResults added in v1.5.0 

func (s *ListTaskDefinitionFamiliesInput) SetMaxResults(v int64) *ListTaskDefinitionFamiliesInput

SetMaxResults sets the MaxResults field's value.

func (*ListTaskDefinitionFamiliesInput) SetNextToken added in v1.5.0 

func (s *ListTaskDefinitionFamiliesInput) SetNextToken(v string) *ListTaskDefinitionFamiliesInput

SetNextToken sets the NextToken field's value.

func (*ListTaskDefinitionFamiliesInput) SetStatus added in v1.5.0 

func (s *ListTaskDefinitionFamiliesInput) SetStatus(v string) *ListTaskDefinitionFamiliesInput

SetStatus sets the Status field's value.

func (ListTaskDefinitionFamiliesInput) String added in v0.6.5 

func (s ListTaskDefinitionFamiliesInput) String() string

String returns the string representation

type ListTaskDefinitionFamiliesOutput 

type ListTaskDefinitionFamiliesOutput struct {

	// The list of task definition family names that match the ListTaskDefinitionFamilies
	// request.
	Families []*string `locationName:"families" type:"list"`

	// The nextToken value to include in a future ListTaskDefinitionFamilies request.
	// When the results of a ListTaskDefinitionFamilies request exceed maxResults,
	// this value can be used to retrieve the next page of results. This value is
	// null when there are no more results to return.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListTaskDefinitionFamiliesOutput) GoString added in v0.6.5 

func (s ListTaskDefinitionFamiliesOutput) GoString() string

GoString returns the string representation

func (*ListTaskDefinitionFamiliesOutput) SetFamilies added in v1.5.0 

func (s *ListTaskDefinitionFamiliesOutput) SetFamilies(v []*string) *ListTaskDefinitionFamiliesOutput

SetFamilies sets the Families field's value.

func (*ListTaskDefinitionFamiliesOutput) SetNextToken added in v1.5.0 

func (s *ListTaskDefinitionFamiliesOutput) SetNextToken(v string) *ListTaskDefinitionFamiliesOutput

SetNextToken sets the NextToken field's value.

func (ListTaskDefinitionFamiliesOutput) String added in v0.6.5 

func (s ListTaskDefinitionFamiliesOutput) String() string

String returns the string representation

type ListTaskDefinitionsInput 

type ListTaskDefinitionsInput struct {

	// The full family name with which to filter the ListTaskDefinitions results.
	// Specifying a familyPrefix limits the listed task definitions to task definition
	// revisions that belong to that family.
	FamilyPrefix *string `locationName:"familyPrefix" type:"string"`

	// The maximum number of task definition results returned by ListTaskDefinitions
	// in paginated output. When this parameter is used, ListTaskDefinitions only
	// returns maxResults results in a single page along with a nextToken response
	// element. The remaining results of the initial request can be seen by sending
	// another ListTaskDefinitions request with the returned nextToken value. This
	// value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions
	// returns up to 100 results and a nextToken value if applicable.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The nextToken value returned from a previous paginated ListTaskDefinitions
	// request where maxResults was used and the results exceeded the value of that
	// parameter. Pagination continues from the end of the previous results that
	// returned the nextToken value.
	//
	// This token should be treated as an opaque identifier that is only used to
	// retrieve the next items in a list and not for other programmatic purposes.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The order in which to sort the results. Valid values are ASC and DESC. By
	// default (ASC), task definitions are listed lexicographically by family name
	// and in ascending numerical order by revision so that the newest task definitions
	// in a family are listed last. Setting this parameter to DESC reverses the
	// sort order on family name and revision so that the newest task definitions
	// in a family are listed first.
	Sort *string `locationName:"sort" type:"string" enum:"SortOrder"`

	// The task definition status with which to filter the ListTaskDefinitions results.
	// By default, only ACTIVE task definitions are listed. By setting this parameter
	// to INACTIVE, you can view task definitions that are INACTIVE as long as an
	// active task or service still references them. If you paginate the resulting
	// output, be sure to keep the status value constant in each subsequent request.
	Status *string `locationName:"status" type:"string" enum:"TaskDefinitionStatus"`
	// contains filtered or unexported fields
}

func (ListTaskDefinitionsInput) GoString added in v0.6.5 

func (s ListTaskDefinitionsInput) GoString() string

GoString returns the string representation

func (*ListTaskDefinitionsInput) SetFamilyPrefix added in v1.5.0 

func (s *ListTaskDefinitionsInput) SetFamilyPrefix(v string) *ListTaskDefinitionsInput

SetFamilyPrefix sets the FamilyPrefix field's value.

func (*ListTaskDefinitionsInput) SetMaxResults added in v1.5.0 

func (s *ListTaskDefinitionsInput) SetMaxResults(v int64) *ListTaskDefinitionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListTaskDefinitionsInput) SetNextToken added in v1.5.0 

func (s *ListTaskDefinitionsInput) SetNextToken(v string) *ListTaskDefinitionsInput

SetNextToken sets the NextToken field's value.

func (*ListTaskDefinitionsInput) SetSort added in v1.5.0 

func (s *ListTaskDefinitionsInput) SetSort(v string) *ListTaskDefinitionsInput

SetSort sets the Sort field's value.

func (*ListTaskDefinitionsInput) SetStatus added in v1.5.0 

func (s *ListTaskDefinitionsInput) SetStatus(v string) *ListTaskDefinitionsInput

SetStatus sets the Status field's value.

func (ListTaskDefinitionsInput) String added in v0.6.5 

func (s ListTaskDefinitionsInput) String() string

String returns the string representation

type ListTaskDefinitionsOutput 

type ListTaskDefinitionsOutput struct {

	// The nextToken value to include in a future ListTaskDefinitions request. When
	// the results of a ListTaskDefinitions request exceed maxResults, this value
	// can be used to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions
	// request.
	TaskDefinitionArns []*string `locationName:"taskDefinitionArns" type:"list"`
	// contains filtered or unexported fields
}

func (ListTaskDefinitionsOutput) GoString added in v0.6.5 

func (s ListTaskDefinitionsOutput) GoString() string

GoString returns the string representation

func (*ListTaskDefinitionsOutput) SetNextToken added in v1.5.0 

func (s *ListTaskDefinitionsOutput) SetNextToken(v string) *ListTaskDefinitionsOutput

SetNextToken sets the NextToken field's value.

func (*ListTaskDefinitionsOutput) SetTaskDefinitionArns added in v1.5.0 

func (s *ListTaskDefinitionsOutput) SetTaskDefinitionArns(v []*string) *ListTaskDefinitionsOutput

SetTaskDefinitionArns sets the TaskDefinitionArns field's value.

func (ListTaskDefinitionsOutput) String added in v0.6.5 

func (s ListTaskDefinitionsOutput) String() string

String returns the string representation

type ListTasksInput 

type ListTasksInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts
	// the tasks to list. If you do not specify a cluster, the default cluster is
	// assumed.
	Cluster *string `locationName:"cluster" type:"string"`

	// The container instance ID or full ARN of the container instance with which
	// to filter the ListTasks results. Specifying a containerInstance limits the
	// results to tasks that belong to that container instance.
	ContainerInstance *string `locationName:"containerInstance" type:"string"`

	// The task desired status with which to filter the ListTasks results. Specifying
	// a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has
	// set the desired status to STOPPED, which can be useful for debugging tasks
	// that are not starting properly or have died or finished. The default status
	// filter is RUNNING, which shows tasks that Amazon ECS has set the desired
	// status to RUNNING.
	//
	// Although you can filter results based on a desired status of PENDING, this
	// does not return any results because Amazon ECS never sets the desired status
	// of a task to that value (only a task's lastStatus may have a value of PENDING).
	DesiredStatus *string `locationName:"desiredStatus" type:"string" enum:"DesiredStatus"`

	// The name of the family with which to filter the ListTasks results. Specifying
	// a family limits the results to tasks that belong to that family.
	Family *string `locationName:"family" type:"string"`

	// The launch type for services you want to list.
	LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"`

	// The maximum number of task results returned by ListTasks in paginated output.
	// When this parameter is used, ListTasks only returns maxResults results in
	// a single page along with a nextToken response element. The remaining results
	// of the initial request can be seen by sending another ListTasks request with
	// the returned nextToken value. This value can be between 1 and 100. If this
	// parameter is not used, then ListTasks returns up to 100 results and a nextToken
	// value if applicable.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The nextToken value returned from a previous paginated ListTasks request
	// where maxResults was used and the results exceeded the value of that parameter.
	// Pagination continues from the end of the previous results that returned the
	// nextToken value.
	//
	// This token should be treated as an opaque identifier that is only used to
	// retrieve the next items in a list and not for other programmatic purposes.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The name of the service with which to filter the ListTasks results. Specifying
	// a serviceName limits the results to tasks that belong to that service.
	ServiceName *string `locationName:"serviceName" type:"string"`

	// The startedBy value with which to filter the task results. Specifying a startedBy
	// value limits the results to tasks that were started with that value.
	StartedBy *string `locationName:"startedBy" type:"string"`
	// contains filtered or unexported fields
}

func (ListTasksInput) GoString added in v0.6.5 

func (s ListTasksInput) GoString() string

GoString returns the string representation

func (*ListTasksInput) SetCluster added in v1.5.0 

func (s *ListTasksInput) SetCluster(v string) *ListTasksInput

SetCluster sets the Cluster field's value.

func (*ListTasksInput) SetContainerInstance added in v1.5.0 

func (s *ListTasksInput) SetContainerInstance(v string) *ListTasksInput

SetContainerInstance sets the ContainerInstance field's value.

func (*ListTasksInput) SetDesiredStatus added in v1.5.0 

func (s *ListTasksInput) SetDesiredStatus(v string) *ListTasksInput

SetDesiredStatus sets the DesiredStatus field's value.

func (*ListTasksInput) SetFamily added in v1.5.0 

func (s *ListTasksInput) SetFamily(v string) *ListTasksInput

SetFamily sets the Family field's value.

func (*ListTasksInput) SetLaunchType added in v1.12.36 

func (s *ListTasksInput) SetLaunchType(v string) *ListTasksInput

SetLaunchType sets the LaunchType field's value.

func (*ListTasksInput) SetMaxResults added in v1.5.0 

func (s *ListTasksInput) SetMaxResults(v int64) *ListTasksInput

SetMaxResults sets the MaxResults field's value.

func (*ListTasksInput) SetNextToken added in v1.5.0 

func (s *ListTasksInput) SetNextToken(v string) *ListTasksInput

SetNextToken sets the NextToken field's value.

func (*ListTasksInput) SetServiceName added in v1.5.0 

func (s *ListTasksInput) SetServiceName(v string) *ListTasksInput

SetServiceName sets the ServiceName field's value.

func (*ListTasksInput) SetStartedBy added in v1.5.0 

func (s *ListTasksInput) SetStartedBy(v string) *ListTasksInput

SetStartedBy sets the StartedBy field's value.

func (ListTasksInput) String added in v0.6.5 

func (s ListTasksInput) String() string

String returns the string representation

type ListTasksOutput 

type ListTasksOutput struct {

	// The nextToken value to include in a future ListTasks request. When the results
	// of a ListTasks request exceed maxResults, this value can be used to retrieve
	// the next page of results. This value is null when there are no more results
	// to return.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The list of task ARN entries for the ListTasks request.
	TaskArns []*string `locationName:"taskArns" type:"list"`
	// contains filtered or unexported fields
}

func (ListTasksOutput) GoString added in v0.6.5 

func (s ListTasksOutput) GoString() string

GoString returns the string representation

func (*ListTasksOutput) SetNextToken added in v1.5.0 

func (s *ListTasksOutput) SetNextToken(v string) *ListTasksOutput

SetNextToken sets the NextToken field's value.

func (*ListTasksOutput) SetTaskArns added in v1.5.0 

func (s *ListTasksOutput) SetTaskArns(v []*string) *ListTasksOutput

SetTaskArns sets the TaskArns field's value.

func (ListTasksOutput) String added in v0.6.5 

func (s ListTasksOutput) String() string

String returns the string representation

type LoadBalancer 

type LoadBalancer struct {

	// The name of the container (as it appears in a container definition) to associate
	// with the load balancer.
	ContainerName *string `locationName:"containerName" type:"string"`

	// The port on the container to associate with the load balancer. This port
	// must correspond to a containerPort in the service's task definition. Your
	// container instances must allow ingress traffic on the hostPort of the port
	// mapping.
	ContainerPort *int64 `locationName:"containerPort" type:"integer"`

	// The name of a load balancer.
	LoadBalancerName *string `locationName:"loadBalancerName" type:"string"`

	// The full Amazon Resource Name (ARN) of the Elastic Load Balancing target
	// group associated with a service.
	//
	// If your service's task definition uses the awsvpc network mode (which is
	// required for the Fargate launch type), you must choose ip as the target type,
	// not instance, because tasks that use the awsvpc network mode are associated
	// with an elastic network interface, not an Amazon EC2 instance.
	TargetGroupArn *string `locationName:"targetGroupArn" type:"string"`
	// contains filtered or unexported fields
}

Details on a load balancer that is used with a service.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

func (LoadBalancer) GoString added in v0.6.5 

func (s LoadBalancer) GoString() string

GoString returns the string representation

func (*LoadBalancer) SetContainerName added in v1.5.0 

func (s *LoadBalancer) SetContainerName(v string) *LoadBalancer

SetContainerName sets the ContainerName field's value.

func (*LoadBalancer) SetContainerPort added in v1.5.0 

func (s *LoadBalancer) SetContainerPort(v int64) *LoadBalancer

SetContainerPort sets the ContainerPort field's value.

func (*LoadBalancer) SetLoadBalancerName added in v1.5.0 

func (s *LoadBalancer) SetLoadBalancerName(v string) *LoadBalancer

SetLoadBalancerName sets the LoadBalancerName field's value.

func (*LoadBalancer) SetTargetGroupArn added in v1.5.0 

func (s *LoadBalancer) SetTargetGroupArn(v string) *LoadBalancer

SetTargetGroupArn sets the TargetGroupArn field's value.

func (LoadBalancer) String added in v0.6.5 

func (s LoadBalancer) String() string

String returns the string representation

type LogConfiguration added in v0.9.14 

type LogConfiguration struct {

	// The log driver to use for the container. The valid values listed for this
	// parameter are log drivers that the Amazon ECS container agent can communicate
	// with by default. If using the Fargate launch type, the only supported value
	// is awslogs. For more information about using the awslogs driver, see Using
	// the awslogs Log Driver (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// If you have a custom driver that is not listed above that you would like
	// to work with the Amazon ECS container agent, you can fork the Amazon ECS
	// container agent project that is available on GitHub (https://github.com/aws/amazon-ecs-agent)
	// and customize it to work with that driver. We encourage you to submit pull
	// requests for changes that you would like to have included. However, Amazon
	// Web Services does not currently support running modified copies of this software.
	//
	// This parameter requires version 1.18 of the Docker Remote API or greater
	// on your container instance. To check the Docker Remote API version on your
	// container instance, log in to your container instance and run the following
	// command: sudo docker version | grep "Server API version"
	//
	// LogDriver is a required field
	LogDriver *string `locationName:"logDriver" type:"string" required:"true" enum:"LogDriver"`

	// The configuration options to send to the log driver. This parameter requires
	// version 1.19 of the Docker Remote API or greater on your container instance.
	// To check the Docker Remote API version on your container instance, log in
	// to your container instance and run the following command: sudo docker version
	// | grep "Server API version"
	Options map[string]*string `locationName:"options" type:"map"`
	// contains filtered or unexported fields
}

Log configuration options to send to a custom log driver for the container.

func (LogConfiguration) GoString added in v0.9.14 

func (s LogConfiguration) GoString() string

GoString returns the string representation

func (*LogConfiguration) SetLogDriver added in v1.5.0 

func (s *LogConfiguration) SetLogDriver(v string) *LogConfiguration

SetLogDriver sets the LogDriver field's value.

func (*LogConfiguration) SetOptions added in v1.5.0 

func (s *LogConfiguration) SetOptions(v map[string]*string) *LogConfiguration

SetOptions sets the Options field's value.

func (LogConfiguration) String added in v0.9.14 

func (s LogConfiguration) String() string

String returns the string representation

func (*LogConfiguration) Validate added in v1.1.21 

func (s *LogConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MountPoint 

type MountPoint struct {

	// The path on the container to mount the host volume at.
	ContainerPath *string `locationName:"containerPath" type:"string"`

	// If this value is true, the container has read-only access to the volume.
	// If this value is false, then the container can write to the volume. The default
	// value is false.
	ReadOnly *bool `locationName:"readOnly" type:"boolean"`

	// The name of the volume to mount.
	SourceVolume *string `locationName:"sourceVolume" type:"string"`
	// contains filtered or unexported fields
}

Details on a volume mount point that is used in a container definition.

func (MountPoint) GoString added in v0.6.5 

func (s MountPoint) GoString() string

GoString returns the string representation

func (*MountPoint) SetContainerPath added in v1.5.0 

func (s *MountPoint) SetContainerPath(v string) *MountPoint

SetContainerPath sets the ContainerPath field's value.

func (*MountPoint) SetReadOnly added in v1.5.0 

func (s *MountPoint) SetReadOnly(v bool) *MountPoint

SetReadOnly sets the ReadOnly field's value.

func (*MountPoint) SetSourceVolume added in v1.5.0 

func (s *MountPoint) SetSourceVolume(v string) *MountPoint

SetSourceVolume sets the SourceVolume field's value.

func (MountPoint) String added in v0.6.5 

func (s MountPoint) String() string

String returns the string representation

type NetworkBinding 

type NetworkBinding struct {

	// The IP address that the container is bound to on the container instance.
	BindIP *string `locationName:"bindIP" type:"string"`

	// The port number on the container that is used with the network binding.
	ContainerPort *int64 `locationName:"containerPort" type:"integer"`

	// The port number on the host that is used with the network binding.
	HostPort *int64 `locationName:"hostPort" type:"integer"`

	// The protocol used for the network binding.
	Protocol *string `locationName:"protocol" type:"string" enum:"TransportProtocol"`
	// contains filtered or unexported fields
}

Details on the network bindings between a container and its host container instance. 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.

func (NetworkBinding) GoString added in v0.6.5 

func (s NetworkBinding) GoString() string

GoString returns the string representation

func (*NetworkBinding) SetBindIP added in v1.5.0 

func (s *NetworkBinding) SetBindIP(v string) *NetworkBinding

SetBindIP sets the BindIP field's value.

func (*NetworkBinding) SetContainerPort added in v1.5.0 

func (s *NetworkBinding) SetContainerPort(v int64) *NetworkBinding

SetContainerPort sets the ContainerPort field's value.

func (*NetworkBinding) SetHostPort added in v1.5.0 

func (s *NetworkBinding) SetHostPort(v int64) *NetworkBinding

SetHostPort sets the HostPort field's value.

func (*NetworkBinding) SetProtocol added in v1.5.0 

func (s *NetworkBinding) SetProtocol(v string) *NetworkBinding

SetProtocol sets the Protocol field's value.

func (NetworkBinding) String added in v0.6.5 

func (s NetworkBinding) String() string

String returns the string representation

type NetworkConfiguration added in v1.12.27 

type NetworkConfiguration struct {

	// The VPC subnets and security groups associated with a task.
	AwsvpcConfiguration *AwsVpcConfiguration `locationName:"awsvpcConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

An object representing the network configuration for a task or service.

func (NetworkConfiguration) GoString added in v1.12.27 

func (s NetworkConfiguration) GoString() string

GoString returns the string representation

func (*NetworkConfiguration) SetAwsvpcConfiguration added in v1.12.27 

func (s *NetworkConfiguration) SetAwsvpcConfiguration(v *AwsVpcConfiguration) *NetworkConfiguration

SetAwsvpcConfiguration sets the AwsvpcConfiguration field's value.

func (NetworkConfiguration) String added in v1.12.27 

func (s NetworkConfiguration) String() string

String returns the string representation

func (*NetworkConfiguration) Validate added in v1.12.27 

func (s *NetworkConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type NetworkInterface added in v1.12.27 

type NetworkInterface struct {

	// The attachment ID for the network interface.
	AttachmentId *string `locationName:"attachmentId" type:"string"`

	// The private IPv6 address for the network interface.
	Ipv6Address *string `locationName:"ipv6Address" type:"string"`

	// The private IPv4 address for the network interface.
	PrivateIpv4Address *string `locationName:"privateIpv4Address" type:"string"`
	// contains filtered or unexported fields
}

An object representing the Elastic Network Interface for tasks that use the awsvpc network mode.

func (NetworkInterface) GoString added in v1.12.27 

func (s NetworkInterface) GoString() string

GoString returns the string representation

func (*NetworkInterface) SetAttachmentId added in v1.12.27 

func (s *NetworkInterface) SetAttachmentId(v string) *NetworkInterface

SetAttachmentId sets the AttachmentId field's value.

func (*NetworkInterface) SetIpv6Address added in v1.12.27 

func (s *NetworkInterface) SetIpv6Address(v string) *NetworkInterface

SetIpv6Address sets the Ipv6Address field's value.

func (*NetworkInterface) SetPrivateIpv4Address added in v1.12.27 

func (s *NetworkInterface) SetPrivateIpv4Address(v string) *NetworkInterface

SetPrivateIpv4Address sets the PrivateIpv4Address field's value.

func (NetworkInterface) String added in v1.12.27 

func (s NetworkInterface) String() string

String returns the string representation

type PlacementConstraint added in v1.6.9 

type PlacementConstraint struct {

	// A cluster query language expression to apply to the constraint. Note you
	// cannot specify an expression if the constraint type is distinctInstance.
	// For more information, see Cluster Query Language (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html)
	// in the Amazon Elastic Container Service Developer Guide.
	Expression *string `locationName:"expression" type:"string"`

	// The type of constraint. Use distinctInstance to ensure that each task in
	// a particular group is running on a different container instance. Use memberOf
	// to restrict the selection to a group of valid candidates. The value distinctInstance
	// is not supported in task definitions.
	Type *string `locationName:"type" type:"string" enum:"PlacementConstraintType"`
	// contains filtered or unexported fields
}

An object representing a constraint on task placement. For more information, see Task Placement Constraints (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the Amazon Elastic Container Service Developer Guide.

func (PlacementConstraint) GoString added in v1.6.9 

func (s PlacementConstraint) GoString() string

GoString returns the string representation

func (*PlacementConstraint) SetExpression added in v1.6.9 

func (s *PlacementConstraint) SetExpression(v string) *PlacementConstraint

SetExpression sets the Expression field's value.

func (*PlacementConstraint) SetType added in v1.6.9 

func (s *PlacementConstraint) SetType(v string) *PlacementConstraint

SetType sets the Type field's value.

func (PlacementConstraint) String added in v1.6.9 

func (s PlacementConstraint) String() string

String returns the string representation

type PlacementStrategy added in v1.6.9 

type PlacementStrategy struct {

	// The field to apply the placement strategy against. For the spread placement
	// strategy, valid values are instanceId (or host, which has the same effect),
	// or any platform or custom attribute that is applied to a container instance,
	// such as attribute:ecs.availability-zone. For the binpack placement strategy,
	// valid values are cpu and memory. For the random placement strategy, this
	// field is not used.
	Field *string `locationName:"field" type:"string"`

	// The type of placement strategy. The random placement strategy randomly places
	// tasks on available candidates. The spread placement strategy spreads placement
	// across available candidates evenly based on the field parameter. The binpack
	// strategy places tasks on available candidates that have the least available
	// amount of the resource that is specified with the field parameter. For example,
	// if you binpack on memory, a task is placed on the instance with the least
	// amount of remaining memory (but still enough to run the task).
	Type *string `locationName:"type" type:"string" enum:"PlacementStrategyType"`
	// contains filtered or unexported fields
}

The task placement strategy for a task or service. For more information, see Task Placement Strategies (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the Amazon Elastic Container Service Developer Guide.

func (PlacementStrategy) GoString added in v1.6.9 

func (s PlacementStrategy) GoString() string

GoString returns the string representation

func (*PlacementStrategy) SetField added in v1.6.9 

func (s *PlacementStrategy) SetField(v string) *PlacementStrategy

SetField sets the Field field's value.

func (*PlacementStrategy) SetType added in v1.6.9 

func (s *PlacementStrategy) SetType(v string) *PlacementStrategy

SetType sets the Type field's value.

func (PlacementStrategy) String added in v1.6.9 

func (s PlacementStrategy) String() string

String returns the string representation

type PortMapping 

type PortMapping struct {

	// The port number on the container that is bound to the user-specified or automatically
	// assigned host port.
	//
	// If using containers in a task with the awsvpc or host network mode, exposed
	// ports should be specified using containerPort.
	//
	// If using containers in a task with the bridge network mode and you specify
	// a container port and not a host port, your container automatically receives
	// a host port in the ephemeral port range (for more information, see hostPort).
	// Port mappings that are automatically assigned in this way do not count toward
	// the 100 reserved ports limit of a container instance.
	ContainerPort *int64 `locationName:"containerPort" type:"integer"`

	// The port number on the container instance to reserve for your container.
	//
	// If using containers in a task with the awsvpc or host network mode, the hostPort
	// can either be left blank or set to the same value as the containerPort.
	//
	// If using containers in a task with the bridge network mode, you can specify
	// a non-reserved host port for your container port mapping, or you can omit
	// the hostPort (or set it to 0) while specifying a containerPort and your container
	// automatically receives a port in the ephemeral port range for your container
	// instance operating system and Docker version.
	//
	// The default ephemeral port range for Docker version 1.6.0 and later is listed
	// on the instance under /proc/sys/net/ipv4/ip_local_port_range; if this kernel
	// parameter is unavailable, the default ephemeral port range from 49153 through
	// 65535 is used. You should not attempt to specify a host port in the ephemeral
	// port range as these are reserved for automatic assignment. In general, ports
	// below 32768 are outside of the ephemeral port range.
	//
	// The default ephemeral port range from 49153 through 65535 is always used
	// for Docker versions before 1.6.0.
	//
	// The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376,
	// and the Amazon ECS container agent ports 51678 and 51679. Any host port that
	// was previously specified in a running task is also reserved while the task
	// is running (after a task stops, the host port is released). The current reserved
	// ports are displayed in the remainingResources of DescribeContainerInstances
	// output, and a container instance may have up to 100 reserved ports at a time,
	// including the default reserved ports (automatically assigned ports do not
	// count toward the 100 reserved ports limit).
	HostPort *int64 `locationName:"hostPort" type:"integer"`

	// The protocol used for the port mapping. Valid values are tcp and udp. The
	// default is tcp.
	Protocol *string `locationName:"protocol" type:"string" enum:"TransportProtocol"`
	// contains filtered or unexported fields
}

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.

If using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

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.

func (PortMapping) GoString added in v0.6.5 

func (s PortMapping) GoString() string

GoString returns the string representation

func (*PortMapping) SetContainerPort added in v1.5.0 

func (s *PortMapping) SetContainerPort(v int64) *PortMapping

SetContainerPort sets the ContainerPort field's value.

func (*PortMapping) SetHostPort added in v1.5.0 

func (s *PortMapping) SetHostPort(v int64) *PortMapping

SetHostPort sets the HostPort field's value.

func (*PortMapping) SetProtocol added in v1.5.0 

func (s *PortMapping) SetProtocol(v string) *PortMapping

SetProtocol sets the Protocol field's value.

func (PortMapping) String added in v0.6.5 

func (s PortMapping) String() string

String returns the string representation

type PutAttributesInput added in v1.6.9 

type PutAttributesInput struct {

	// The attributes to apply to your resource. You can specify up to 10 custom
	// attributes per resource. You can specify up to 10 attributes in a single
	// call.
	//
	// Attributes is a required field
	Attributes []*Attribute `locationName:"attributes" type:"list" required:"true"`

	// The short name or full Amazon Resource Name (ARN) of the cluster that contains
	// the resource to apply attributes. If you do not specify a cluster, the default
	// cluster is assumed.
	Cluster *string `locationName:"cluster" type:"string"`
	// contains filtered or unexported fields
}

func (PutAttributesInput) GoString added in v1.6.9 

func (s PutAttributesInput) GoString() string

GoString returns the string representation

func (*PutAttributesInput) SetAttributes added in v1.6.9 

func (s *PutAttributesInput) SetAttributes(v []*Attribute) *PutAttributesInput

SetAttributes sets the Attributes field's value.

func (*PutAttributesInput) SetCluster added in v1.6.9 

func (s *PutAttributesInput) SetCluster(v string) *PutAttributesInput

SetCluster sets the Cluster field's value.

func (PutAttributesInput) String added in v1.6.9 

func (s PutAttributesInput) String() string

String returns the string representation

func (*PutAttributesInput) Validate added in v1.6.9 

func (s *PutAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutAttributesOutput added in v1.6.9 

type PutAttributesOutput struct {

	// The attributes applied to your resource.
	Attributes []*Attribute `locationName:"attributes" type:"list"`
	// contains filtered or unexported fields
}

func (PutAttributesOutput) GoString added in v1.6.9 

func (s PutAttributesOutput) GoString() string

GoString returns the string representation

func (*PutAttributesOutput) SetAttributes added in v1.6.9 

func (s *PutAttributesOutput) SetAttributes(v []*Attribute) *PutAttributesOutput

SetAttributes sets the Attributes field's value.

func (PutAttributesOutput) String added in v1.6.9 

func (s PutAttributesOutput) String() string

String returns the string representation

type RegisterContainerInstanceInput 

type RegisterContainerInstanceInput struct {

	// The container instance attributes that this container instance supports.
	Attributes []*Attribute `locationName:"attributes" type:"list"`

	// The short name or full Amazon Resource Name (ARN) of the cluster with which
	// to register your container instance. If you do not specify a cluster, the
	// default cluster is assumed.
	Cluster *string `locationName:"cluster" type:"string"`

	// The ARN of the container instance (if it was previously registered).
	ContainerInstanceArn *string `locationName:"containerInstanceArn" type:"string"`

	// The instance identity document for the EC2 instance to register. This document
	// can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/
	InstanceIdentityDocument *string `locationName:"instanceIdentityDocument" type:"string"`

	// The instance identity document signature for the EC2 instance to register.
	// This signature can be found by running the following command from the instance:
	// curl http://169.254.169.254/latest/dynamic/instance-identity/signature/
	InstanceIdentityDocumentSignature *string `locationName:"instanceIdentityDocumentSignature" type:"string"`

	// The resources available on the instance.
	TotalResources []*Resource `locationName:"totalResources" type:"list"`

	// The version information for the Amazon ECS container agent and Docker daemon
	// running on the container instance.
	VersionInfo *VersionInfo `locationName:"versionInfo" type:"structure"`
	// contains filtered or unexported fields
}

func (RegisterContainerInstanceInput) GoString added in v0.6.5 

func (s RegisterContainerInstanceInput) GoString() string

GoString returns the string representation

func (*RegisterContainerInstanceInput) SetAttributes added in v1.5.0 

func (s *RegisterContainerInstanceInput) SetAttributes(v []*Attribute) *RegisterContainerInstanceInput

SetAttributes sets the Attributes field's value.

func (*RegisterContainerInstanceInput) SetCluster added in v1.5.0 

func (s *RegisterContainerInstanceInput) SetCluster(v string) *RegisterContainerInstanceInput

SetCluster sets the Cluster field's value.

func (*RegisterContainerInstanceInput) SetContainerInstanceArn added in v1.5.0 

func (s *RegisterContainerInstanceInput) SetContainerInstanceArn(v string) *RegisterContainerInstanceInput

SetContainerInstanceArn sets the ContainerInstanceArn field's value.

func (*RegisterContainerInstanceInput) SetInstanceIdentityDocument added in v1.5.0 

func (s *RegisterContainerInstanceInput) SetInstanceIdentityDocument(v string) *RegisterContainerInstanceInput

SetInstanceIdentityDocument sets the InstanceIdentityDocument field's value.

func (*RegisterContainerInstanceInput) SetInstanceIdentityDocumentSignature added in v1.5.0 

func (s *RegisterContainerInstanceInput) SetInstanceIdentityDocumentSignature(v string) *RegisterContainerInstanceInput

SetInstanceIdentityDocumentSignature sets the InstanceIdentityDocumentSignature field's value.

func (*RegisterContainerInstanceInput) SetTotalResources added in v1.5.0 

func (s *RegisterContainerInstanceInput) SetTotalResources(v []*Resource) *RegisterContainerInstanceInput

SetTotalResources sets the TotalResources field's value.

func (*RegisterContainerInstanceInput) SetVersionInfo added in v1.5.0 

func (s *RegisterContainerInstanceInput) SetVersionInfo(v *VersionInfo) *RegisterContainerInstanceInput

SetVersionInfo sets the VersionInfo field's value.

func (RegisterContainerInstanceInput) String added in v0.6.5 

func (s RegisterContainerInstanceInput) String() string

String returns the string representation

func (*RegisterContainerInstanceInput) Validate added in v1.1.21 

func (s *RegisterContainerInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterContainerInstanceOutput 

type RegisterContainerInstanceOutput struct {

	// The container instance that was registered.
	ContainerInstance *ContainerInstance `locationName:"containerInstance" type:"structure"`
	// contains filtered or unexported fields
}

func (RegisterContainerInstanceOutput) GoString added in v0.6.5 

func (s RegisterContainerInstanceOutput) GoString() string

GoString returns the string representation

func (*RegisterContainerInstanceOutput) SetContainerInstance added in v1.5.0 

func (s *RegisterContainerInstanceOutput) SetContainerInstance(v *ContainerInstance) *RegisterContainerInstanceOutput

SetContainerInstance sets the ContainerInstance field's value.

func (RegisterContainerInstanceOutput) String added in v0.6.5 

func (s RegisterContainerInstanceOutput) String() string

String returns the string representation

type RegisterTaskDefinitionInput 

type RegisterTaskDefinitionInput struct {

	// A list of container definitions in JSON format that describe the different
	// containers that make up your task.
	//
	// ContainerDefinitions is a required field
	ContainerDefinitions []*ContainerDefinition `locationName:"containerDefinitions" type:"list" required:"true"`

	// The number of CPU units used by the task. It can be expressed as an integer
	// using CPU units, for example 1024, or as a string using vCPUs, for example
	// 1 vCPU or 1 vcpu, in a task definition but will be converted to an integer
	// indicating the CPU units when the task definition is registered.
	//
	// Task-level CPU and memory parameters are ignored for Windows containers.
	// We recommend specifying container-level resources for Windows containers.
	//
	// If using the EC2 launch type, this field is optional. Supported values are
	// between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
	//
	// If using the Fargate launch type, this field is required and you must use
	// one of the following values, which determines your range of supported values
	// for the memory parameter:
	//
	//    * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB),
	//    2048 (2 GB)
	//
	//    * 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072
	//    (3 GB), 4096 (4 GB)
	//
	//    * 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096
	//    (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
	//
	//    * 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384
	//    (16 GB) in increments of 1024 (1 GB)
	//
	//    * 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720
	//    (30 GB) in increments of 1024 (1 GB)
	Cpu *string `locationName:"cpu" type:"string"`

	// The Amazon Resource Name (ARN) of the task execution role that the Amazon
	// ECS container agent and the Docker daemon can assume.
	ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string"`

	// You must specify a family for a task definition, which allows you to track
	// multiple versions of the same task definition. The family is used as a name
	// for your task definition. Up to 255 letters (uppercase and lowercase), numbers,
	// hyphens, and underscores are allowed.
	//
	// Family is a required field
	Family *string `locationName:"family" type:"string" required:"true"`

	// The amount of memory (in MiB) used by the task. It can be expressed as an
	// integer using MiB, for example 1024, or as a string using GB, for example
	// 1GB or 1 GB, in a task definition but will be converted to an integer indicating
	// the MiB when the task definition is registered.
	//
	// Task-level CPU and memory parameters are ignored for Windows containers.
	// We recommend specifying container-level resources for Windows containers.
	//
	// If using the EC2 launch type, this field is optional.
	//
	// If using the Fargate launch type, this field is required and you must use
	// one of the following values, which determines your range of supported values
	// for the cpu parameter:
	//
	//    * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25
	//    vCPU)
	//
	//    * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values:
	//    512 (.5 vCPU)
	//
	//    * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168
	//    (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
	//
	//    * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
	//    Available cpu values: 2048 (2 vCPU)
	//
	//    * Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
	//    Available cpu values: 4096 (4 vCPU)
	Memory *string `locationName:"memory" type:"string"`

	// The Docker networking mode to use for the containers in the task. The valid
	// values are none, bridge, awsvpc, and host. The default Docker network mode
	// is bridge. If using the Fargate launch type, the awsvpc network mode is required.
	// If using the EC2 launch type, any network mode can be used. If the network
	// mode is set to none, you can't specify port mappings in your container definitions,
	// and the task's containers do not have external connectivity. The host and
	// awsvpc network modes offer the highest networking performance for containers
	// because they use the EC2 network stack instead of the virtualized network
	// stack provided by the bridge mode.
	//
	// With the host and awsvpc network modes, exposed container ports are mapped
	// directly to the corresponding host port (for the host network mode) or the
	// attached elastic network interface port (for the awsvpc network mode), so
	// you cannot take advantage of dynamic host port mappings.
	//
	// If the network mode is awsvpc, 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
	// (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// If the network mode is host, you can't run multiple instantiations of the
	// same task on a single container instance when port mappings are used.
	//
	// Docker for Windows uses different network modes than Docker for Linux. When
	// you register a task definition with Windows containers, you must not specify
	// a network mode.
	//
	// For more information, see Network settings (https://docs.docker.com/engine/reference/run/#network-settings)
	// in the Docker run reference.
	NetworkMode *string `locationName:"networkMode" type:"string" enum:"NetworkMode"`

	// An array of placement constraint objects to use for the task. You can specify
	// a maximum of 10 constraints per task (this limit includes constraints in
	// the task definition and those specified at run time).
	PlacementConstraints []*TaskDefinitionPlacementConstraint `locationName:"placementConstraints" type:"list"`

	// The launch type required by the task. If no value is specified, it defaults
	// to EC2.
	RequiresCompatibilities []*string `locationName:"requiresCompatibilities" type:"list"`

	// The short name or full Amazon Resource Name (ARN) of the IAM role that containers
	// in this task can assume. All containers in this task are granted the permissions
	// that are specified in this role. For more information, see IAM Roles for
	// Tasks (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html)
	// in the Amazon Elastic Container Service Developer Guide.
	TaskRoleArn *string `locationName:"taskRoleArn" type:"string"`

	// A list of volume definitions in JSON format that containers in your task
	// may use.
	Volumes []*Volume `locationName:"volumes" type:"list"`
	// contains filtered or unexported fields
}

func (RegisterTaskDefinitionInput) GoString added in v0.6.5 

func (s RegisterTaskDefinitionInput) GoString() string

GoString returns the string representation

func (*RegisterTaskDefinitionInput) SetContainerDefinitions added in v1.5.0 

func (s *RegisterTaskDefinitionInput) SetContainerDefinitions(v []*ContainerDefinition) *RegisterTaskDefinitionInput

SetContainerDefinitions sets the ContainerDefinitions field's value.

func (*RegisterTaskDefinitionInput) SetCpu added in v1.12.36 

func (s *RegisterTaskDefinitionInput) SetCpu(v string) *RegisterTaskDefinitionInput

SetCpu sets the Cpu field's value.

func (*RegisterTaskDefinitionInput) SetExecutionRoleArn added in v1.12.36 

func (s *RegisterTaskDefinitionInput) SetExecutionRoleArn(v string) *RegisterTaskDefinitionInput

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*RegisterTaskDefinitionInput) SetFamily added in v1.5.0 

func (s *RegisterTaskDefinitionInput) SetFamily(v string) *RegisterTaskDefinitionInput

SetFamily sets the Family field's value.

func (*RegisterTaskDefinitionInput) SetMemory added in v1.12.36 

func (s *RegisterTaskDefinitionInput) SetMemory(v string) *RegisterTaskDefinitionInput

SetMemory sets the Memory field's value.

func (*RegisterTaskDefinitionInput) SetNetworkMode added in v1.5.0 

func (s *RegisterTaskDefinitionInput) SetNetworkMode(v string) *RegisterTaskDefinitionInput

SetNetworkMode sets the NetworkMode field's value.

func (*RegisterTaskDefinitionInput) SetPlacementConstraints added in v1.6.9 

func (s *RegisterTaskDefinitionInput) SetPlacementConstraints(v []*TaskDefinitionPlacementConstraint) *RegisterTaskDefinitionInput

SetPlacementConstraints sets the PlacementConstraints field's value.

func (*RegisterTaskDefinitionInput) SetRequiresCompatibilities added in v1.12.36 

func (s *RegisterTaskDefinitionInput) SetRequiresCompatibilities(v []*string) *RegisterTaskDefinitionInput

SetRequiresCompatibilities sets the RequiresCompatibilities field's value.

func (*RegisterTaskDefinitionInput) SetTaskRoleArn added in v1.5.0 

func (s *RegisterTaskDefinitionInput) SetTaskRoleArn(v string) *RegisterTaskDefinitionInput

SetTaskRoleArn sets the TaskRoleArn field's value.

func (*RegisterTaskDefinitionInput) SetVolumes added in v1.5.0 

func (s *RegisterTaskDefinitionInput) SetVolumes(v []*Volume) *RegisterTaskDefinitionInput

SetVolumes sets the Volumes field's value.

func (RegisterTaskDefinitionInput) String added in v0.6.5 

func (s RegisterTaskDefinitionInput) String() string

String returns the string representation

func (*RegisterTaskDefinitionInput) Validate added in v1.1.21 

func (s *RegisterTaskDefinitionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterTaskDefinitionOutput 

type RegisterTaskDefinitionOutput struct {

	// The full description of the registered task definition.
	TaskDefinition *TaskDefinition `locationName:"taskDefinition" type:"structure"`
	// contains filtered or unexported fields
}

func (RegisterTaskDefinitionOutput) GoString added in v0.6.5 

func (s RegisterTaskDefinitionOutput) GoString() string

GoString returns the string representation

func (*RegisterTaskDefinitionOutput) SetTaskDefinition added in v1.5.0 

func (s *RegisterTaskDefinitionOutput) SetTaskDefinition(v *TaskDefinition) *RegisterTaskDefinitionOutput

SetTaskDefinition sets the TaskDefinition field's value.

func (RegisterTaskDefinitionOutput) String added in v0.6.5 

func (s RegisterTaskDefinitionOutput) String() string

String returns the string representation

type Resource 

type Resource struct {

	// When the doubleValue type is set, the value of the resource must be a double
	// precision floating-point type.
	DoubleValue *float64 `locationName:"doubleValue" type:"double"`

	// When the integerValue type is set, the value of the resource must be an integer.
	IntegerValue *int64 `locationName:"integerValue" type:"integer"`

	// When the longValue type is set, the value of the resource must be an extended
	// precision floating-point type.
	LongValue *int64 `locationName:"longValue" type:"long"`

	// The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, or a user-defined
	// resource.
	Name *string `locationName:"name" type:"string"`

	// When the stringSetValue type is set, the value of the resource must be a
	// string type.
	StringSetValue []*string `locationName:"stringSetValue" type:"list"`

	// The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET.
	Type *string `locationName:"type" type:"string"`
	// contains filtered or unexported fields
}

Describes the resources available for a container instance.

func (Resource) GoString added in v0.6.5 

func (s Resource) GoString() string

GoString returns the string representation

func (*Resource) SetDoubleValue added in v1.5.0 

func (s *Resource) SetDoubleValue(v float64) *Resource

SetDoubleValue sets the DoubleValue field's value.

func (*Resource) SetIntegerValue added in v1.5.0 

func (s *Resource) SetIntegerValue(v int64) *Resource

SetIntegerValue sets the IntegerValue field's value.

func (*Resource) SetLongValue added in v1.5.0 

func (s *Resource) SetLongValue(v int64) *Resource

SetLongValue sets the LongValue field's value.

func (*Resource) SetName added in v1.5.0 

func (s *Resource) SetName(v string) *Resource

SetName sets the Name field's value.

func (*Resource) SetStringSetValue added in v1.5.0 

func (s *Resource) SetStringSetValue(v []*string) *Resource

SetStringSetValue sets the StringSetValue field's value.

func (*Resource) SetType added in v1.5.0 

func (s *Resource) SetType(v string) *Resource

SetType sets the Type field's value.

func (Resource) String added in v0.6.5 

func (s Resource) String() string

String returns the string representation

type RunTaskInput 

type RunTaskInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster on which
	// to run your task. If you do not specify a cluster, the default cluster is
	// assumed.
	Cluster *string `locationName:"cluster" type:"string"`

	// The number of instantiations of the specified task to place on your cluster.
	// You can specify up to 10 tasks per call.
	Count *int64 `locationName:"count" type:"integer"`

	// The name of the task group to associate with the task. The default value
	// is the family name of the task definition (for example, family:my-family-name).
	Group *string `locationName:"group" type:"string"`

	// The launch type on which to run your task.
	LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"`

	// The network configuration for the task. This parameter is required for task
	// definitions that use the awsvpc network mode to receive their own Elastic
	// Network Interface, and it is not supported for other network modes. For more
	// information, see Task Networking (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html)
	// in the Amazon Elastic Container Service Developer Guide.
	NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"`

	// A list of container overrides in JSON format that specify the name of a container
	// in the specified task definition and the overrides it should receive. You
	// can override the default command for a container (that is specified in the
	// task definition or Docker image) with a command override. You can also override
	// existing environment variables (that are specified in the task definition
	// or Docker image) on a container or add new environment variables to it with
	// an environment override.
	//
	// A total of 8192 characters are allowed for overrides. This limit includes
	// the JSON formatting characters of the override structure.
	Overrides *TaskOverride `locationName:"overrides" type:"structure"`

	// An array of placement constraint objects to use for the task. You can specify
	// up to 10 constraints per task (including constraints in the task definition
	// and those specified at run time).
	PlacementConstraints []*PlacementConstraint `locationName:"placementConstraints" type:"list"`

	// The placement strategy objects to use for the task. You can specify a maximum
	// of five strategy rules per task.
	PlacementStrategy []*PlacementStrategy `locationName:"placementStrategy" type:"list"`

	// The platform version on which to run your task. If one is not specified,
	// the latest version is used by default.
	PlatformVersion *string `locationName:"platformVersion" type:"string"`

	// An optional tag specified when a task is started. For example if you automatically
	// trigger a task to run a batch process job, you could apply a unique identifier
	// for that job to your task with the startedBy parameter. You can then identify
	// which tasks belong to that job by filtering the results of a ListTasks call
	// with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers,
	// hyphens, and underscores are allowed.
	//
	// If a task is started by an Amazon ECS service, then the startedBy parameter
	// contains the deployment ID of the service that starts it.
	StartedBy *string `locationName:"startedBy" type:"string"`

	// The family and revision (family:revision) or full ARN of the task definition
	// to run. If a revision is not specified, the latest ACTIVE revision is used.
	//
	// TaskDefinition is a required field
	TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RunTaskInput) GoString added in v0.6.5 

func (s RunTaskInput) GoString() string

GoString returns the string representation

func (*RunTaskInput) SetCluster added in v1.5.0 

func (s *RunTaskInput) SetCluster(v string) *RunTaskInput

SetCluster sets the Cluster field's value.

func (*RunTaskInput) SetCount added in v1.5.0 

func (s *RunTaskInput) SetCount(v int64) *RunTaskInput

SetCount sets the Count field's value.

func (*RunTaskInput) SetGroup added in v1.6.9 

func (s *RunTaskInput) SetGroup(v string) *RunTaskInput

SetGroup sets the Group field's value.

func (*RunTaskInput) SetLaunchType added in v1.12.36 

func (s *RunTaskInput) SetLaunchType(v string) *RunTaskInput

SetLaunchType sets the LaunchType field's value.

func (*RunTaskInput) SetNetworkConfiguration added in v1.12.27 

func (s *RunTaskInput) SetNetworkConfiguration(v *NetworkConfiguration) *RunTaskInput

SetNetworkConfiguration sets the NetworkConfiguration field's value.

func (*RunTaskInput) SetOverrides added in v1.5.0 

func (s *RunTaskInput) SetOverrides(v *TaskOverride) *RunTaskInput

SetOverrides sets the Overrides field's value.

func (*RunTaskInput) SetPlacementConstraints added in v1.6.9 

func (s *RunTaskInput) SetPlacementConstraints(v []*PlacementConstraint) *RunTaskInput

SetPlacementConstraints sets the PlacementConstraints field's value.

func (*RunTaskInput) SetPlacementStrategy added in v1.6.9 

func (s *RunTaskInput) SetPlacementStrategy(v []*PlacementStrategy) *RunTaskInput

SetPlacementStrategy sets the PlacementStrategy field's value.

func (*RunTaskInput) SetPlatformVersion added in v1.12.36 

func (s *RunTaskInput) SetPlatformVersion(v string) *RunTaskInput

SetPlatformVersion sets the PlatformVersion field's value.

func (*RunTaskInput) SetStartedBy added in v1.5.0 

func (s *RunTaskInput) SetStartedBy(v string) *RunTaskInput

SetStartedBy sets the StartedBy field's value.

func (*RunTaskInput) SetTaskDefinition added in v1.5.0 

func (s *RunTaskInput) SetTaskDefinition(v string) *RunTaskInput

SetTaskDefinition sets the TaskDefinition field's value.

func (RunTaskInput) String added in v0.6.5 

func (s RunTaskInput) String() string

String returns the string representation

func (*RunTaskInput) Validate added in v1.1.21 

func (s *RunTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RunTaskOutput 

type RunTaskOutput struct {

	// Any failures associated with the call.
	Failures []*Failure `locationName:"failures" type:"list"`

	// A full description of the tasks that were run. The tasks that were successfully
	// placed on your cluster are described here.
	Tasks []*Task `locationName:"tasks" type:"list"`
	// contains filtered or unexported fields
}

func (RunTaskOutput) GoString added in v0.6.5 

func (s RunTaskOutput) GoString() string

GoString returns the string representation

func (*RunTaskOutput) SetFailures added in v1.5.0 

func (s *RunTaskOutput) SetFailures(v []*Failure) *RunTaskOutput

SetFailures sets the Failures field's value.

func (*RunTaskOutput) SetTasks added in v1.5.0 

func (s *RunTaskOutput) SetTasks(v []*Task) *RunTaskOutput

SetTasks sets the Tasks field's value.

func (RunTaskOutput) String added in v0.6.5 

func (s RunTaskOutput) String() string

String returns the string representation

type Service 

type Service struct {

	// The Amazon Resource Name (ARN) of the cluster that hosts the service.
	ClusterArn *string `locationName:"clusterArn" type:"string"`

	// The Unix time stamp for when the service was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"unix"`

	// Optional deployment parameters that control how many tasks run during the
	// deployment and the ordering of stopping and starting tasks.
	DeploymentConfiguration *DeploymentConfiguration `locationName:"deploymentConfiguration" type:"structure"`

	// The current state of deployments for the service.
	Deployments []*Deployment `locationName:"deployments" type:"list"`

	// The desired number of instantiations of the task definition to keep running
	// on the service. This value is specified when the service is created with
	// CreateService, and it can be modified with UpdateService.
	DesiredCount *int64 `locationName:"desiredCount" type:"integer"`

	// The event stream for your service. A maximum of 100 of the latest events
	// are displayed.
	Events []*ServiceEvent `locationName:"events" type:"list"`

	// The period of time, in seconds, that the Amazon ECS service scheduler ignores
	// unhealthy Elastic Load Balancing target health checks after a task has first
	// started.
	HealthCheckGracePeriodSeconds *int64 `locationName:"healthCheckGracePeriodSeconds" type:"integer"`

	// The launch type on which your service is running.
	LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"`

	// A list of Elastic Load Balancing load balancer objects, containing the load
	// balancer name, the container name (as it appears in a container definition),
	// and the container port to access from the load balancer.
	//
	// Services with tasks that use the awsvpc network mode (for example, those
	// with the Fargate launch type) only support Application Load Balancers and
	// Network Load Balancers; Classic Load Balancers are not supported. Also, when
	// you create any target groups for these services, you must choose ip as the
	// target type, not instance, because tasks that use the awsvpc network mode
	// are associated with an elastic network interface, not an Amazon EC2 instance.
	LoadBalancers []*LoadBalancer `locationName:"loadBalancers" type:"list"`

	// The VPC subnet and security group configuration for tasks that receive their
	// own Elastic Network Interface by using the awsvpc networking mode.
	NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"`

	// The number of tasks in the cluster that are in the PENDING state.
	PendingCount *int64 `locationName:"pendingCount" type:"integer"`

	// The placement constraints for the tasks in the service.
	PlacementConstraints []*PlacementConstraint `locationName:"placementConstraints" type:"list"`

	// The placement strategy that determines how tasks for the service are placed.
	PlacementStrategy []*PlacementStrategy `locationName:"placementStrategy" type:"list"`

	// The platform version on which your task is running. For more information,
	// see AWS Fargate Platform Versions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
	// in the Amazon Elastic Container Service Developer Guide.
	PlatformVersion *string `locationName:"platformVersion" type:"string"`

	// The ARN of the IAM role associated with the service that allows the Amazon
	// ECS container agent to register container instances with an Elastic Load
	// Balancing load balancer.
	RoleArn *string `locationName:"roleArn" type:"string"`

	// The number of tasks in the cluster that are in the RUNNING state.
	RunningCount *int64 `locationName:"runningCount" type:"integer"`

	// The scheduling strategy to use for the service. For more information, see
	// Services (http://docs.aws.amazon.com/AmazonECS/latest/developerguideecs_services.html).
	//
	// There are two service scheduler strategies available:
	//
	//    * REPLICA-The replica scheduling strategy places and maintains the 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.
	//
	//    * DAEMON-The daemon scheduling strategy deploys exactly one task on each
	//    container instance in your cluster. When using this strategy, do not specify
	//    a desired number of tasks or any task placement strategies.
	//
	// Fargate tasks do not support the DAEMON scheduling strategy.
	SchedulingStrategy *string `locationName:"schedulingStrategy" type:"string" enum:"SchedulingStrategy"`

	// The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace,
	// followed by the region of the service, the AWS account ID of the service
	// owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.
	ServiceArn *string `locationName:"serviceArn" type:"string"`

	// The name of your service. Up to 255 letters (uppercase and lowercase), numbers,
	// hyphens, and underscores are allowed. Service names must be unique within
	// a cluster, but you can have similarly named services in multiple clusters
	// within a region or across multiple regions.
	ServiceName *string `locationName:"serviceName" type:"string"`

	ServiceRegistries []*ServiceRegistry `locationName:"serviceRegistries" type:"list"`

	// The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.
	Status *string `locationName:"status" type:"string"`

	// The task definition to use for tasks in the service. This value is specified
	// when the service is created with CreateService, and it can be modified with
	// UpdateService.
	TaskDefinition *string `locationName:"taskDefinition" type:"string"`
	// contains filtered or unexported fields
}

Details on a service within a cluster

func (Service) GoString added in v0.6.5 

func (s Service) GoString() string

GoString returns the string representation

func (*Service) SetClusterArn added in v1.5.0 

func (s *Service) SetClusterArn(v string) *Service

SetClusterArn sets the ClusterArn field's value.

func (*Service) SetCreatedAt added in v1.5.0 

func (s *Service) SetCreatedAt(v time.Time) *Service

SetCreatedAt sets the CreatedAt field's value.

func (*Service) SetDeploymentConfiguration added in v1.5.0 

func (s *Service) SetDeploymentConfiguration(v *DeploymentConfiguration) *Service

SetDeploymentConfiguration sets the DeploymentConfiguration field's value.

func (*Service) SetDeployments added in v1.5.0 

func (s *Service) SetDeployments(v []*Deployment) *Service

SetDeployments sets the Deployments field's value.

func (*Service) SetDesiredCount added in v1.5.0 

func (s *Service) SetDesiredCount(v int64) *Service

SetDesiredCount sets the DesiredCount field's value.

func (*Service) SetEvents added in v1.5.0 

func (s *Service) SetEvents(v []*ServiceEvent) *Service

SetEvents sets the Events field's value.

func (*Service) SetHealthCheckGracePeriodSeconds added in v1.12.53 

func (s *Service) SetHealthCheckGracePeriodSeconds(v int64) *Service

SetHealthCheckGracePeriodSeconds sets the HealthCheckGracePeriodSeconds field's value.

func (*Service) SetLaunchType added in v1.12.36 

func (s *Service) SetLaunchType(v string) *Service

SetLaunchType sets the LaunchType field's value.

func (*Service) SetLoadBalancers added in v1.5.0 

func (s *Service) SetLoadBalancers(v []*LoadBalancer) *Service

SetLoadBalancers sets the LoadBalancers field's value.

func (*Service) SetNetworkConfiguration added in v1.12.27 

func (s *Service) SetNetworkConfiguration(v *NetworkConfiguration) *Service

SetNetworkConfiguration sets the NetworkConfiguration field's value.

func (*Service) SetPendingCount added in v1.5.0 

func (s *Service) SetPendingCount(v int64) *Service

SetPendingCount sets the PendingCount field's value.

func (*Service) SetPlacementConstraints added in v1.6.9 

func (s *Service) SetPlacementConstraints(v []*PlacementConstraint) *Service

SetPlacementConstraints sets the PlacementConstraints field's value.

func (*Service) SetPlacementStrategy added in v1.6.9 

func (s *Service) SetPlacementStrategy(v []*PlacementStrategy) *Service

SetPlacementStrategy sets the PlacementStrategy field's value.

func (*Service) SetPlatformVersion added in v1.12.36 

func (s *Service) SetPlatformVersion(v string) *Service

SetPlatformVersion sets the PlatformVersion field's value.

func (*Service) SetRoleArn added in v1.5.0 

func (s *Service) SetRoleArn(v string) *Service

SetRoleArn sets the RoleArn field's value.

func (*Service) SetRunningCount added in v1.5.0 

func (s *Service) SetRunningCount(v int64) *Service

SetRunningCount sets the RunningCount field's value.

func (*Service) SetSchedulingStrategy added in v1.14.5 

func (s *Service) SetSchedulingStrategy(v string) *Service

SetSchedulingStrategy sets the SchedulingStrategy field's value.

func (*Service) SetServiceArn added in v1.5.0 

func (s *Service) SetServiceArn(v string) *Service

SetServiceArn sets the ServiceArn field's value.

func (*Service) SetServiceName added in v1.5.0 

func (s *Service) SetServiceName(v string) *Service

SetServiceName sets the ServiceName field's value.

func (*Service) SetServiceRegistries added in v1.13.19 

func (s *Service) SetServiceRegistries(v []*ServiceRegistry) *Service

SetServiceRegistries sets the ServiceRegistries field's value.

func (*Service) SetStatus added in v1.5.0 

func (s *Service) SetStatus(v string) *Service

SetStatus sets the Status field's value.

func (*Service) SetTaskDefinition added in v1.5.0 

func (s *Service) SetTaskDefinition(v string) *Service

SetTaskDefinition sets the TaskDefinition field's value.

func (Service) String added in v0.6.5 

func (s Service) String() string

String returns the string representation

type ServiceEvent 

type ServiceEvent struct {

	// The Unix time stamp for when the event was triggered.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"unix"`

	// The ID string of the event.
	Id *string `locationName:"id" type:"string"`

	// The event message.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Details on an event associated with a service.

func (ServiceEvent) GoString added in v0.6.5 

func (s ServiceEvent) GoString() string

GoString returns the string representation

func (*ServiceEvent) SetCreatedAt added in v1.5.0 

func (s *ServiceEvent) SetCreatedAt(v time.Time) *ServiceEvent

SetCreatedAt sets the CreatedAt field's value.

func (*ServiceEvent) SetId added in v1.5.0 

func (s *ServiceEvent) SetId(v string) *ServiceEvent

SetId sets the Id field's value.

func (*ServiceEvent) SetMessage added in v1.5.0 

func (s *ServiceEvent) SetMessage(v string) *ServiceEvent

SetMessage sets the Message field's value.

func (ServiceEvent) String added in v0.6.5 

func (s ServiceEvent) String() string

String returns the string representation

type ServiceRegistry added in v1.13.19 

type ServiceRegistry struct {

	// The container name value, already specified in the task definition, to be
	// used for your service discovery service. If the task definition that your
	// service task specifies uses the bridge or host network mode, you must specify
	// a containerName and containerPort combination from the task definition. If
	// the task definition that your service task specifies uses the awsvpc network
	// mode and a type SRV DNS record is used, you must specify either a containerName
	// and containerPort combination or a port value, but not both.
	ContainerName *string `locationName:"containerName" type:"string"`

	// The port value, already specified in the task definition, to be used for
	// your service discovery service. If the task definition your service task
	// specifies uses the bridge or host network mode, you must specify a containerName
	// and containerPort combination from the task definition. If the task definition
	// your service task specifies uses the awsvpc network mode and a type SRV DNS
	// record is used, you must specify either a containerName and containerPort
	// combination or a port value, but not both.
	ContainerPort *int64 `locationName:"containerPort" type:"integer"`

	// The port value used if your service discovery service specified an SRV record.
	// This field is required if both the awsvpc network mode and SRV records are
	// used.
	Port *int64 `locationName:"port" type:"integer"`

	// The Amazon Resource Name (ARN) of the service registry. The currently supported
	// service registry is Amazon Route 53 Auto Naming. For more information, see
	// Service (https://docs.aws.amazon.com/Route53/latest/APIReference/API_autonaming_Service.html).
	RegistryArn *string `locationName:"registryArn" type:"string"`
	// contains filtered or unexported fields
}

Details of the service registry.

func (ServiceRegistry) GoString added in v1.13.19 

func (s ServiceRegistry) GoString() string

GoString returns the string representation

func (*ServiceRegistry) SetContainerName added in v1.13.54 

func (s *ServiceRegistry) SetContainerName(v string) *ServiceRegistry

SetContainerName sets the ContainerName field's value.

func (*ServiceRegistry) SetContainerPort added in v1.13.54 

func (s *ServiceRegistry) SetContainerPort(v int64) *ServiceRegistry

SetContainerPort sets the ContainerPort field's value.

func (*ServiceRegistry) SetPort added in v1.13.19 

func (s *ServiceRegistry) SetPort(v int64) *ServiceRegistry

SetPort sets the Port field's value.

func (*ServiceRegistry) SetRegistryArn added in v1.13.19 

func (s *ServiceRegistry) SetRegistryArn(v string) *ServiceRegistry

SetRegistryArn sets the RegistryArn field's value.

func (ServiceRegistry) String added in v1.13.19 

func (s ServiceRegistry) String() string

String returns the string representation

type StartTaskInput 

type StartTaskInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster on which
	// to start your task. If you do not specify a cluster, the default cluster
	// is assumed.
	Cluster *string `locationName:"cluster" type:"string"`

	// The container instance IDs or full ARN entries for the container instances
	// on which you would like to place your task. You can specify up to 10 container
	// instances.
	//
	// ContainerInstances is a required field
	ContainerInstances []*string `locationName:"containerInstances" type:"list" required:"true"`

	// The name of the task group to associate with the task. The default value
	// is the family name of the task definition (for example, family:my-family-name).
	Group *string `locationName:"group" type:"string"`

	// The VPC subnet and security group configuration for tasks that receive their
	// own Elastic Network Interface by using the awsvpc networking mode.
	NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"`

	// A list of container overrides in JSON format that specify the name of a container
	// in the specified task definition and the overrides it should receive. You
	// can override the default command for a container (that is specified in the
	// task definition or Docker image) with a command override. You can also override
	// existing environment variables (that are specified in the task definition
	// or Docker image) on a container or add new environment variables to it with
	// an environment override.
	//
	// A total of 8192 characters are allowed for overrides. This limit includes
	// the JSON formatting characters of the override structure.
	Overrides *TaskOverride `locationName:"overrides" type:"structure"`

	// An optional tag specified when a task is started. For example if you automatically
	// trigger a task to run a batch process job, you could apply a unique identifier
	// for that job to your task with the startedBy parameter. You can then identify
	// which tasks belong to that job by filtering the results of a ListTasks call
	// with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers,
	// hyphens, and underscores are allowed.
	//
	// If a task is started by an Amazon ECS service, then the startedBy parameter
	// contains the deployment ID of the service that starts it.
	StartedBy *string `locationName:"startedBy" type:"string"`

	// The family and revision (family:revision) or full ARN of the task definition
	// to start. If a revision is not specified, the latest ACTIVE revision is used.
	//
	// TaskDefinition is a required field
	TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartTaskInput) GoString added in v0.6.5 

func (s StartTaskInput) GoString() string

GoString returns the string representation

func (*StartTaskInput) SetCluster added in v1.5.0 

func (s *StartTaskInput) SetCluster(v string) *StartTaskInput

SetCluster sets the Cluster field's value.

func (*StartTaskInput) SetContainerInstances added in v1.5.0 

func (s *StartTaskInput) SetContainerInstances(v []*string) *StartTaskInput

SetContainerInstances sets the ContainerInstances field's value.

func (*StartTaskInput) SetGroup added in v1.6.9 

func (s *StartTaskInput) SetGroup(v string) *StartTaskInput

SetGroup sets the Group field's value.

func (*StartTaskInput) SetNetworkConfiguration added in v1.12.27 

func (s *StartTaskInput) SetNetworkConfiguration(v *NetworkConfiguration) *StartTaskInput

SetNetworkConfiguration sets the NetworkConfiguration field's value.

func (*StartTaskInput) SetOverrides added in v1.5.0 

func (s *StartTaskInput) SetOverrides(v *TaskOverride) *StartTaskInput

SetOverrides sets the Overrides field's value.

func (*StartTaskInput) SetStartedBy added in v1.5.0 

func (s *StartTaskInput) SetStartedBy(v string) *StartTaskInput

SetStartedBy sets the StartedBy field's value.

func (*StartTaskInput) SetTaskDefinition added in v1.5.0 

func (s *StartTaskInput) SetTaskDefinition(v string) *StartTaskInput

SetTaskDefinition sets the TaskDefinition field's value.

func (StartTaskInput) String added in v0.6.5 

func (s StartTaskInput) String() string

String returns the string representation

func (*StartTaskInput) Validate added in v1.1.21 

func (s *StartTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartTaskOutput 

type StartTaskOutput struct {

	// Any failures associated with the call.
	Failures []*Failure `locationName:"failures" type:"list"`

	// A full description of the tasks that were started. Each task that was successfully
	// placed on your container instances is described.
	Tasks []*Task `locationName:"tasks" type:"list"`
	// contains filtered or unexported fields
}

func (StartTaskOutput) GoString added in v0.6.5 

func (s StartTaskOutput) GoString() string

GoString returns the string representation

func (*StartTaskOutput) SetFailures added in v1.5.0 

func (s *StartTaskOutput) SetFailures(v []*Failure) *StartTaskOutput

SetFailures sets the Failures field's value.

func (*StartTaskOutput) SetTasks added in v1.5.0 

func (s *StartTaskOutput) SetTasks(v []*Task) *StartTaskOutput

SetTasks sets the Tasks field's value.

func (StartTaskOutput) String added in v0.6.5 

func (s StartTaskOutput) String() string

String returns the string representation

type StopTaskInput 

type StopTaskInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts
	// the task to stop. If you do not specify a cluster, the default cluster is
	// assumed.
	Cluster *string `locationName:"cluster" type:"string"`

	// An optional message specified when a task is stopped. For example, if you
	// are using a custom scheduler, you can use this parameter to specify the reason
	// for stopping the task here, and the message appears in subsequent DescribeTasks
	// API operations on this task. Up to 255 characters are allowed in this message.
	Reason *string `locationName:"reason" type:"string"`

	// The task ID or full ARN entry of the task to stop.
	//
	// Task is a required field
	Task *string `locationName:"task" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopTaskInput) GoString added in v0.6.5 

func (s StopTaskInput) GoString() string

GoString returns the string representation

func (*StopTaskInput) SetCluster added in v1.5.0 

func (s *StopTaskInput) SetCluster(v string) *StopTaskInput

SetCluster sets the Cluster field's value.

func (*StopTaskInput) SetReason added in v1.5.0 

func (s *StopTaskInput) SetReason(v string) *StopTaskInput

SetReason sets the Reason field's value.

func (*StopTaskInput) SetTask added in v1.5.0 

func (s *StopTaskInput) SetTask(v string) *StopTaskInput

SetTask sets the Task field's value.

func (StopTaskInput) String added in v0.6.5 

func (s StopTaskInput) String() string

String returns the string representation

func (*StopTaskInput) Validate added in v1.1.21 

func (s *StopTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopTaskOutput 

type StopTaskOutput struct {

	// The task that was stopped.
	Task *Task `locationName:"task" type:"structure"`
	// contains filtered or unexported fields
}

func (StopTaskOutput) GoString added in v0.6.5 

func (s StopTaskOutput) GoString() string

GoString returns the string representation

func (*StopTaskOutput) SetTask added in v1.5.0 

func (s *StopTaskOutput) SetTask(v *Task) *StopTaskOutput

SetTask sets the Task field's value.

func (StopTaskOutput) String added in v0.6.5 

func (s StopTaskOutput) String() string

String returns the string representation

type SubmitContainerStateChangeInput 

type SubmitContainerStateChangeInput struct {

	// The short name or full ARN of the cluster that hosts the container.
	Cluster *string `locationName:"cluster" type:"string"`

	// The name of the container.
	ContainerName *string `locationName:"containerName" type:"string"`

	// The exit code returned for the state change request.
	ExitCode *int64 `locationName:"exitCode" type:"integer"`

	// The network bindings of the container.
	NetworkBindings []*NetworkBinding `locationName:"networkBindings" type:"list"`

	// The reason for the state change request.
	Reason *string `locationName:"reason" type:"string"`

	// The status of the state change request.
	Status *string `locationName:"status" type:"string"`

	// The task ID or full Amazon Resource Name (ARN) of the task that hosts the
	// container.
	Task *string `locationName:"task" type:"string"`
	// contains filtered or unexported fields
}

func (SubmitContainerStateChangeInput) GoString added in v0.6.5 

func (s SubmitContainerStateChangeInput) GoString() string

GoString returns the string representation

func (*SubmitContainerStateChangeInput) SetCluster added in v1.5.0 

func (s *SubmitContainerStateChangeInput) SetCluster(v string) *SubmitContainerStateChangeInput

SetCluster sets the Cluster field's value.

func (*SubmitContainerStateChangeInput) SetContainerName added in v1.5.0 

func (s *SubmitContainerStateChangeInput) SetContainerName(v string) *SubmitContainerStateChangeInput

SetContainerName sets the ContainerName field's value.

func (*SubmitContainerStateChangeInput) SetExitCode added in v1.5.0 

func (s *SubmitContainerStateChangeInput) SetExitCode(v int64) *SubmitContainerStateChangeInput

SetExitCode sets the ExitCode field's value.

func (*SubmitContainerStateChangeInput) SetNetworkBindings added in v1.5.0 

func (s *SubmitContainerStateChangeInput) SetNetworkBindings(v []*NetworkBinding) *SubmitContainerStateChangeInput

SetNetworkBindings sets the NetworkBindings field's value.

func (*SubmitContainerStateChangeInput) SetReason added in v1.5.0 

func (s *SubmitContainerStateChangeInput) SetReason(v string) *SubmitContainerStateChangeInput

SetReason sets the Reason field's value.

func (*SubmitContainerStateChangeInput) SetStatus added in v1.5.0 

func (s *SubmitContainerStateChangeInput) SetStatus(v string) *SubmitContainerStateChangeInput

SetStatus sets the Status field's value.

func (*SubmitContainerStateChangeInput) SetTask added in v1.5.0 

func (s *SubmitContainerStateChangeInput) SetTask(v string) *SubmitContainerStateChangeInput

SetTask sets the Task field's value.

func (SubmitContainerStateChangeInput) String added in v0.6.5 

func (s SubmitContainerStateChangeInput) String() string

String returns the string representation

type SubmitContainerStateChangeOutput 

type SubmitContainerStateChangeOutput struct {

	// Acknowledgement of the state change.
	Acknowledgment *string `locationName:"acknowledgment" type:"string"`
	// contains filtered or unexported fields
}

func (SubmitContainerStateChangeOutput) GoString added in v0.6.5 

func (s SubmitContainerStateChangeOutput) GoString() string

GoString returns the string representation

func (*SubmitContainerStateChangeOutput) SetAcknowledgment added in v1.5.0 

func (s *SubmitContainerStateChangeOutput) SetAcknowledgment(v string) *SubmitContainerStateChangeOutput

SetAcknowledgment sets the Acknowledgment field's value.

func (SubmitContainerStateChangeOutput) String added in v0.6.5 

func (s SubmitContainerStateChangeOutput) String() string

String returns the string representation

type SubmitTaskStateChangeInput 

type SubmitTaskStateChangeInput struct {

	// Any attachments associated with the state change request.
	Attachments []*AttachmentStateChange `locationName:"attachments" type:"list"`

	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts
	// the task.
	Cluster *string `locationName:"cluster" type:"string"`

	// Any containers associated with the state change request.
	Containers []*ContainerStateChange `locationName:"containers" type:"list"`

	// The Unix time stamp for when the task execution stopped.
	ExecutionStoppedAt *time.Time `locationName:"executionStoppedAt" type:"timestamp" timestampFormat:"unix"`

	// The Unix time stamp for when the container image pull began.
	PullStartedAt *time.Time `locationName:"pullStartedAt" type:"timestamp" timestampFormat:"unix"`

	// The Unix time stamp for when the container image pull completed.
	PullStoppedAt *time.Time `locationName:"pullStoppedAt" type:"timestamp" timestampFormat:"unix"`

	// The reason for the state change request.
	Reason *string `locationName:"reason" type:"string"`

	// The status of the state change request.
	Status *string `locationName:"status" type:"string"`

	// The task ID or full ARN of the task in the state change request.
	Task *string `locationName:"task" type:"string"`
	// contains filtered or unexported fields
}

func (SubmitTaskStateChangeInput) GoString added in v0.6.5 

func (s SubmitTaskStateChangeInput) GoString() string

GoString returns the string representation

func (*SubmitTaskStateChangeInput) SetAttachments added in v1.12.27 

func (s *SubmitTaskStateChangeInput) SetAttachments(v []*AttachmentStateChange) *SubmitTaskStateChangeInput

SetAttachments sets the Attachments field's value.

func (*SubmitTaskStateChangeInput) SetCluster added in v1.5.0 

func (s *SubmitTaskStateChangeInput) SetCluster(v string) *SubmitTaskStateChangeInput

SetCluster sets the Cluster field's value.

func (*SubmitTaskStateChangeInput) SetContainers added in v1.12.27 

func (s *SubmitTaskStateChangeInput) SetContainers(v []*ContainerStateChange) *SubmitTaskStateChangeInput

SetContainers sets the Containers field's value.

func (*SubmitTaskStateChangeInput) SetExecutionStoppedAt added in v1.12.36 

func (s *SubmitTaskStateChangeInput) SetExecutionStoppedAt(v time.Time) *SubmitTaskStateChangeInput

SetExecutionStoppedAt sets the ExecutionStoppedAt field's value.

func (*SubmitTaskStateChangeInput) SetPullStartedAt added in v1.12.36 

func (s *SubmitTaskStateChangeInput) SetPullStartedAt(v time.Time) *SubmitTaskStateChangeInput

SetPullStartedAt sets the PullStartedAt field's value.

func (*SubmitTaskStateChangeInput) SetPullStoppedAt added in v1.12.36 

func (s *SubmitTaskStateChangeInput) SetPullStoppedAt(v time.Time) *SubmitTaskStateChangeInput

SetPullStoppedAt sets the PullStoppedAt field's value.

func (*SubmitTaskStateChangeInput) SetReason added in v1.5.0 

func (s *SubmitTaskStateChangeInput) SetReason(v string) *SubmitTaskStateChangeInput

SetReason sets the Reason field's value.

func (*SubmitTaskStateChangeInput) SetStatus added in v1.5.0 

func (s *SubmitTaskStateChangeInput) SetStatus(v string) *SubmitTaskStateChangeInput

SetStatus sets the Status field's value.

func (*SubmitTaskStateChangeInput) SetTask added in v1.5.0 

func (s *SubmitTaskStateChangeInput) SetTask(v string) *SubmitTaskStateChangeInput

SetTask sets the Task field's value.

func (SubmitTaskStateChangeInput) String added in v0.6.5 

func (s SubmitTaskStateChangeInput) String() string

String returns the string representation

func (*SubmitTaskStateChangeInput) Validate added in v1.12.27 

func (s *SubmitTaskStateChangeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SubmitTaskStateChangeOutput 

type SubmitTaskStateChangeOutput struct {

	// Acknowledgement of the state change.
	Acknowledgment *string `locationName:"acknowledgment" type:"string"`
	// contains filtered or unexported fields
}

func (SubmitTaskStateChangeOutput) GoString added in v0.6.5 

func (s SubmitTaskStateChangeOutput) GoString() string

GoString returns the string representation

func (*SubmitTaskStateChangeOutput) SetAcknowledgment added in v1.5.0 

func (s *SubmitTaskStateChangeOutput) SetAcknowledgment(v string) *SubmitTaskStateChangeOutput

SetAcknowledgment sets the Acknowledgment field's value.

func (SubmitTaskStateChangeOutput) String added in v0.6.5 

func (s SubmitTaskStateChangeOutput) String() string

String returns the string representation

type Task 

type Task struct {

	// The Elastic Network Adapter associated with the task if the task uses the
	// awsvpc network mode.
	Attachments []*Attachment `locationName:"attachments" type:"list"`

	// The ARN of the cluster that hosts the task.
	ClusterArn *string `locationName:"clusterArn" type:"string"`

	// The connectivity status of a task.
	Connectivity *string `locationName:"connectivity" type:"string" enum:"Connectivity"`

	// The Unix time stamp for when the task last went into CONNECTED status.
	ConnectivityAt *time.Time `locationName:"connectivityAt" type:"timestamp" timestampFormat:"unix"`

	// The ARN of the container instances that host the task.
	ContainerInstanceArn *string `locationName:"containerInstanceArn" type:"string"`

	// The containers associated with the task.
	Containers []*Container `locationName:"containers" type:"list"`

	// The number of CPU units used by the task. It can be expressed as an integer
	// using CPU units, for example 1024, or as a string using vCPUs, for example
	// 1 vCPU or 1 vcpu, in a task definition but is converted to an integer indicating
	// the CPU units when the task definition is registered.
	//
	// If using the EC2 launch type, this field is optional. Supported values are
	// between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
	//
	// If using the Fargate launch type, this field is required and you must use
	// one of the following values, which determines your range of supported values
	// for the memory parameter:
	//
	//    * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB),
	//    2048 (2 GB)
	//
	//    * 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072
	//    (3 GB), 4096 (4 GB)
	//
	//    * 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096
	//    (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
	//
	//    * 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384
	//    (16 GB) in increments of 1024 (1 GB)
	//
	//    * 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720
	//    (30 GB) in increments of 1024 (1 GB)
	Cpu *string `locationName:"cpu" type:"string"`

	// The Unix time stamp for when the task was created (the task entered the PENDING
	// state).
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"unix"`

	// The desired status of the task.
	DesiredStatus *string `locationName:"desiredStatus" type:"string"`

	// The Unix time stamp for when the task execution stopped.
	ExecutionStoppedAt *time.Time `locationName:"executionStoppedAt" type:"timestamp" timestampFormat:"unix"`

	// The name of the task group associated with the task.
	Group *string `locationName:"group" type:"string"`

	// The health status for the task, which is determined by the health of the
	// essential containers in the task. If all essential containers in the task
	// are reporting as HEALTHY, then the task status also reports as HEALTHY. If
	// any essential containers in the task are reporting as UNHEALTHY or UNKNOWN,
	// then the task status also reports as UNHEALTHY or UNKNOWN, accordingly.
	//
	// The Amazon ECS container agent does not monitor or report on Docker health
	// checks that are embedded in a container image (such as those specified in
	// a parent image or from the image's Dockerfile) and not specified in the container
	// definition. Health check parameters that are specified in a container definition
	// override any Docker health checks that exist in the container image.
	HealthStatus *string `locationName:"healthStatus" type:"string" enum:"HealthStatus"`

	// The last known status of the task.
	LastStatus *string `locationName:"lastStatus" type:"string"`

	// The launch type on which your task is running.
	LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"`

	// The amount of memory (in MiB) used by the task. It can be expressed as an
	// integer using MiB, for example 1024, or as a string using GB, for example
	// 1GB or 1 GB, in a task definition but is converted to an integer indicating
	// the MiB when the task definition is registered.
	//
	// If using the EC2 launch type, this field is optional.
	//
	// If using the Fargate launch type, this field is required and you must use
	// one of the following values, which determines your range of supported values
	// for the cpu parameter:
	//
	//    * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25
	//    vCPU)
	//
	//    * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values:
	//    512 (.5 vCPU)
	//
	//    * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168
	//    (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
	//
	//    * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
	//    Available cpu values: 2048 (2 vCPU)
	//
	//    * Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
	//    Available cpu values: 4096 (4 vCPU)
	Memory *string `locationName:"memory" type:"string"`

	// One or more container overrides.
	Overrides *TaskOverride `locationName:"overrides" type:"structure"`

	// The platform version on which your task is running. For more information,
	// see AWS Fargate Platform Versions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
	// in the Amazon Elastic Container Service Developer Guide.
	PlatformVersion *string `locationName:"platformVersion" type:"string"`

	// The Unix time stamp for when the container image pull began.
	PullStartedAt *time.Time `locationName:"pullStartedAt" type:"timestamp" timestampFormat:"unix"`

	// The Unix time stamp for when the container image pull completed.
	PullStoppedAt *time.Time `locationName:"pullStoppedAt" type:"timestamp" timestampFormat:"unix"`

	// The Unix time stamp for when the task started (the task transitioned from
	// the PENDING state to the RUNNING state).
	StartedAt *time.Time `locationName:"startedAt" type:"timestamp" timestampFormat:"unix"`

	// The tag specified when a task is started. If the task is started by an Amazon
	// ECS service, then the startedBy parameter contains the deployment ID of the
	// service that starts it.
	StartedBy *string `locationName:"startedBy" type:"string"`

	// The Unix time stamp for when the task was stopped (the task transitioned
	// from the RUNNING state to the STOPPED state).
	StoppedAt *time.Time `locationName:"stoppedAt" type:"timestamp" timestampFormat:"unix"`

	// The reason the task was stopped.
	StoppedReason *string `locationName:"stoppedReason" type:"string"`

	// The Unix time stamp for when the task will stop (transitions from the RUNNING
	// state to STOPPED).
	StoppingAt *time.Time `locationName:"stoppingAt" type:"timestamp" timestampFormat:"unix"`

	// The Amazon Resource Name (ARN) of the task.
	TaskArn *string `locationName:"taskArn" type:"string"`

	// The ARN of the task definition that creates the task.
	TaskDefinitionArn *string `locationName:"taskDefinitionArn" type:"string"`

	// The version counter for the task. Every time a task experiences a change
	// that triggers a CloudWatch event, the version counter is incremented. If
	// you are replicating your Amazon ECS task state with CloudWatch Events, you
	// can compare the version of a task reported by the Amazon ECS APIs with the
	// version reported in CloudWatch Events for the task (inside the detail object)
	// to verify that the version in your event stream is current.
	Version *int64 `locationName:"version" type:"long"`
	// contains filtered or unexported fields
}

Details on a task in a cluster.

func (Task) GoString added in v0.6.5 

func (s Task) GoString() string

GoString returns the string representation

func (*Task) SetAttachments added in v1.12.27 

func (s *Task) SetAttachments(v []*Attachment) *Task

SetAttachments sets the Attachments field's value.

func (*Task) SetClusterArn added in v1.5.0 

func (s *Task) SetClusterArn(v string) *Task

SetClusterArn sets the ClusterArn field's value.

func (*Task) SetConnectivity added in v1.12.36 

func (s *Task) SetConnectivity(v string) *Task

SetConnectivity sets the Connectivity field's value.

func (*Task) SetConnectivityAt added in v1.12.36 

func (s *Task) SetConnectivityAt(v time.Time) *Task

SetConnectivityAt sets the ConnectivityAt field's value.

func (*Task) SetContainerInstanceArn added in v1.5.0 

func (s *Task) SetContainerInstanceArn(v string) *Task

SetContainerInstanceArn sets the ContainerInstanceArn field's value.

func (*Task) SetContainers added in v1.5.0 

func (s *Task) SetContainers(v []*Container) *Task

SetContainers sets the Containers field's value.

func (*Task) SetCpu added in v1.12.36 

func (s *Task) SetCpu(v string) *Task

SetCpu sets the Cpu field's value.

func (*Task) SetCreatedAt added in v1.5.0 

func (s *Task) SetCreatedAt(v time.Time) *Task

SetCreatedAt sets the CreatedAt field's value.

func (*Task) SetDesiredStatus added in v1.5.0 

func (s *Task) SetDesiredStatus(v string) *Task

SetDesiredStatus sets the DesiredStatus field's value.

func (*Task) SetExecutionStoppedAt added in v1.12.36 

func (s *Task) SetExecutionStoppedAt(v time.Time) *Task

SetExecutionStoppedAt sets the ExecutionStoppedAt field's value.

func (*Task) SetGroup added in v1.6.9 

func (s *Task) SetGroup(v string) *Task

SetGroup sets the Group field's value.

func (*Task) SetHealthStatus added in v1.13.11 

func (s *Task) SetHealthStatus(v string) *Task

SetHealthStatus sets the HealthStatus field's value.

func (*Task) SetLastStatus added in v1.5.0 

func (s *Task) SetLastStatus(v string) *Task

SetLastStatus sets the LastStatus field's value.

func (*Task) SetLaunchType added in v1.12.36 

func (s *Task) SetLaunchType(v string) *Task

SetLaunchType sets the LaunchType field's value.

func (*Task) SetMemory added in v1.12.36 

func (s *Task) SetMemory(v string) *Task

SetMemory sets the Memory field's value.

func (*Task) SetOverrides added in v1.5.0 

func (s *Task) SetOverrides(v *TaskOverride) *Task

SetOverrides sets the Overrides field's value.

func (*Task) SetPlatformVersion added in v1.12.36 

func (s *Task) SetPlatformVersion(v string) *Task

SetPlatformVersion sets the PlatformVersion field's value.

func (*Task) SetPullStartedAt added in v1.12.36 

func (s *Task) SetPullStartedAt(v time.Time) *Task

SetPullStartedAt sets the PullStartedAt field's value.

func (*Task) SetPullStoppedAt added in v1.12.36 

func (s *Task) SetPullStoppedAt(v time.Time) *Task

SetPullStoppedAt sets the PullStoppedAt field's value.

func (*Task) SetStartedAt added in v1.5.0 

func (s *Task) SetStartedAt(v time.Time) *Task

SetStartedAt sets the StartedAt field's value.

func (*Task) SetStartedBy added in v1.5.0 

func (s *Task) SetStartedBy(v string) *Task

SetStartedBy sets the StartedBy field's value.

func (*Task) SetStoppedAt added in v1.5.0 

func (s *Task) SetStoppedAt(v time.Time) *Task

SetStoppedAt sets the StoppedAt field's value.

func (*Task) SetStoppedReason added in v1.5.0 

func (s *Task) SetStoppedReason(v string) *Task

SetStoppedReason sets the StoppedReason field's value.

func (*Task) SetStoppingAt added in v1.12.36 

func (s *Task) SetStoppingAt(v time.Time) *Task

SetStoppingAt sets the StoppingAt field's value.

func (*Task) SetTaskArn added in v1.5.0 

func (s *Task) SetTaskArn(v string) *Task

SetTaskArn sets the TaskArn field's value.

func (*Task) SetTaskDefinitionArn added in v1.5.0 

func (s *Task) SetTaskDefinitionArn(v string) *Task

SetTaskDefinitionArn sets the TaskDefinitionArn field's value.

func (*Task) SetVersion added in v1.5.9 

func (s *Task) SetVersion(v int64) *Task

SetVersion sets the Version field's value.

func (Task) String added in v0.6.5 

func (s Task) String() string

String returns the string representation

type TaskDefinition 

type TaskDefinition struct {

	// The launch type to use with your task. For more information, see Amazon ECS
	// Launch Types (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)
	// in the Amazon Elastic Container Service Developer Guide.
	Compatibilities []*string `locationName:"compatibilities" type:"list"`

	// A list of container definitions in JSON format that describe the different
	// containers that make up your task. For more information about container definition
	// parameters and defaults, see Amazon ECS Task Definitions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html)
	// in the Amazon Elastic Container Service Developer Guide.
	ContainerDefinitions []*ContainerDefinition `locationName:"containerDefinitions" type:"list"`

	// The number of cpu units used by the task. If using the EC2 launch type, this
	// field is optional and any value can be used. If using the Fargate launch
	// type, this field is required and you must use one of the following values,
	// which determines your range of valid values for the memory parameter:
	//
	//    * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB),
	//    2048 (2 GB)
	//
	//    * 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072
	//    (3 GB), 4096 (4 GB)
	//
	//    * 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096
	//    (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
	//
	//    * 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384
	//    (16 GB) in increments of 1024 (1 GB)
	//
	//    * 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720
	//    (30 GB) in increments of 1024 (1 GB)
	Cpu *string `locationName:"cpu" type:"string"`

	// The Amazon Resource Name (ARN) of the task execution role that the Amazon
	// ECS container agent and the Docker daemon can assume.
	ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string"`

	// The family of your task definition, used as the definition name.
	Family *string `locationName:"family" type:"string"`

	// The amount (in MiB) of memory used by the task. If using the EC2 launch type,
	// this field is optional and any value can be used. If using the Fargate launch
	// type, this field is required and you must use one of the following values,
	// which determines your range of valid values for the cpu parameter:
	//
	//    * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25
	//    vCPU)
	//
	//    * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values:
	//    512 (.5 vCPU)
	//
	//    * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168
	//    (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
	//
	//    * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
	//    Available cpu values: 2048 (2 vCPU)
	//
	//    * Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
	//    Available cpu values: 4096 (4 vCPU)
	Memory *string `locationName:"memory" type:"string"`

	// The Docker networking mode to use for the containers in the task. The valid
	// values are none, bridge, awsvpc, and host. The default Docker network mode
	// is bridge. If using the Fargate launch type, the awsvpc network mode is required.
	// If using the EC2 launch type, any network mode can be used. If the network
	// mode is set to none, you can't specify port mappings in your container definitions,
	// and the task's containers do not have external connectivity. The host and
	// awsvpc network modes offer the highest networking performance for containers
	// because they use the EC2 network stack instead of the virtualized network
	// stack provided by the bridge mode.
	//
	// With the host and awsvpc network modes, exposed container ports are mapped
	// directly to the corresponding host port (for the host network mode) or the
	// attached elastic network interface port (for the awsvpc network mode), so
	// you cannot take advantage of dynamic host port mappings.
	//
	// If the network mode is awsvpc, 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
	// (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// Currently, only the Amazon ECS-optimized AMI, other Amazon Linux variants
	// with the ecs-init package, or AWS Fargate infrastructure support the awsvpc
	// network mode.
	//
	// If the network mode is host, you can't run multiple instantiations of the
	// same task on a single container instance when port mappings are used.
	//
	// Docker for Windows uses different network modes than Docker for Linux. When
	// you register a task definition with Windows containers, you must not specify
	// a network mode. If you use the console to register a task definition with
	// Windows containers, you must choose the <default> network mode object.
	//
	// For more information, see Network settings (https://docs.docker.com/engine/reference/run/#network-settings)
	// in the Docker run reference.
	NetworkMode *string `locationName:"networkMode" type:"string" enum:"NetworkMode"`

	// An array of placement constraint objects to use for tasks. This field is
	// not valid if using the Fargate launch type for your task.
	PlacementConstraints []*TaskDefinitionPlacementConstraint `locationName:"placementConstraints" type:"list"`

	// The container instance attributes required by your task. This field is not
	// valid if using the Fargate launch type for your task.
	RequiresAttributes []*Attribute `locationName:"requiresAttributes" type:"list"`

	// The launch type the task is using.
	RequiresCompatibilities []*string `locationName:"requiresCompatibilities" type:"list"`

	// The revision of the task in a particular family. The revision is a version
	// number of a task definition in a family. When you register a task definition
	// for the first time, the revision is 1; each time you register a new revision
	// of a task definition in the same family, the revision value always increases
	// by one (even if you have deregistered previous revisions in this family).
	Revision *int64 `locationName:"revision" type:"integer"`

	// The status of the task definition.
	Status *string `locationName:"status" type:"string" enum:"TaskDefinitionStatus"`

	// The full Amazon Resource Name (ARN) of the task definition.
	TaskDefinitionArn *string `locationName:"taskDefinitionArn" type:"string"`

	// The ARN of the IAM role that containers in this task can assume. All containers
	// in this task are granted the permissions that are specified in this role.
	//
	// IAM roles for tasks on Windows require that the -EnableTaskIAMRole option
	// is set when you launch the Amazon ECS-optimized Windows AMI. Your containers
	// must also run some configuration code in order to take advantage of the feature.
	// For more information, see Windows IAM Roles for Tasks (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html)
	// in the Amazon Elastic Container Service Developer Guide.
	TaskRoleArn *string `locationName:"taskRoleArn" type:"string"`

	// The list of volumes in a task.
	//
	// If you are using the Fargate launch type, the host and sourcePath parameters
	// are not supported.
	//
	// For more information about volume definition parameters and defaults, see
	// Amazon ECS Task Definitions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)
	// in the Amazon Elastic Container Service Developer Guide.
	Volumes []*Volume `locationName:"volumes" type:"list"`
	// contains filtered or unexported fields
}

Details of a task definition.

func (TaskDefinition) GoString added in v0.6.5 

func (s TaskDefinition) GoString() string

GoString returns the string representation

func (*TaskDefinition) SetCompatibilities added in v1.12.36 

func (s *TaskDefinition) SetCompatibilities(v []*string) *TaskDefinition

SetCompatibilities sets the Compatibilities field's value.

func (*TaskDefinition) SetContainerDefinitions added in v1.5.0 

func (s *TaskDefinition) SetContainerDefinitions(v []*ContainerDefinition) *TaskDefinition

SetContainerDefinitions sets the ContainerDefinitions field's value.

func (*TaskDefinition) SetCpu added in v1.12.36 

func (s *TaskDefinition) SetCpu(v string) *TaskDefinition

SetCpu sets the Cpu field's value.

func (*TaskDefinition) SetExecutionRoleArn added in v1.12.36 

func (s *TaskDefinition) SetExecutionRoleArn(v string) *TaskDefinition

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*TaskDefinition) SetFamily added in v1.5.0 

func (s *TaskDefinition) SetFamily(v string) *TaskDefinition

SetFamily sets the Family field's value.

func (*TaskDefinition) SetMemory added in v1.12.36 

func (s *TaskDefinition) SetMemory(v string) *TaskDefinition

SetMemory sets the Memory field's value.

func (*TaskDefinition) SetNetworkMode added in v1.5.0 

func (s *TaskDefinition) SetNetworkMode(v string) *TaskDefinition

SetNetworkMode sets the NetworkMode field's value.

func (*TaskDefinition) SetPlacementConstraints added in v1.6.9 

func (s *TaskDefinition) SetPlacementConstraints(v []*TaskDefinitionPlacementConstraint) *TaskDefinition

SetPlacementConstraints sets the PlacementConstraints field's value.

func (*TaskDefinition) SetRequiresAttributes added in v1.5.0 

func (s *TaskDefinition) SetRequiresAttributes(v []*Attribute) *TaskDefinition

SetRequiresAttributes sets the RequiresAttributes field's value.

func (*TaskDefinition) SetRequiresCompatibilities added in v1.12.36 

func (s *TaskDefinition) SetRequiresCompatibilities(v []*string) *TaskDefinition

SetRequiresCompatibilities sets the RequiresCompatibilities field's value.

func (*TaskDefinition) SetRevision added in v1.5.0 

func (s *TaskDefinition) SetRevision(v int64) *TaskDefinition

SetRevision sets the Revision field's value.

func (*TaskDefinition) SetStatus added in v1.5.0 

func (s *TaskDefinition) SetStatus(v string) *TaskDefinition

SetStatus sets the Status field's value.

func (*TaskDefinition) SetTaskDefinitionArn added in v1.5.0 

func (s *TaskDefinition) SetTaskDefinitionArn(v string) *TaskDefinition

SetTaskDefinitionArn sets the TaskDefinitionArn field's value.

func (*TaskDefinition) SetTaskRoleArn added in v1.5.0 

func (s *TaskDefinition) SetTaskRoleArn(v string) *TaskDefinition

SetTaskRoleArn sets the TaskRoleArn field's value.

func (*TaskDefinition) SetVolumes added in v1.5.0 

func (s *TaskDefinition) SetVolumes(v []*Volume) *TaskDefinition

SetVolumes sets the Volumes field's value.

func (TaskDefinition) String added in v0.6.5 

func (s TaskDefinition) String() string

String returns the string representation

type TaskDefinitionPlacementConstraint added in v1.6.9 

type TaskDefinitionPlacementConstraint struct {

	// A cluster query language expression to apply to the constraint. For more
	// information, see Cluster Query Language (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html)
	// in the Amazon Elastic Container Service Developer Guide.
	Expression *string `locationName:"expression" type:"string"`

	// The type of constraint. The DistinctInstance constraint ensures that each
	// task in a particular group is running on a different container instance.
	// The MemberOf constraint restricts selection to be from a group of valid candidates.
	Type *string `locationName:"type" type:"string" enum:"TaskDefinitionPlacementConstraintType"`
	// contains filtered or unexported fields
}

An object representing a constraint on task placement in the task definition.

If you are using the Fargate launch type, task placement constraints are not supported.

For more information, see Task Placement Constraints (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the Amazon Elastic Container Service Developer Guide.

func (TaskDefinitionPlacementConstraint) GoString added in v1.6.9 

func (s TaskDefinitionPlacementConstraint) GoString() string

GoString returns the string representation

func (*TaskDefinitionPlacementConstraint) SetExpression added in v1.6.9 

func (s *TaskDefinitionPlacementConstraint) SetExpression(v string) *TaskDefinitionPlacementConstraint

SetExpression sets the Expression field's value.

func (*TaskDefinitionPlacementConstraint) SetType added in v1.6.9 

func (s *TaskDefinitionPlacementConstraint) SetType(v string) *TaskDefinitionPlacementConstraint

SetType sets the Type field's value.

func (TaskDefinitionPlacementConstraint) String added in v1.6.9 

func (s TaskDefinitionPlacementConstraint) String() string

String returns the string representation

type TaskOverride 

type TaskOverride struct {

	// One or more container overrides sent to a task.
	ContainerOverrides []*ContainerOverride `locationName:"containerOverrides" type:"list"`

	// The Amazon Resource Name (ARN) of the task execution role that the Amazon
	// ECS container agent and the Docker daemon can assume.
	ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string"`

	// The Amazon Resource Name (ARN) of the IAM role that containers in this task
	// can assume. All containers in this task are granted the permissions that
	// are specified in this role.
	TaskRoleArn *string `locationName:"taskRoleArn" type:"string"`
	// contains filtered or unexported fields
}

The overrides associated with a task.

func (TaskOverride) GoString added in v0.6.5 

func (s TaskOverride) GoString() string

GoString returns the string representation

func (*TaskOverride) SetContainerOverrides added in v1.5.0 

func (s *TaskOverride) SetContainerOverrides(v []*ContainerOverride) *TaskOverride

SetContainerOverrides sets the ContainerOverrides field's value.

func (*TaskOverride) SetExecutionRoleArn added in v1.12.36 

func (s *TaskOverride) SetExecutionRoleArn(v string) *TaskOverride

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*TaskOverride) SetTaskRoleArn added in v1.5.0 

func (s *TaskOverride) SetTaskRoleArn(v string) *TaskOverride

SetTaskRoleArn sets the TaskRoleArn field's value.

func (TaskOverride) String added in v0.6.5 

func (s TaskOverride) String() string

String returns the string representation

type Tmpfs added in v1.13.17 

type Tmpfs struct {

	// The absolute file path where the tmpfs volume will be mounted.
	//
	// ContainerPath is a required field
	ContainerPath *string `locationName:"containerPath" type:"string" required:"true"`

	// The list of tmpfs volume mount options.
	//
	// Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev"
	// | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" |
	// "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind"
	// | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared"
	// | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime"
	MountOptions []*string `locationName:"mountOptions" type:"list"`

	// The size (in MiB) of the tmpfs volume.
	//
	// Size is a required field
	Size *int64 `locationName:"size" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

The container path, mount options, and size of the tmpfs mount.

func (Tmpfs) GoString added in v1.13.17 

func (s Tmpfs) GoString() string

GoString returns the string representation

func (*Tmpfs) SetContainerPath added in v1.13.17 

func (s *Tmpfs) SetContainerPath(v string) *Tmpfs

SetContainerPath sets the ContainerPath field's value.

func (*Tmpfs) SetMountOptions added in v1.13.17 

func (s *Tmpfs) SetMountOptions(v []*string) *Tmpfs

SetMountOptions sets the MountOptions field's value.

func (*Tmpfs) SetSize added in v1.13.17 

func (s *Tmpfs) SetSize(v int64) *Tmpfs

SetSize sets the Size field's value.

func (Tmpfs) String added in v1.13.17 

func (s Tmpfs) String() string

String returns the string representation

func (*Tmpfs) Validate added in v1.13.17 

func (s *Tmpfs) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Ulimit added in v0.9.14 

type Ulimit struct {

	// The hard limit for the ulimit type.
	//
	// HardLimit is a required field
	HardLimit *int64 `locationName:"hardLimit" type:"integer" required:"true"`

	// The type of the ulimit.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true" enum:"UlimitName"`

	// The soft limit for the ulimit type.
	//
	// SoftLimit is a required field
	SoftLimit *int64 `locationName:"softLimit" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

The ulimit settings to pass to the container.

func (Ulimit) GoString added in v0.9.14 

func (s Ulimit) GoString() string

GoString returns the string representation

func (*Ulimit) SetHardLimit added in v1.5.0 

func (s *Ulimit) SetHardLimit(v int64) *Ulimit

SetHardLimit sets the HardLimit field's value.

func (*Ulimit) SetName added in v1.5.0 

func (s *Ulimit) SetName(v string) *Ulimit

SetName sets the Name field's value.

func (*Ulimit) SetSoftLimit added in v1.5.0 

func (s *Ulimit) SetSoftLimit(v int64) *Ulimit

SetSoftLimit sets the SoftLimit field's value.

func (Ulimit) String added in v0.9.14 

func (s Ulimit) String() string

String returns the string representation

func (*Ulimit) Validate added in v1.1.21 

func (s *Ulimit) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateContainerAgentInput added in v0.6.2 

type UpdateContainerAgentInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that your
	// container instance is running on. If you do not specify a cluster, the default
	// cluster is assumed.
	Cluster *string `locationName:"cluster" type:"string"`

	// The container instance ID or full ARN entries for the container instance
	// on which you would like to update the Amazon ECS container agent.
	//
	// ContainerInstance is a required field
	ContainerInstance *string `locationName:"containerInstance" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateContainerAgentInput) GoString added in v0.6.5 

func (s UpdateContainerAgentInput) GoString() string

GoString returns the string representation

func (*UpdateContainerAgentInput) SetCluster added in v1.5.0 

func (s *UpdateContainerAgentInput) SetCluster(v string) *UpdateContainerAgentInput

SetCluster sets the Cluster field's value.

func (*UpdateContainerAgentInput) SetContainerInstance added in v1.5.0 

func (s *UpdateContainerAgentInput) SetContainerInstance(v string) *UpdateContainerAgentInput

SetContainerInstance sets the ContainerInstance field's value.

func (UpdateContainerAgentInput) String added in v0.6.5 

func (s UpdateContainerAgentInput) String() string

String returns the string representation

func (*UpdateContainerAgentInput) Validate added in v1.1.21 

func (s *UpdateContainerAgentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateContainerAgentOutput added in v0.6.2 

type UpdateContainerAgentOutput struct {

	// The container instance for which the container agent was updated.
	ContainerInstance *ContainerInstance `locationName:"containerInstance" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateContainerAgentOutput) GoString added in v0.6.5 

func (s UpdateContainerAgentOutput) GoString() string

GoString returns the string representation

func (*UpdateContainerAgentOutput) SetContainerInstance added in v1.5.0 

func (s *UpdateContainerAgentOutput) SetContainerInstance(v *ContainerInstance) *UpdateContainerAgentOutput

SetContainerInstance sets the ContainerInstance field's value.

func (UpdateContainerAgentOutput) String added in v0.6.5 

func (s UpdateContainerAgentOutput) String() string

String returns the string representation

type UpdateContainerInstancesStateInput added in v1.6.16 

type UpdateContainerInstancesStateInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts
	// the container instance to update. If you do not specify a cluster, the default
	// cluster is assumed.
	Cluster *string `locationName:"cluster" type:"string"`

	// A list of container instance IDs or full ARN entries.
	//
	// ContainerInstances is a required field
	ContainerInstances []*string `locationName:"containerInstances" type:"list" required:"true"`

	// The container instance state with which to update the container instance.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"ContainerInstanceStatus"`
	// contains filtered or unexported fields
}

func (UpdateContainerInstancesStateInput) GoString added in v1.6.16 

func (s UpdateContainerInstancesStateInput) GoString() string

GoString returns the string representation

func (*UpdateContainerInstancesStateInput) SetCluster added in v1.6.16 

func (s *UpdateContainerInstancesStateInput) SetCluster(v string) *UpdateContainerInstancesStateInput

SetCluster sets the Cluster field's value.

func (*UpdateContainerInstancesStateInput) SetContainerInstances added in v1.6.16 

func (s *UpdateContainerInstancesStateInput) SetContainerInstances(v []*string) *UpdateContainerInstancesStateInput

SetContainerInstances sets the ContainerInstances field's value.

func (*UpdateContainerInstancesStateInput) SetStatus added in v1.6.16 

func (s *UpdateContainerInstancesStateInput) SetStatus(v string) *UpdateContainerInstancesStateInput

SetStatus sets the Status field's value.

func (UpdateContainerInstancesStateInput) String added in v1.6.16 

func (s UpdateContainerInstancesStateInput) String() string

String returns the string representation

func (*UpdateContainerInstancesStateInput) Validate added in v1.6.16 

func (s *UpdateContainerInstancesStateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateContainerInstancesStateOutput added in v1.6.16 

type UpdateContainerInstancesStateOutput struct {

	// The list of container instances.
	ContainerInstances []*ContainerInstance `locationName:"containerInstances" type:"list"`

	// Any failures associated with the call.
	Failures []*Failure `locationName:"failures" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateContainerInstancesStateOutput) GoString added in v1.6.16 

func (s UpdateContainerInstancesStateOutput) GoString() string

GoString returns the string representation

func (*UpdateContainerInstancesStateOutput) SetContainerInstances added in v1.6.16 

func (s *UpdateContainerInstancesStateOutput) SetContainerInstances(v []*ContainerInstance) *UpdateContainerInstancesStateOutput

SetContainerInstances sets the ContainerInstances field's value.

func (*UpdateContainerInstancesStateOutput) SetFailures added in v1.6.16 

func (s *UpdateContainerInstancesStateOutput) SetFailures(v []*Failure) *UpdateContainerInstancesStateOutput

SetFailures sets the Failures field's value.

func (UpdateContainerInstancesStateOutput) String added in v1.6.16 

func (s UpdateContainerInstancesStateOutput) String() string

String returns the string representation

type UpdateServiceInput 

type UpdateServiceInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that your
	// service is running on. If you do not specify a cluster, the default cluster
	// is assumed.
	Cluster *string `locationName:"cluster" type:"string"`

	// Optional deployment parameters that control how many tasks run during the
	// deployment and the ordering of stopping and starting tasks.
	DeploymentConfiguration *DeploymentConfiguration `locationName:"deploymentConfiguration" type:"structure"`

	// The number of instantiations of the task to place and keep running in your
	// service.
	DesiredCount *int64 `locationName:"desiredCount" type:"integer"`

	// Whether to force a new deployment of the service. Deployments are not forced
	// by default. You can use this option to trigger a new deployment with no service
	// definition changes. For example, you can update a service's tasks to use
	// a newer Docker image with the same image/tag combination (my_image:latest)
	// or to roll Fargate tasks onto a newer platform version.
	ForceNewDeployment *bool `locationName:"forceNewDeployment" type:"boolean"`

	// The period of time, in seconds, that the Amazon ECS service scheduler should
	// ignore unhealthy Elastic Load Balancing target health checks after a task
	// has first started. This is only valid if your service is configured to use
	// a load balancer. If your service's tasks take a while to start and respond
	// to Elastic Load Balancing health checks, you can specify a health check grace
	// period of up to 1,800 seconds during which the ECS service scheduler ignores
	// the Elastic Load Balancing health check status. This grace period can prevent
	// the ECS service scheduler from marking tasks as unhealthy and stopping them
	// before they have time to come up.
	HealthCheckGracePeriodSeconds *int64 `locationName:"healthCheckGracePeriodSeconds" type:"integer"`

	// The network configuration for the service. This parameter is required for
	// task definitions that use the awsvpc network mode to receive their own elastic
	// network interface, and it is not supported for other network modes. For more
	// information, see Task Networking (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// Updating a service to add a subnet to a list of existing subnets does not
	// trigger a service deployment. For example, if your network configuration
	// change is to keep the existing subnets and simply add another subnet to the
	// network configuration, this does not trigger a new service deployment.
	NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"`

	// The platform version you want to update your service to run.
	PlatformVersion *string `locationName:"platformVersion" type:"string"`

	// The name of the service to update.
	//
	// Service is a required field
	Service *string `locationName:"service" type:"string" required:"true"`

	// The family and revision (family:revision) or full ARN of the task definition
	// to run in your service. If a revision is not specified, the latest ACTIVE
	// revision is used. If you modify the task definition with UpdateService, Amazon
	// ECS spawns a task with the new version of the task definition and then stops
	// an old task after the new version is running.
	TaskDefinition *string `locationName:"taskDefinition" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateServiceInput) GoString added in v0.6.5 

func (s UpdateServiceInput) GoString() string

GoString returns the string representation

func (*UpdateServiceInput) SetCluster added in v1.5.0 

func (s *UpdateServiceInput) SetCluster(v string) *UpdateServiceInput

SetCluster sets the Cluster field's value.

func (*UpdateServiceInput) SetDeploymentConfiguration added in v1.5.0 

func (s *UpdateServiceInput) SetDeploymentConfiguration(v *DeploymentConfiguration) *UpdateServiceInput

SetDeploymentConfiguration sets the DeploymentConfiguration field's value.

func (*UpdateServiceInput) SetDesiredCount added in v1.5.0 

func (s *UpdateServiceInput) SetDesiredCount(v int64) *UpdateServiceInput

SetDesiredCount sets the DesiredCount field's value.

func (*UpdateServiceInput) SetForceNewDeployment added in v1.12.36 

func (s *UpdateServiceInput) SetForceNewDeployment(v bool) *UpdateServiceInput

SetForceNewDeployment sets the ForceNewDeployment field's value.

func (*UpdateServiceInput) SetHealthCheckGracePeriodSeconds added in v1.12.53 

func (s *UpdateServiceInput) SetHealthCheckGracePeriodSeconds(v int64) *UpdateServiceInput

SetHealthCheckGracePeriodSeconds sets the HealthCheckGracePeriodSeconds field's value.

func (*UpdateServiceInput) SetNetworkConfiguration added in v1.12.27 

func (s *UpdateServiceInput) SetNetworkConfiguration(v *NetworkConfiguration) *UpdateServiceInput

SetNetworkConfiguration sets the NetworkConfiguration field's value.

func (*UpdateServiceInput) SetPlatformVersion added in v1.12.36 

func (s *UpdateServiceInput) SetPlatformVersion(v string) *UpdateServiceInput

SetPlatformVersion sets the PlatformVersion field's value.

func (*UpdateServiceInput) SetService added in v1.5.0 

func (s *UpdateServiceInput) SetService(v string) *UpdateServiceInput

SetService sets the Service field's value.

func (*UpdateServiceInput) SetTaskDefinition added in v1.5.0 

func (s *UpdateServiceInput) SetTaskDefinition(v string) *UpdateServiceInput

SetTaskDefinition sets the TaskDefinition field's value.

func (UpdateServiceInput) String added in v0.6.5 

func (s UpdateServiceInput) String() string

String returns the string representation

func (*UpdateServiceInput) Validate added in v1.1.21 

func (s *UpdateServiceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateServiceOutput 

type UpdateServiceOutput struct {

	// The full description of your service following the update call.
	Service *Service `locationName:"service" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateServiceOutput) GoString added in v0.6.5 

func (s UpdateServiceOutput) GoString() string

GoString returns the string representation

func (*UpdateServiceOutput) SetService added in v1.5.0 

func (s *UpdateServiceOutput) SetService(v *Service) *UpdateServiceOutput

SetService sets the Service field's value.

func (UpdateServiceOutput) String added in v0.6.5 

func (s UpdateServiceOutput) String() string

String returns the string representation

type VersionInfo 

type VersionInfo struct {

	// The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent
	//  (https://github.com/aws/amazon-ecs-agent/commits/master) GitHub repository.
	AgentHash *string `locationName:"agentHash" type:"string"`

	// The version number of the Amazon ECS container agent.
	AgentVersion *string `locationName:"agentVersion" type:"string"`

	// The Docker version running on the container instance.
	DockerVersion *string `locationName:"dockerVersion" type:"string"`
	// contains filtered or unexported fields
}

The Docker and Amazon ECS container agent version information about a container instance.

func (VersionInfo) GoString added in v0.6.5 

func (s VersionInfo) GoString() string

GoString returns the string representation

func (*VersionInfo) SetAgentHash added in v1.5.0 

func (s *VersionInfo) SetAgentHash(v string) *VersionInfo

SetAgentHash sets the AgentHash field's value.

func (*VersionInfo) SetAgentVersion added in v1.5.0 

func (s *VersionInfo) SetAgentVersion(v string) *VersionInfo

SetAgentVersion sets the AgentVersion field's value.

func (*VersionInfo) SetDockerVersion added in v1.5.0 

func (s *VersionInfo) SetDockerVersion(v string) *VersionInfo

SetDockerVersion sets the DockerVersion field's value.

func (VersionInfo) String added in v0.6.5 

func (s VersionInfo) String() string

String returns the string representation

type Volume 

type Volume struct {

	// The contents of the host parameter determine whether your data volume persists
	// on the host container instance and where it is stored. If the host parameter
	// is empty, then the Docker daemon assigns a host path for your data volume,
	// but the data is not guaranteed to persist after the containers associated
	// with it stop running.
	//
	// Windows containers can mount whole directories on the same drive as $env:ProgramData.
	// Windows containers cannot mount directories on a different drive, and mount
	// point cannot be across drives. For example, you can mount C:\my\path:C:\my\path
	// and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.
	Host *HostVolumeProperties `locationName:"host" type:"structure"`

	// The name of the volume. Up to 255 letters (uppercase and lowercase), numbers,
	// hyphens, and underscores are allowed. This name is referenced in the sourceVolume
	// parameter of container definition mountPoints.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

A data volume used in a task definition.

func (Volume) GoString added in v0.6.5 

func (s Volume) GoString() string

GoString returns the string representation

func (*Volume) SetHost added in v1.5.0 

func (s *Volume) SetHost(v *HostVolumeProperties) *Volume

SetHost sets the Host field's value.

func (*Volume) SetName added in v1.5.0 

func (s *Volume) SetName(v string) *Volume

SetName sets the Name field's value.

func (Volume) String added in v0.6.5 

func (s Volume) String() string

String returns the string representation

type VolumeFrom 

type VolumeFrom struct {

	// If this value is true, the container has read-only access to the volume.
	// If this value is false, then the container can write to the volume. The default
	// value is false.
	ReadOnly *bool `locationName:"readOnly" type:"boolean"`

	// The name of another container within the same task definition to mount volumes
	// from.
	SourceContainer *string `locationName:"sourceContainer" type:"string"`
	// contains filtered or unexported fields
}

Details on a data volume from another container in the same task definition.

func (VolumeFrom) GoString added in v0.6.5 

func (s VolumeFrom) GoString() string

GoString returns the string representation

func (*VolumeFrom) SetReadOnly added in v1.5.0 

func (s *VolumeFrom) SetReadOnly(v bool) *VolumeFrom

SetReadOnly sets the ReadOnly field's value.

func (*VolumeFrom) SetSourceContainer added in v1.5.0 

func (s *VolumeFrom) SetSourceContainer(v string) *VolumeFrom

SetSourceContainer sets the SourceContainer field's value.

func (VolumeFrom) String added in v0.6.5 

func (s VolumeFrom) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package ecsiface provides an interface to enable mocking the Amazon EC2 Container Service service client for testing your code.
 Package ecsiface provides an interface to enable mocking the Amazon EC2 Container Service service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.