ecs

package
v1.54.7 Latest Latest
Warning

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

 Go to latest Published: Jun 24, 2024 License: Apache-2.0 Imports: 10 Imported by: 1,219

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. It makes it easy to run, stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.

Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes it easy to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.

You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your own cluster management and configuration management systems. You also don't need to worry about scaling your management infrastructure.

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 (
	// ApplicationProtocolHttp is a ApplicationProtocol enum value
	ApplicationProtocolHttp = "http"

	// ApplicationProtocolHttp2 is a ApplicationProtocol enum value
	ApplicationProtocolHttp2 = "http2"

	// ApplicationProtocolGrpc is a ApplicationProtocol enum value
	ApplicationProtocolGrpc = "grpc"
)
View Source 
const (
	// AssignPublicIpEnabled is a AssignPublicIp enum value
	AssignPublicIpEnabled = "ENABLED"

	// AssignPublicIpDisabled is a AssignPublicIp enum value
	AssignPublicIpDisabled = "DISABLED"
)
View Source 
const (
	// CPUArchitectureX8664 is a CPUArchitecture enum value
	CPUArchitectureX8664 = "X86_64"

	// CPUArchitectureArm64 is a CPUArchitecture enum value
	CPUArchitectureArm64 = "ARM64"
)
View Source 
const (
	// CapacityProviderStatusActive is a CapacityProviderStatus enum value
	CapacityProviderStatusActive = "ACTIVE"

	// CapacityProviderStatusInactive is a CapacityProviderStatus enum value
	CapacityProviderStatusInactive = "INACTIVE"
)
View Source 
const (
	// CapacityProviderUpdateStatusDeleteInProgress is a CapacityProviderUpdateStatus enum value
	CapacityProviderUpdateStatusDeleteInProgress = "DELETE_IN_PROGRESS"

	// CapacityProviderUpdateStatusDeleteComplete is a CapacityProviderUpdateStatus enum value
	CapacityProviderUpdateStatusDeleteComplete = "DELETE_COMPLETE"

	// CapacityProviderUpdateStatusDeleteFailed is a CapacityProviderUpdateStatus enum value
	CapacityProviderUpdateStatusDeleteFailed = "DELETE_FAILED"

	// CapacityProviderUpdateStatusUpdateInProgress is a CapacityProviderUpdateStatus enum value
	CapacityProviderUpdateStatusUpdateInProgress = "UPDATE_IN_PROGRESS"

	// CapacityProviderUpdateStatusUpdateComplete is a CapacityProviderUpdateStatus enum value
	CapacityProviderUpdateStatusUpdateComplete = "UPDATE_COMPLETE"

	// CapacityProviderUpdateStatusUpdateFailed is a CapacityProviderUpdateStatus enum value
	CapacityProviderUpdateStatusUpdateFailed = "UPDATE_FAILED"
)
View Source 
const (
	// ClusterFieldAttachments is a ClusterField enum value
	ClusterFieldAttachments = "ATTACHMENTS"

	// ClusterFieldConfigurations is a ClusterField enum value
	ClusterFieldConfigurations = "CONFIGURATIONS"

	// ClusterFieldSettings is a ClusterField enum value
	ClusterFieldSettings = "SETTINGS"

	// ClusterFieldStatistics is a ClusterField enum value
	ClusterFieldStatistics = "STATISTICS"

	// ClusterFieldTags is a ClusterField enum value
	ClusterFieldTags = "TAGS"
)
View Source 
const (
	// CompatibilityEc2 is a Compatibility enum value
	CompatibilityEc2 = "EC2"

	// CompatibilityFargate is a Compatibility enum value
	CompatibilityFargate = "FARGATE"

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

	// ConnectivityDisconnected is a Connectivity enum value
	ConnectivityDisconnected = "DISCONNECTED"
)
View Source 
const (
	// ContainerConditionStart is a ContainerCondition enum value
	ContainerConditionStart = "START"

	// ContainerConditionComplete is a ContainerCondition enum value
	ContainerConditionComplete = "COMPLETE"

	// ContainerConditionSuccess is a ContainerCondition enum value
	ContainerConditionSuccess = "SUCCESS"

	// ContainerConditionHealthy is a ContainerCondition enum value
	ContainerConditionHealthy = "HEALTHY"
)
View Source 
const (
	// ContainerInstanceFieldTags is a ContainerInstanceField enum value
	ContainerInstanceFieldTags = "TAGS"

	// ContainerInstanceFieldContainerInstanceHealth is a ContainerInstanceField enum value
	ContainerInstanceFieldContainerInstanceHealth = "CONTAINER_INSTANCE_HEALTH"
)
View Source 
const (
	// ContainerInstanceStatusActive is a ContainerInstanceStatus enum value
	ContainerInstanceStatusActive = "ACTIVE"

	// ContainerInstanceStatusDraining is a ContainerInstanceStatus enum value
	ContainerInstanceStatusDraining = "DRAINING"

	// ContainerInstanceStatusRegistering is a ContainerInstanceStatus enum value
	ContainerInstanceStatusRegistering = "REGISTERING"

	// ContainerInstanceStatusDeregistering is a ContainerInstanceStatus enum value
	ContainerInstanceStatusDeregistering = "DEREGISTERING"

	// ContainerInstanceStatusRegistrationFailed is a ContainerInstanceStatus enum value
	ContainerInstanceStatusRegistrationFailed = "REGISTRATION_FAILED"
)
View Source 
const (
	// DeploymentControllerTypeEcs is a DeploymentControllerType enum value
	DeploymentControllerTypeEcs = "ECS"

	// DeploymentControllerTypeCodeDeploy is a DeploymentControllerType enum value
	DeploymentControllerTypeCodeDeploy = "CODE_DEPLOY"

	// DeploymentControllerTypeExternal is a DeploymentControllerType enum value
	DeploymentControllerTypeExternal = "EXTERNAL"
)
View Source 
const (
	// DeploymentRolloutStateCompleted is a DeploymentRolloutState enum value
	DeploymentRolloutStateCompleted = "COMPLETED"

	// DeploymentRolloutStateFailed is a DeploymentRolloutState enum value
	DeploymentRolloutStateFailed = "FAILED"

	// DeploymentRolloutStateInProgress is a DeploymentRolloutState enum value
	DeploymentRolloutStateInProgress = "IN_PROGRESS"
)
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 (
	// EFSAuthorizationConfigIAMEnabled is a EFSAuthorizationConfigIAM enum value
	EFSAuthorizationConfigIAMEnabled = "ENABLED"

	// EFSAuthorizationConfigIAMDisabled is a EFSAuthorizationConfigIAM enum value
	EFSAuthorizationConfigIAMDisabled = "DISABLED"
)
View Source 
const (
	// EFSTransitEncryptionEnabled is a EFSTransitEncryption enum value
	EFSTransitEncryptionEnabled = "ENABLED"

	// EFSTransitEncryptionDisabled is a EFSTransitEncryption enum value
	EFSTransitEncryptionDisabled = "DISABLED"
)
View Source 
const (
	// ExecuteCommandLoggingNone is a ExecuteCommandLogging enum value
	ExecuteCommandLoggingNone = "NONE"

	// ExecuteCommandLoggingDefault is a ExecuteCommandLogging enum value
	ExecuteCommandLoggingDefault = "DEFAULT"

	// ExecuteCommandLoggingOverride is a ExecuteCommandLogging enum value
	ExecuteCommandLoggingOverride = "OVERRIDE"
)
View Source 
const (
	// FirelensConfigurationTypeFluentd is a FirelensConfigurationType enum value
	FirelensConfigurationTypeFluentd = "fluentd"

	// FirelensConfigurationTypeFluentbit is a FirelensConfigurationType enum value
	FirelensConfigurationTypeFluentbit = "fluentbit"
)
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 (
	// InstanceHealthCheckStateOk is a InstanceHealthCheckState enum value
	InstanceHealthCheckStateOk = "OK"

	// InstanceHealthCheckStateImpaired is a InstanceHealthCheckState enum value
	InstanceHealthCheckStateImpaired = "IMPAIRED"

	// InstanceHealthCheckStateInsufficientData is a InstanceHealthCheckState enum value
	InstanceHealthCheckStateInsufficientData = "INSUFFICIENT_DATA"

	// InstanceHealthCheckStateInitializing is a InstanceHealthCheckState enum value
	InstanceHealthCheckStateInitializing = "INITIALIZING"
)
View Source 
const (
	// IpcModeHost is a IpcMode enum value
	IpcModeHost = "host"

	// IpcModeTask is a IpcMode enum value
	IpcModeTask = "task"

	// IpcModeNone is a IpcMode enum value
	IpcModeNone = "none"
)
View Source 
const (
	// LaunchTypeEc2 is a LaunchType enum value
	LaunchTypeEc2 = "EC2"

	// LaunchTypeFargate is a LaunchType enum value
	LaunchTypeFargate = "FARGATE"

	// LaunchTypeExternal is a LaunchType enum value
	LaunchTypeExternal = "EXTERNAL"
)
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"

	// LogDriverAwsfirelens is a LogDriver enum value
	LogDriverAwsfirelens = "awsfirelens"
)
View Source 
const (
	// ManagedDrainingEnabled is a ManagedDraining enum value
	ManagedDrainingEnabled = "ENABLED"

	// ManagedDrainingDisabled is a ManagedDraining enum value
	ManagedDrainingDisabled = "DISABLED"
)
View Source 
const (
	// ManagedScalingStatusEnabled is a ManagedScalingStatus enum value
	ManagedScalingStatusEnabled = "ENABLED"

	// ManagedScalingStatusDisabled is a ManagedScalingStatus enum value
	ManagedScalingStatusDisabled = "DISABLED"
)
View Source 
const (
	// ManagedTerminationProtectionEnabled is a ManagedTerminationProtection enum value
	ManagedTerminationProtectionEnabled = "ENABLED"

	// ManagedTerminationProtectionDisabled is a ManagedTerminationProtection enum value
	ManagedTerminationProtectionDisabled = "DISABLED"
)
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 (
	// OSFamilyWindowsServer2019Full is a OSFamily enum value
	OSFamilyWindowsServer2019Full = "WINDOWS_SERVER_2019_FULL"

	// OSFamilyWindowsServer2019Core is a OSFamily enum value
	OSFamilyWindowsServer2019Core = "WINDOWS_SERVER_2019_CORE"

	// OSFamilyWindowsServer2016Full is a OSFamily enum value
	OSFamilyWindowsServer2016Full = "WINDOWS_SERVER_2016_FULL"

	// OSFamilyWindowsServer2004Core is a OSFamily enum value
	OSFamilyWindowsServer2004Core = "WINDOWS_SERVER_2004_CORE"

	// OSFamilyWindowsServer2022Core is a OSFamily enum value
	OSFamilyWindowsServer2022Core = "WINDOWS_SERVER_2022_CORE"

	// OSFamilyWindowsServer2022Full is a OSFamily enum value
	OSFamilyWindowsServer2022Full = "WINDOWS_SERVER_2022_FULL"

	// OSFamilyWindowsServer20h2Core is a OSFamily enum value
	OSFamilyWindowsServer20h2Core = "WINDOWS_SERVER_20H2_CORE"

	// OSFamilyLinux is a OSFamily enum value
	OSFamilyLinux = "LINUX"
)
View Source 
const (
	// PidModeHost is a PidMode enum value
	PidModeHost = "host"

	// PidModeTask is a PidMode enum value
	PidModeTask = "task"
)
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 (
	// PropagateTagsTaskDefinition is a PropagateTags enum value
	PropagateTagsTaskDefinition = "TASK_DEFINITION"

	// PropagateTagsService is a PropagateTags enum value
	PropagateTagsService = "SERVICE"

	// PropagateTagsNone is a PropagateTags enum value
	PropagateTagsNone = "NONE"
)
View Source 
const (
	// ResourceTypeGpu is a ResourceType enum value
	ResourceTypeGpu = "GPU"

	// ResourceTypeInferenceAccelerator is a ResourceType enum value
	ResourceTypeInferenceAccelerator = "InferenceAccelerator"
)
View Source 
const (
	// SchedulingStrategyReplica is a SchedulingStrategy enum value
	SchedulingStrategyReplica = "REPLICA"

	// SchedulingStrategyDaemon is a SchedulingStrategy enum value
	SchedulingStrategyDaemon = "DAEMON"
)
View Source 
const (
	// ScopeTask is a Scope enum value
	ScopeTask = "task"

	// ScopeShared is a Scope enum value
	ScopeShared = "shared"
)
View Source 
const (
	// SettingNameServiceLongArnFormat is a SettingName enum value
	SettingNameServiceLongArnFormat = "serviceLongArnFormat"

	// SettingNameTaskLongArnFormat is a SettingName enum value
	SettingNameTaskLongArnFormat = "taskLongArnFormat"

	// SettingNameContainerInstanceLongArnFormat is a SettingName enum value
	SettingNameContainerInstanceLongArnFormat = "containerInstanceLongArnFormat"

	// SettingNameAwsvpcTrunking is a SettingName enum value
	SettingNameAwsvpcTrunking = "awsvpcTrunking"

	// SettingNameContainerInsights is a SettingName enum value
	SettingNameContainerInsights = "containerInsights"

	// SettingNameFargateFipsmode is a SettingName enum value
	SettingNameFargateFipsmode = "fargateFIPSMode"

	// SettingNameTagResourceAuthorization is a SettingName enum value
	SettingNameTagResourceAuthorization = "tagResourceAuthorization"

	// SettingNameFargateTaskRetirementWaitPeriod is a SettingName enum value
	SettingNameFargateTaskRetirementWaitPeriod = "fargateTaskRetirementWaitPeriod"

	// SettingNameGuardDutyActivate is a SettingName enum value
	SettingNameGuardDutyActivate = "guardDutyActivate"
)
View Source 
const (
	// SettingTypeUser is a SettingType enum value
	SettingTypeUser = "user"

	// SettingTypeAwsManaged is a SettingType enum value
	SettingTypeAwsManaged = "aws_managed"
)
View Source 
const (
	// SortOrderAsc is a SortOrder enum value
	SortOrderAsc = "ASC"

	// SortOrderDesc is a SortOrder enum value
	SortOrderDesc = "DESC"
)
View Source 
const (
	// StabilityStatusSteadyState is a StabilityStatus enum value
	StabilityStatusSteadyState = "STEADY_STATE"

	// StabilityStatusStabilizing is a StabilityStatus enum value
	StabilityStatusStabilizing = "STABILIZING"
)
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"

	// TaskDefinitionStatusDeleteInProgress is a TaskDefinitionStatus enum value
	TaskDefinitionStatusDeleteInProgress = "DELETE_IN_PROGRESS"
)
View Source 
const (
	// TaskFilesystemTypeExt3 is a TaskFilesystemType enum value
	TaskFilesystemTypeExt3 = "ext3"

	// TaskFilesystemTypeExt4 is a TaskFilesystemType enum value
	TaskFilesystemTypeExt4 = "ext4"

	// TaskFilesystemTypeXfs is a TaskFilesystemType enum value
	TaskFilesystemTypeXfs = "xfs"
)
View Source 
const (
	// TaskStopCodeTaskFailedToStart is a TaskStopCode enum value
	TaskStopCodeTaskFailedToStart = "TaskFailedToStart"

	// TaskStopCodeEssentialContainerExited is a TaskStopCode enum value
	TaskStopCodeEssentialContainerExited = "EssentialContainerExited"

	// TaskStopCodeUserInitiated is a TaskStopCode enum value
	TaskStopCodeUserInitiated = "UserInitiated"

	// TaskStopCodeServiceSchedulerInitiated is a TaskStopCode enum value
	TaskStopCodeServiceSchedulerInitiated = "ServiceSchedulerInitiated"

	// TaskStopCodeSpotInterruption is a TaskStopCode enum value
	TaskStopCodeSpotInterruption = "SpotInterruption"

	// TaskStopCodeTerminationNotice is a TaskStopCode enum value
	TaskStopCodeTerminationNotice = "TerminationNotice"
)
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 don't have authorization to perform the requested action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

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

	// ErrCodeBlockedException for service response error code
	// "BlockedException".
	//
	// Your Amazon Web Services account was blocked. For more information, contact
	// Amazon Web Services Support (http://aws.amazon.com/contact-us/).
	ErrCodeBlockedException = "BlockedException"

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

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

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

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

	// ErrCodeClusterNotFoundException for service response error code
	// "ClusterNotFoundException".
	//
	// The specified cluster wasn't found. You can view your available clusters
	// with ListClusters. Amazon ECS clusters are Region specific.
	ErrCodeClusterNotFoundException = "ClusterNotFoundException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The RunTask request could not be processed due to conflicts. The provided
	// clientToken is already in use with a different RunTask request. The resourceIds
	// are the existing task ARNs which are already associated with the clientToken.
	//
	// To fix this issue:
	//
	//    * Run RunTask with a unique clientToken.
	//
	//    * Run RunTask with the clientToken and the original set of parameters
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// The specified parameter isn't valid. Review the available parameters for
	// the API request.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The limit for the resource was exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

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

	// ErrCodeNamespaceNotFoundException for service response error code
	// "NamespaceNotFoundException".
	//
	// The specified namespace wasn't found.
	ErrCodeNamespaceNotFoundException = "NamespaceNotFoundException"

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

	// ErrCodePlatformTaskDefinitionIncompatibilityException for service response error code
	// "PlatformTaskDefinitionIncompatibilityException".
	//
	// The specified platform version doesn't satisfy the required capabilities
	// of the task definition.
	ErrCodePlatformTaskDefinitionIncompatibilityException = "PlatformTaskDefinitionIncompatibilityException"

	// ErrCodePlatformUnknownException for service response error code
	// "PlatformUnknownException".
	//
	// The specified platform version doesn't exist.
	ErrCodePlatformUnknownException = "PlatformUnknownException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The specified resource is in-use and can't be removed.
	ErrCodeResourceInUseException = "ResourceInUseException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource wasn't found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// 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 isn't active. You can't update a service that's inactive.
	// If you have previously deleted a service, you can re-create it with CreateService.
	ErrCodeServiceNotActiveException = "ServiceNotActiveException"

	// ErrCodeServiceNotFoundException for service response error code
	// "ServiceNotFoundException".
	//
	// The specified service wasn't found. You can view your available services
	// with ListServices. Amazon ECS services are cluster specific and Region specific.
	ErrCodeServiceNotFoundException = "ServiceNotFoundException"

	// ErrCodeTargetNotConnectedException for service response error code
	// "TargetNotConnectedException".
	//
	// The execute command cannot run. This error can be caused by any of the following
	// configuration issues:
	//
	//    * Incorrect IAM permissions
	//
	//    * The SSM agent is not installed or is not running
	//
	//    * There is an interface Amazon VPC endpoint for Amazon ECS, but there
	//    is not one for Systems Manager Session Manager
	//
	// For information about how to troubleshoot the issues, see Troubleshooting
	// issues with ECS Exec (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html)
	// in the Amazon Elastic Container Service Developer Guide.
	ErrCodeTargetNotConnectedException = "TargetNotConnectedException"

	// ErrCodeTargetNotFoundException for service response error code
	// "TargetNotFoundException".
	//
	// The specified target wasn't found. You can view your available container
	// instances with ListContainerInstances. Amazon ECS container instances are
	// cluster-specific and Region-specific.
	ErrCodeTargetNotFoundException = "TargetNotFoundException"

	// ErrCodeTaskSetNotFoundException for service response error code
	// "TaskSetNotFoundException".
	//
	// The specified task set wasn't found. You can view your available task sets
	// with DescribeTaskSets. Task sets are specific to each cluster, service and
	// Region.
	ErrCodeTaskSetNotFoundException = "TaskSetNotFoundException"

	// ErrCodeUnsupportedFeatureException for service response error code
	// "UnsupportedFeatureException".
	//
	// The specified task isn't supported in this Region.
	ErrCodeUnsupportedFeatureException = "UnsupportedFeatureException"

	// ErrCodeUpdateInProgressException for service response error code
	// "UpdateInProgressException".
	//
	// There's already a current Amazon ECS container agent update in progress on
	// the container instance that's specified. If the container agent becomes disconnected
	// while it's in a transitional stage, such as PENDING or STAGING, the update
	// process can get stuck in that state. However, when the agent reconnects,
	// it resumes where it stopped previously.
	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 identifier of a specific service.
)

Service information constants

View Source 
const (
	// CapacityProviderFieldTags is a CapacityProviderField enum value
	CapacityProviderFieldTags = "TAGS"
)
View Source 
const (
	// ClusterSettingNameContainerInsights is a ClusterSettingName enum value
	ClusterSettingNameContainerInsights = "containerInsights"
)
View Source 
const (
	// EBSResourceTypeVolume is a EBSResourceType enum value
	EBSResourceTypeVolume = "volume"
)
View Source 
const (
	// EnvironmentFileTypeS3 is a EnvironmentFileType enum value
	EnvironmentFileTypeS3 = "s3"
)
View Source 
const (
	// InstanceHealthCheckTypeContainerRuntime is a InstanceHealthCheckType enum value
	InstanceHealthCheckTypeContainerRuntime = "CONTAINER_RUNTIME"
)
View Source 
const (
	// ManagedAgentNameExecuteCommandAgent is a ManagedAgentName enum value
	ManagedAgentNameExecuteCommandAgent = "ExecuteCommandAgent"
)
View Source 
const (
	// PlatformDeviceTypeGpu is a PlatformDeviceType enum value
	PlatformDeviceTypeGpu = "GPU"
)
View Source 
const (
	// ProxyConfigurationTypeAppmesh is a ProxyConfigurationType enum value
	ProxyConfigurationTypeAppmesh = "APPMESH"
)
View Source 
const (
	// ScaleUnitPercent is a ScaleUnit enum value
	ScaleUnitPercent = "PERCENT"
)
View Source 
const (
	// ServiceFieldTags is a ServiceField enum value
	ServiceFieldTags = "TAGS"
)
View Source 
const (
	// TargetTypeContainerInstance is a TargetType enum value
	TargetTypeContainerInstance = "container-instance"
)
View Source 
const (
	// TaskDefinitionFieldTags is a TaskDefinitionField enum value
	TaskDefinitionFieldTags = "TAGS"
)
View Source 
const (
	// TaskDefinitionPlacementConstraintTypeMemberOf is a TaskDefinitionPlacementConstraintType enum value
	TaskDefinitionPlacementConstraintTypeMemberOf = "memberOf"
)
View Source 
const (
	// TaskFieldTags is a TaskField enum value
	TaskFieldTags = "TAGS"
)
View Source 
const (
	// TaskSetFieldTags is a TaskSetField enum value
	TaskSetFieldTags = "TAGS"
)

Variables

This section is empty.

Functions

func AgentUpdateStatus_Values added in v1.34.3 

func AgentUpdateStatus_Values() []string

AgentUpdateStatus_Values returns all elements of the AgentUpdateStatus enum

func ApplicationProtocol_Values added in v1.44.146 

func ApplicationProtocol_Values() []string

ApplicationProtocol_Values returns all elements of the ApplicationProtocol enum

func AssignPublicIp_Values added in v1.34.3 

func AssignPublicIp_Values() []string

AssignPublicIp_Values returns all elements of the AssignPublicIp enum

func CPUArchitecture_Values added in v1.41.13 

func CPUArchitecture_Values() []string

CPUArchitecture_Values returns all elements of the CPUArchitecture enum

func CapacityProviderField_Values added in v1.34.3 

func CapacityProviderField_Values() []string

CapacityProviderField_Values returns all elements of the CapacityProviderField enum

func CapacityProviderStatus_Values added in v1.34.3 

func CapacityProviderStatus_Values() []string

CapacityProviderStatus_Values returns all elements of the CapacityProviderStatus enum

func CapacityProviderUpdateStatus_Values added in v1.34.3 

func CapacityProviderUpdateStatus_Values() []string

CapacityProviderUpdateStatus_Values returns all elements of the CapacityProviderUpdateStatus enum

func ClusterField_Values added in v1.34.3 

func ClusterField_Values() []string

ClusterField_Values returns all elements of the ClusterField enum

func ClusterSettingName_Values added in v1.34.3 

func ClusterSettingName_Values() []string

ClusterSettingName_Values returns all elements of the ClusterSettingName enum

func Compatibility_Values added in v1.34.3 

func Compatibility_Values() []string

Compatibility_Values returns all elements of the Compatibility enum

func Connectivity_Values added in v1.34.3 

func Connectivity_Values() []string

Connectivity_Values returns all elements of the Connectivity enum

func ContainerCondition_Values added in v1.34.3 

func ContainerCondition_Values() []string

ContainerCondition_Values returns all elements of the ContainerCondition enum

func ContainerInstanceField_Values added in v1.34.3 

func ContainerInstanceField_Values() []string

ContainerInstanceField_Values returns all elements of the ContainerInstanceField enum

func ContainerInstanceStatus_Values added in v1.34.3 

func ContainerInstanceStatus_Values() []string

ContainerInstanceStatus_Values returns all elements of the ContainerInstanceStatus enum

func DeploymentControllerType_Values added in v1.34.3 

func DeploymentControllerType_Values() []string

DeploymentControllerType_Values returns all elements of the DeploymentControllerType enum

func DeploymentRolloutState_Values added in v1.35.34 

func DeploymentRolloutState_Values() []string

DeploymentRolloutState_Values returns all elements of the DeploymentRolloutState enum

func DesiredStatus_Values added in v1.34.3 

func DesiredStatus_Values() []string

DesiredStatus_Values returns all elements of the DesiredStatus enum

func DeviceCgroupPermission_Values added in v1.34.3 

func DeviceCgroupPermission_Values() []string

DeviceCgroupPermission_Values returns all elements of the DeviceCgroupPermission enum

func EBSResourceType_Values added in v1.49.19 

func EBSResourceType_Values() []string

EBSResourceType_Values returns all elements of the EBSResourceType enum

func EFSAuthorizationConfigIAM_Values added in v1.34.3 

func EFSAuthorizationConfigIAM_Values() []string

EFSAuthorizationConfigIAM_Values returns all elements of the EFSAuthorizationConfigIAM enum

func EFSTransitEncryption_Values added in v1.34.3 

func EFSTransitEncryption_Values() []string

EFSTransitEncryption_Values returns all elements of the EFSTransitEncryption enum

func EnvironmentFileType_Values added in v1.34.3 

func EnvironmentFileType_Values() []string

EnvironmentFileType_Values returns all elements of the EnvironmentFileType enum

func ExecuteCommandLogging_Values added in v1.37.31 

func ExecuteCommandLogging_Values() []string

ExecuteCommandLogging_Values returns all elements of the ExecuteCommandLogging enum

func FirelensConfigurationType_Values added in v1.34.3 

func FirelensConfigurationType_Values() []string

FirelensConfigurationType_Values returns all elements of the FirelensConfigurationType enum

func HealthStatus_Values added in v1.34.3 

func HealthStatus_Values() []string

HealthStatus_Values returns all elements of the HealthStatus enum

func InstanceHealthCheckState_Values added in v1.42.2 

func InstanceHealthCheckState_Values() []string

InstanceHealthCheckState_Values returns all elements of the InstanceHealthCheckState enum

func InstanceHealthCheckType_Values added in v1.42.2 

func InstanceHealthCheckType_Values() []string

InstanceHealthCheckType_Values returns all elements of the InstanceHealthCheckType enum

func IpcMode_Values added in v1.34.3 

func IpcMode_Values() []string

IpcMode_Values returns all elements of the IpcMode enum

func LaunchType_Values added in v1.34.3 

func LaunchType_Values() []string

LaunchType_Values returns all elements of the LaunchType enum

func LogDriver_Values added in v1.34.3 

func LogDriver_Values() []string

LogDriver_Values returns all elements of the LogDriver enum

func ManagedAgentName_Values added in v1.37.31 

func ManagedAgentName_Values() []string

ManagedAgentName_Values returns all elements of the ManagedAgentName enum

func ManagedDraining_Values added in v1.49.15 

func ManagedDraining_Values() []string

ManagedDraining_Values returns all elements of the ManagedDraining enum

func ManagedScalingStatus_Values added in v1.34.3 

func ManagedScalingStatus_Values() []string

ManagedScalingStatus_Values returns all elements of the ManagedScalingStatus enum

func ManagedTerminationProtection_Values added in v1.34.3 

func ManagedTerminationProtection_Values() []string

ManagedTerminationProtection_Values returns all elements of the ManagedTerminationProtection enum

func NetworkMode_Values added in v1.34.3 

func NetworkMode_Values() []string

NetworkMode_Values returns all elements of the NetworkMode enum

func OSFamily_Values added in v1.41.13 

func OSFamily_Values() []string

OSFamily_Values returns all elements of the OSFamily enum

func PidMode_Values added in v1.34.3 

func PidMode_Values() []string

PidMode_Values returns all elements of the PidMode enum

func PlacementConstraintType_Values added in v1.34.3 

func PlacementConstraintType_Values() []string

PlacementConstraintType_Values returns all elements of the PlacementConstraintType enum

func PlacementStrategyType_Values added in v1.34.3 

func PlacementStrategyType_Values() []string

PlacementStrategyType_Values returns all elements of the PlacementStrategyType enum

func PlatformDeviceType_Values added in v1.34.3 

func PlatformDeviceType_Values() []string

PlatformDeviceType_Values returns all elements of the PlatformDeviceType enum

func PropagateTags_Values added in v1.34.3 

func PropagateTags_Values() []string

PropagateTags_Values returns all elements of the PropagateTags enum

func ProxyConfigurationType_Values added in v1.34.3 

func ProxyConfigurationType_Values() []string

ProxyConfigurationType_Values returns all elements of the ProxyConfigurationType enum

func ResourceType_Values added in v1.34.3 

func ResourceType_Values() []string

ResourceType_Values returns all elements of the ResourceType enum

func ScaleUnit_Values added in v1.34.3 

func ScaleUnit_Values() []string

ScaleUnit_Values returns all elements of the ScaleUnit enum

func SchedulingStrategy_Values added in v1.34.3 

func SchedulingStrategy_Values() []string

SchedulingStrategy_Values returns all elements of the SchedulingStrategy enum

func Scope_Values added in v1.34.3 

func Scope_Values() []string

Scope_Values returns all elements of the Scope enum

func ServiceField_Values added in v1.34.3 

func ServiceField_Values() []string

ServiceField_Values returns all elements of the ServiceField enum

func SettingName_Values added in v1.34.3 

func SettingName_Values() []string

SettingName_Values returns all elements of the SettingName enum

func SettingType_Values added in v1.48.4 

func SettingType_Values() []string

SettingType_Values returns all elements of the SettingType enum

func SortOrder_Values added in v1.34.3 

func SortOrder_Values() []string

SortOrder_Values returns all elements of the SortOrder enum

func StabilityStatus_Values added in v1.34.3 

func StabilityStatus_Values() []string

StabilityStatus_Values returns all elements of the StabilityStatus enum

func TargetType_Values added in v1.34.3 

func TargetType_Values() []string

TargetType_Values returns all elements of the TargetType enum

func TaskDefinitionFamilyStatus_Values added in v1.34.3 

func TaskDefinitionFamilyStatus_Values() []string

TaskDefinitionFamilyStatus_Values returns all elements of the TaskDefinitionFamilyStatus enum

func TaskDefinitionField_Values added in v1.34.3 

func TaskDefinitionField_Values() []string

TaskDefinitionField_Values returns all elements of the TaskDefinitionField enum

func TaskDefinitionPlacementConstraintType_Values added in v1.34.3 

func TaskDefinitionPlacementConstraintType_Values() []string

TaskDefinitionPlacementConstraintType_Values returns all elements of the TaskDefinitionPlacementConstraintType enum

func TaskDefinitionStatus_Values added in v1.34.3 

func TaskDefinitionStatus_Values() []string

TaskDefinitionStatus_Values returns all elements of the TaskDefinitionStatus enum

func TaskField_Values added in v1.34.3 

func TaskField_Values() []string

TaskField_Values returns all elements of the TaskField enum

func TaskFilesystemType_Values added in v1.49.19 

func TaskFilesystemType_Values() []string

TaskFilesystemType_Values returns all elements of the TaskFilesystemType enum

func TaskSetField_Values added in v1.34.3 

func TaskSetField_Values() []string

TaskSetField_Values returns all elements of the TaskSetField enum

func TaskStopCode_Values added in v1.34.3 

func TaskStopCode_Values() []string

TaskStopCode_Values returns all elements of the TaskStopCode enum

func TransportProtocol_Values added in v1.34.3 

func TransportProtocol_Values() []string

TransportProtocol_Values returns all elements of the TransportProtocol enum

func UlimitName_Values added in v1.34.3 

func UlimitName_Values() []string

UlimitName_Values returns all elements of the UlimitName enum

Types

type AccessDeniedException added in v1.28.0 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You don't have authorization to perform the requested action.

func (*AccessDeniedException) Code added in v1.28.0 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error added in v1.28.0 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString added in v1.28.0 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message added in v1.28.0 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr added in v1.28.0 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID added in v1.28.0 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode added in v1.28.0 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String added in v1.28.0 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// For Service Connect services, this includes portName, clientAliases, discoveryName,
	// and ingressPortOverride.
	//
	// For Elastic Block Storage, this includes roleArn, deleteOnTermination, volumeName,
	// volumeId, and statusReason (only when the attachment fails to create or attach).
	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, DELETED, and FAILED.
	Status *string `locationName:"status" type:"string"`

	// The type of the attachment, such as ElasticNetworkInterface, Service Connect,
	// and AmazonElasticBlockStorage.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. The name must contain between 1 and 128 characters.
	// The name may contain letters (uppercase and lowercase), numbers, hyphens
	// (-), underscores (_), forward slashes (/), back slashes (\), or periods (.).
	//
	// 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 to attach the attribute with. 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. The value must contain between 1 and 128 characters.
	// It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores
	// (_), periods (.), at signs (@), forward slashes (/), back slashes (\), colons
	// (:), or spaces. The value can't start or end with a space.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

An attribute is a name-value pair that's associated with an Amazon ECS object. Use attributes to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes (https://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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 AttributeLimitExceededException added in v1.28.0 

type AttributeLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You can apply up to 10 custom attributes for each resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.

func (*AttributeLimitExceededException) Code added in v1.28.0 

func (s *AttributeLimitExceededException) Code() string

Code returns the exception type name.

func (*AttributeLimitExceededException) Error added in v1.28.0 

func (s *AttributeLimitExceededException) Error() string

func (AttributeLimitExceededException) GoString added in v1.28.0 

func (s AttributeLimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttributeLimitExceededException) Message added in v1.28.0 

func (s *AttributeLimitExceededException) Message() string

Message returns the exception's message.

func (*AttributeLimitExceededException) OrigErr added in v1.28.0 

func (s *AttributeLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AttributeLimitExceededException) RequestID added in v1.28.0 

func (s *AttributeLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AttributeLimitExceededException) StatusCode added in v1.28.0 

func (s *AttributeLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AttributeLimitExceededException) String added in v1.28.0 

func (s AttributeLimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutoScalingGroupProvider added in v1.25.46 

type AutoScalingGroupProvider struct {

	// The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or
	// the Auto Scaling group name.
	//
	// AutoScalingGroupArn is a required field
	AutoScalingGroupArn *string `locationName:"autoScalingGroupArn" type:"string" required:"true"`

	// The managed draining option for the Auto Scaling group capacity provider.
	// When you enable this, Amazon ECS manages and gracefully drains the EC2 container
	// instances that are in the Auto Scaling group capacity provider.
	ManagedDraining *string `locationName:"managedDraining" type:"string" enum:"ManagedDraining"`

	// The managed scaling settings for the Auto Scaling group capacity provider.
	ManagedScaling *ManagedScaling `locationName:"managedScaling" type:"structure"`

	// The managed termination protection setting to use for the Auto Scaling group
	// capacity provider. This determines whether the Auto Scaling group has managed
	// termination protection. The default is off.
	//
	// When using managed termination protection, managed scaling must also be used
	// otherwise managed termination protection doesn't work.
	//
	// When managed termination protection is on, Amazon ECS prevents the Amazon
	// EC2 instances in an Auto Scaling group that contain tasks from being terminated
	// during a scale-in action. The Auto Scaling group and each instance in the
	// Auto Scaling group must have instance protection from scale-in actions on
	// as well. For more information, see Instance Protection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection)
	// in the Auto Scaling User Guide.
	//
	// When managed termination protection is off, your Amazon EC2 instances aren't
	// protected from termination when the Auto Scaling group scales in.
	ManagedTerminationProtection *string `locationName:"managedTerminationProtection" type:"string" enum:"ManagedTerminationProtection"`
	// contains filtered or unexported fields
}

The details of the Auto Scaling group for the capacity provider.

func (AutoScalingGroupProvider) GoString added in v1.25.46 

func (s AutoScalingGroupProvider) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoScalingGroupProvider) SetAutoScalingGroupArn added in v1.25.46 

func (s *AutoScalingGroupProvider) SetAutoScalingGroupArn(v string) *AutoScalingGroupProvider

SetAutoScalingGroupArn sets the AutoScalingGroupArn field's value.

func (*AutoScalingGroupProvider) SetManagedDraining added in v1.49.15 

func (s *AutoScalingGroupProvider) SetManagedDraining(v string) *AutoScalingGroupProvider

SetManagedDraining sets the ManagedDraining field's value.

func (*AutoScalingGroupProvider) SetManagedScaling added in v1.25.46 

func (s *AutoScalingGroupProvider) SetManagedScaling(v *ManagedScaling) *AutoScalingGroupProvider

SetManagedScaling sets the ManagedScaling field's value.

func (*AutoScalingGroupProvider) SetManagedTerminationProtection added in v1.25.46 

func (s *AutoScalingGroupProvider) SetManagedTerminationProtection(v string) *AutoScalingGroupProvider

SetManagedTerminationProtection sets the ManagedTerminationProtection field's value.

func (AutoScalingGroupProvider) String added in v1.25.46 

func (s AutoScalingGroupProvider) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoScalingGroupProvider) Validate added in v1.25.46 

func (s *AutoScalingGroupProvider) Validate() error

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

type AutoScalingGroupProviderUpdate added in v1.35.34 

type AutoScalingGroupProviderUpdate struct {

	// The managed draining option for the Auto Scaling group capacity provider.
	// When you enable this, Amazon ECS manages and gracefully drains the EC2 container
	// instances that are in the Auto Scaling group capacity provider.
	ManagedDraining *string `locationName:"managedDraining" type:"string" enum:"ManagedDraining"`

	// The managed scaling settings for the Auto Scaling group capacity provider.
	ManagedScaling *ManagedScaling `locationName:"managedScaling" type:"structure"`

	// The managed termination protection setting to use for the Auto Scaling group
	// capacity provider. This determines whether the Auto Scaling group has managed
	// termination protection.
	//
	// When using managed termination protection, managed scaling must also be used
	// otherwise managed termination protection doesn't work.
	//
	// When managed termination protection is on, Amazon ECS prevents the Amazon
	// EC2 instances in an Auto Scaling group that contain tasks from being terminated
	// during a scale-in action. The Auto Scaling group and each instance in the
	// Auto Scaling group must have instance protection from scale-in actions on.
	// For more information, see Instance Protection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection)
	// in the Auto Scaling User Guide.
	//
	// When managed termination protection is off, your Amazon EC2 instances aren't
	// protected from termination when the Auto Scaling group scales in.
	ManagedTerminationProtection *string `locationName:"managedTerminationProtection" type:"string" enum:"ManagedTerminationProtection"`
	// contains filtered or unexported fields
}

The details of the Auto Scaling group capacity provider to update.

func (AutoScalingGroupProviderUpdate) GoString added in v1.35.34 

func (s AutoScalingGroupProviderUpdate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoScalingGroupProviderUpdate) SetManagedDraining added in v1.49.15 

func (s *AutoScalingGroupProviderUpdate) SetManagedDraining(v string) *AutoScalingGroupProviderUpdate

SetManagedDraining sets the ManagedDraining field's value.

func (*AutoScalingGroupProviderUpdate) SetManagedScaling added in v1.35.34 

func (s *AutoScalingGroupProviderUpdate) SetManagedScaling(v *ManagedScaling) *AutoScalingGroupProviderUpdate

SetManagedScaling sets the ManagedScaling field's value.

func (*AutoScalingGroupProviderUpdate) SetManagedTerminationProtection added in v1.35.34 

func (s *AutoScalingGroupProviderUpdate) SetManagedTerminationProtection(v string) *AutoScalingGroupProviderUpdate

SetManagedTerminationProtection sets the ManagedTerminationProtection field's value.

func (AutoScalingGroupProviderUpdate) String added in v1.35.34 

func (s AutoScalingGroupProviderUpdate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoScalingGroupProviderUpdate) Validate added in v1.35.34 

func (s *AutoScalingGroupProviderUpdate) 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.
	// The default value is DISABLED.
	AssignPublicIp *string `locationName:"assignPublicIp" type:"string" enum:"AssignPublicIp"`

	// The IDs of the security groups associated with the task or service. If you
	// don't specify a security group, the default security group for the VPC is
	// used. There's a limit of 5 security groups that can be specified per AwsVpcConfiguration.
	//
	// All specified security groups must be from the same VPC.
	SecurityGroups []*string `locationName:"securityGroups" type:"list"`

	// The IDs of the subnets associated with the task or service. There's a limit
	// of 16 subnets that can be specified per AwsVpcConfiguration.
	//
	// All specified subnets must be from the same VPC.
	//
	// 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. For example awsvpcConfiguration={subnets=["subnet-12344321"],securityGroups=["sg-12344321"]}

func (AwsVpcConfiguration) GoString added in v1.12.27 

func (s AwsVpcConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 BlockedException added in v1.28.0 

type BlockedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Your Amazon Web Services account was blocked. For more information, contact Amazon Web Services Support (http://aws.amazon.com/contact-us/).

func (*BlockedException) Code added in v1.28.0 

func (s *BlockedException) Code() string

Code returns the exception type name.

func (*BlockedException) Error added in v1.28.0 

func (s *BlockedException) Error() string

func (BlockedException) GoString added in v1.28.0 

func (s BlockedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BlockedException) Message added in v1.28.0 

func (s *BlockedException) Message() string

Message returns the exception's message.

func (*BlockedException) OrigErr added in v1.28.0 

func (s *BlockedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BlockedException) RequestID added in v1.28.0 

func (s *BlockedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BlockedException) StatusCode added in v1.28.0 

func (s *BlockedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BlockedException) String added in v1.28.0 

func (s BlockedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CapacityProvider added in v1.25.46 

type CapacityProvider struct {

	// The Auto Scaling group settings for the capacity provider.
	AutoScalingGroupProvider *AutoScalingGroupProvider `locationName:"autoScalingGroupProvider" type:"structure"`

	// The Amazon Resource Name (ARN) that identifies the capacity provider.
	CapacityProviderArn *string `locationName:"capacityProviderArn" type:"string"`

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

	// The current status of the capacity provider. Only capacity providers in an
	// ACTIVE state can be used in a cluster. When a capacity provider is successfully
	// deleted, it has an INACTIVE status.
	Status *string `locationName:"status" type:"string" enum:"CapacityProviderStatus"`

	// The metadata that you apply to the capacity provider to help you categorize
	// and organize it. Each tag consists of a key and an optional value. You define
	// both.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case-sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for either keys or values as it is reserved for Amazon Web
	//    Services use. You cannot edit or delete tag keys or values with this prefix.
	//    Tags with this prefix do not count against your tags per resource limit.
	Tags []*Tag `locationName:"tags" type:"list"`

	// The update status of the capacity provider. The following are the possible
	// states that is returned.
	//
	// DELETE_IN_PROGRESS
	//
	// The capacity provider is in the process of being deleted.
	//
	// DELETE_COMPLETE
	//
	// The capacity provider was successfully deleted and has an INACTIVE status.
	//
	// DELETE_FAILED
	//
	// The capacity provider can't be deleted. The update status reason provides
	// further details about why the delete failed.
	UpdateStatus *string `locationName:"updateStatus" type:"string" enum:"CapacityProviderUpdateStatus"`

	// The update status reason. This provides further details about the update
	// status for the capacity provider.
	UpdateStatusReason *string `locationName:"updateStatusReason" type:"string"`
	// contains filtered or unexported fields
}

The details for a capacity provider.

func (CapacityProvider) GoString added in v1.25.46 

func (s CapacityProvider) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CapacityProvider) SetAutoScalingGroupProvider added in v1.25.46 

func (s *CapacityProvider) SetAutoScalingGroupProvider(v *AutoScalingGroupProvider) *CapacityProvider

SetAutoScalingGroupProvider sets the AutoScalingGroupProvider field's value.

func (*CapacityProvider) SetCapacityProviderArn added in v1.25.46 

func (s *CapacityProvider) SetCapacityProviderArn(v string) *CapacityProvider

SetCapacityProviderArn sets the CapacityProviderArn field's value.

func (*CapacityProvider) SetName added in v1.25.46 

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

SetName sets the Name field's value.

func (*CapacityProvider) SetStatus added in v1.25.46 

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

SetStatus sets the Status field's value.

func (*CapacityProvider) SetTags added in v1.25.46 

func (s *CapacityProvider) SetTags(v []*Tag) *CapacityProvider

SetTags sets the Tags field's value.

func (*CapacityProvider) SetUpdateStatus added in v1.32.0 

func (s *CapacityProvider) SetUpdateStatus(v string) *CapacityProvider

SetUpdateStatus sets the UpdateStatus field's value.

func (*CapacityProvider) SetUpdateStatusReason added in v1.32.0 

func (s *CapacityProvider) SetUpdateStatusReason(v string) *CapacityProvider

SetUpdateStatusReason sets the UpdateStatusReason field's value.

func (CapacityProvider) String added in v1.25.46 

func (s CapacityProvider) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CapacityProviderStrategyItem added in v1.25.46 

type CapacityProviderStrategyItem struct {

	// The base value designates how many tasks, at a minimum, to run on the specified
	// capacity provider. Only one capacity provider in a capacity provider strategy
	// can have a base defined. If no value is specified, the default value of 0
	// is used.
	Base *int64 `locationName:"base" type:"integer"`

	// The short name of the capacity provider.
	//
	// CapacityProvider is a required field
	CapacityProvider *string `locationName:"capacityProvider" type:"string" required:"true"`

	// The weight value designates the relative percentage of the total number of
	// tasks launched that should use the specified capacity provider. The weight
	// value is taken into consideration after the base value, if defined, is satisfied.
	//
	// If no weight value is specified, the default value of 0 is used. When multiple
	// capacity providers are specified within a capacity provider strategy, at
	// least one of the capacity providers must have a weight value greater than
	// zero and any capacity providers with a weight of 0 can't be used to place
	// tasks. If you specify multiple capacity providers in a strategy that all
	// have a weight of 0, any RunTask or CreateService actions using the capacity
	// provider strategy will fail.
	//
	// An example scenario for using weights is defining a strategy that contains
	// two capacity providers and both have a weight of 1, then when the base is
	// satisfied, the tasks will be split evenly across the two capacity providers.
	// Using that same logic, if you specify a weight of 1 for capacityProviderA
	// and a weight of 4 for capacityProviderB, then for every one task that's run
	// using capacityProviderA, four tasks would use capacityProviderB.
	Weight *int64 `locationName:"weight" type:"integer"`
	// contains filtered or unexported fields
}

The details of a capacity provider strategy. A capacity provider strategy can be set when using the RunTask or CreateCluster APIs or as the default capacity provider strategy for a cluster with the CreateCluster API.

Only capacity providers that are already associated with a cluster and have an ACTIVE or UPDATING status can be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.

With FARGATE_SPOT, you can run interruption tolerant tasks at a rate that's discounted compared to the FARGATE price. FARGATE_SPOT runs tasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are interrupted with a two-minute warning. FARGATE_SPOT only supports Linux tasks with the X86_64 architecture on platform version 1.3.0 or later.

A capacity provider strategy may contain a maximum of 6 capacity providers.

func (CapacityProviderStrategyItem) GoString added in v1.25.46 

func (s CapacityProviderStrategyItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CapacityProviderStrategyItem) SetBase added in v1.25.46 

func (s *CapacityProviderStrategyItem) SetBase(v int64) *CapacityProviderStrategyItem

SetBase sets the Base field's value.

func (*CapacityProviderStrategyItem) SetCapacityProvider added in v1.25.46 

func (s *CapacityProviderStrategyItem) SetCapacityProvider(v string) *CapacityProviderStrategyItem

SetCapacityProvider sets the CapacityProvider field's value.

func (*CapacityProviderStrategyItem) SetWeight added in v1.25.46 

func (s *CapacityProviderStrategyItem) SetWeight(v int64) *CapacityProviderStrategyItem

SetWeight sets the Weight field's value.

func (CapacityProviderStrategyItem) String added in v1.25.46 

func (s CapacityProviderStrategyItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CapacityProviderStrategyItem) Validate added in v1.25.46 

func (s *CapacityProviderStrategyItem) Validate() error

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

type ClientException added in v1.28.0 

type ClientException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Message that describes the cause of the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

func (*ClientException) Code added in v1.28.0 

func (s *ClientException) Code() string

Code returns the exception type name.

func (*ClientException) Error added in v1.28.0 

func (s *ClientException) Error() string

func (ClientException) GoString added in v1.28.0 

func (s ClientException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClientException) Message added in v1.28.0 

func (s *ClientException) Message() string

Message returns the exception's message.

func (*ClientException) OrigErr added in v1.28.0 

func (s *ClientException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ClientException) RequestID added in v1.28.0 

func (s *ClientException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ClientException) StatusCode added in v1.28.0 

func (s *ClientException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ClientException) String added in v1.28.0 

func (s ClientException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 resources attached to a cluster. When using a capacity provider with
	// a cluster, the capacity provider and associated resources are returned as
	// cluster attachments.
	Attachments []*Attachment `locationName:"attachments" type:"list"`

	// The status of the capacity providers associated with the cluster. The following
	// are the states that are returned.
	//
	// UPDATE_IN_PROGRESS
	//
	// The available capacity providers for the cluster are updating.
	//
	// UPDATE_COMPLETE
	//
	// The capacity providers have successfully updated.
	//
	// UPDATE_FAILED
	//
	// The capacity provider updates failed.
	AttachmentsStatus *string `locationName:"attachmentsStatus" type:"string"`

	// The capacity providers associated with the cluster.
	CapacityProviders []*string `locationName:"capacityProviders" type:"list"`

	// The Amazon Resource Name (ARN) that identifies the cluster. For more information
	// about the ARN format, see Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids)
	// in the Amazon ECS Developer Guide.
	ClusterArn *string `locationName:"clusterArn" type:"string"`

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

	// The execute command configuration for the cluster.
	Configuration *ClusterConfiguration `locationName:"configuration" type:"structure"`

	// The default capacity provider strategy for the cluster. When services or
	// tasks are run in the cluster with no launch type or capacity provider strategy
	// specified, the default capacity provider strategy is used.
	DefaultCapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"defaultCapacityProviderStrategy" type:"list"`

	// 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. This includes
	// container instances in both ACTIVE and DRAINING status.
	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"`

	// Use this parameter to set a default Service Connect namespace. After you
	// set a default Service Connect namespace, any new services with Service Connect
	// turned on that are created in the cluster are added as client services in
	// the namespace. This setting only applies to new services that set the enabled
	// parameter to true in the ServiceConnectConfiguration. You can set the namespace
	// of each service individually in the ServiceConnectConfiguration to override
	// this default parameter.
	//
	// Tasks that run in a namespace can use short names to connect to services
	// in the namespace. Tasks can connect to services across all of the clusters
	// in the namespace. Tasks connect through a managed proxy container that collects
	// logs and metrics for increased visibility. Only the tasks that Amazon ECS
	// services create are supported with Service Connect. For more information,
	// see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
	// in the Amazon Elastic Container Service Developer Guide.
	ServiceConnectDefaults *ClusterServiceConnectDefaults `locationName:"serviceConnectDefaults" type:"structure"`

	// The settings for the cluster. This parameter indicates whether CloudWatch
	// Container Insights is on or off for a cluster.
	Settings []*ClusterSetting `locationName:"settings" type:"list"`

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

	// The status of the cluster. The following are the possible states that are
	// returned.
	//
	// ACTIVE
	//
	// The cluster is ready to accept tasks and if applicable you can register container
	// instances with the cluster.
	//
	// PROVISIONING
	//
	// The cluster has capacity providers that are associated with it and the resources
	// needed for the capacity provider are being created.
	//
	// DEPROVISIONING
	//
	// The cluster has capacity providers that are associated with it and the resources
	// needed for the capacity provider are being deleted.
	//
	// FAILED
	//
	// The cluster has capacity providers that are associated with it and the resources
	// needed for the capacity provider have failed to create.
	//
	// INACTIVE
	//
	// The cluster has been deleted. Clusters with an INACTIVE status may remain
	// discoverable in your account for a period of time. However, this behavior
	// is subject to change in the future. We don't recommend that you rely on INACTIVE
	// clusters persisting.
	Status *string `locationName:"status" type:"string"`

	// The metadata that you apply to the cluster to help you categorize and organize
	// them. Each tag consists of a key and an optional value. You define both.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case-sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for either keys or values as it is reserved for Amazon Web
	//    Services use. You cannot edit or delete tag keys or values with this prefix.
	//    Tags with this prefix do not count against your tags per resource limit.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

A regional grouping of one or more container instances where 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Cluster) SetActiveServicesCount added in v1.5.0 

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

SetActiveServicesCount sets the ActiveServicesCount field's value.

func (*Cluster) SetAttachments added in v1.25.46 

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

SetAttachments sets the Attachments field's value.

func (*Cluster) SetAttachmentsStatus added in v1.25.46 

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

SetAttachmentsStatus sets the AttachmentsStatus field's value.

func (*Cluster) SetCapacityProviders added in v1.25.46 

func (s *Cluster) SetCapacityProviders(v []*string) *Cluster

SetCapacityProviders sets the CapacityProviders 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) SetConfiguration added in v1.37.31 

func (s *Cluster) SetConfiguration(v *ClusterConfiguration) *Cluster

SetConfiguration sets the Configuration field's value.

func (*Cluster) SetDefaultCapacityProviderStrategy added in v1.25.46 

func (s *Cluster) SetDefaultCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *Cluster

SetDefaultCapacityProviderStrategy sets the DefaultCapacityProviderStrategy 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) SetServiceConnectDefaults added in v1.44.146 

func (s *Cluster) SetServiceConnectDefaults(v *ClusterServiceConnectDefaults) *Cluster

SetServiceConnectDefaults sets the ServiceConnectDefaults field's value.

func (*Cluster) SetSettings added in v1.21.0 

func (s *Cluster) SetSettings(v []*ClusterSetting) *Cluster

SetSettings sets the Settings 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) SetTags added in v1.15.77 

func (s *Cluster) SetTags(v []*Tag) *Cluster

SetTags sets the Tags field's value.

func (Cluster) String added in v0.6.5 

func (s Cluster) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClusterConfiguration added in v1.37.31 

type ClusterConfiguration struct {

	// The details of the execute command configuration.
	ExecuteCommandConfiguration *ExecuteCommandConfiguration `locationName:"executeCommandConfiguration" type:"structure"`

	// The details of the managed storage configuration.
	ManagedStorageConfiguration *ManagedStorageConfiguration `locationName:"managedStorageConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

The execute command and managed storage configuration for the cluster.

func (ClusterConfiguration) GoString added in v1.37.31 

func (s ClusterConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterConfiguration) SetExecuteCommandConfiguration added in v1.37.31 

func (s *ClusterConfiguration) SetExecuteCommandConfiguration(v *ExecuteCommandConfiguration) *ClusterConfiguration

SetExecuteCommandConfiguration sets the ExecuteCommandConfiguration field's value.

func (*ClusterConfiguration) SetManagedStorageConfiguration added in v1.53.20 

func (s *ClusterConfiguration) SetManagedStorageConfiguration(v *ManagedStorageConfiguration) *ClusterConfiguration

SetManagedStorageConfiguration sets the ManagedStorageConfiguration field's value.

func (ClusterConfiguration) String added in v1.37.31 

func (s ClusterConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClusterContainsContainerInstancesException added in v1.28.0 

type ClusterContainsContainerInstancesException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You can't delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.

func (*ClusterContainsContainerInstancesException) Code added in v1.28.0 

func (s *ClusterContainsContainerInstancesException) Code() string

Code returns the exception type name.

func (*ClusterContainsContainerInstancesException) Error added in v1.28.0 

func (s *ClusterContainsContainerInstancesException) Error() string

func (ClusterContainsContainerInstancesException) GoString added in v1.28.0 

func (s ClusterContainsContainerInstancesException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterContainsContainerInstancesException) Message added in v1.28.0 

func (s *ClusterContainsContainerInstancesException) Message() string

Message returns the exception's message.

func (*ClusterContainsContainerInstancesException) OrigErr added in v1.28.0 

func (s *ClusterContainsContainerInstancesException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ClusterContainsContainerInstancesException) RequestID added in v1.28.0 

func (s *ClusterContainsContainerInstancesException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ClusterContainsContainerInstancesException) StatusCode added in v1.28.0 

func (s *ClusterContainsContainerInstancesException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ClusterContainsContainerInstancesException) String added in v1.28.0 

func (s ClusterContainsContainerInstancesException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClusterContainsServicesException added in v1.28.0 

type ClusterContainsServicesException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You can't delete a cluster that contains services. First, update the service to reduce its desired task count to 0, and then delete the service. For more information, see UpdateService and DeleteService.

func (*ClusterContainsServicesException) Code added in v1.28.0 

func (s *ClusterContainsServicesException) Code() string

Code returns the exception type name.

func (*ClusterContainsServicesException) Error added in v1.28.0 

func (s *ClusterContainsServicesException) Error() string

func (ClusterContainsServicesException) GoString added in v1.28.0 

func (s ClusterContainsServicesException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterContainsServicesException) Message added in v1.28.0 

func (s *ClusterContainsServicesException) Message() string

Message returns the exception's message.

func (*ClusterContainsServicesException) OrigErr added in v1.28.0 

func (s *ClusterContainsServicesException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ClusterContainsServicesException) RequestID added in v1.28.0 

func (s *ClusterContainsServicesException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ClusterContainsServicesException) StatusCode added in v1.28.0 

func (s *ClusterContainsServicesException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ClusterContainsServicesException) String added in v1.28.0 

func (s ClusterContainsServicesException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClusterContainsTasksException added in v1.28.0 

type ClusterContainsTasksException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You can't delete a cluster that has active tasks.

func (*ClusterContainsTasksException) Code added in v1.28.0 

func (s *ClusterContainsTasksException) Code() string

Code returns the exception type name.

func (*ClusterContainsTasksException) Error added in v1.28.0 

func (s *ClusterContainsTasksException) Error() string

func (ClusterContainsTasksException) GoString added in v1.28.0 

func (s ClusterContainsTasksException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterContainsTasksException) Message added in v1.28.0 

func (s *ClusterContainsTasksException) Message() string

Message returns the exception's message.

func (*ClusterContainsTasksException) OrigErr added in v1.28.0 

func (s *ClusterContainsTasksException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ClusterContainsTasksException) RequestID added in v1.28.0 

func (s *ClusterContainsTasksException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ClusterContainsTasksException) StatusCode added in v1.28.0 

func (s *ClusterContainsTasksException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ClusterContainsTasksException) String added in v1.28.0 

func (s ClusterContainsTasksException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClusterNotFoundException added in v1.28.0 

type ClusterNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

func (*ClusterNotFoundException) Code added in v1.28.0 

func (s *ClusterNotFoundException) Code() string

Code returns the exception type name.

func (*ClusterNotFoundException) Error added in v1.28.0 

func (s *ClusterNotFoundException) Error() string

func (ClusterNotFoundException) GoString added in v1.28.0 

func (s ClusterNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterNotFoundException) Message added in v1.28.0 

func (s *ClusterNotFoundException) Message() string

Message returns the exception's message.

func (*ClusterNotFoundException) OrigErr added in v1.28.0 

func (s *ClusterNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ClusterNotFoundException) RequestID added in v1.28.0 

func (s *ClusterNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ClusterNotFoundException) StatusCode added in v1.28.0 

func (s *ClusterNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ClusterNotFoundException) String added in v1.28.0 

func (s ClusterNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClusterServiceConnectDefaults added in v1.44.146 

type ClusterServiceConnectDefaults struct {

	// The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace.
	// When you create a service and don't specify a Service Connect configuration,
	// this namespace is used.
	Namespace *string `locationName:"namespace" type:"string"`
	// contains filtered or unexported fields
}

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the Amazon Elastic Container Service Developer Guide.

func (ClusterServiceConnectDefaults) GoString added in v1.44.146 

func (s ClusterServiceConnectDefaults) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterServiceConnectDefaults) SetNamespace added in v1.44.146 

func (s *ClusterServiceConnectDefaults) SetNamespace(v string) *ClusterServiceConnectDefaults

SetNamespace sets the Namespace field's value.

func (ClusterServiceConnectDefaults) String added in v1.44.146 

func (s ClusterServiceConnectDefaults) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClusterServiceConnectDefaultsRequest added in v1.44.146 

type ClusterServiceConnectDefaultsRequest struct {

	// The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace
	// that's used when you create a service and don't specify a Service Connect
	// configuration. The namespace name can include up to 1024 characters. The
	// name is case-sensitive. The name can't include hyphens (-), tilde (~), greater
	// than (>), less than (<), or slash (/).
	//
	// If you enter an existing namespace name or ARN, then that namespace will
	// be used. Any namespace type is supported. The namespace must be in this account
	// and this Amazon Web Services Region.
	//
	// If you enter a new name, a Cloud Map namespace will be created. Amazon ECS
	// creates a Cloud Map namespace with the "API calls" method of instance discovery
	// only. This instance discovery method is the "HTTP" namespace type in the
	// Command Line Interface. Other types of instance discovery aren't used by
	// Service Connect.
	//
	// If you update the cluster with an empty string "" for the namespace name,
	// the cluster configuration for Service Connect is removed. Note that the namespace
	// will remain in Cloud Map and must be deleted separately.
	//
	// For more information about Cloud Map, see Working with Services (https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html)
	// in the Cloud Map Developer Guide.
	//
	// Namespace is a required field
	Namespace *string `locationName:"namespace" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the Amazon Elastic Container Service Developer Guide.

func (ClusterServiceConnectDefaultsRequest) GoString added in v1.44.146 

func (s ClusterServiceConnectDefaultsRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterServiceConnectDefaultsRequest) SetNamespace added in v1.44.146 

func (s *ClusterServiceConnectDefaultsRequest) SetNamespace(v string) *ClusterServiceConnectDefaultsRequest

SetNamespace sets the Namespace field's value.

func (ClusterServiceConnectDefaultsRequest) String added in v1.44.146 

func (s ClusterServiceConnectDefaultsRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterServiceConnectDefaultsRequest) Validate added in v1.44.146 

func (s *ClusterServiceConnectDefaultsRequest) Validate() error

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

type ClusterSetting added in v1.21.0 

type ClusterSetting struct {

	// The name of the cluster setting. The value is containerInsights .
	Name *string `locationName:"name" type:"string" enum:"ClusterSettingName"`

	// The value to set for the cluster setting. The supported values are enabled
	// and disabled.
	//
	// If you set name to containerInsights and value to enabled, CloudWatch Container
	// Insights will be on for the cluster, otherwise it will be off unless the
	// containerInsights account setting is turned on. If a cluster value is specified,
	// it will override the containerInsights value set with PutAccountSetting (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html)
	// or PutAccountSettingDefault (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html).
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.

func (ClusterSetting) GoString added in v1.21.0 

func (s ClusterSetting) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterSetting) SetName added in v1.21.0 

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

SetName sets the Name field's value.

func (*ClusterSetting) SetValue added in v1.21.0 

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

SetValue sets the Value field's value.

func (ClusterSetting) String added in v1.21.0 

func (s ClusterSetting) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException added in v1.47.10 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The existing task ARNs which are already associated with the clientToken.
	ResourceIds []*string `locationName:"resourceIds" type:"list"`
	// contains filtered or unexported fields
}

The RunTask request could not be processed due to conflicts. The provided clientToken is already in use with a different RunTask request. The resourceIds are the existing task ARNs which are already associated with the clientToken.

To fix this issue:

  • Run RunTask with a unique clientToken.

  • Run RunTask with the clientToken and the original set of parameters

func (*ConflictException) Code added in v1.47.10 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.47.10 

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.47.10 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message added in v1.47.10 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.47.10 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.47.10 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.47.10 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String added in v1.47.10 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Container 

type Container struct {

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

	// The number of CPU units set for the container. The value is 0 if no value
	// was specified in the container definition when the task definition was registered.
	Cpu *string `locationName:"cpu" type:"string"`

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

	// The IDs of each GPU assigned to the container.
	GpuIds []*string `locationName:"gpuIds" type:"list"`

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

	// The image used for the container.
	Image *string `locationName:"image" type:"string"`

	// The container image manifest digest.
	ImageDigest *string `locationName:"imageDigest" type:"string"`

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

	// The details of any Amazon ECS managed agents associated with the container.
	ManagedAgents []*ManagedAgent `locationName:"managedAgents" type:"list"`

	// The hard limit (in MiB) of memory set for the container.
	Memory *string `locationName:"memory" type:"string"`

	// The soft limit (in MiB) of memory set for the container.
	MemoryReservation *string `locationName:"memoryReservation" 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 ID of the Docker container.
	RuntimeId *string `locationName:"runtimeId" type:"string"`

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

A Docker container that's part of a task.

func (Container) GoString added in v0.6.5 

func (s Container) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Container) SetContainerArn added in v1.5.0 

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

SetContainerArn sets the ContainerArn field's value.

func (*Container) SetCpu added in v1.16.27 

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

SetCpu sets the Cpu 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) SetGpuIds added in v1.16.27 

func (s *Container) SetGpuIds(v []*string) *Container

SetGpuIds sets the GpuIds 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) SetImage added in v1.24.2 

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

SetImage sets the Image field's value.

func (*Container) SetImageDigest added in v1.24.2 

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

SetImageDigest sets the ImageDigest 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) SetManagedAgents added in v1.37.31 

func (s *Container) SetManagedAgents(v []*ManagedAgent) *Container

SetManagedAgents sets the ManagedAgents field's value.

func (*Container) SetMemory added in v1.16.27 

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

SetMemory sets the Memory field's value.

func (*Container) SetMemoryReservation added in v1.16.27 

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

SetMemoryReservation sets the MemoryReservation 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) SetRuntimeId added in v1.23.12 

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

SetRuntimeId sets the RuntimeId 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerDefinition 

type ContainerDefinition struct {

	// The command that's passed to the container. This parameter maps to Cmd in
	// the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the COMMAND parameter to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	// For more information, see https://docs.docker.com/engine/reference/builder/#cmd
	// (https://docs.docker.com/engine/reference/builder/#cmd). If there are multiple
	// arguments, each argument is a separated string in the array.
	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/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --cpu-shares option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// 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.
	//
	// 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's 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 is guaranteed a minimum of 512
	// CPU units when needed. Moreover, each container could float to higher CPU
	// usage if the other container was not using it. 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 isn't 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 two 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's described in the task definition. A null or zero CPU value
	// is passed to Docker as 0, which Windows interprets as 1% of one CPU.
	Cpu *int64 `locationName:"cpu" type:"integer"`

	// A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec) file that
	// configures the container for Active Directory authentication. We recommend
	// that you use this parameter instead of the dockerSecurityOptions. The maximum
	// number of ARNs is 1.
	//
	// There are two formats for each ARN.
	//
	// credentialspecdomainless:MyARN
	//
	// You use credentialspecdomainless:MyARN to provide a CredSpec with an additional
	// section for a secret in Secrets Manager. You provide the login credentials
	// to the domain in the secret.
	//
	// Each task that runs on any container instance can join different domains.
	//
	// You can use this format without joining the container instance to a domain.
	//
	// credentialspec:MyARN
	//
	// You use credentialspec:MyARN to provide a CredSpec for a single domain.
	//
	// You must join the container instance to the domain before you start any tasks
	// that use this task definition.
	//
	// In both formats, replace MyARN with the ARN in SSM or Amazon S3.
	//
	// If you provide a credentialspecdomainless:MyARN, the credspec must provide
	// a ARN in Secrets Manager for a secret containing the username, password,
	// and the domain to connect to. For better security, the instance isn't joined
	// to the domain for domainless authentication. Other applications on the instance
	// can't use the domainless credentials. You can use this parameter to run tasks
	// on the same instance, even it the tasks need to join different domains. For
	// more information, see Using gMSAs for Windows Containers (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html)
	// and Using gMSAs for Linux Containers (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html).
	CredentialSpecs []*string `locationName:"credentialSpecs" type:"list"`

	// The dependencies defined for container startup and shutdown. A container
	// can contain multiple dependencies on other containers in a task definition.
	// When a dependency is defined for container startup, for container shutdown
	// it is reversed.
	//
	// For tasks using the EC2 launch type, the container instances require at least
	// version 1.26.0 of the container agent to turn on container dependencies.
	// However, we recommend using the latest container agent version. For information
	// about checking your agent version and updating to the latest version, see
	// Updating the Amazon ECS Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html)
	// in the Amazon Elastic Container Service Developer Guide. If you're using
	// an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1
	// of the ecs-init package. If your container instances are launched from version
	// 20190301 or later, then they contain the required versions of the container
	// agent and ecs-init. For more information, see Amazon ECS-optimized Linux
	// AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// For tasks using the Fargate launch type, the task or service requires the
	// following platforms:
	//
	//    * Linux platform version 1.3.0 or later.
	//
	//    * Windows platform version 1.0.0 or later.
	DependsOn []*ContainerDependency `locationName:"dependsOn" type:"list"`

	// When this parameter is true, networking is off within the container. This
	// parameter maps to NetworkDisabled in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/).
	//
	// 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/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --dns-search option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// 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/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --dns option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// 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/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --label option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	// 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 --format '{{.Server.APIVersion}}'
	DockerLabels map[string]*string `locationName:"dockerLabels" type:"map"`

	// A list of strings to provide custom configuration for multiple security systems.
	// For more information about valid values, see Docker Run Security Configuration
	// (https://docs.docker.com/engine/reference/run/#security-configuration). This
	// field isn't valid for containers in tasks using the Fargate launch type.
	//
	// For Linux tasks on EC2, this parameter can be used to reference custom labels
	// for SELinux and AppArmor multi-level security systems.
	//
	// For any tasks on EC2, this parameter can be used to reference a credential
	// spec file that configures a container for Active Directory authentication.
	// For more information, see Using gMSAs for Windows Containers (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html)
	// and Using gMSAs for Linux Containers (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// This parameter maps to SecurityOpt in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --security-opt option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// 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
	// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// For more information about valid values, see Docker Run Security Configuration
	// (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" |
	// "credentialspec:CredentialSpecFilePath"
	DockerSecurityOptions []*string `locationName:"dockerSecurityOptions" type:"list"`

	//
	// Early versions of the Amazon ECS container agent don't 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's passed to the container. This parameter maps to Entrypoint
	// in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --entrypoint option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	// 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/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --env option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// We don't recommend that you use plaintext environment variables for sensitive
	// information, such as credential data.
	Environment []*KeyValuePair `locationName:"environment" type:"list"`

	// A list of files containing the environment variables to pass to a container.
	// This parameter maps to the --env-file option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// You can specify up to ten environment files. The file must have a .env file
	// extension. Each line in an environment file contains an environment variable
	// in VARIABLE=VALUE format. Lines beginning with # are treated as comments
	// and are ignored. For more information about the environment variable file
	// syntax, see Declare default environment variables in file (https://docs.docker.com/compose/env-file/).
	//
	// If there are environment variables specified using the environment parameter
	// in a container definition, they take precedence over the variables contained
	// within an environment file. If multiple environment files are specified that
	// contain the same variable, they're processed from the top down. We recommend
	// that you use unique variable names. For more information, see Specifying
	// Environment Variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html)
	// in the Amazon Elastic Container Service Developer Guide.
	EnvironmentFiles []*EnvironmentFile `locationName:"environmentFiles" 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, its failure doesn't 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's composed of multiple containers, 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
	// (https://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. This parameter maps to ExtraHosts in the Create a container
	// (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section
	// of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and
	// the --add-host option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// This parameter isn't supported for Windows containers or tasks that use the
	// awsvpc network mode.
	ExtraHosts []*HostEntry `locationName:"extraHosts" type:"list"`

	// The FireLens configuration for the container. This is used to specify and
	// configure a log router for container logs. For more information, see Custom
	// Log Routing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html)
	// in the Amazon Elastic Container Service Developer Guide.
	FirelensConfiguration *FirelensConfiguration `locationName:"firelensConfiguration" type:"structure"`

	// The container 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/api/v1.35/#operation/ContainerCreate) section
	// of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and
	// the HEALTHCHECK parameter of docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	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/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --hostname option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// The hostname parameter is not supported if you're using the awsvpc network
	// mode.
	Hostname *string `locationName:"hostname" type:"string"`

	// The image used to start a container. This string is passed directly to the
	// Docker daemon. By default, images in the Docker Hub registry are available.
	// 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/api/v1.35/#operation/ContainerCreate) section
	// of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and
	// the IMAGE parameter of docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	//    * 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 aren't 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"`

	// When this parameter is true, you can deploy containerized applications that
	// require stdin or a tty to be allocated. This parameter maps to OpenStdin
	// in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --interactive option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	Interactive *bool `locationName:"interactive" type:"boolean"`

	// The links parameter allows containers to communicate with each other without
	// the need for port mappings. This parameter is only supported if the network
	// mode of a task definition is bridge. The name:internalName construct is analogous
	// to name:alias in Docker links. Up to 255 letters (uppercase and lowercase),
	// numbers, underscores, and hyphens are allowed. For more information about
	// linking Docker containers, go to Legacy container links (https://docs.docker.com/network/links/)
	// in the Docker documentation. This parameter maps to Links in the Create a
	// container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --link option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// 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
	// kernel capabilities. For more information see KernelCapabilities.
	//
	// This parameter is not supported for Windows containers.
	LinuxParameters *LinuxParameters `locationName:"linuxParameters" type:"structure"`

	// The log configuration specification for the container.
	//
	// This parameter maps to LogConfig in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --log-driver option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	// By default, containers use the same logging driver that the Docker daemon
	// uses. However the container can 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 about 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 --format '{{.Server.APIVersion}}'
	//
	// 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 (https://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 amount (in MiB) of memory to present to the container. If your container
	// attempts to exceed the memory specified here, the container is killed. The
	// total amount of memory reserved for all containers within a task must be
	// lower than the task memory value, if one is specified. This parameter maps
	// to Memory in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --memory option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// If using the Fargate launch type, this parameter is optional.
	//
	// If using the EC2 launch type, you must specify either a task-level memory
	// value or a container-level memory value. If you specify both a container-level
	// memory and memoryReservation value, memory must be greater than memoryReservation.
	// If you specify memoryReservation, then that value is subtracted from the
	// available memory resources for the container instance where the container
	// is placed. Otherwise, the value of memory is used.
	//
	// The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory
	// for a container. So, don't specify less than 6 MiB of memory for your containers.
	//
	// The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory
	// for a container. So, don't specify less 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/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --memory-reservation option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// If a task-level memory value is not specified, you must specify a non-zero
	// integer for one or both of memory or memoryReservation in a container definition.
	// 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 where 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 20.10.0 or later daemon reserves a minimum of 6 MiB of memory
	// for a container. So, don't specify less than 6 MiB of memory for your containers.
	//
	// The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory
	// for a container. So, don't specify less 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/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --volume option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// Windows containers can mount whole directories on the same drive as $env:ProgramData.
	// Windows containers can't mount directories on a different drive, and mount
	// point can't be across drives.
	MountPoints []*MountPoint `locationName:"mountPoints" type:"list"`

	// The name of a container. If you're 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, underscores, and hyphens are allowed. This parameter
	// maps to name in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --name option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	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, 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's no loopback for port mappings on Windows, so you can't 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/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --publish option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	// 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. The assignments
	// are also visible in 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/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --privileged option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// This parameter is not supported for Windows containers or tasks run on Fargate.
	Privileged *bool `locationName:"privileged" type:"boolean"`

	// When this parameter is true, a TTY is allocated. This parameter maps to Tty
	// in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --tty option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	PseudoTerminal *bool `locationName:"pseudoTerminal" 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/api/v1.35/#operation/ContainerCreate) section
	// of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and
	// the --read-only option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// This parameter is not supported for Windows containers.
	ReadonlyRootFilesystem *bool `locationName:"readonlyRootFilesystem" type:"boolean"`

	// The private repository authentication credentials to use.
	RepositoryCredentials *RepositoryCredentials `locationName:"repositoryCredentials" type:"structure"`

	// The type and amount of a resource to assign to a container. The only supported
	// resource is a GPU.
	ResourceRequirements []*ResourceRequirement `locationName:"resourceRequirements" type:"list"`

	// The secrets to pass to the container. For more information, see Specifying
	// Sensitive Data (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html)
	// in the Amazon Elastic Container Service Developer Guide.
	Secrets []*Secret `locationName:"secrets" type:"list"`

	// Time duration (in seconds) to wait before giving up on resolving dependencies
	// for a container. For example, you specify two containers in a task definition
	// with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS,
	// or HEALTHY status. If a startTimeout value is specified for containerB and
	// it doesn't reach the desired status within that time then containerA gives
	// up and not start. This results in the task transitioning to a STOPPED state.
	//
	// When the ECS_CONTAINER_START_TIMEOUT container agent configuration variable
	// is used, it's enforced independently from this start timeout value.
	//
	// For tasks using the Fargate launch type, the task or service requires the
	// following platforms:
	//
	//    * Linux platform version 1.3.0 or later.
	//
	//    * Windows platform version 1.0.0 or later.
	//
	// For tasks using the EC2 launch type, your container instances require at
	// least version 1.26.0 of the container agent to use a container start timeout
	// value. However, we recommend using the latest container agent version. For
	// information about checking your agent version and updating to the latest
	// version, see Updating the Amazon ECS Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html)
	// in the Amazon Elastic Container Service Developer Guide. If you're using
	// an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1
	// of the ecs-init package. If your container instances are launched from version
	// 20190301 or later, then they contain the required versions of the container
	// agent and ecs-init. For more information, see Amazon ECS-optimized Linux
	// AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// The valid values are 2-120 seconds.
	StartTimeout *int64 `locationName:"startTimeout" type:"integer"`

	// Time duration (in seconds) to wait before the container is forcefully killed
	// if it doesn't exit normally on its own.
	//
	// For tasks using the Fargate launch type, the task or service requires the
	// following platforms:
	//
	//    * Linux platform version 1.3.0 or later.
	//
	//    * Windows platform version 1.0.0 or later.
	//
	// The max stop timeout value is 120 seconds and if the parameter is not specified,
	// the default value of 30 seconds is used.
	//
	// For tasks that use the EC2 launch type, if the stopTimeout parameter isn't
	// specified, the value set for the Amazon ECS container agent configuration
	// variable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the stopTimeout parameter
	// or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then
	// the default values of 30 seconds for Linux containers and 30 seconds on Windows
	// containers are used. Your container instances require at least version 1.26.0
	// of the container agent to use a container stop timeout value. However, we
	// recommend using the latest container agent version. For information about
	// checking your agent version and updating to the latest version, see Updating
	// the Amazon ECS Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html)
	// in the Amazon Elastic Container Service Developer Guide. If you're using
	// an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1
	// of the ecs-init package. If your container instances are launched from version
	// 20190301 or later, then they contain the required versions of the container
	// agent and ecs-init. For more information, see Amazon ECS-optimized Linux
	// AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// The valid values are 2-120 seconds.
	StopTimeout *int64 `locationName:"stopTimeout" type:"integer"`

	// A list of namespaced kernel parameters to set in the container. This parameter
	// maps to Sysctls in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --sysctl option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	// For example, you can configure net.ipv4.tcp_keepalive_time setting to maintain
	// longer lived connections.
	SystemControls []*SystemControl `locationName:"systemControls" type:"list"`

	// A list of ulimits to set in the container. If a ulimit value is specified
	// in a task definition, it overrides the default values set by Docker. This
	// parameter maps to Ulimits in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --ulimit option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	// Valid naming values are displayed in the Ulimit data type.
	//
	// Amazon ECS tasks hosted on Fargate use the default resource limit values
	// set by the operating system with the exception of the nofile resource limit
	// parameter which Fargate overrides. The nofile resource limit sets a restriction
	// on the number of open files that a container can use. The default nofile
	// soft limit is 1024 and the default hard limit is 65535.
	//
	// 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 --format '{{.Server.APIVersion}}'
	//
	// This parameter is not supported for Windows containers.
	Ulimits []*Ulimit `locationName:"ulimits" type:"list"`

	// The user to use inside the container. This parameter maps to User in the
	// Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --user option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// When running tasks using the host network mode, don't run containers using
	// the root user (UID 0). We recommend using a non-root user for better security.
	//
	// You can specify the user using the following formats. If specifying a UID
	// or GID, you must specify it as a positive integer.
	//
	//    * user
	//
	//    * user:group
	//
	//    * uid
	//
	//    * uid:gid
	//
	//    * user:gid
	//
	//    * uid:group
	//
	// 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/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --volumes-from option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	VolumesFrom []*VolumeFrom `locationName:"volumesFrom" type:"list"`

	// The working directory to run commands inside the container in. This parameter
	// maps to WorkingDir in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --workdir option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetCredentialSpecs added in v1.44.294 

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

SetCredentialSpecs sets the CredentialSpecs field's value.

func (*ContainerDefinition) SetDependsOn added in v1.17.13 

func (s *ContainerDefinition) SetDependsOn(v []*ContainerDependency) *ContainerDefinition

SetDependsOn sets the DependsOn 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) SetEnvironmentFiles added in v1.31.0 

func (s *ContainerDefinition) SetEnvironmentFiles(v []*EnvironmentFile) *ContainerDefinition

SetEnvironmentFiles sets the EnvironmentFiles 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) SetFirelensConfiguration added in v1.23.13 

func (s *ContainerDefinition) SetFirelensConfiguration(v *FirelensConfiguration) *ContainerDefinition

SetFirelensConfiguration sets the FirelensConfiguration 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 (*ContainerDefinition) SetInteractive added in v1.15.36 

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

SetInteractive sets the Interactive 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) SetPseudoTerminal added in v1.15.36 

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

SetPseudoTerminal sets the PseudoTerminal 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) SetRepositoryCredentials added in v1.14.33 

func (s *ContainerDefinition) SetRepositoryCredentials(v *RepositoryCredentials) *ContainerDefinition

SetRepositoryCredentials sets the RepositoryCredentials field's value.

func (*ContainerDefinition) SetResourceRequirements added in v1.16.27 

func (s *ContainerDefinition) SetResourceRequirements(v []*ResourceRequirement) *ContainerDefinition

SetResourceRequirements sets the ResourceRequirements field's value.

func (*ContainerDefinition) SetSecrets added in v1.15.77 

func (s *ContainerDefinition) SetSecrets(v []*Secret) *ContainerDefinition

SetSecrets sets the Secrets field's value.

func (*ContainerDefinition) SetStartTimeout added in v1.17.13 

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

SetStartTimeout sets the StartTimeout field's value.

func (*ContainerDefinition) SetStopTimeout added in v1.17.13 

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

SetStopTimeout sets the StopTimeout field's value.

func (*ContainerDefinition) SetSystemControls added in v1.15.36 

func (s *ContainerDefinition) SetSystemControls(v []*SystemControl) *ContainerDefinition

SetSystemControls sets the SystemControls 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 ContainerDependency added in v1.17.13 

type ContainerDependency struct {

	// The dependency condition of the container. The following are the available
	// conditions and their behavior:
	//
	//    * START - This condition emulates the behavior of links and volumes today.
	//    It validates that a dependent container is started before permitting other
	//    containers to start.
	//
	//    * COMPLETE - This condition validates that a dependent container runs
	//    to completion (exits) before permitting other containers to start. This
	//    can be useful for nonessential containers that run a script and then exit.
	//    This condition can't be set on an essential container.
	//
	//    * SUCCESS - This condition is the same as COMPLETE, but it also requires
	//    that the container exits with a zero status. This condition can't be set
	//    on an essential container.
	//
	//    * HEALTHY - This condition validates that the dependent container passes
	//    its Docker health check before permitting other containers to start. This
	//    requires that the dependent container has health checks configured. This
	//    condition is confirmed only at task startup.
	//
	// Condition is a required field
	Condition *string `locationName:"condition" type:"string" required:"true" enum:"ContainerCondition"`

	// The name of a container.
	//
	// ContainerName is a required field
	ContainerName *string `locationName:"containerName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

Your Amazon ECS container instances require at least version 1.26.0 of the container agent to use container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the Amazon Elastic Container Service Developer Guide.

For tasks that use the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.

  • Windows platform version 1.0.0 or later.

For more information about how to create a container dependency, see Container dependency (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/example_task_definitions.html#example_task_definition-containerdependency) in the Amazon Elastic Container Service Developer Guide.

func (ContainerDependency) GoString added in v1.17.13 

func (s ContainerDependency) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerDependency) SetCondition added in v1.17.13 

func (s *ContainerDependency) SetCondition(v string) *ContainerDependency

SetCondition sets the Condition field's value.

func (*ContainerDependency) SetContainerName added in v1.17.13 

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

SetContainerName sets the ContainerName field's value.

func (ContainerDependency) String added in v1.17.13 

func (s ContainerDependency) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerDependency) Validate added in v1.17.13 

func (s *ContainerDependency) 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. An instance
	// with an agent that may be unhealthy or stopped return false. Only instances
	// connected to an agent can accept task placement requests.
	AgentConnected *bool `locationName:"agentConnected" type:"boolean"`

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

	// The resources attached to a container instance, such as an elastic network
	// interface.
	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 capacity provider that's associated with the container instance.
	CapacityProviderName *string `locationName:"capacityProviderName" type:"string"`

	// The Amazon Resource Name (ARN) of the container instance. For more information
	// about the ARN format, see Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids)
	// in the Amazon ECS Developer Guide.
	ContainerInstanceArn *string `locationName:"containerInstanceArn" type:"string"`

	// The ID of the container instance. For Amazon EC2 instances, this value is
	// the Amazon EC2 instance ID. For external instances, this value is the Amazon
	// Web Services Systems Manager managed instance ID.
	Ec2InstanceId *string `locationName:"ec2InstanceId" type:"string"`

	// An object representing the health status of the container instance.
	HealthStatus *ContainerInstanceHealthStatus `locationName:"healthStatus" type:"structure"`

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

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

	// 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 wasn't already 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's not specified here
	// is available for new tasks.
	RemainingResources []*Resource `locationName:"remainingResources" type:"list"`

	// The number of tasks on the container instance that have a desired status
	// (desiredStatus) of RUNNING.
	RunningTasksCount *int64 `locationName:"runningTasksCount" type:"integer"`

	// The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED,
	// ACTIVE, INACTIVE, DEREGISTERING, or DRAINING.
	//
	// If your account has opted in to the awsvpcTrunking account setting, then
	// any newly registered container instance will transition to a REGISTERING
	// status while the trunk elastic network interface is provisioned for the instance.
	// If the registration fails, the instance will transition to a REGISTRATION_FAILED
	// status. You can describe the container instance and see the reason for failure
	// in the statusReason parameter. Once the container instance is terminated,
	// the instance transitions to a DEREGISTERING status while the trunk elastic
	// network interface is deprovisioned. The instance then transitions to an INACTIVE
	// status.
	//
	// The ACTIVE status indicates that the container instance can accept tasks.
	// The DRAINING indicates that new tasks aren't 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 (https://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 reason that the container instance reached its current status.
	StatusReason *string `locationName:"statusReason" type:"string"`

	// The metadata that you apply to the container instance to help you categorize
	// and organize them. Each tag consists of a key and an optional value. You
	// define both.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case-sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for either keys or values as it is reserved for Amazon Web
	//    Services use. You cannot edit or delete tag keys or values with this prefix.
	//    Tags with this prefix do not count against your tags per resource limit.
	Tags []*Tag `locationName:"tags" type:"list"`

	// 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're 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 Amazon EC2 or External instance that's 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetCapacityProviderName added in v1.25.46 

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

SetCapacityProviderName sets the CapacityProviderName 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) SetHealthStatus added in v1.42.2 

func (s *ContainerInstance) SetHealthStatus(v *ContainerInstanceHealthStatus) *ContainerInstance

SetHealthStatus sets the HealthStatus 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) SetStatusReason added in v1.19.45 

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

SetStatusReason sets the StatusReason field's value.

func (*ContainerInstance) SetTags added in v1.15.77 

func (s *ContainerInstance) SetTags(v []*Tag) *ContainerInstance

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerInstanceHealthStatus added in v1.42.2 

type ContainerInstanceHealthStatus struct {

	// An array of objects representing the details of the container instance health
	// status.
	Details []*InstanceHealthCheckResult `locationName:"details" type:"list"`

	// The overall health status of the container instance. This is an aggregate
	// status of all container instance health checks.
	OverallStatus *string `locationName:"overallStatus" type:"string" enum:"InstanceHealthCheckState"`
	// contains filtered or unexported fields
}

An object representing the health status of the container instance.

func (ContainerInstanceHealthStatus) GoString added in v1.42.2 

func (s ContainerInstanceHealthStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerInstanceHealthStatus) SetDetails added in v1.42.2 

func (s *ContainerInstanceHealthStatus) SetDetails(v []*InstanceHealthCheckResult) *ContainerInstanceHealthStatus

SetDetails sets the Details field's value.

func (*ContainerInstanceHealthStatus) SetOverallStatus added in v1.42.2 

func (s *ContainerInstanceHealthStatus) SetOverallStatus(v string) *ContainerInstanceHealthStatus

SetOverallStatus sets the OverallStatus field's value.

func (ContainerInstanceHealthStatus) String added in v1.42.2 

func (s ContainerInstanceHealthStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// A list of files containing the environment variables to pass to a container,
	// instead of the value from the container definition.
	EnvironmentFiles []*EnvironmentFile `locationName:"environmentFiles" 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"`

	// The type and amount of a resource to assign to a container, instead of the
	// default value from the task definition. The only supported resource is a
	// GPU.
	ResourceRequirements []*ResourceRequirement `locationName:"resourceRequirements" type:"list"`
	// contains filtered or unexported fields
}

The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is {"containerOverrides": [ ] }. If a non-empty container override is specified, the name parameter must be included.

You can use Secrets Manager or Amazon Web Services Systems Manager Parameter Store to store the sensitive data. For more information, see Retrieve secrets through environment variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/secrets-envvar.html) in the Amazon ECS Developer Guide.

func (ContainerOverride) GoString added in v0.6.5 

func (s ContainerOverride) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetEnvironmentFiles added in v1.31.0 

func (s *ContainerOverride) SetEnvironmentFiles(v []*EnvironmentFile) *ContainerOverride

SetEnvironmentFiles sets the EnvironmentFiles 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) SetResourceRequirements added in v1.16.27 

func (s *ContainerOverride) SetResourceRequirements(v []*ResourceRequirement) *ContainerOverride

SetResourceRequirements sets the ResourceRequirements field's value.

func (ContainerOverride) String added in v0.6.5 

func (s ContainerOverride) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerOverride) Validate added in v1.16.27 

func (s *ContainerOverride) Validate() error

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

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"`

	// The container image SHA 256 digest.
	ImageDigest *string `locationName:"imageDigest" type:"string"`

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

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

	// The ID of the Docker container.
	RuntimeId *string `locationName:"runtimeId" type:"string"`

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

An object that represents 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetImageDigest added in v1.24.2 

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

SetImageDigest sets the ImageDigest 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) SetRuntimeId added in v1.23.12 

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

SetRuntimeId sets the RuntimeId 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateCapacityProviderInput added in v1.25.46 

type CreateCapacityProviderInput struct {

	// The details of the Auto Scaling group for the capacity provider.
	//
	// AutoScalingGroupProvider is a required field
	AutoScalingGroupProvider *AutoScalingGroupProvider `locationName:"autoScalingGroupProvider" type:"structure" required:"true"`

	// The name of the capacity provider. Up to 255 characters are allowed. They
	// include letters (both upper and lowercase letters), numbers, underscores
	// (_), and hyphens (-). The name can't be prefixed with "aws", "ecs", or "fargate".
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The metadata that you apply to the capacity provider to categorize and organize
	// them more conveniently. Each tag consists of a key and an optional value.
	// You define both of them.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case-sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for either keys or values as it is reserved for Amazon Web
	//    Services use. You cannot edit or delete tag keys or values with this prefix.
	//    Tags with this prefix do not count against your tags per resource limit.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateCapacityProviderInput) GoString added in v1.25.46 

func (s CreateCapacityProviderInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCapacityProviderInput) SetAutoScalingGroupProvider added in v1.25.46 

func (s *CreateCapacityProviderInput) SetAutoScalingGroupProvider(v *AutoScalingGroupProvider) *CreateCapacityProviderInput

SetAutoScalingGroupProvider sets the AutoScalingGroupProvider field's value.

func (*CreateCapacityProviderInput) SetName added in v1.25.46 

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

SetName sets the Name field's value.

func (*CreateCapacityProviderInput) SetTags added in v1.25.46 

func (s *CreateCapacityProviderInput) SetTags(v []*Tag) *CreateCapacityProviderInput

SetTags sets the Tags field's value.

func (CreateCapacityProviderInput) String added in v1.25.46 

func (s CreateCapacityProviderInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCapacityProviderInput) Validate added in v1.25.46 

func (s *CreateCapacityProviderInput) Validate() error

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

type CreateCapacityProviderOutput added in v1.25.46 

type CreateCapacityProviderOutput struct {

	// The full description of the new capacity provider.
	CapacityProvider *CapacityProvider `locationName:"capacityProvider" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateCapacityProviderOutput) GoString added in v1.25.46 

func (s CreateCapacityProviderOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCapacityProviderOutput) SetCapacityProvider added in v1.25.46 

func (s *CreateCapacityProviderOutput) SetCapacityProvider(v *CapacityProvider) *CreateCapacityProviderOutput

SetCapacityProvider sets the CapacityProvider field's value.

func (CreateCapacityProviderOutput) String added in v1.25.46 

func (s CreateCapacityProviderOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateClusterInput 

type CreateClusterInput struct {

	// The short name of one or more capacity providers to associate with the cluster.
	// A capacity provider must be associated with a cluster before it can be included
	// as part of the default capacity provider strategy of the cluster or used
	// in a capacity provider strategy when calling the CreateService (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html)
	// or RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html)
	// actions.
	//
	// If specifying a capacity provider that uses an Auto Scaling group, the capacity
	// provider must be created but not associated with another cluster. New Auto
	// Scaling group capacity providers can be created with the CreateCapacityProvider
	// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html)
	// API operation.
	//
	// To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT
	// capacity providers. The Fargate capacity providers are available to all accounts
	// and only need to be associated with a cluster to be used.
	//
	// The PutCapacityProvider (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html)
	// API operation is used to update the list of available capacity providers
	// for a cluster after the cluster is created.
	CapacityProviders []*string `locationName:"capacityProviders" type:"list"`

	// The name of your cluster. If you don't specify a name for your cluster, you
	// create a cluster that's named default. Up to 255 letters (uppercase and lowercase),
	// numbers, underscores, and hyphens are allowed.
	ClusterName *string `locationName:"clusterName" type:"string"`

	// The execute command configuration for the cluster.
	Configuration *ClusterConfiguration `locationName:"configuration" type:"structure"`

	// The capacity provider strategy to set as the default for the cluster. After
	// a default capacity provider strategy is set for a cluster, when you call
	// the CreateService (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html)
	// or RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html)
	// APIs with no capacity provider strategy or launch type specified, the default
	// capacity provider strategy for the cluster is used.
	//
	// If a default capacity provider strategy isn't defined for a cluster when
	// it was created, it can be defined later with the PutClusterCapacityProviders
	// API operation.
	DefaultCapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"defaultCapacityProviderStrategy" type:"list"`

	// Use this parameter to set a default Service Connect namespace. After you
	// set a default Service Connect namespace, any new services with Service Connect
	// turned on that are created in the cluster are added as client services in
	// the namespace. This setting only applies to new services that set the enabled
	// parameter to true in the ServiceConnectConfiguration. You can set the namespace
	// of each service individually in the ServiceConnectConfiguration to override
	// this default parameter.
	//
	// Tasks that run in a namespace can use short names to connect to services
	// in the namespace. Tasks can connect to services across all of the clusters
	// in the namespace. Tasks connect through a managed proxy container that collects
	// logs and metrics for increased visibility. Only the tasks that Amazon ECS
	// services create are supported with Service Connect. For more information,
	// see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
	// in the Amazon Elastic Container Service Developer Guide.
	ServiceConnectDefaults *ClusterServiceConnectDefaultsRequest `locationName:"serviceConnectDefaults" type:"structure"`

	// The setting to use when creating a cluster. This parameter is used to turn
	// on CloudWatch Container Insights for a cluster. If this value is specified,
	// it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
	Settings []*ClusterSetting `locationName:"settings" type:"list"`

	// The metadata that you apply to the cluster to help you categorize and organize
	// them. Each tag consists of a key and an optional value. You define both.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case-sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for either keys or values as it is reserved for Amazon Web
	//    Services use. You cannot edit or delete tag keys or values with this prefix.
	//    Tags with this prefix do not count against your tags per resource limit.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateClusterInput) GoString added in v0.6.5 

func (s CreateClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateClusterInput) SetCapacityProviders added in v1.25.46 

func (s *CreateClusterInput) SetCapacityProviders(v []*string) *CreateClusterInput

SetCapacityProviders sets the CapacityProviders field's value.

func (*CreateClusterInput) SetClusterName added in v1.5.0 

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

SetClusterName sets the ClusterName field's value.

func (*CreateClusterInput) SetConfiguration added in v1.37.31 

func (s *CreateClusterInput) SetConfiguration(v *ClusterConfiguration) *CreateClusterInput

SetConfiguration sets the Configuration field's value.

func (*CreateClusterInput) SetDefaultCapacityProviderStrategy added in v1.25.46 

func (s *CreateClusterInput) SetDefaultCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *CreateClusterInput

SetDefaultCapacityProviderStrategy sets the DefaultCapacityProviderStrategy field's value.

func (*CreateClusterInput) SetServiceConnectDefaults added in v1.44.146 

func (s *CreateClusterInput) SetServiceConnectDefaults(v *ClusterServiceConnectDefaultsRequest) *CreateClusterInput

SetServiceConnectDefaults sets the ServiceConnectDefaults field's value.

func (*CreateClusterInput) SetSettings added in v1.21.0 

func (s *CreateClusterInput) SetSettings(v []*ClusterSetting) *CreateClusterInput

SetSettings sets the Settings field's value.

func (*CreateClusterInput) SetTags added in v1.15.77 

func (s *CreateClusterInput) SetTags(v []*Tag) *CreateClusterInput

SetTags sets the Tags field's value.

func (CreateClusterInput) String added in v0.6.5 

func (s CreateClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateClusterInput) Validate added in v1.15.77 

func (s *CreateClusterInput) Validate() error

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateServiceInput 

type CreateServiceInput struct {

	// The capacity provider strategy to use for the service.
	//
	// If a capacityProviderStrategy is specified, the launchType parameter must
	// be omitted. If no capacityProviderStrategy or launchType is specified, the
	// defaultCapacityProviderStrategy for the cluster is used.
	//
	// A capacity provider strategy may contain a maximum of 6 capacity providers.
	CapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"capacityProviderStrategy" type:"list"`

	// An identifier that you provide to ensure the idempotency of the request.
	// It must be unique and is case sensitive. Up to 36 ASCII characters in the
	// range of 33-126 (inclusive) are allowed.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// The short name or full Amazon Resource Name (ARN) of the cluster that you
	// run your service 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 deployment controller to use for the service. If no deployment controller
	// is specified, the default value of ECS is used.
	DeploymentController *DeploymentController `locationName:"deploymentController" type:"structure"`

	// The number of instantiations of the specified task definition to place and
	// keep running in your service.
	//
	// This is required if schedulingStrategy is REPLICA or isn't specified. If
	// schedulingStrategy is DAEMON then this isn't required.
	DesiredCount *int64 `locationName:"desiredCount" type:"integer"`

	// Specifies whether to turn on Amazon ECS managed tags for the tasks within
	// the service. For more information, see Tagging your Amazon ECS resources
	// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// When you use Amazon ECS managed tags, you need to set the propagateTags request
	// parameter.
	EnableECSManagedTags *bool `locationName:"enableECSManagedTags" type:"boolean"`

	// Determines whether the execute command functionality is turned on for the
	// service. If true, this enables execute command functionality on all containers
	// in the service tasks.
	EnableExecuteCommand *bool `locationName:"enableExecuteCommand" type:"boolean"`

	// 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. This is only used when your service is configured to use a load
	// balancer. If your service has a load balancer defined and you don't specify
	// a health check grace period value, the default value of 0 is used.
	//
	// If you do not use an Elastic Load Balancing, we recommend that you use the
	// startPeriod in the task definition health check parameters. For more information,
	// see Health check (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html).
	//
	// 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 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS
	// service scheduler ignores health check status. This grace period can prevent
	// the service scheduler from marking tasks as unhealthy and stopping them before
	// they have time to come up.
	HealthCheckGracePeriodSeconds *int64 `locationName:"healthCheckGracePeriodSeconds" type:"integer"`

	// The infrastructure that you run your service on. For more information, see
	// Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.
	//
	// Fargate Spot infrastructure is available for use but a capacity provider
	// strategy must be used. For more information, see Fargate capacity providers
	// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-capacity-providers.html)
	// in the Amazon ECS Developer Guide.
	//
	// The EC2 launch type runs your tasks on Amazon EC2 instances registered to
	// your cluster.
	//
	// The EXTERNAL launch type runs your tasks on your on-premises server or virtual
	// machine (VM) capacity registered to your cluster.
	//
	// A service can use either a launch type or a capacity provider strategy. If
	// a launchType is specified, the capacityProviderStrategy parameter must be
	// omitted.
	LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"`

	// A load balancer object representing the load balancers to use with your service.
	// For more information, see Service load balancing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// If the service uses the rolling update (ECS) deployment controller and using
	// either an Application Load Balancer or Network Load Balancer, you must specify
	// one or more target group ARNs to attach to the service. The service-linked
	// role is required for services that use multiple target groups. For more information,
	// see Using service-linked roles for Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// If the service uses the CODE_DEPLOY deployment controller, the service is
	// required to use either an Application Load Balancer or Network Load Balancer.
	// When creating an CodeDeploy deployment group, you specify two target groups
	// (referred to as a targetGroupPair). During a deployment, CodeDeploy determines
	// which task set in your service has the status PRIMARY, and it associates
	// one target group with it. Then, it also associates the other target group
	// with the replacement task set. The load balancer can also have up to two
	// listeners: a required listener for production traffic and an optional listener
	// that you can use to perform validation tests with Lambda functions before
	// routing production traffic to it.
	//
	// If you use the CODE_DEPLOY deployment controller, these values can be changed
	// when updating the service.
	//
	// For Application Load Balancers and Network Load Balancers, this object must
	// contain the load balancer target group ARN, the container name, and the container
	// port to access from the load balancer. The container name must be as it appears
	// in a container definition. The load balancer name parameter must be omitted.
	// 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
	// that's specified here.
	//
	// For Classic Load Balancers, this object must contain the load balancer name,
	// the container name , and the container port to access from the load balancer.
	// The container name must be as it appears in a container definition. The target
	// group ARN parameter must be omitted. When a task from this service is placed
	// on a container instance, the container instance is registered with the load
	// balancer that's 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 aren't supported. Also, when
	// you create any target groups for these services, you must choose ip as the
	// target type, not instance. This is 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 isn't supported for other network modes. For more
	// information, see Task networking (https://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 for each task. This limit includes
	// constraints in the task definition and those specified at runtime.
	PlacementConstraints []*PlacementConstraint `locationName:"placementConstraints" type:"list"`

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

	// The platform version that your tasks in the service are running on. A platform
	// version is specified only for tasks using the Fargate launch type. If one
	// isn't specified, the LATEST platform version is used. For more information,
	// see Fargate platform versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
	// in the Amazon Elastic Container Service Developer Guide.
	PlatformVersion *string `locationName:"platformVersion" type:"string"`

	// Specifies whether to propagate the tags from the task definition to the task.
	// If no value is specified, the tags aren't propagated. Tags can only be propagated
	// to the task during task creation. To add tags to a task after task creation,
	// use the TagResource (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html)
	// API action.
	//
	// You must set this to a value other than NONE when you use Cost Explorer.
	// For more information, see Amazon ECS usage reports (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/usage-reports.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// The default is NONE.
	PropagateTags *string `locationName:"propagateTags" type:"string" enum:"PropagateTags"`

	// 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 doesn't 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 for your service unless you specify a role here. The service-linked
	// role is required if your task definition uses the awsvpc network mode or
	// if the service is configured to use service discovery, an external deployment
	// controller, multiple target groups, or Elastic Inference accelerators in
	// which case you don't specify a role here. For more information, see Using
	// service-linked roles for Amazon ECS (https://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 (https://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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_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. This scheduler
	//    strategy is required if the service uses the CODE_DEPLOY or EXTERNAL deployment
	//    controller types.
	//
	//    * DAEMON-The daemon scheduling strategy deploys exactly one task on each
	//    active container instance that meets all of the task placement constraints
	//    that you specify in your cluster. The service scheduler also evaluates
	//    the task placement constraints for running tasks and will stop tasks that
	//    don't meet the placement constraints. When you're using this strategy,
	//    you don't need to specify a desired number of tasks, a task placement
	//    strategy, or use Service Auto Scaling policies. Tasks using the Fargate
	//    launch type or the CODE_DEPLOY or EXTERNAL deployment controller types
	//    don't support the DAEMON scheduling strategy.
	SchedulingStrategy *string `locationName:"schedulingStrategy" type:"string" enum:"SchedulingStrategy"`

	// The configuration for this service to discover and connect to services, and
	// be discovered by, and connected from, other services within a namespace.
	//
	// Tasks that run in a namespace can use short names to connect to services
	// in the namespace. Tasks can connect to services across all of the clusters
	// in the namespace. Tasks connect through a managed proxy container that collects
	// logs and metrics for increased visibility. Only the tasks that Amazon ECS
	// services create are supported with Service Connect. For more information,
	// see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
	// in the Amazon Elastic Container Service Developer Guide.
	ServiceConnectConfiguration *ServiceConnectConfiguration `locationName:"serviceConnectConfiguration" type:"structure"`

	// The name of your service. Up to 255 letters (uppercase and lowercase), numbers,
	// underscores, and hyphens 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 registry to associate with this service.
	// For more information, see Service discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).
	//
	// Each service may be associated with one service registry. Multiple service
	// registries for each service isn't supported.
	ServiceRegistries []*ServiceRegistry `locationName:"serviceRegistries" type:"list"`

	// The metadata that you apply to the service to help you categorize and organize
	// them. Each tag consists of a key and an optional value, both of which you
	// define. When a service is deleted, the tags are deleted as well.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case-sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for either keys or values as it is reserved for Amazon Web
	//    Services use. You cannot edit or delete tag keys or values with this prefix.
	//    Tags with this prefix do not count against your tags per resource limit.
	Tags []*Tag `locationName:"tags" type:"list"`

	// The family and revision (family:revision) or full ARN of the task definition
	// to run in your service. If a revision isn't specified, the latest ACTIVE
	// revision is used.
	//
	// A task definition must be specified if the service uses either the ECS or
	// CODE_DEPLOY deployment controllers.
	//
	// For more information about deployment types, see Amazon ECS deployment types
	// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html).
	TaskDefinition *string `locationName:"taskDefinition" type:"string"`

	// The configuration for a volume specified in the task definition as a volume
	// that is configured at launch time. Currently, the only supported volume type
	// is an Amazon EBS volume.
	VolumeConfigurations []*ServiceVolumeConfiguration `locationName:"volumeConfigurations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateServiceInput) GoString added in v0.6.5 

func (s CreateServiceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateServiceInput) SetCapacityProviderStrategy added in v1.25.46 

func (s *CreateServiceInput) SetCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *CreateServiceInput

SetCapacityProviderStrategy sets the CapacityProviderStrategy field's value.

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) SetDeploymentController added in v1.15.84 

func (s *CreateServiceInput) SetDeploymentController(v *DeploymentController) *CreateServiceInput

SetDeploymentController sets the DeploymentController 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) SetEnableECSManagedTags added in v1.15.77 

func (s *CreateServiceInput) SetEnableECSManagedTags(v bool) *CreateServiceInput

SetEnableECSManagedTags sets the EnableECSManagedTags field's value.

func (*CreateServiceInput) SetEnableExecuteCommand added in v1.37.31 

func (s *CreateServiceInput) SetEnableExecuteCommand(v bool) *CreateServiceInput

SetEnableExecuteCommand sets the EnableExecuteCommand 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) SetPropagateTags added in v1.15.77 

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

SetPropagateTags sets the PropagateTags 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) SetServiceConnectConfiguration added in v1.44.146 

func (s *CreateServiceInput) SetServiceConnectConfiguration(v *ServiceConnectConfiguration) *CreateServiceInput

SetServiceConnectConfiguration sets the ServiceConnectConfiguration 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) SetTags added in v1.15.77 

func (s *CreateServiceInput) SetTags(v []*Tag) *CreateServiceInput

SetTags sets the Tags 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) SetVolumeConfigurations added in v1.49.19 

func (s *CreateServiceInput) SetVolumeConfigurations(v []*ServiceVolumeConfiguration) *CreateServiceInput

SetVolumeConfigurations sets the VolumeConfigurations field's value.

func (CreateServiceInput) String added in v0.6.5 

func (s CreateServiceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// A service will return either a capacityProviderStrategy or launchType parameter,
	// but not both, depending where one was specified when it was created.
	//
	// If a service is using the ECS deployment controller, the deploymentController
	// and taskSets parameters will not be returned.
	//
	// if the service uses the CODE_DEPLOY deployment controller, the deploymentController,
	// taskSets and deployments parameters will be returned, however the deployments
	// parameter will be an empty list.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateTaskSetInput added in v1.19.3 

type CreateTaskSetInput struct {

	// The capacity provider strategy to use for the task set.
	//
	// A capacity provider strategy consists of one or more capacity providers along
	// with the base and weight to assign to them. A capacity provider must be associated
	// with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders
	// API is used to associate a capacity provider with a cluster. Only capacity
	// providers with an ACTIVE or UPDATING status can be used.
	//
	// If a capacityProviderStrategy is specified, the launchType parameter must
	// be omitted. If no capacityProviderStrategy or launchType is specified, the
	// defaultCapacityProviderStrategy for the cluster is used.
	//
	// If specifying a capacity provider that uses an Auto Scaling group, the capacity
	// provider must already be created. New capacity providers can be created with
	// the CreateCapacityProvider API operation.
	//
	// To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT
	// capacity providers. The Fargate capacity providers are available to all accounts
	// and only need to be associated with a cluster to be used.
	//
	// The PutClusterCapacityProviders API operation is used to update the list
	// of available capacity providers for a cluster after the cluster is created.
	CapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"capacityProviderStrategy" type:"list"`

	// An identifier that you provide to ensure the idempotency of the request.
	// It must be unique and is case sensitive. Up to 36 ASCII characters in the
	// range of 33-126 (inclusive) are allowed.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts
	// the service to create the task set in.
	//
	// Cluster is a required field
	Cluster *string `locationName:"cluster" type:"string" required:"true"`

	// An optional non-unique tag that identifies this task set in external systems.
	// If the task set is associated with a service discovery registry, the tasks
	// in this task set will have the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute
	// set to the provided value.
	ExternalId *string `locationName:"externalId" type:"string"`

	// The launch type that new tasks in the task set uses. For more information,
	// see Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// If a launchType is specified, the capacityProviderStrategy parameter must
	// be omitted.
	LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"`

	// A load balancer object representing the load balancer to use with the task
	// set. The supported load balancer types are either an Application Load Balancer
	// or a Network Load Balancer.
	LoadBalancers []*LoadBalancer `locationName:"loadBalancers" type:"list"`

	// An object representing the network configuration for a task set.
	NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"`

	// The platform version that the tasks in the task set uses. A platform version
	// is specified only for tasks using the Fargate launch type. If one isn't specified,
	// the LATEST platform version is used.
	PlatformVersion *string `locationName:"platformVersion" type:"string"`

	// A floating-point percentage of the desired number of tasks to place and keep
	// running in the task set.
	Scale *Scale `locationName:"scale" type:"structure"`

	// The short name or full Amazon Resource Name (ARN) of the service to create
	// the task set in.
	//
	// Service is a required field
	Service *string `locationName:"service" type:"string" required:"true"`

	// The details of the service discovery registries to assign to this task set.
	// For more information, see Service discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).
	ServiceRegistries []*ServiceRegistry `locationName:"serviceRegistries" type:"list"`

	// The metadata that you apply to the task set to help you categorize and organize
	// them. Each tag consists of a key and an optional value. You define both.
	// When a service is deleted, the tags are deleted.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case-sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for either keys or values as it is reserved for Amazon Web
	//    Services use. You cannot edit or delete tag keys or values with this prefix.
	//    Tags with this prefix do not count against your tags per resource limit.
	Tags []*Tag `locationName:"tags" type:"list"`

	// The task definition for the tasks in the task set to use. If a revision isn't
	// 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 (CreateTaskSetInput) GoString added in v1.19.3 

func (s CreateTaskSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTaskSetInput) SetCapacityProviderStrategy added in v1.25.46 

func (s *CreateTaskSetInput) SetCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *CreateTaskSetInput

SetCapacityProviderStrategy sets the CapacityProviderStrategy field's value.

func (*CreateTaskSetInput) SetClientToken added in v1.19.3 

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

SetClientToken sets the ClientToken field's value.

func (*CreateTaskSetInput) SetCluster added in v1.19.3 

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

SetCluster sets the Cluster field's value.

func (*CreateTaskSetInput) SetExternalId added in v1.19.3 

func (s *CreateTaskSetInput) SetExternalId(v string) *CreateTaskSetInput

SetExternalId sets the ExternalId field's value.

func (*CreateTaskSetInput) SetLaunchType added in v1.19.3 

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

SetLaunchType sets the LaunchType field's value.

func (*CreateTaskSetInput) SetLoadBalancers added in v1.19.3 

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

SetLoadBalancers sets the LoadBalancers field's value.

func (*CreateTaskSetInput) SetNetworkConfiguration added in v1.19.3 

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

SetNetworkConfiguration sets the NetworkConfiguration field's value.

func (*CreateTaskSetInput) SetPlatformVersion added in v1.19.3 

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

SetPlatformVersion sets the PlatformVersion field's value.

func (*CreateTaskSetInput) SetScale added in v1.19.3 

func (s *CreateTaskSetInput) SetScale(v *Scale) *CreateTaskSetInput

SetScale sets the Scale field's value.

func (*CreateTaskSetInput) SetService added in v1.19.3 

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

SetService sets the Service field's value.

func (*CreateTaskSetInput) SetServiceRegistries added in v1.19.3 

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

SetServiceRegistries sets the ServiceRegistries field's value.

func (*CreateTaskSetInput) SetTags added in v1.28.9 

func (s *CreateTaskSetInput) SetTags(v []*Tag) *CreateTaskSetInput

SetTags sets the Tags field's value.

func (*CreateTaskSetInput) SetTaskDefinition added in v1.19.3 

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

SetTaskDefinition sets the TaskDefinition field's value.

func (CreateTaskSetInput) String added in v1.19.3 

func (s CreateTaskSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTaskSetInput) Validate added in v1.19.3 

func (s *CreateTaskSetInput) Validate() error

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

type CreateTaskSetOutput added in v1.19.3 

type CreateTaskSetOutput struct {

	// Information about a set of Amazon ECS tasks in either an CodeDeploy or an
	// EXTERNAL deployment. A task set includes details such as the desired number
	// of tasks, how many tasks are running, and whether the task set serves production
	// traffic.
	TaskSet *TaskSet `locationName:"taskSet" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateTaskSetOutput) GoString added in v1.19.3 

func (s CreateTaskSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTaskSetOutput) SetTaskSet added in v1.19.3 

func (s *CreateTaskSetOutput) SetTaskSet(v *TaskSet) *CreateTaskSetOutput

SetTaskSet sets the TaskSet field's value.

func (CreateTaskSetOutput) String added in v1.19.3 

func (s CreateTaskSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAccountSettingInput added in v1.15.77 

type DeleteAccountSettingInput struct {

	// The resource name to disable the account setting for. If serviceLongArnFormat
	// is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat
	// is specified, the ARN and resource ID for your Amazon ECS tasks is affected.
	// If containerInstanceLongArnFormat is specified, the ARN and resource ID for
	// your Amazon ECS container instances is affected. If awsvpcTrunking is specified,
	// the ENI limit for your Amazon ECS container instances is affected.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true" enum:"SettingName"`

	// The Amazon Resource Name (ARN) of the principal. It can be an user, role,
	// or the root user. If you specify the root user, it disables the account setting
	// for all users, roles, and the root user of the account unless a user or role
	// explicitly overrides these settings. If this field is omitted, the setting
	// is changed only for the authenticated user.
	PrincipalArn *string `locationName:"principalArn" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteAccountSettingInput) GoString added in v1.15.77 

func (s DeleteAccountSettingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAccountSettingInput) SetName added in v1.15.77 

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

SetName sets the Name field's value.

func (*DeleteAccountSettingInput) SetPrincipalArn added in v1.15.77 

func (s *DeleteAccountSettingInput) SetPrincipalArn(v string) *DeleteAccountSettingInput

SetPrincipalArn sets the PrincipalArn field's value.

func (DeleteAccountSettingInput) String added in v1.15.77 

func (s DeleteAccountSettingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAccountSettingInput) Validate added in v1.15.77 

func (s *DeleteAccountSettingInput) Validate() error

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

type DeleteAccountSettingOutput added in v1.15.77 

type DeleteAccountSettingOutput struct {

	// The account setting for the specified principal ARN.
	Setting *Setting `locationName:"setting" type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteAccountSettingOutput) GoString added in v1.15.77 

func (s DeleteAccountSettingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAccountSettingOutput) SetSetting added in v1.15.77 

func (s *DeleteAccountSettingOutput) SetSetting(v *Setting) *DeleteAccountSettingOutput

SetSetting sets the Setting field's value.

func (DeleteAccountSettingOutput) String added in v1.15.77 

func (s DeleteAccountSettingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAttributesInput added in v1.6.9 

type DeleteAttributesInput struct {

	// The attributes to delete from your resource. You can specify up to 10 attributes
	// for each request. For custom attributes, specify the attribute name and target
	// ID, but don't 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteCapacityProviderInput added in v1.32.0 

type DeleteCapacityProviderInput struct {

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

func (DeleteCapacityProviderInput) GoString added in v1.32.0 

func (s DeleteCapacityProviderInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCapacityProviderInput) SetCapacityProvider added in v1.32.0 

func (s *DeleteCapacityProviderInput) SetCapacityProvider(v string) *DeleteCapacityProviderInput

SetCapacityProvider sets the CapacityProvider field's value.

func (DeleteCapacityProviderInput) String added in v1.32.0 

func (s DeleteCapacityProviderInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCapacityProviderInput) Validate added in v1.32.0 

func (s *DeleteCapacityProviderInput) Validate() error

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

type DeleteCapacityProviderOutput added in v1.32.0 

type DeleteCapacityProviderOutput struct {

	// The details of the capacity provider.
	CapacityProvider *CapacityProvider `locationName:"capacityProvider" type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteCapacityProviderOutput) GoString added in v1.32.0 

func (s DeleteCapacityProviderOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCapacityProviderOutput) SetCapacityProvider added in v1.32.0 

func (s *DeleteCapacityProviderOutput) SetCapacityProvider(v *CapacityProvider) *DeleteCapacityProviderOutput

SetCapacityProvider sets the CapacityProvider field's value.

func (DeleteCapacityProviderOutput) String added in v1.32.0 

func (s DeleteCapacityProviderOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 wasn't scaled down to
	// zero tasks. It's only necessary to use this if the service uses 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteTaskDefinitionsInput added in v1.44.208 

type DeleteTaskDefinitionsInput struct {

	// The family and revision (family:revision) or full Amazon Resource Name (ARN)
	// of the task definition to delete. You must specify a revision.
	//
	// You can specify up to 10 task definitions as a comma separated list.
	//
	// TaskDefinitions is a required field
	TaskDefinitions []*string `locationName:"taskDefinitions" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteTaskDefinitionsInput) GoString added in v1.44.208 

func (s DeleteTaskDefinitionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTaskDefinitionsInput) SetTaskDefinitions added in v1.44.208 

func (s *DeleteTaskDefinitionsInput) SetTaskDefinitions(v []*string) *DeleteTaskDefinitionsInput

SetTaskDefinitions sets the TaskDefinitions field's value.

func (DeleteTaskDefinitionsInput) String added in v1.44.208 

func (s DeleteTaskDefinitionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTaskDefinitionsInput) Validate added in v1.44.208 

func (s *DeleteTaskDefinitionsInput) Validate() error

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

type DeleteTaskDefinitionsOutput added in v1.44.208 

type DeleteTaskDefinitionsOutput struct {

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

	// The list of deleted task definitions.
	TaskDefinitions []*TaskDefinition `locationName:"taskDefinitions" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteTaskDefinitionsOutput) GoString added in v1.44.208 

func (s DeleteTaskDefinitionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTaskDefinitionsOutput) SetFailures added in v1.44.208 

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

SetFailures sets the Failures field's value.

func (*DeleteTaskDefinitionsOutput) SetTaskDefinitions added in v1.44.208 

func (s *DeleteTaskDefinitionsOutput) SetTaskDefinitions(v []*TaskDefinition) *DeleteTaskDefinitionsOutput

SetTaskDefinitions sets the TaskDefinitions field's value.

func (DeleteTaskDefinitionsOutput) String added in v1.44.208 

func (s DeleteTaskDefinitionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteTaskSetInput added in v1.19.3 

type DeleteTaskSetInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts
	// the service that the task set found in to delete.
	//
	// Cluster is a required field
	Cluster *string `locationName:"cluster" type:"string" required:"true"`

	// If true, you can delete a task set even if it hasn't been scaled down to
	// zero.
	Force *bool `locationName:"force" type:"boolean"`

	// The short name or full Amazon Resource Name (ARN) of the service that hosts
	// the task set to delete.
	//
	// Service is a required field
	Service *string `locationName:"service" type:"string" required:"true"`

	// The task set ID or full Amazon Resource Name (ARN) of the task set to delete.
	//
	// TaskSet is a required field
	TaskSet *string `locationName:"taskSet" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteTaskSetInput) GoString added in v1.19.3 

func (s DeleteTaskSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTaskSetInput) SetCluster added in v1.19.3 

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

SetCluster sets the Cluster field's value.

func (*DeleteTaskSetInput) SetForce added in v1.19.3 

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

SetForce sets the Force field's value.

func (*DeleteTaskSetInput) SetService added in v1.19.3 

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

SetService sets the Service field's value.

func (*DeleteTaskSetInput) SetTaskSet added in v1.19.3 

func (s *DeleteTaskSetInput) SetTaskSet(v string) *DeleteTaskSetInput

SetTaskSet sets the TaskSet field's value.

func (DeleteTaskSetInput) String added in v1.19.3 

func (s DeleteTaskSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTaskSetInput) Validate added in v1.19.3 

func (s *DeleteTaskSetInput) Validate() error

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

type DeleteTaskSetOutput added in v1.19.3 

type DeleteTaskSetOutput struct {

	// Details about the task set.
	TaskSet *TaskSet `locationName:"taskSet" type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteTaskSetOutput) GoString added in v1.19.3 

func (s DeleteTaskSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTaskSetOutput) SetTaskSet added in v1.19.3 

func (s *DeleteTaskSetOutput) SetTaskSet(v *TaskSet) *DeleteTaskSetOutput

SetTaskSet sets the TaskSet field's value.

func (DeleteTaskSetOutput) String added in v1.19.3 

func (s DeleteTaskSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Deployment 

type Deployment struct {

	// The capacity provider strategy that the deployment is using.
	CapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"capacityProviderStrategy" type:"list"`

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

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

	// The number of consecutively failed tasks in the deployment. A task is considered
	// a failure if the service scheduler can't launch the task, the task doesn't
	// transition to a RUNNING state, or if it fails any of its defined health checks
	// and is stopped.
	//
	// Once a service deployment has one or more successfully running tasks, the
	// failed task count resets to zero and stops being evaluated.
	FailedTasks *int64 `locationName:"failedTasks" type:"integer"`

	// The Fargate ephemeral storage settings for the deployment.
	FargateEphemeralStorage *DeploymentEphemeralStorage `locationName:"fargateEphemeralStorage" type:"structure"`

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

	// The launch type the tasks in the service are using. For more information,
	// see Amazon ECS Launch Types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)
	// in the Amazon Elastic Container Service Developer Guide.
	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 operating system that your tasks in the service, or tasks are running
	// on. A platform family is specified only for tasks using the Fargate launch
	// type.
	//
	// All tasks that run as part of this service must use the same platformFamily
	// value as the service, for example, LINUX..
	PlatformFamily *string `locationName:"platformFamily" type:"string"`

	// The platform version that your tasks in the service run on. A platform version
	// is only specified for tasks using the Fargate launch type. If one isn't specified,
	// the LATEST platform version is used. For more information, see Fargate Platform
	// Versions (https://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 rolloutState of a service is only returned for services that use the
	// rolling update (ECS) deployment type that aren't behind a Classic Load Balancer.
	//
	// The rollout state of the deployment. When a service deployment is started,
	// it begins in an IN_PROGRESS state. When the service reaches a steady state,
	// the deployment transitions to a COMPLETED state. If the service fails to
	// reach a steady state and circuit breaker is turned on, the deployment transitions
	// to a FAILED state. A deployment in FAILED state doesn't launch any new tasks.
	// For more information, see DeploymentCircuitBreaker.
	RolloutState *string `locationName:"rolloutState" type:"string" enum:"DeploymentRolloutState"`

	// A description of the rollout state of a deployment.
	RolloutStateReason *string `locationName:"rolloutStateReason" type:"string"`

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

	// The details of the Service Connect configuration that's used by this deployment.
	// Compare the configuration between multiple deployments when troubleshooting
	// issues with new deployments.
	//
	// The configuration for this service to discover and connect to services, and
	// be discovered by, and connected from, other services within a namespace.
	//
	// Tasks that run in a namespace can use short names to connect to services
	// in the namespace. Tasks can connect to services across all of the clusters
	// in the namespace. Tasks connect through a managed proxy container that collects
	// logs and metrics for increased visibility. Only the tasks that Amazon ECS
	// services create are supported with Service Connect. For more information,
	// see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
	// in the Amazon Elastic Container Service Developer Guide.
	ServiceConnectConfiguration *ServiceConnectConfiguration `locationName:"serviceConnectConfiguration" type:"structure"`

	// The list of Service Connect resources that are associated with this deployment.
	// Each list entry maps a discovery name to a Cloud Map service name.
	ServiceConnectResources []*ServiceConnectServiceResource `locationName:"serviceConnectResources" type:"list"`

	// The status of the deployment. The following describes each state.
	//
	// PRIMARY
	//
	// The most recent deployment of a service.
	//
	// ACTIVE
	//
	// A service deployment that still has running tasks, but are in the process
	// of being replaced with a new PRIMARY deployment.
	//
	// INACTIVE
	//
	// A deployment that has been completely replaced.
	Status *string `locationName:"status" type:"string"`

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

	// The Unix timestamp for the time when the service deployment was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`

	// The details of the volume that was configuredAtLaunch. You can configure
	// different settings like the size, throughput, volumeType, and ecryption in
	// ServiceManagedEBSVolumeConfiguration (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ServiceManagedEBSVolumeConfiguration.html).
	// The name of the volume must match the name from the task definition.
	VolumeConfigurations []*ServiceVolumeConfiguration `locationName:"volumeConfigurations" type:"list"`
	// contains filtered or unexported fields
}

The details of an Amazon ECS service deployment. This is used only when a service uses the ECS deployment controller type.

func (Deployment) GoString added in v0.6.5 

func (s Deployment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Deployment) SetCapacityProviderStrategy added in v1.25.46 

func (s *Deployment) SetCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *Deployment

SetCapacityProviderStrategy sets the CapacityProviderStrategy field's value.

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) SetFailedTasks added in v1.35.34 

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

SetFailedTasks sets the FailedTasks field's value.

func (*Deployment) SetFargateEphemeralStorage added in v1.53.20 

func (s *Deployment) SetFargateEphemeralStorage(v *DeploymentEphemeralStorage) *Deployment

SetFargateEphemeralStorage sets the FargateEphemeralStorage 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) SetPlatformFamily added in v1.41.13 

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

SetPlatformFamily sets the PlatformFamily 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) SetRolloutState added in v1.35.34 

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

SetRolloutState sets the RolloutState field's value.

func (*Deployment) SetRolloutStateReason added in v1.35.34 

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

SetRolloutStateReason sets the RolloutStateReason 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) SetServiceConnectConfiguration added in v1.44.146 

func (s *Deployment) SetServiceConnectConfiguration(v *ServiceConnectConfiguration) *Deployment

SetServiceConnectConfiguration sets the ServiceConnectConfiguration field's value.

func (*Deployment) SetServiceConnectResources added in v1.44.146 

func (s *Deployment) SetServiceConnectResources(v []*ServiceConnectServiceResource) *Deployment

SetServiceConnectResources sets the ServiceConnectResources 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) SetVolumeConfigurations added in v1.49.19 

func (s *Deployment) SetVolumeConfigurations(v []*ServiceVolumeConfiguration) *Deployment

SetVolumeConfigurations sets the VolumeConfigurations field's value.

func (Deployment) String added in v0.6.5 

func (s Deployment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeploymentAlarms added in v1.44.163 

type DeploymentAlarms struct {

	// One or more CloudWatch alarm names. Use a "," to separate the alarms.
	//
	// AlarmNames is a required field
	AlarmNames []*string `locationName:"alarmNames" type:"list" required:"true"`

	// Determines whether to use the CloudWatch alarm option in the service deployment
	// process.
	//
	// Enable is a required field
	Enable *bool `locationName:"enable" type:"boolean" required:"true"`

	// Determines whether to configure Amazon ECS to roll back the service if a
	// service deployment fails. If rollback is used, when a service deployment
	// fails, the service is rolled back to the last deployment that completed successfully.
	//
	// Rollback is a required field
	Rollback *bool `locationName:"rollback" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.

When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure.

You can only use the DeploymentAlarms method to detect failures when the DeploymentController is set to ECS (rolling update).

For more information, see Rolling update (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the Amazon Elastic Container Service Developer Guide .

func (DeploymentAlarms) GoString added in v1.44.163 

func (s DeploymentAlarms) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentAlarms) SetAlarmNames added in v1.44.163 

func (s *DeploymentAlarms) SetAlarmNames(v []*string) *DeploymentAlarms

SetAlarmNames sets the AlarmNames field's value.

func (*DeploymentAlarms) SetEnable added in v1.44.163 

func (s *DeploymentAlarms) SetEnable(v bool) *DeploymentAlarms

SetEnable sets the Enable field's value.

func (*DeploymentAlarms) SetRollback added in v1.44.163 

func (s *DeploymentAlarms) SetRollback(v bool) *DeploymentAlarms

SetRollback sets the Rollback field's value.

func (DeploymentAlarms) String added in v1.44.163 

func (s DeploymentAlarms) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentAlarms) Validate added in v1.44.163 

func (s *DeploymentAlarms) Validate() error

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

type DeploymentCircuitBreaker added in v1.35.34 

type DeploymentCircuitBreaker struct {

	// Determines whether to use the deployment circuit breaker logic for the service.
	//
	// Enable is a required field
	Enable *bool `locationName:"enable" type:"boolean" required:"true"`

	// Determines whether to configure Amazon ECS to roll back the service if a
	// service deployment fails. If rollback is on, when a service deployment fails,
	// the service is rolled back to the last deployment that completed successfully.
	//
	// Rollback is a required field
	Rollback *bool `locationName:"rollback" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type.

The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If it is turned on, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see Rolling update (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the Amazon Elastic Container Service Developer Guide.

For more information about API failure reasons, see API failure reasons (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) in the Amazon Elastic Container Service Developer Guide.

func (DeploymentCircuitBreaker) GoString added in v1.35.34 

func (s DeploymentCircuitBreaker) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentCircuitBreaker) SetEnable added in v1.35.34 

func (s *DeploymentCircuitBreaker) SetEnable(v bool) *DeploymentCircuitBreaker

SetEnable sets the Enable field's value.

func (*DeploymentCircuitBreaker) SetRollback added in v1.35.34 

func (s *DeploymentCircuitBreaker) SetRollback(v bool) *DeploymentCircuitBreaker

SetRollback sets the Rollback field's value.

func (DeploymentCircuitBreaker) String added in v1.35.34 

func (s DeploymentCircuitBreaker) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentCircuitBreaker) Validate added in v1.35.34 

func (s *DeploymentCircuitBreaker) Validate() error

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

type DeploymentConfiguration added in v1.0.7 

type DeploymentConfiguration struct {

	// Information about the CloudWatch alarms.
	Alarms *DeploymentAlarms `locationName:"alarms" type:"structure"`

	//
	// The deployment circuit breaker can only be used for services using the rolling
	// update (ECS) deployment type.
	//
	// The deployment circuit breaker determines whether a service deployment will
	// fail if the service can't reach a steady state. If you use the deployment
	// circuit breaker, a service deployment will transition to a failed state and
	// stop launching new tasks. If you use the rollback option, when a service
	// deployment fails, the service is rolled back to the last deployment that
	// completed successfully. For more information, see Rolling update (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html)
	// in the Amazon Elastic Container Service Developer Guide
	DeploymentCircuitBreaker *DeploymentCircuitBreaker `locationName:"deploymentCircuitBreaker" type:"structure"`

	// If a service is using the rolling update (ECS) deployment type, the maximumPercent
	// parameter represents an upper limit on the number of your service's tasks
	// that are allowed in the RUNNING or PENDING state during a deployment, as
	// a percentage of the desiredCount (rounded down to the nearest integer). This
	// parameter enables you to define the deployment batch size. For example, if
	// your service is using the REPLICA service scheduler and has a desiredCount
	// of four tasks and a maximumPercent value of 200%, the scheduler may start
	// four new tasks before stopping the four older tasks (provided that the cluster
	// resources required to do this are available). The default maximumPercent
	// value for a service using the REPLICA service scheduler is 200%.
	//
	// If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment
	// types and tasks that use the EC2 launch type, the maximum percent value is
	// set to the default value and is used to define the upper limit on the number
	// of the tasks in the service that remain in the RUNNING state while the container
	// instances are in the DRAINING state. If the tasks in the service use the
	// Fargate launch type, the maximum percent value is not used, although it is
	// returned when describing your service.
	MaximumPercent *int64 `locationName:"maximumPercent" type:"integer"`

	// If a service is using the rolling update (ECS) deployment type, 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 service
	// scheduler may stop two existing tasks to free up cluster capacity before
	// starting two new tasks.
	//
	// For services that do not use a load balancer, the following should be noted:
	//
	//    * A service is considered healthy if all essential containers within the
	//    tasks in the service pass their health checks.
	//
	//    * If a task has no essential containers with a health check defined, the
	//    service scheduler will wait for 40 seconds after a task reaches a RUNNING
	//    state before the task is counted towards the minimum healthy percent total.
	//
	//    * If a task has one or more essential containers with a health check defined,
	//    the service scheduler will wait for the task to reach a healthy status
	//    before counting it towards the minimum healthy percent total. A task is
	//    considered healthy when all essential containers within the task have
	//    passed their health checks. The amount of time the service scheduler can
	//    wait for is determined by the container health check settings.
	//
	// For services that do use a load balancer, the following should be noted:
	//
	//    * If a task has no essential containers with a health check defined, the
	//    service scheduler will wait for the load balancer target group health
	//    check to return a healthy status before counting the task towards the
	//    minimum healthy percent total.
	//
	//    * If a task has an essential container with a health check defined, the
	//    service scheduler will wait for both the task to reach a healthy status
	//    and the load balancer target group health check to return a healthy status
	//    before counting the task towards the minimum healthy percent total.
	//
	// The default value for a replica service for minimumHealthyPercent is 100%.
	// The default minimumHealthyPercent value for a service using the DAEMON service
	// schedule is 0% for the CLI, the Amazon Web Services SDKs, and the APIs and
	// 50% for the Amazon Web Services Management Console.
	//
	// The minimum number of healthy tasks during a deployment is the desiredCount
	// multiplied by the minimumHealthyPercent/100, rounded up to the nearest integer
	// value.
	//
	// If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment
	// types and is running tasks that use the EC2 launch type, the minimum healthy
	// percent value is set to the default value and is used to define the lower
	// limit on the number of the tasks in the service that remain in the RUNNING
	// state while the container instances are in the DRAINING state. If a service
	// is using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types
	// and is running tasks that use the Fargate launch type, the minimum healthy
	// percent value is not used, although it is returned when describing your service.
	MinimumHealthyPercent *int64 `locationName:"minimumHealthyPercent" type:"integer"`
	// contains filtered or unexported fields
}

Optional deployment parameters that control how many tasks run during a 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentConfiguration) SetAlarms added in v1.44.163 

func (s *DeploymentConfiguration) SetAlarms(v *DeploymentAlarms) *DeploymentConfiguration

SetAlarms sets the Alarms field's value.

func (*DeploymentConfiguration) SetDeploymentCircuitBreaker added in v1.35.34 

func (s *DeploymentConfiguration) SetDeploymentCircuitBreaker(v *DeploymentCircuitBreaker) *DeploymentConfiguration

SetDeploymentCircuitBreaker sets the DeploymentCircuitBreaker field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentConfiguration) Validate added in v1.35.34 

func (s *DeploymentConfiguration) Validate() error

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

type DeploymentController added in v1.15.84 

type DeploymentController struct {

	// The deployment controller type to use.
	//
	// There are three deployment controller types available:
	//
	// ECS
	//
	// The rolling update (ECS) deployment type involves replacing the current running
	// version of the container with the latest version. The number of containers
	// Amazon ECS adds or removes from the service during a rolling update is controlled
	// by adjusting the minimum and maximum number of healthy tasks allowed during
	// a service deployment, as specified in the DeploymentConfiguration.
	//
	// CODE_DEPLOY
	//
	// The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment
	// model powered by CodeDeploy, which allows you to verify a new deployment
	// of a service before sending production traffic to it.
	//
	// EXTERNAL
	//
	// The external (EXTERNAL) deployment type enables you to use any third-party
	// deployment controller for full control over the deployment process for an
	// Amazon ECS service.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"DeploymentControllerType"`
	// contains filtered or unexported fields
}

The deployment controller to use for the service. For more information, see Amazon ECS deployment types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) in the Amazon Elastic Container Service Developer Guide.

func (DeploymentController) GoString added in v1.15.84 

func (s DeploymentController) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentController) SetType added in v1.15.84 

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

SetType sets the Type field's value.

func (DeploymentController) String added in v1.15.84 

func (s DeploymentController) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentController) Validate added in v1.15.84 

func (s *DeploymentController) Validate() error

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

type DeploymentEphemeralStorage added in v1.53.20 

type DeploymentEphemeralStorage struct {

	// Specify an Key Management Service key ID to encrypt the ephemeral storage
	// for deployment.
	KmsKeyId *string `locationName:"kmsKeyId" type:"string"`
	// contains filtered or unexported fields
}

The amount of ephemeral storage to allocate for the deployment.

func (DeploymentEphemeralStorage) GoString added in v1.53.20 

func (s DeploymentEphemeralStorage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentEphemeralStorage) SetKmsKeyId added in v1.53.20 

func (s *DeploymentEphemeralStorage) SetKmsKeyId(v string) *DeploymentEphemeralStorage

SetKmsKeyId sets the KmsKeyId field's value.

func (DeploymentEphemeralStorage) String added in v1.53.20 

func (s DeploymentEphemeralStorage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	// For more information about the ARN format, see Amazon Resource Name (ARN)
	// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids)
	// in the Amazon ECS Developer Guide.
	//
	// ContainerInstance is a required field
	ContainerInstance *string `locationName:"containerInstance" type:"string" required:"true"`

	// Forces the container instance to be deregistered. 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're 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeCapacityProvidersInput added in v1.25.46 

type DescribeCapacityProvidersInput struct {

	// The short name or full Amazon Resource Name (ARN) of one or more capacity
	// providers. Up to 100 capacity providers can be described in an action.
	CapacityProviders []*string `locationName:"capacityProviders" type:"list"`

	// Specifies whether or not you want to see the resource tags for the capacity
	// provider. If TAGS is specified, the tags are included in the response. If
	// this field is omitted, tags aren't included in the response.
	Include []*string `locationName:"include" type:"list" enum:"CapacityProviderField"`

	// The maximum number of account setting results returned by DescribeCapacityProviders
	// in paginated output. When this parameter is used, DescribeCapacityProviders
	// 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 DescribeCapacityProviders request with the returned nextToken value.
	// This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders
	// 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 DescribeCapacityProviders
	// 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 (DescribeCapacityProvidersInput) GoString added in v1.25.46 

func (s DescribeCapacityProvidersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCapacityProvidersInput) SetCapacityProviders added in v1.25.46 

func (s *DescribeCapacityProvidersInput) SetCapacityProviders(v []*string) *DescribeCapacityProvidersInput

SetCapacityProviders sets the CapacityProviders field's value.

func (*DescribeCapacityProvidersInput) SetInclude added in v1.25.46 

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

SetInclude sets the Include field's value.

func (*DescribeCapacityProvidersInput) SetMaxResults added in v1.25.46 

func (s *DescribeCapacityProvidersInput) SetMaxResults(v int64) *DescribeCapacityProvidersInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeCapacityProvidersInput) SetNextToken added in v1.25.46 

func (s *DescribeCapacityProvidersInput) SetNextToken(v string) *DescribeCapacityProvidersInput

SetNextToken sets the NextToken field's value.

func (DescribeCapacityProvidersInput) String added in v1.25.46 

func (s DescribeCapacityProvidersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeCapacityProvidersOutput added in v1.25.46 

type DescribeCapacityProvidersOutput struct {

	// The list of capacity providers.
	CapacityProviders []*CapacityProvider `locationName:"capacityProviders" type:"list"`

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

	// The nextToken value to include in a future DescribeCapacityProviders request.
	// When the results of a DescribeCapacityProviders 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 (DescribeCapacityProvidersOutput) GoString added in v1.25.46 

func (s DescribeCapacityProvidersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeCapacityProvidersOutput) SetCapacityProviders added in v1.25.46 

func (s *DescribeCapacityProvidersOutput) SetCapacityProviders(v []*CapacityProvider) *DescribeCapacityProvidersOutput

SetCapacityProviders sets the CapacityProviders field's value.

func (*DescribeCapacityProvidersOutput) SetFailures added in v1.25.46 

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

SetFailures sets the Failures field's value.

func (*DescribeCapacityProvidersOutput) SetNextToken added in v1.25.46 

func (s *DescribeCapacityProvidersOutput) SetNextToken(v string) *DescribeCapacityProvidersOutput

SetNextToken sets the NextToken field's value.

func (DescribeCapacityProvidersOutput) String added in v1.25.46 

func (s DescribeCapacityProvidersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// Determines whether to include additional information about the clusters in
	// the response. If this field is omitted, this information isn't included.
	//
	// If ATTACHMENTS is specified, the attachments for the container instances
	// or tasks within the cluster are included, for example the capacity providers.
	//
	// If SETTINGS is specified, the settings for the cluster are included.
	//
	// If CONFIGURATIONS is specified, the configuration for the cluster is included.
	//
	// If STATISTICS is specified, the task and service count is included, separated
	// by launch type.
	//
	// If TAGS is specified, the metadata tags associated with the cluster are included.
	Include []*string `locationName:"include" type:"list" enum:"ClusterField"`
	// contains filtered or unexported fields
}

func (DescribeClustersInput) GoString added in v0.6.5 

func (s DescribeClustersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. This parameter is required if the container instance
	// or container instances you are describing were launched in any cluster other
	// than the default cluster.
	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"`

	// Specifies whether you want to see the resource tags for the container instance.
	// If TAGS is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH
	// is specified, the container instance health is included in the response.
	// If this field is omitted, tags and container instance health status aren't
	// included in the response.
	Include []*string `locationName:"include" type:"list" enum:"ContainerInstanceField"`
	// contains filtered or unexported fields
}

func (DescribeContainerInstancesInput) GoString added in v0.6.5 

func (s DescribeContainerInstancesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetInclude added in v1.15.77 

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

SetInclude sets the Include field's value.

func (DescribeContainerInstancesInput) String added in v0.6.5 

func (s DescribeContainerInstancesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. This parameter is required if the service or services you are
	// describing were launched in any cluster other than the default cluster.
	Cluster *string `locationName:"cluster" type:"string"`

	// Determines whether you want to see the resource tags for the service. If
	// TAGS is specified, the tags are included in the response. If this field is
	// omitted, tags aren't included in the response.
	Include []*string `locationName:"include" type:"list" enum:"ServiceField"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeServicesInput) SetCluster added in v1.5.0 

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

SetCluster sets the Cluster field's value.

func (*DescribeServicesInput) SetInclude added in v1.15.77 

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

SetInclude sets the Include 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTaskDefinitionInput 

type DescribeTaskDefinitionInput struct {

	// Determines whether to see the resource tags for the task definition. If TAGS
	// is specified, the tags are included in the response. If this field is omitted,
	// tags aren't included in the response.
	Include []*string `locationName:"include" type:"list" enum:"TaskDefinitionField"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTaskDefinitionInput) SetInclude added in v1.15.77 

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

SetInclude sets the Include field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 metadata that's applied to the task definition to help you categorize
	// and organize them. Each tag consists of a key and an optional value. You
	// define both.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case-sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for either keys or values as it is reserved for Amazon Web
	//    Services use. You cannot edit or delete tag keys or values with this prefix.
	//    Tags with this prefix do not count against your tags per resource limit.
	Tags []*Tag `locationName:"tags" type:"list"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTaskDefinitionOutput) SetTags added in v1.15.77 

func (s *DescribeTaskDefinitionOutput) SetTags(v []*Tag) *DescribeTaskDefinitionOutput

SetTags sets the Tags field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTaskSetsInput added in v1.19.3 

type DescribeTaskSetsInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts
	// the service that the task sets exist in.
	//
	// Cluster is a required field
	Cluster *string `locationName:"cluster" type:"string" required:"true"`

	// Specifies whether to see the resource tags for the task set. If TAGS is specified,
	// the tags are included in the response. If this field is omitted, tags aren't
	// included in the response.
	Include []*string `locationName:"include" type:"list" enum:"TaskSetField"`

	// The short name or full Amazon Resource Name (ARN) of the service that the
	// task sets exist in.
	//
	// Service is a required field
	Service *string `locationName:"service" type:"string" required:"true"`

	// The ID or full Amazon Resource Name (ARN) of task sets to describe.
	TaskSets []*string `locationName:"taskSets" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeTaskSetsInput) GoString added in v1.19.3 

func (s DescribeTaskSetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTaskSetsInput) SetCluster added in v1.19.3 

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

SetCluster sets the Cluster field's value.

func (*DescribeTaskSetsInput) SetInclude added in v1.28.9 

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

SetInclude sets the Include field's value.

func (*DescribeTaskSetsInput) SetService added in v1.19.3 

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

SetService sets the Service field's value.

func (*DescribeTaskSetsInput) SetTaskSets added in v1.19.3 

func (s *DescribeTaskSetsInput) SetTaskSets(v []*string) *DescribeTaskSetsInput

SetTaskSets sets the TaskSets field's value.

func (DescribeTaskSetsInput) String added in v1.19.3 

func (s DescribeTaskSetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTaskSetsInput) Validate added in v1.19.3 

func (s *DescribeTaskSetsInput) Validate() error

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

type DescribeTaskSetsOutput added in v1.19.3 

type DescribeTaskSetsOutput struct {

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

	// The list of task sets described.
	TaskSets []*TaskSet `locationName:"taskSets" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeTaskSetsOutput) GoString added in v1.19.3 

func (s DescribeTaskSetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTaskSetsOutput) SetFailures added in v1.19.3 

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

SetFailures sets the Failures field's value.

func (*DescribeTaskSetsOutput) SetTaskSets added in v1.19.3 

func (s *DescribeTaskSetsOutput) SetTaskSets(v []*TaskSet) *DescribeTaskSetsOutput

SetTaskSets sets the TaskSets field's value.

func (DescribeTaskSetsOutput) String added in v1.19.3 

func (s DescribeTaskSetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTasksInput 

type DescribeTasksInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts
	// the task or tasks to describe. If you do not specify a cluster, the default
	// cluster is assumed. This parameter is required if the task or tasks you are
	// describing were launched in any cluster other than the default cluster.
	Cluster *string `locationName:"cluster" type:"string"`

	// Specifies whether you want to see the resource tags for the task. If TAGS
	// is specified, the tags are included in the response. If this field is omitted,
	// tags aren't included in the response.
	Include []*string `locationName:"include" type:"list" enum:"TaskField"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTasksInput) SetCluster added in v1.5.0 

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

SetCluster sets the Cluster field's value.

func (*DescribeTasksInput) SetInclude added in v1.15.77 

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

SetInclude sets the Include 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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" enum:"DeviceCgroupPermission"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. For more
	// information about the ARN format, see Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids)
	// in the Amazon ECS Developer Guide.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DiscoverPollEndpointOutput 

type DiscoverPollEndpointOutput struct {

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

	// The endpoint for the Amazon ECS agent to poll for Service Connect configuration.
	// For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
	// in the Amazon Elastic Container Service Developer Guide.
	ServiceConnectEndpoint *string `locationName:"serviceConnectEndpoint" 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DiscoverPollEndpointOutput) SetEndpoint added in v1.5.0 

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

SetEndpoint sets the Endpoint field's value.

func (*DiscoverPollEndpointOutput) SetServiceConnectEndpoint added in v1.44.146 

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

SetServiceConnectEndpoint sets the ServiceConnectEndpoint 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DockerVolumeConfiguration added in v1.15.9 

type DockerVolumeConfiguration struct {

	// If this value is true, the Docker volume is created if it doesn't already
	// exist.
	//
	// This field is only used if the scope is shared.
	Autoprovision *bool `locationName:"autoprovision" type:"boolean"`

	// The Docker volume driver to use. The driver value must match the driver name
	// provided by Docker because it is used for task placement. If the driver was
	// installed using the Docker plugin CLI, use docker plugin ls to retrieve the
	// driver name from your container instance. If the driver was installed using
	// another method, use Docker plugin discovery to retrieve the driver name.
	// For more information, see Docker plugin discovery (https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery).
	// This parameter maps to Driver in the Create a volume (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the xxdriver option to docker volume create (https://docs.docker.com/engine/reference/commandline/volume_create/).
	Driver *string `locationName:"driver" type:"string"`

	// A map of Docker driver-specific options passed through. This parameter maps
	// to DriverOpts in the Create a volume (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the xxopt option to docker volume create (https://docs.docker.com/engine/reference/commandline/volume_create/).
	DriverOpts map[string]*string `locationName:"driverOpts" type:"map"`

	// Custom metadata to add to your Docker volume. This parameter maps to Labels
	// in the Create a volume (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the xxlabel option to docker volume create (https://docs.docker.com/engine/reference/commandline/volume_create/).
	Labels map[string]*string `locationName:"labels" type:"map"`

	// The scope for the Docker volume that determines its lifecycle. Docker volumes
	// that are scoped to a task are automatically provisioned when the task starts
	// and destroyed when the task stops. Docker volumes that are scoped as shared
	// persist after the task stops.
	Scope *string `locationName:"scope" type:"string" enum:"Scope"`
	// contains filtered or unexported fields
}

This parameter is specified when you're using Docker volumes. Docker volumes are only supported when you're using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.

func (DockerVolumeConfiguration) GoString added in v1.15.9 

func (s DockerVolumeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DockerVolumeConfiguration) SetAutoprovision added in v1.15.9 

func (s *DockerVolumeConfiguration) SetAutoprovision(v bool) *DockerVolumeConfiguration

SetAutoprovision sets the Autoprovision field's value.

func (*DockerVolumeConfiguration) SetDriver added in v1.15.9 

func (s *DockerVolumeConfiguration) SetDriver(v string) *DockerVolumeConfiguration

SetDriver sets the Driver field's value.

func (*DockerVolumeConfiguration) SetDriverOpts added in v1.15.9 

func (s *DockerVolumeConfiguration) SetDriverOpts(v map[string]*string) *DockerVolumeConfiguration

SetDriverOpts sets the DriverOpts field's value.

func (*DockerVolumeConfiguration) SetLabels added in v1.15.9 

func (s *DockerVolumeConfiguration) SetLabels(v map[string]*string) *DockerVolumeConfiguration

SetLabels sets the Labels field's value.

func (*DockerVolumeConfiguration) SetScope added in v1.15.9 

func (s *DockerVolumeConfiguration) SetScope(v string) *DockerVolumeConfiguration

SetScope sets the Scope field's value.

func (DockerVolumeConfiguration) String added in v1.15.9 

func (s DockerVolumeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EBSTagSpecification added in v1.49.19 

type EBSTagSpecification struct {

	// Determines whether to propagate the tags from the task definition to the
	// Amazon EBS volume. Tags can only propagate to a SERVICE specified in ServiceVolumeConfiguration.
	// If no value is specified, the tags aren't propagated.
	PropagateTags *string `locationName:"propagateTags" type:"string" enum:"PropagateTags"`

	// The type of volume resource.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true" enum:"EBSResourceType"`

	// The tags applied to this Amazon EBS volume. AmazonECSCreated and AmazonECSManaged
	// are reserved tags that can't be used.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

The tag specifications of an Amazon EBS volume.

func (EBSTagSpecification) GoString added in v1.49.19 

func (s EBSTagSpecification) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EBSTagSpecification) SetPropagateTags added in v1.49.19 

func (s *EBSTagSpecification) SetPropagateTags(v string) *EBSTagSpecification

SetPropagateTags sets the PropagateTags field's value.

func (*EBSTagSpecification) SetResourceType added in v1.49.19 

func (s *EBSTagSpecification) SetResourceType(v string) *EBSTagSpecification

SetResourceType sets the ResourceType field's value.

func (*EBSTagSpecification) SetTags added in v1.49.19 

func (s *EBSTagSpecification) SetTags(v []*Tag) *EBSTagSpecification

SetTags sets the Tags field's value.

func (EBSTagSpecification) String added in v1.49.19 

func (s EBSTagSpecification) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EBSTagSpecification) Validate added in v1.49.19 

func (s *EBSTagSpecification) Validate() error

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

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: 

mySession := session.Must(session.NewSession())

// 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) CreateCapacityProvider added in v1.25.46 

func (c *ECS) CreateCapacityProvider(input *CreateCapacityProviderInput) (*CreateCapacityProviderOutput, error)

CreateCapacityProvider API operation for Amazon EC2 Container Service.

Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.

Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use the FARGATE and FARGATE_SPOT capacity providers. These providers are available to all accounts in the Amazon Web Services Regions that Fargate supports.

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 CreateCapacityProvider for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • LimitExceededException The limit for the resource was exceeded.

  • UpdateInProgressException There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.

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

func (*ECS) CreateCapacityProviderRequest added in v1.25.46 

func (c *ECS) CreateCapacityProviderRequest(input *CreateCapacityProviderInput) (req *request.Request, output *CreateCapacityProviderOutput)

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

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 CreateCapacityProvider for more information on using the CreateCapacityProvider 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 CreateCapacityProviderRequest method.
req, resp := client.CreateCapacityProviderRequest(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/CreateCapacityProvider

func (*ECS) CreateCapacityProviderWithContext added in v1.25.46 

func (c *ECS) CreateCapacityProviderWithContext(ctx aws.Context, input *CreateCapacityProviderInput, opts ...request.Option) (*CreateCapacityProviderOutput, error)

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

See CreateCapacityProvider 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) 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 Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS (https://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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • NamespaceNotFoundException The specified namespace wasn't found.

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())
			case ecs.ErrCodeNamespaceNotFoundException:
				fmt.Println(ecs.ErrCodeNamespaceNotFoundException, 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 successfully.

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 your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the Amazon Elastic Container Service Developer Guide.

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. volumeConfigurations is only supported for REPLICA service and not DAEMON service. For more infomation, see Amazon EBS volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types) in the Amazon Elastic Container Service Developer Guide.

Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.

There are two service scheduler strategies available:

  • REPLICA - The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler concepts (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) in the Amazon Elastic Container Service Developer Guide.

  • DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service scheduler concepts (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) in the Amazon Elastic Container Service Developer Guide.

You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.

If a service uses the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the RUNNING state, tasks for services that don't use a load balancer are considered healthy . If they're in the RUNNING state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state. This is while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used. This is the case even if they're currently visible when describing your service.

When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) in the Amazon Elastic Container Service Developer Guide.

When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html) in the Amazon Elastic Container Service Developer Guide

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • UnsupportedFeatureException The specified task isn't supported in this Region.

  • PlatformUnknownException The specified platform version doesn't exist.

  • PlatformTaskDefinitionIncompatibilityException The specified platform version doesn't satisfy the required capabilities of the task definition.

  • AccessDeniedException You don't have authorization to perform the requested action.

  • NamespaceNotFoundException The specified namespace wasn't found.

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())
			case ecs.ErrCodeNamespaceNotFoundException:
				fmt.Println(ecs.ErrCodeNamespaceNotFoundException, 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())
			case ecs.ErrCodeNamespaceNotFoundException:
				fmt.Println(ecs.ErrCodeNamespaceNotFoundException, 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 successfully.

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) CreateTaskSet added in v1.19.3 

func (c *ECS) CreateTaskSet(input *CreateTaskSetInput) (*CreateTaskSetOutput, error)

CreateTaskSet API operation for Amazon EC2 Container Service.

Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) in the Amazon Elastic Container Service Developer Guide.

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

For information about the maximum number of task sets and otther quotas, see Amazon ECS service quotas (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.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 CreateTaskSet for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • UnsupportedFeatureException The specified task isn't supported in this Region.

  • PlatformUnknownException The specified platform version doesn't exist.

  • PlatformTaskDefinitionIncompatibilityException The specified platform version doesn't satisfy the required capabilities of the task definition.

  • AccessDeniedException You don't have authorization to perform the requested action.

  • ServiceNotFoundException The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

  • ServiceNotActiveException The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.

  • NamespaceNotFoundException The specified namespace wasn't found.

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

func (*ECS) CreateTaskSetRequest added in v1.19.3 

func (c *ECS) CreateTaskSetRequest(input *CreateTaskSetInput) (req *request.Request, output *CreateTaskSetOutput)

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

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 CreateTaskSet for more information on using the CreateTaskSet 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 CreateTaskSetRequest method.
req, resp := client.CreateTaskSetRequest(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/CreateTaskSet

func (*ECS) CreateTaskSetWithContext added in v1.19.3 

func (c *ECS) CreateTaskSetWithContext(ctx aws.Context, input *CreateTaskSetInput, opts ...request.Option) (*CreateTaskSetOutput, error)

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

See CreateTaskSet 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) DeleteAccountSetting added in v1.15.77 

func (c *ECS) DeleteAccountSetting(input *DeleteAccountSettingInput) (*DeleteAccountSettingOutput, error)

DeleteAccountSetting API operation for Amazon EC2 Container Service.

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

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 DeleteAccountSetting for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

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

Example (Shared00)

To delete your account setting This example deletes the account setting for your user for the specified resource type. 

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.DeleteAccountSettingInput{
		Name: aws.String("serviceLongArnFormat"),
	}

	result, err := svc.DeleteAccountSetting(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 delete the account settings for a specific IAM user or IAM role This example deletes the account setting for a specific IAM user or IAM role for the specified resource type. Only the root user can view or modify the account settings for another user. 

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.DeleteAccountSettingInput{
		Name:         aws.String("containerInstanceLongArnFormat"),
		PrincipalArn: aws.String("arn:aws:iam::<aws_account_id>:user/principalName"),
	}

	result, err := svc.DeleteAccountSetting(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) DeleteAccountSettingRequest added in v1.15.77 

func (c *ECS) DeleteAccountSettingRequest(input *DeleteAccountSettingInput) (req *request.Request, output *DeleteAccountSettingOutput)

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

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 DeleteAccountSetting for more information on using the DeleteAccountSetting 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 DeleteAccountSettingRequest method.
req, resp := client.DeleteAccountSettingRequest(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/DeleteAccountSetting

func (*ECS) DeleteAccountSettingWithContext added in v1.15.77 

func (c *ECS) DeleteAccountSettingWithContext(ctx aws.Context, input *DeleteAccountSettingInput, opts ...request.Option) (*DeleteAccountSettingOutput, error)

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

See DeleteAccountSetting 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 Types:

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • TargetNotFoundException The specified target wasn't found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.

  • InvalidParameterException The specified parameter isn't valid. 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 successfully.

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) DeleteCapacityProvider added in v1.32.0 

func (c *ECS) DeleteCapacityProvider(input *DeleteCapacityProviderInput) (*DeleteCapacityProviderOutput, error)

DeleteCapacityProvider API operation for Amazon EC2 Container Service.

Deletes the specified capacity provider.

The FARGATE and FARGATE_SPOT capacity providers are reserved and can't be deleted. You can disassociate them from a cluster using either the PutClusterCapacityProviders API or by deleting the cluster.

Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity provider strategy from all services. The UpdateService API can be used to remove a capacity provider from a service's capacity provider strategy. When updating a service, the forceNewDeployment option can be used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity provider are transitioned to use the capacity from the remaining capacity providers. Only capacity providers that aren't associated with a cluster can be deleted. To remove a capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.

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 DeleteCapacityProvider for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

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

func (*ECS) DeleteCapacityProviderRequest added in v1.32.0 

func (c *ECS) DeleteCapacityProviderRequest(input *DeleteCapacityProviderInput) (req *request.Request, output *DeleteCapacityProviderOutput)

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

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 DeleteCapacityProvider for more information on using the DeleteCapacityProvider 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 DeleteCapacityProviderRequest method.
req, resp := client.DeleteCapacityProviderRequest(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/DeleteCapacityProvider

func (*ECS) DeleteCapacityProviderWithContext added in v1.32.0 

func (c *ECS) DeleteCapacityProviderWithContext(ctx aws.Context, input *DeleteCapacityProviderInput, opts ...request.Option) (*DeleteCapacityProviderOutput, error)

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

See DeleteCapacityProvider 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. The cluster transitions to the INACTIVE state. Clusters with an INACTIVE status might remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting.

You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • ClusterContainsContainerInstancesException You can't delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.

  • ClusterContainsServicesException You can't delete a cluster that contains services. First, update the service to reduce its desired task count to 0, and then delete the service. For more information, see UpdateService and DeleteService.

  • ClusterContainsTasksException You can't delete a cluster that has active tasks.

  • UpdateInProgressException There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.

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())
			case ecs.ErrCodeUpdateInProgressException:
				fmt.Println(ecs.ErrCodeUpdateInProgressException, 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 successfully.

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

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

If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error.

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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • ServiceNotFoundException The specified service wasn't 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 successfully.

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) DeleteTaskDefinitions added in v1.44.208 

func (c *ECS) DeleteTaskDefinitions(input *DeleteTaskDefinitionsInput) (*DeleteTaskDefinitionsOutput, error)

DeleteTaskDefinitions API operation for Amazon EC2 Container Service.

Deletes one or more task definitions.

You must deregister a task definition revision before you delete it. For more information, see DeregisterTaskDefinition (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterTaskDefinition.html).

When you delete a task definition revision, it is immediately transitions from the INACTIVE to DELETE_IN_PROGRESS. Existing tasks and services that reference a DELETE_IN_PROGRESS task definition revision continue to run without disruption. Existing services that reference a DELETE_IN_PROGRESS task definition revision can still scale up or down by modifying the service's desired count.

You can't use a DELETE_IN_PROGRESS task definition revision to run new tasks or create new services. You also can't update an existing service to reference a DELETE_IN_PROGRESS task definition revision.

A task definition revision will stay in DELETE_IN_PROGRESS status until all the associated tasks and services have been terminated.

When you delete all INACTIVE task definition revisions, the task definition name is not displayed in the console and not returned in the API. If a task definition revisions are in the DELETE_IN_PROGRESS state, the task definition name is displayed in the console and returned in the API. The task definition name is retained by Amazon ECS and the revision is incremented the next time you create a task definition with that name.

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 DeleteTaskDefinitions for usage and error information.

Returned Error Types:

  • AccessDeniedException You don't have authorization to perform the requested action.

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

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

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

func (*ECS) DeleteTaskDefinitionsRequest added in v1.44.208 

func (c *ECS) DeleteTaskDefinitionsRequest(input *DeleteTaskDefinitionsInput) (req *request.Request, output *DeleteTaskDefinitionsOutput)

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

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 DeleteTaskDefinitions for more information on using the DeleteTaskDefinitions 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 DeleteTaskDefinitionsRequest method.
req, resp := client.DeleteTaskDefinitionsRequest(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/DeleteTaskDefinitions

func (*ECS) DeleteTaskDefinitionsWithContext added in v1.44.208 

func (c *ECS) DeleteTaskDefinitionsWithContext(ctx aws.Context, input *DeleteTaskDefinitionsInput, opts ...request.Option) (*DeleteTaskDefinitionsOutput, error)

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

See DeleteTaskDefinitions 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) DeleteTaskSet added in v1.19.3 

func (c *ECS) DeleteTaskSet(input *DeleteTaskSetInput) (*DeleteTaskSetOutput, error)

DeleteTaskSet API operation for Amazon EC2 Container Service.

Deletes a specified task set within a service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.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 DeleteTaskSet for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • UnsupportedFeatureException The specified task isn't supported in this Region.

  • AccessDeniedException You don't have authorization to perform the requested action.

  • ServiceNotFoundException The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

  • ServiceNotActiveException The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.

  • TaskSetNotFoundException The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.

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

func (*ECS) DeleteTaskSetRequest added in v1.19.3 

func (c *ECS) DeleteTaskSetRequest(input *DeleteTaskSetInput) (req *request.Request, output *DeleteTaskSetOutput)

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

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 DeleteTaskSet for more information on using the DeleteTaskSet 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 DeleteTaskSetRequest method.
req, resp := client.DeleteTaskSetRequest(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/DeleteTaskSet

func (*ECS) DeleteTaskSetWithContext added in v1.19.3 

func (c *ECS) DeleteTaskSetWithContext(ctx aws.Context, input *DeleteTaskSetInput, opts ...request.Option) (*DeleteTaskSetOutput, error)

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

See DeleteTaskSet 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, we recommend that you stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.

Deregistering a container instance removes the instance from a cluster, but it doesn't terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.

If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents aren't automatically deregistered when terminated).

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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't 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 successfully.

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. If you want to delete a task definition revision, you must first deregister the task definition revision.

You can't use an INACTIVE task definition to run new tasks or create new services, and you can't update an existing service to reference an INACTIVE task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.

At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.

You must deregister a task definition revision before you delete it. For more information, see DeleteTaskDefinitions (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteTaskDefinitions.html).

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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. 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 successfully.

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) DescribeCapacityProviders added in v1.25.46 

func (c *ECS) DescribeCapacityProviders(input *DescribeCapacityProvidersInput) (*DescribeCapacityProvidersOutput, error)

DescribeCapacityProviders API operation for Amazon EC2 Container Service.

Describes one or more of your capacity providers.

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 DescribeCapacityProviders for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

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

func (*ECS) DescribeCapacityProvidersRequest added in v1.25.46 

func (c *ECS) DescribeCapacityProvidersRequest(input *DescribeCapacityProvidersInput) (req *request.Request, output *DescribeCapacityProvidersOutput)

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

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 DescribeCapacityProviders for more information on using the DescribeCapacityProviders 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 DescribeCapacityProvidersRequest method.
req, resp := client.DescribeCapacityProvidersRequest(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/DescribeCapacityProviders

func (*ECS) DescribeCapacityProvidersWithContext added in v1.25.46 

func (c *ECS) DescribeCapacityProvidersWithContext(ctx aws.Context, input *DescribeCapacityProvidersInput, opts ...request.Option) (*DescribeCapacityProvidersOutput, error)

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

See DescribeCapacityProviders 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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. 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 successfully.

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 one or more container instances. Returns metadata about 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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't 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 successfully.

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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't 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 successfully.

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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. 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 successfully.

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) DescribeTaskSets added in v1.19.3 

func (c *ECS) DescribeTaskSets(input *DescribeTaskSetsInput) (*DescribeTaskSetsOutput, error)

DescribeTaskSets API operation for Amazon EC2 Container Service.

Describes the task sets in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.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 DescribeTaskSets for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • UnsupportedFeatureException The specified task isn't supported in this Region.

  • AccessDeniedException You don't have authorization to perform the requested action.

  • ServiceNotFoundException The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

  • ServiceNotActiveException The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.

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

func (*ECS) DescribeTaskSetsRequest added in v1.19.3 

func (c *ECS) DescribeTaskSetsRequest(input *DescribeTaskSetsInput) (req *request.Request, output *DescribeTaskSetsOutput)

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

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 DescribeTaskSets for more information on using the DescribeTaskSets 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 DescribeTaskSetsRequest method.
req, resp := client.DescribeTaskSetsRequest(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/DescribeTaskSets

func (*ECS) DescribeTaskSetsWithContext added in v1.19.3 

func (c *ECS) DescribeTaskSetsWithContext(ctx aws.Context, input *DescribeTaskSetsInput, opts ...request.Option) (*DescribeTaskSetsOutput, error)

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

See DescribeTaskSets 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.

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

If you have tasks with tags, and then delete the cluster, the tagged tasks are returned in the response. If you create a new cluster with the same name as the deleted cluster, the tagged tasks are not included in the response.

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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't 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 successfully.

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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

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

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) ExecuteCommand added in v1.37.31 

func (c *ECS) ExecuteCommand(input *ExecuteCommandInput) (*ExecuteCommandOutput, error)

ExecuteCommand API operation for Amazon EC2 Container Service.

Runs a command remotely on a container within a task.

If you use a condition key in your IAM policy to refine the conditions for the policy statement, for example limit the actions to a specific cluster, you receive an AccessDeniedException when there is a mismatch between the condition key value and the corresponding parameter value.

For information about required permissions and considerations, see Using Amazon ECS Exec for debugging (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html) in the Amazon ECS 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 ExecuteCommand for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • AccessDeniedException You don't have authorization to perform the requested action.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • TargetNotConnectedException The execute command cannot run. This error can be caused by any of the following configuration issues:

  • Incorrect IAM permissions

  • The SSM agent is not installed or is not running

  • There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for Systems Manager Session Manager

    For information about how to troubleshoot the issues, see Troubleshooting issues with ECS Exec (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html) in the Amazon Elastic Container Service Developer Guide.

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

func (*ECS) ExecuteCommandRequest added in v1.37.31 

func (c *ECS) ExecuteCommandRequest(input *ExecuteCommandInput) (req *request.Request, output *ExecuteCommandOutput)

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

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 ExecuteCommand for more information on using the ExecuteCommand 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 ExecuteCommandRequest method.
req, resp := client.ExecuteCommandRequest(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/ExecuteCommand

func (*ECS) ExecuteCommandWithContext added in v1.37.31 

func (c *ECS) ExecuteCommandWithContext(ctx aws.Context, input *ExecuteCommandInput, opts ...request.Option) (*ExecuteCommandOutput, error)

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

See ExecuteCommand 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) GetTaskProtection added in v1.44.135 

func (c *ECS) GetTaskProtection(input *GetTaskProtectionInput) (*GetTaskProtectionOutput, error)

GetTaskProtection API operation for Amazon EC2 Container Service.

Retrieves the protection status of tasks in an Amazon ECS 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 GetTaskProtection for usage and error information.

Returned Error Types:

  • AccessDeniedException You don't have authorization to perform the requested action.

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ResourceNotFoundException The specified resource wasn't found.

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

  • UnsupportedFeatureException The specified task isn't supported in this Region.

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

Example (Shared00)

To get the protection status of a task In this example, we get the protection status for a single 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.GetTaskProtectionInput{
		Cluster: aws.String("test-task-protection"),
		Tasks: []*string{
			aws.String("b8b1cf532d0e46ba8d44a40d1de16772"),
		},
	}

	result, err := svc.GetTaskProtection(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeAccessDeniedException:
				fmt.Println(ecs.ErrCodeAccessDeniedException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeResourceNotFoundException:
				fmt.Println(ecs.ErrCodeResourceNotFoundException, aerr.Error())
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeUnsupportedFeatureException:
				fmt.Println(ecs.ErrCodeUnsupportedFeatureException, 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) GetTaskProtectionRequest added in v1.44.135 

func (c *ECS) GetTaskProtectionRequest(input *GetTaskProtectionInput) (req *request.Request, output *GetTaskProtectionOutput)

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

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 GetTaskProtection for more information on using the GetTaskProtection 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 GetTaskProtectionRequest method.
req, resp := client.GetTaskProtectionRequest(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/GetTaskProtection

func (*ECS) GetTaskProtectionWithContext added in v1.44.135 

func (c *ECS) GetTaskProtectionWithContext(ctx aws.Context, input *GetTaskProtectionInput, opts ...request.Option) (*GetTaskProtectionOutput, error)

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

See GetTaskProtection 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) ListAccountSettings added in v1.15.77 

func (c *ECS) ListAccountSettings(input *ListAccountSettingsInput) (*ListAccountSettingsOutput, error)

ListAccountSettings API operation for Amazon EC2 Container Service.

Lists the account settings for a specified principal.

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 ListAccountSettings for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

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

Example (Shared00)

To view your effective account settings This example displays the effective account settings for your account. 

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.ListAccountSettingsInput{
		EffectiveSettings: aws.Bool(true),
	}

	result, err := svc.ListAccountSettings(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 view the effective account settings for a specific IAM user or IAM role This example displays the effective account settings for the specified user or role. 

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.ListAccountSettingsInput{
		EffectiveSettings: aws.Bool(true),
		PrincipalArn:      aws.String("arn:aws:iam::<aws_account_id>:user/principalName"),
	}

	result, err := svc.ListAccountSettings(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) ListAccountSettingsPages added in v1.28.5 

func (c *ECS) ListAccountSettingsPages(input *ListAccountSettingsInput, fn func(*ListAccountSettingsOutput, bool) bool) error

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

See ListAccountSettings 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 ListAccountSettings operation.
pageNum := 0
err := client.ListAccountSettingsPages(params,
    func(page *ecs.ListAccountSettingsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ECS) ListAccountSettingsPagesWithContext added in v1.28.5 

func (c *ECS) ListAccountSettingsPagesWithContext(ctx aws.Context, input *ListAccountSettingsInput, fn func(*ListAccountSettingsOutput, bool) bool, opts ...request.Option) error

ListAccountSettingsPagesWithContext same as ListAccountSettingsPages 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) ListAccountSettingsRequest added in v1.15.77 

func (c *ECS) ListAccountSettingsRequest(input *ListAccountSettingsInput) (req *request.Request, output *ListAccountSettingsOutput)

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

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 ListAccountSettings for more information on using the ListAccountSettings 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 ListAccountSettingsRequest method.
req, resp := client.ListAccountSettingsRequest(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/ListAccountSettings

func (*ECS) ListAccountSettingsWithContext added in v1.15.77 

func (c *ECS) ListAccountSettingsWithContext(ctx aws.Context, input *ListAccountSettingsInput, opts ...request.Option) (*ListAccountSettingsOutput, error)

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

See ListAccountSettings 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. You can do this, 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 Types:

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

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

func (*ECS) ListAttributesPages added in v1.25.46 

func (c *ECS) ListAttributesPages(input *ListAttributesInput, fn func(*ListAttributesOutput, bool) bool) error

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

See ListAttributes 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 ListAttributes operation.
pageNum := 0
err := client.ListAttributesPages(params,
    func(page *ecs.ListAttributesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ECS) ListAttributesPagesWithContext added in v1.25.46 

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

ListAttributesPagesWithContext same as ListAttributesPages 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) 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 successfully.

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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. 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 *ecs.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 successfully.

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 (https://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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't 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 *ecs.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 successfully.

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.

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

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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't 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) ListServicesByNamespace added in v1.44.146 

func (c *ECS) ListServicesByNamespace(input *ListServicesByNamespaceInput) (*ListServicesByNamespaceOutput, error)

ListServicesByNamespace API operation for Amazon EC2 Container Service.

This operation lists all of the services that are associated with a Cloud Map namespace. This list might include services in different clusters. In contrast, ListServices can only list services in one cluster at a time. If you need to filter the list of services in a single cluster by various parameters, use ListServices. For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.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 ListServicesByNamespace for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • NamespaceNotFoundException The specified namespace wasn't found.

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

func (*ECS) ListServicesByNamespacePages added in v1.44.146 

func (c *ECS) ListServicesByNamespacePages(input *ListServicesByNamespaceInput, fn func(*ListServicesByNamespaceOutput, bool) bool) error

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

See ListServicesByNamespace 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 ListServicesByNamespace operation.
pageNum := 0
err := client.ListServicesByNamespacePages(params,
    func(page *ecs.ListServicesByNamespaceOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ECS) ListServicesByNamespacePagesWithContext added in v1.44.146 

func (c *ECS) ListServicesByNamespacePagesWithContext(ctx aws.Context, input *ListServicesByNamespaceInput, fn func(*ListServicesByNamespaceOutput, bool) bool, opts ...request.Option) error

ListServicesByNamespacePagesWithContext same as ListServicesByNamespacePages 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) ListServicesByNamespaceRequest added in v1.44.146 

func (c *ECS) ListServicesByNamespaceRequest(input *ListServicesByNamespaceInput) (req *request.Request, output *ListServicesByNamespaceOutput)

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

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 ListServicesByNamespace for more information on using the ListServicesByNamespace 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 ListServicesByNamespaceRequest method.
req, resp := client.ListServicesByNamespaceRequest(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/ListServicesByNamespace

func (*ECS) ListServicesByNamespaceWithContext added in v1.44.146 

func (c *ECS) ListServicesByNamespaceWithContext(ctx aws.Context, input *ListServicesByNamespaceInput, opts ...request.Option) (*ListServicesByNamespaceOutput, error)

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

See ListServicesByNamespace 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) 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 *ecs.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 successfully.

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) ListTagsForResource added in v1.15.77 

func (c *ECS) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon EC2 Container Service.

List the tags for 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 ListTagsForResource for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

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

Example (Shared00)

To list the tags for a cluster. This example lists the tags for the 'dev' 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.ListTagsForResourceInput{
		ResourceArn: aws.String("arn:aws:ecs:region:aws_account_id:cluster/dev"),
	}

	result, err := svc.ListTagsForResource(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.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, 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) ListTagsForResourceRequest added in v1.15.77 

func (c *ECS) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

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

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 ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(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/ListTagsForResource

func (*ECS) ListTagsForResourceWithContext added in v1.15.77 

func (c *ECS) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource 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. This list includes task definition families that no longer have any ACTIVE task definition revisions.

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

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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. 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 *ecs.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 successfully.

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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. 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 *ecs.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 successfully.

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. You can filter the results by cluster, task definition family, container instance, launch type, what IAM principal started the task, or by the desired status of the task.

Recently stopped tasks might appear in the returned results.

Returns 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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • ServiceNotFoundException The specified service wasn't 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 *ecs.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 successfully.

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) PutAccountSetting added in v1.15.77 

func (c *ECS) PutAccountSetting(input *PutAccountSettingInput) (*PutAccountSettingOutput, error)

PutAccountSetting API operation for Amazon EC2 Container Service.

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

If you change the root user account setting, the default settings are reset for users and roles that do not have specified individual account settings. For more information, see Account Settings (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.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 PutAccountSetting for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

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

Example (Shared00)

To modify your account settings This example modifies your account settings to opt in to the new ARN and resource ID format for Amazon ECS services. If you’re using this command as the root user, then changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves. 

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.PutAccountSettingInput{
		Name:  aws.String("serviceLongArnFormat"),
		Value: aws.String("enabled"),
	}

	result, err := svc.PutAccountSetting(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 modify the account settings for a specific IAM user or IAM role This example modifies the account setting for a specific IAM user or IAM role to opt in to the new ARN and resource ID format for Amazon ECS container instances. If you’re using this command as the root user, then changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves. 

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.PutAccountSettingInput{
		Name:         aws.String("containerInstanceLongArnFormat"),
		PrincipalArn: aws.String("arn:aws:iam::<aws_account_id>:user/principalName"),
		Value:        aws.String("enabled"),
	}

	result, err := svc.PutAccountSetting(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) PutAccountSettingDefault added in v1.16.31 

func (c *ECS) PutAccountSettingDefault(input *PutAccountSettingDefaultInput) (*PutAccountSettingDefaultOutput, error)

PutAccountSettingDefault API operation for Amazon EC2 Container Service.

Modifies an account setting for all users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.

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 PutAccountSettingDefault for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

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

Example (Shared00)

To modify the default account settings for all IAM users or roles on an account This example modifies the default account setting for the specified resource for all IAM users or roles on an account. These changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves. 

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.PutAccountSettingDefaultInput{
		Name:  aws.String("serviceLongArnFormat"),
		Value: aws.String("enabled"),
	}

	result, err := svc.PutAccountSettingDefault(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) PutAccountSettingDefaultRequest added in v1.16.31 

func (c *ECS) PutAccountSettingDefaultRequest(input *PutAccountSettingDefaultInput) (req *request.Request, output *PutAccountSettingDefaultOutput)

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

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 PutAccountSettingDefault for more information on using the PutAccountSettingDefault 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 PutAccountSettingDefaultRequest method.
req, resp := client.PutAccountSettingDefaultRequest(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/PutAccountSettingDefault

func (*ECS) PutAccountSettingDefaultWithContext added in v1.16.31 

func (c *ECS) PutAccountSettingDefaultWithContext(ctx aws.Context, input *PutAccountSettingDefaultInput, opts ...request.Option) (*PutAccountSettingDefaultOutput, error)

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

See PutAccountSettingDefault 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) PutAccountSettingRequest added in v1.15.77 

func (c *ECS) PutAccountSettingRequest(input *PutAccountSettingInput) (req *request.Request, output *PutAccountSettingOutput)

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

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 PutAccountSetting for more information on using the PutAccountSetting 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 PutAccountSettingRequest method.
req, resp := client.PutAccountSettingRequest(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/PutAccountSetting

func (*ECS) PutAccountSettingWithContext added in v1.15.77 

func (c *ECS) PutAccountSettingWithContext(ctx aws.Context, input *PutAccountSettingInput, opts ...request.Option) (*PutAccountSettingOutput, error)

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

See PutAccountSetting 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 doesn't exist, it's created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes (https://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 Types:

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • TargetNotFoundException The specified target wasn't found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.

  • AttributeLimitExceededException You can apply up to 10 custom attributes for each resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.

  • InvalidParameterException The specified parameter isn't valid. 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 successfully.

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) PutClusterCapacityProviders added in v1.25.46 

func (c *ECS) PutClusterCapacityProviders(input *PutClusterCapacityProvidersInput) (*PutClusterCapacityProvidersOutput, error)

PutClusterCapacityProviders API operation for Amazon EC2 Container Service.

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

You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers that are associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster's default capacity provider strategy is used. We recommend that you define a default capacity provider strategy for your cluster. However, you must specify an empty array ([]) to bypass defining a default strategy.

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 PutClusterCapacityProviders for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • ResourceInUseException The specified resource is in-use and can't be removed.

  • UpdateInProgressException There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.

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

func (*ECS) PutClusterCapacityProvidersRequest added in v1.25.46 

func (c *ECS) PutClusterCapacityProvidersRequest(input *PutClusterCapacityProvidersInput) (req *request.Request, output *PutClusterCapacityProvidersOutput)

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

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 PutClusterCapacityProviders for more information on using the PutClusterCapacityProviders 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 PutClusterCapacityProvidersRequest method.
req, resp := client.PutClusterCapacityProvidersRequest(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/PutClusterCapacityProviders

func (*ECS) PutClusterCapacityProvidersWithContext added in v1.25.46 

func (c *ECS) PutClusterCapacityProvidersWithContext(ctx aws.Context, input *PutClusterCapacityProvidersInput, opts ...request.Option) (*PutClusterCapacityProvidersOutput, error)

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

See PutClusterCapacityProviders 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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. 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 successfully.

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

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

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. 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 successfully.

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.

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks (https://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.

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types) in the Amazon Elastic Container Service Developer Guide.

The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.

To manage eventual consistency, you can do the following:

  • Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.

  • Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.

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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • UnsupportedFeatureException The specified task isn't supported in this Region.

  • PlatformUnknownException The specified platform version doesn't exist.

  • PlatformTaskDefinitionIncompatibilityException The specified platform version doesn't satisfy the required capabilities of the task definition.

  • AccessDeniedException You don't have authorization to perform the requested action.

  • BlockedException Your Amazon Web Services account was blocked. For more information, contact Amazon Web Services Support (http://aws.amazon.com/contact-us/).

  • ConflictException The RunTask request could not be processed due to conflicts. The provided clientToken is already in use with a different RunTask request. The resourceIds are the existing task ARNs which are already associated with the clientToken.

    To fix this issue:

  • Run RunTask with a unique clientToken.

  • Run RunTask with the clientToken and the original set of parameters

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())
			case ecs.ErrCodeConflictException:
				fmt.Println(ecs.ErrCodeConflictException, 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 successfully.

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.

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html) in the Amazon Elastic Container Service Developer Guide.

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types) 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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • UnsupportedFeatureException The specified task isn't supported in this Region.

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

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. Any tags associated with the task will be deleted.

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

For Windows containers, POSIX signals do not work and runtime stops the container by sending a CTRL_SHUTDOWN_EVENT. For more information, see Unable to react to graceful shutdown of (Windows) container #25982 (https://github.com/moby/moby/issues/25982) on GitHub.

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 (https://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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't 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 successfully.

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) SubmitAttachmentStateChanges added in v1.19.45 

func (c *ECS) SubmitAttachmentStateChanges(input *SubmitAttachmentStateChangesInput) (*SubmitAttachmentStateChangesOutput, error)

SubmitAttachmentStateChanges 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 an attachment 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 SubmitAttachmentStateChanges for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • AccessDeniedException You don't have authorization to perform the requested action.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

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

func (*ECS) SubmitAttachmentStateChangesRequest added in v1.19.45 

func (c *ECS) SubmitAttachmentStateChangesRequest(input *SubmitAttachmentStateChangesInput) (req *request.Request, output *SubmitAttachmentStateChangesOutput)

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

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 SubmitAttachmentStateChanges for more information on using the SubmitAttachmentStateChanges 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 SubmitAttachmentStateChangesRequest method.
req, resp := client.SubmitAttachmentStateChangesRequest(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/SubmitAttachmentStateChanges

func (*ECS) SubmitAttachmentStateChangesWithContext added in v1.19.45 

func (c *ECS) SubmitAttachmentStateChangesWithContext(ctx aws.Context, input *SubmitAttachmentStateChangesInput, opts ...request.Option) (*SubmitAttachmentStateChangesOutput, error)

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

See SubmitAttachmentStateChanges 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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • AccessDeniedException You don't 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 successfully.

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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • AccessDeniedException You don't have authorization to perform the requested action.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

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

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) TagResource added in v1.15.77 

func (c *ECS) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon EC2 Container Service.

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that are associated with that resource are deleted as well.

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 TagResource for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • ResourceNotFoundException The specified resource wasn't found.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

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

Example (Shared00)

To tag a cluster. This example tags the 'dev' cluster with key 'team' and value 'dev'. 

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.TagResourceInput{
		ResourceArn: aws.String("arn:aws:ecs:region:aws_account_id:cluster/dev"),
		Tags: []*ecs.Tag{
			{
				Key:   aws.String("team"),
				Value: aws.String("dev"),
			},
		},
	}

	result, err := svc.TagResource(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.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			case ecs.ErrCodeResourceNotFoundException:
				fmt.Println(ecs.ErrCodeResourceNotFoundException, 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) TagResourceRequest added in v1.15.77 

func (c *ECS) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

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

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 TagResource for more information on using the TagResource 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 TagResourceRequest method.
req, resp := client.TagResourceRequest(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/TagResource

func (*ECS) TagResourceWithContext added in v1.15.77 

func (c *ECS) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource 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) UntagResource added in v1.15.77 

func (c *ECS) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon EC2 Container Service.

Deletes specified tags from a 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 UntagResource for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • ResourceNotFoundException The specified resource wasn't found.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

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

Example (Shared00)

To untag a cluster. This example deletes the 'team' tag from the 'dev' 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.UntagResourceInput{
		ResourceArn: aws.String("arn:aws:ecs:region:aws_account_id:cluster/dev"),
		TagKeys: []*string{
			aws.String("team"),
		},
	}

	result, err := svc.UntagResource(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.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			case ecs.ErrCodeResourceNotFoundException:
				fmt.Println(ecs.ErrCodeResourceNotFoundException, 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) UntagResourceRequest added in v1.15.77 

func (c *ECS) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

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

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 UntagResource for more information on using the UntagResource 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 UntagResourceRequest method.
req, resp := client.UntagResourceRequest(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/UntagResource

func (*ECS) UntagResourceWithContext added in v1.15.77 

func (c *ECS) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

See UntagResource 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) UpdateCapacityProvider added in v1.35.34 

func (c *ECS) UpdateCapacityProvider(input *UpdateCapacityProviderInput) (*UpdateCapacityProviderOutput, error)

UpdateCapacityProvider API operation for Amazon EC2 Container Service.

Modifies the parameters for a capacity provider.

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 UpdateCapacityProvider for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

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

func (*ECS) UpdateCapacityProviderRequest added in v1.35.34 

func (c *ECS) UpdateCapacityProviderRequest(input *UpdateCapacityProviderInput) (req *request.Request, output *UpdateCapacityProviderOutput)

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

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 UpdateCapacityProvider for more information on using the UpdateCapacityProvider 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 UpdateCapacityProviderRequest method.
req, resp := client.UpdateCapacityProviderRequest(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/UpdateCapacityProvider

func (*ECS) UpdateCapacityProviderWithContext added in v1.35.34 

func (c *ECS) UpdateCapacityProviderWithContext(ctx aws.Context, input *UpdateCapacityProviderInput, opts ...request.Option) (*UpdateCapacityProviderOutput, error)

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

See UpdateCapacityProvider 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) UpdateCluster added in v1.37.31 

func (c *ECS) UpdateCluster(input *UpdateClusterInput) (*UpdateClusterOutput, error)

UpdateCluster API operation for Amazon EC2 Container Service.

Updates the 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 UpdateCluster for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • NamespaceNotFoundException The specified namespace wasn't found.

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

func (*ECS) UpdateClusterRequest added in v1.37.31 

func (c *ECS) UpdateClusterRequest(input *UpdateClusterInput) (req *request.Request, output *UpdateClusterOutput)

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

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 UpdateCluster for more information on using the UpdateCluster 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 UpdateClusterRequest method.
req, resp := client.UpdateClusterRequest(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/UpdateCluster

func (*ECS) UpdateClusterSettings added in v1.23.13 

func (c *ECS) UpdateClusterSettings(input *UpdateClusterSettingsInput) (*UpdateClusterSettingsOutput, error)

UpdateClusterSettings API operation for Amazon EC2 Container Service.

Modifies the settings to use for a 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 UpdateClusterSettings for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

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

func (*ECS) UpdateClusterSettingsRequest added in v1.23.13 

func (c *ECS) UpdateClusterSettingsRequest(input *UpdateClusterSettingsInput) (req *request.Request, output *UpdateClusterSettingsOutput)

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

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 UpdateClusterSettings for more information on using the UpdateClusterSettings 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 UpdateClusterSettingsRequest method.
req, resp := client.UpdateClusterSettingsRequest(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/UpdateClusterSettings

func (*ECS) UpdateClusterSettingsWithContext added in v1.23.13 

func (c *ECS) UpdateClusterSettingsWithContext(ctx aws.Context, input *UpdateClusterSettingsInput, opts ...request.Option) (*UpdateClusterSettingsOutput, error)

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

See UpdateClusterSettings 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) UpdateClusterWithContext added in v1.37.31 

func (c *ECS) UpdateClusterWithContext(ctx aws.Context, input *UpdateClusterInput, opts ...request.Option) (*UpdateClusterOutput, error)

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

See UpdateCluster 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 doesn't interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.

The UpdateContainerAgent API isn't supported for container instances using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the ecs-init package. This updates the agent. For more information, see Updating the Amazon ECS container agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html) in the Amazon Elastic Container Service Developer Guide.

Agent updates with the UpdateContainerAgent API operation do not apply to Windows container instances. We recommend that you launch new container instances to update the agent version in your Windows clusters.

The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon Linux AMI with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent (https://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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • UpdateInProgressException There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.

  • NoUpdateAvailableException There's no update available for this Amazon ECS container agent. This might be because the agent is already running the latest version or because it's so old that there's no update path to the current version.

  • MissingVersionException Amazon ECS can't determine the current version of the Amazon ECS container agent on the container instance and doesn't have enough information to proceed with an update. This could be because the agent running on the container instance is a previous or custom version that doesn't use our version information.

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

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.

Once a container instance has reached an ACTIVE state, you can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.

A container instance can't be changed to DRAINING until it has reached an ACTIVE status. If the instance is in any other status, an error will be received.

When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately.

Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service's deployment configuration parameters, minimumHealthyPercent and maximumPercent. You can change the deployment configuration of your service using UpdateService.

  • If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during task replacement. For example, desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.

  • The maximumPercent parameter represents an upper limit on the number of running tasks during task replacement. You can use this to define the replacement batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.

Any PENDING or RUNNING tasks that do not belong to a service aren't affected. You must wait for them to finish or stop them manually.

A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks.

When a container instance has been drained, you can set a container instance to ACTIVE status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again.

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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't 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 successfully.

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 parameters of a service.

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

For services using the rolling update (ECS) you can update the desired count, deployment configuration, network configuration, load balancers, service registries, enable ECS managed tags option, propagate tags option, task placement constraints and strategies, and task definition. When you update any of these parameters, Amazon ECS starts new tasks with the new configuration.

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types) in the Amazon Elastic Container Service Developer Guide. You can update your volume configurations and trigger a new deployment. volumeConfigurations is only supported for REPLICA service and not DAEMON service. If you leave volumeConfigurations null, it doesn't trigger a new deployment. For more infomation on volumes, see Amazon EBS volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types) in the Amazon Elastic Container Service Developer Guide.

For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, health check grace period, task placement constraints and strategies, enable ECS managed tags option, and propagate tags can be updated using this API. If the network configuration, platform version, task definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more information, see CreateDeployment (https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html) in the CodeDeploy API Reference.

For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, health check grace period, enable ECS managed tags option, and propagate tags option, using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, create a new task set For more information, see CreateTaskSet.

You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types) in the Amazon Elastic Container Service Developer Guide.

If you have updated the container image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.

If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you don't need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.

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

  • If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.

  • The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment. You can use it to define the deployment batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).

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

When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic.

  • Determine which of the container instances in your cluster can support your service's task definition. For example, they have the required CPU, memory, ports, and container instance attributes.

  • By default, the service scheduler attempts to balance tasks across Availability Zones in this manner even though you can choose a different placement strategy. Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.

When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:

  • Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.

  • Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.

You must have a service-linked role when you update any of the following service properties:

  • loadBalancers,

  • serviceRegistries

For more information about the role see the CreateService request parameter role (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role).

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 Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • ServiceNotFoundException The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

  • ServiceNotActiveException The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.

  • PlatformUnknownException The specified platform version doesn't exist.

  • PlatformTaskDefinitionIncompatibilityException The specified platform version doesn't satisfy the required capabilities of the task definition.

  • AccessDeniedException You don't have authorization to perform the requested action.

  • NamespaceNotFoundException The specified namespace wasn't found.

  • UnsupportedFeatureException The specified task isn't supported in this Region.

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())
			case ecs.ErrCodeNamespaceNotFoundException:
				fmt.Println(ecs.ErrCodeNamespaceNotFoundException, aerr.Error())
			case ecs.ErrCodeUnsupportedFeatureException:
				fmt.Println(ecs.ErrCodeUnsupportedFeatureException, 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())
			case ecs.ErrCodeNamespaceNotFoundException:
				fmt.Println(ecs.ErrCodeNamespaceNotFoundException, aerr.Error())
			case ecs.ErrCodeUnsupportedFeatureException:
				fmt.Println(ecs.ErrCodeUnsupportedFeatureException, 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) UpdateServicePrimaryTaskSet added in v1.19.3 

func (c *ECS) UpdateServicePrimaryTaskSet(input *UpdateServicePrimaryTaskSetInput) (*UpdateServicePrimaryTaskSetOutput, error)

UpdateServicePrimaryTaskSet API operation for Amazon EC2 Container Service.

Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.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 UpdateServicePrimaryTaskSet for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • UnsupportedFeatureException The specified task isn't supported in this Region.

  • ServiceNotFoundException The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

  • ServiceNotActiveException The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.

  • TaskSetNotFoundException The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.

  • AccessDeniedException You don't have authorization to perform the requested action.

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

func (*ECS) UpdateServicePrimaryTaskSetRequest added in v1.19.3 

func (c *ECS) UpdateServicePrimaryTaskSetRequest(input *UpdateServicePrimaryTaskSetInput) (req *request.Request, output *UpdateServicePrimaryTaskSetOutput)

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

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 UpdateServicePrimaryTaskSet for more information on using the UpdateServicePrimaryTaskSet 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 UpdateServicePrimaryTaskSetRequest method.
req, resp := client.UpdateServicePrimaryTaskSetRequest(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/UpdateServicePrimaryTaskSet

func (*ECS) UpdateServicePrimaryTaskSetWithContext added in v1.19.3 

func (c *ECS) UpdateServicePrimaryTaskSetWithContext(ctx aws.Context, input *UpdateServicePrimaryTaskSetInput, opts ...request.Option) (*UpdateServicePrimaryTaskSetOutput, error)

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

See UpdateServicePrimaryTaskSet 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) 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 successfully.

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) UpdateTaskProtection added in v1.44.135 

func (c *ECS) UpdateTaskProtection(input *UpdateTaskProtectionInput) (*UpdateTaskProtectionOutput, error)

UpdateTaskProtection API operation for Amazon EC2 Container Service.

Updates the protection status of a task. You can set protectionEnabled to true to protect your task from termination during scale-in events from Service Autoscaling (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html) or deployments (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html).

Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the protectionEnabled property making the task eligible for termination by a subsequent scale-in event.

You can specify a custom expiration period for task protection from 1 minute to up to 2,880 minutes (48 hours). To specify the custom expiration period, set the expiresInMinutes property. The expiresInMinutes property is always reset when you invoke this operation for a task that already has protectionEnabled set to true. You can keep extending the protection expiration period of a task by invoking this operation repeatedly.

To learn more about Amazon ECS task protection, see Task scale-in protection (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection.html) in the Amazon Elastic Container Service Developer Guide .

This operation is only supported for tasks belonging to an Amazon ECS service. Invoking this operation for a standalone task will result in an TASK_NOT_VALID failure. For more information, see API failure reasons (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html).

If you prefer to set task protection from within the container, we recommend using the Task scale-in protection endpoint (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection-endpoint.html).

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 UpdateTaskProtection for usage and error information.

Returned Error Types:

  • AccessDeniedException You don't have authorization to perform the requested action.

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ResourceNotFoundException The specified resource wasn't found.

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

  • UnsupportedFeatureException The specified task isn't supported in this Region.

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

Example (Shared00)

To set task scale-in protection for a task for 60 minutes This example enables scale-in protection for a task for 60 minutes. 

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.UpdateTaskProtectionInput{
		Cluster:           aws.String("test-task-protection"),
		ExpiresInMinutes:  aws.Int64(60),
		ProtectionEnabled: aws.Bool(true),
		Tasks: []*string{
			aws.String("b8b1cf532d0e46ba8d44a40d1de16772"),
		},
	}

	result, err := svc.UpdateTaskProtection(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeAccessDeniedException:
				fmt.Println(ecs.ErrCodeAccessDeniedException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeResourceNotFoundException:
				fmt.Println(ecs.ErrCodeResourceNotFoundException, aerr.Error())
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeUnsupportedFeatureException:
				fmt.Println(ecs.ErrCodeUnsupportedFeatureException, 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 set task scale-in protection for the default time period in minutes This example enables task scale-in protection for a task, without specifying the expiresInMinutes parameter, for the default protection period of 120 minutes. 

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.UpdateTaskProtectionInput{
		Cluster:           aws.String("test-task-protection"),
		ProtectionEnabled: aws.Bool(true),
		Tasks: []*string{
			aws.String("b8b1cf532d0e46ba8d44a40d1de16772"),
		},
	}

	result, err := svc.UpdateTaskProtection(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeAccessDeniedException:
				fmt.Println(ecs.ErrCodeAccessDeniedException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeResourceNotFoundException:
				fmt.Println(ecs.ErrCodeResourceNotFoundException, aerr.Error())
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeUnsupportedFeatureException:
				fmt.Println(ecs.ErrCodeUnsupportedFeatureException, 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 (Shared02)

To remove task scale-in protection This example removes scale-in protection for a 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.UpdateTaskProtectionInput{
		Cluster:           aws.String("test-task-protection"),
		ProtectionEnabled: aws.Bool(false),
		Tasks: []*string{
			aws.String("b8b1cf532d0e46ba8d44a40d1de16772"),
		},
	}

	result, err := svc.UpdateTaskProtection(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case ecs.ErrCodeAccessDeniedException:
				fmt.Println(ecs.ErrCodeAccessDeniedException, aerr.Error())
			case ecs.ErrCodeClientException:
				fmt.Println(ecs.ErrCodeClientException, aerr.Error())
			case ecs.ErrCodeClusterNotFoundException:
				fmt.Println(ecs.ErrCodeClusterNotFoundException, aerr.Error())
			case ecs.ErrCodeInvalidParameterException:
				fmt.Println(ecs.ErrCodeInvalidParameterException, aerr.Error())
			case ecs.ErrCodeResourceNotFoundException:
				fmt.Println(ecs.ErrCodeResourceNotFoundException, aerr.Error())
			case ecs.ErrCodeServerException:
				fmt.Println(ecs.ErrCodeServerException, aerr.Error())
			case ecs.ErrCodeUnsupportedFeatureException:
				fmt.Println(ecs.ErrCodeUnsupportedFeatureException, 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) UpdateTaskProtectionRequest added in v1.44.135 

func (c *ECS) UpdateTaskProtectionRequest(input *UpdateTaskProtectionInput) (req *request.Request, output *UpdateTaskProtectionOutput)

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

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 UpdateTaskProtection for more information on using the UpdateTaskProtection 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 UpdateTaskProtectionRequest method.
req, resp := client.UpdateTaskProtectionRequest(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/UpdateTaskProtection

func (*ECS) UpdateTaskProtectionWithContext added in v1.44.135 

func (c *ECS) UpdateTaskProtectionWithContext(ctx aws.Context, input *UpdateTaskProtectionInput, opts ...request.Option) (*UpdateTaskProtectionOutput, error)

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

See UpdateTaskProtection 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) UpdateTaskSet added in v1.19.3 

func (c *ECS) UpdateTaskSet(input *UpdateTaskSetInput) (*UpdateTaskSetOutput, error)

UpdateTaskSet API operation for Amazon EC2 Container Service.

Modifies a task set. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.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 UpdateTaskSet for usage and error information.

Returned Error Types:

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

  • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

  • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.

  • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

  • UnsupportedFeatureException The specified task isn't supported in this Region.

  • AccessDeniedException You don't have authorization to perform the requested action.

  • ServiceNotFoundException The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

  • ServiceNotActiveException The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.

  • TaskSetNotFoundException The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.

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

func (*ECS) UpdateTaskSetRequest added in v1.19.3 

func (c *ECS) UpdateTaskSetRequest(input *UpdateTaskSetInput) (req *request.Request, output *UpdateTaskSetOutput)

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

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 UpdateTaskSet for more information on using the UpdateTaskSet 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 UpdateTaskSetRequest method.
req, resp := client.UpdateTaskSetRequest(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/UpdateTaskSet

func (*ECS) UpdateTaskSetWithContext added in v1.19.3 

func (c *ECS) UpdateTaskSetWithContext(ctx aws.Context, input *UpdateTaskSetInput, opts ...request.Option) (*UpdateTaskSetOutput, error)

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

See UpdateTaskSet 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 EFSAuthorizationConfig added in v1.30.7 

type EFSAuthorizationConfig struct {

	// The Amazon EFS access point ID to use. If an access point is specified, the
	// root directory value specified in the EFSVolumeConfiguration must either
	// be omitted or set to / which will enforce the path set on the EFS access
	// point. If an access point is used, transit encryption must be on in the EFSVolumeConfiguration.
	// For more information, see Working with Amazon EFS access points (https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html)
	// in the Amazon Elastic File System User Guide.
	AccessPointId *string `locationName:"accessPointId" type:"string"`

	// Determines whether to use the Amazon ECS task role defined in a task definition
	// when mounting the Amazon EFS file system. If it is turned on, transit encryption
	// must be turned on in the EFSVolumeConfiguration. If this parameter is omitted,
	// the default value of DISABLED is used. For more information, see Using Amazon
	// EFS access points (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints)
	// in the Amazon Elastic Container Service Developer Guide.
	Iam *string `locationName:"iam" type:"string" enum:"EFSAuthorizationConfigIAM"`
	// contains filtered or unexported fields
}

The authorization configuration details for the Amazon EFS file system.

func (EFSAuthorizationConfig) GoString added in v1.30.7 

func (s EFSAuthorizationConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EFSAuthorizationConfig) SetAccessPointId added in v1.30.7 

func (s *EFSAuthorizationConfig) SetAccessPointId(v string) *EFSAuthorizationConfig

SetAccessPointId sets the AccessPointId field's value.

func (*EFSAuthorizationConfig) SetIam added in v1.30.7 

func (s *EFSAuthorizationConfig) SetIam(v string) *EFSAuthorizationConfig

SetIam sets the Iam field's value.

func (EFSAuthorizationConfig) String added in v1.30.7 

func (s EFSAuthorizationConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EFSVolumeConfiguration added in v1.28.5 

type EFSVolumeConfiguration struct {

	// The authorization configuration details for the Amazon EFS file system.
	AuthorizationConfig *EFSAuthorizationConfig `locationName:"authorizationConfig" type:"structure"`

	// The Amazon EFS file system ID to use.
	//
	// FileSystemId is a required field
	FileSystemId *string `locationName:"fileSystemId" type:"string" required:"true"`

	// The directory within the Amazon EFS file system to mount as the root directory
	// inside the host. If this parameter is omitted, the root of the Amazon EFS
	// volume will be used. Specifying / will have the same effect as omitting this
	// parameter.
	//
	// If an EFS access point is specified in the authorizationConfig, the root
	// directory parameter must either be omitted or set to / which will enforce
	// the path set on the EFS access point.
	RootDirectory *string `locationName:"rootDirectory" type:"string"`

	// Determines whether to use encryption for Amazon EFS data in transit between
	// the Amazon ECS host and the Amazon EFS server. Transit encryption must be
	// turned on if Amazon EFS IAM authorization is used. If this parameter is omitted,
	// the default value of DISABLED is used. For more information, see Encrypting
	// data in transit (https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html)
	// in the Amazon Elastic File System User Guide.
	TransitEncryption *string `locationName:"transitEncryption" type:"string" enum:"EFSTransitEncryption"`

	// The port to use when sending encrypted data between the Amazon ECS host and
	// the Amazon EFS server. If you do not specify a transit encryption port, it
	// will use the port selection strategy that the Amazon EFS mount helper uses.
	// For more information, see EFS mount helper (https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html)
	// in the Amazon Elastic File System User Guide.
	TransitEncryptionPort *int64 `locationName:"transitEncryptionPort" type:"integer"`
	// contains filtered or unexported fields
}

This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html) in the Amazon Elastic Container Service Developer Guide.

func (EFSVolumeConfiguration) GoString added in v1.28.5 

func (s EFSVolumeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EFSVolumeConfiguration) SetAuthorizationConfig added in v1.30.7 

func (s *EFSVolumeConfiguration) SetAuthorizationConfig(v *EFSAuthorizationConfig) *EFSVolumeConfiguration

SetAuthorizationConfig sets the AuthorizationConfig field's value.

func (*EFSVolumeConfiguration) SetFileSystemId added in v1.28.5 

func (s *EFSVolumeConfiguration) SetFileSystemId(v string) *EFSVolumeConfiguration

SetFileSystemId sets the FileSystemId field's value.

func (*EFSVolumeConfiguration) SetRootDirectory added in v1.28.5 

func (s *EFSVolumeConfiguration) SetRootDirectory(v string) *EFSVolumeConfiguration

SetRootDirectory sets the RootDirectory field's value.

func (*EFSVolumeConfiguration) SetTransitEncryption added in v1.30.7 

func (s *EFSVolumeConfiguration) SetTransitEncryption(v string) *EFSVolumeConfiguration

SetTransitEncryption sets the TransitEncryption field's value.

func (*EFSVolumeConfiguration) SetTransitEncryptionPort added in v1.30.7 

func (s *EFSVolumeConfiguration) SetTransitEncryptionPort(v int64) *EFSVolumeConfiguration

SetTransitEncryptionPort sets the TransitEncryptionPort field's value.

func (EFSVolumeConfiguration) String added in v1.28.5 

func (s EFSVolumeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EFSVolumeConfiguration) Validate added in v1.28.5 

func (s *EFSVolumeConfiguration) Validate() error

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

type EnvironmentFile added in v1.31.0 

type EnvironmentFile struct {

	// The file type to use. Environment files are objects in Amazon S3. The only
	// supported value is s3.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"EnvironmentFileType"`

	// The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment
	// variable file.
	//
	// Value is a required field
	Value *string `locationName:"value" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Use a file to pass environment variables to a container (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/use-environment-file.html) in the Amazon Elastic Container Service Developer Guide.

Environment variable files are objects in Amazon S3 and all Amazon S3 security considerations apply.

You must use the following platforms for the Fargate launch type:

  • Linux platform version 1.4.0 or later.

  • Windows platform version 1.0.0 or later.

Consider the following when using the Fargate launch type:

  • The file is handled like a native Docker env-file.

  • There is no support for shell escape handling.

  • The container entry point interperts the VARIABLE values.

func (EnvironmentFile) GoString added in v1.31.0 

func (s EnvironmentFile) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnvironmentFile) SetType added in v1.31.0 

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

SetType sets the Type field's value.

func (*EnvironmentFile) SetValue added in v1.31.0 

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

SetValue sets the Value field's value.

func (EnvironmentFile) String added in v1.31.0 

func (s EnvironmentFile) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnvironmentFile) Validate added in v1.31.0 

func (s *EnvironmentFile) Validate() error

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

type EphemeralStorage added in v1.38.29 

type EphemeralStorage struct {

	// The total amount, in GiB, of ephemeral storage to set for the task. The minimum
	// supported value is 20 GiB and the maximum supported value is 200 GiB.
	//
	// SizeInGiB is a required field
	SizeInGiB *int64 `locationName:"sizeInGiB" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Using data volumes in tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the Amazon ECS Developer Guide;.

For tasks using the Fargate launch type, the task requires the following platforms:

  • Linux platform version 1.4.0 or later.

  • Windows platform version 1.0.0 or later.

func (EphemeralStorage) GoString added in v1.38.29 

func (s EphemeralStorage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EphemeralStorage) SetSizeInGiB added in v1.38.29 

func (s *EphemeralStorage) SetSizeInGiB(v int64) *EphemeralStorage

SetSizeInGiB sets the SizeInGiB field's value.

func (EphemeralStorage) String added in v1.38.29 

func (s EphemeralStorage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EphemeralStorage) Validate added in v1.38.29 

func (s *EphemeralStorage) Validate() error

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

type ExecuteCommandConfiguration added in v1.37.31 

type ExecuteCommandConfiguration struct {

	// Specify an Key Management Service key ID to encrypt the data between the
	// local client and the container.
	KmsKeyId *string `locationName:"kmsKeyId" type:"string"`

	// The log configuration for the results of the execute command actions. The
	// logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE
	// is specified, a logConfiguration must be provided.
	LogConfiguration *ExecuteCommandLogConfiguration `locationName:"logConfiguration" type:"structure"`

	// The log setting to use for redirecting logs for your execute command results.
	// The following log settings are available.
	//
	//    * NONE: The execute command session is not logged.
	//
	//    * DEFAULT: The awslogs configuration in the task definition is used. If
	//    no logging parameter is specified, it defaults to this value. If no awslogs
	//    log driver is configured in the task definition, the output won't be logged.
	//
	//    * OVERRIDE: Specify the logging details as a part of logConfiguration.
	//    If the OVERRIDE logging option is specified, the logConfiguration is required.
	Logging *string `locationName:"logging" type:"string" enum:"ExecuteCommandLogging"`
	// contains filtered or unexported fields
}

The details of the execute command configuration.

func (ExecuteCommandConfiguration) GoString added in v1.37.31 

func (s ExecuteCommandConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteCommandConfiguration) SetKmsKeyId added in v1.37.31 

func (s *ExecuteCommandConfiguration) SetKmsKeyId(v string) *ExecuteCommandConfiguration

SetKmsKeyId sets the KmsKeyId field's value.

func (*ExecuteCommandConfiguration) SetLogConfiguration added in v1.37.31 

func (s *ExecuteCommandConfiguration) SetLogConfiguration(v *ExecuteCommandLogConfiguration) *ExecuteCommandConfiguration

SetLogConfiguration sets the LogConfiguration field's value.

func (*ExecuteCommandConfiguration) SetLogging added in v1.37.31 

func (s *ExecuteCommandConfiguration) SetLogging(v string) *ExecuteCommandConfiguration

SetLogging sets the Logging field's value.

func (ExecuteCommandConfiguration) String added in v1.37.31 

func (s ExecuteCommandConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecuteCommandInput added in v1.37.31 

type ExecuteCommandInput struct {

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

	// The command to run on the container.
	//
	// Command is a required field
	Command *string `locationName:"command" type:"string" required:"true"`

	// The name of the container to execute the command on. A container name only
	// needs to be specified for tasks containing multiple containers.
	Container *string `locationName:"container" type:"string"`

	// Use this flag to run your command in interactive mode.
	//
	// Interactive is a required field
	Interactive *bool `locationName:"interactive" type:"boolean" required:"true"`

	// The Amazon Resource Name (ARN) or ID of the task the container is part of.
	//
	// Task is a required field
	Task *string `locationName:"task" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ExecuteCommandInput) GoString added in v1.37.31 

func (s ExecuteCommandInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteCommandInput) SetCluster added in v1.37.31 

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

SetCluster sets the Cluster field's value.

func (*ExecuteCommandInput) SetCommand added in v1.37.31 

func (s *ExecuteCommandInput) SetCommand(v string) *ExecuteCommandInput

SetCommand sets the Command field's value.

func (*ExecuteCommandInput) SetContainer added in v1.37.31 

func (s *ExecuteCommandInput) SetContainer(v string) *ExecuteCommandInput

SetContainer sets the Container field's value.

func (*ExecuteCommandInput) SetInteractive added in v1.37.31 

func (s *ExecuteCommandInput) SetInteractive(v bool) *ExecuteCommandInput

SetInteractive sets the Interactive field's value.

func (*ExecuteCommandInput) SetTask added in v1.37.31 

func (s *ExecuteCommandInput) SetTask(v string) *ExecuteCommandInput

SetTask sets the Task field's value.

func (ExecuteCommandInput) String added in v1.37.31 

func (s ExecuteCommandInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteCommandInput) Validate added in v1.37.31 

func (s *ExecuteCommandInput) Validate() error

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

type ExecuteCommandLogConfiguration added in v1.37.31 

type ExecuteCommandLogConfiguration struct {

	// Determines whether to use encryption on the CloudWatch logs. If not specified,
	// encryption will be off.
	CloudWatchEncryptionEnabled *bool `locationName:"cloudWatchEncryptionEnabled" type:"boolean"`

	// The name of the CloudWatch log group to send logs to.
	//
	// The CloudWatch log group must already be created.
	CloudWatchLogGroupName *string `locationName:"cloudWatchLogGroupName" type:"string"`

	// The name of the S3 bucket to send logs to.
	//
	// The S3 bucket must already be created.
	S3BucketName *string `locationName:"s3BucketName" type:"string"`

	// Determines whether to use encryption on the S3 logs. If not specified, encryption
	// is not used.
	S3EncryptionEnabled *bool `locationName:"s3EncryptionEnabled" type:"boolean"`

	// An optional folder in the S3 bucket to place logs in.
	S3KeyPrefix *string `locationName:"s3KeyPrefix" type:"string"`
	// contains filtered or unexported fields
}

The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.

func (ExecuteCommandLogConfiguration) GoString added in v1.37.31 

func (s ExecuteCommandLogConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteCommandLogConfiguration) SetCloudWatchEncryptionEnabled added in v1.37.31 

func (s *ExecuteCommandLogConfiguration) SetCloudWatchEncryptionEnabled(v bool) *ExecuteCommandLogConfiguration

SetCloudWatchEncryptionEnabled sets the CloudWatchEncryptionEnabled field's value.

func (*ExecuteCommandLogConfiguration) SetCloudWatchLogGroupName added in v1.37.31 

func (s *ExecuteCommandLogConfiguration) SetCloudWatchLogGroupName(v string) *ExecuteCommandLogConfiguration

SetCloudWatchLogGroupName sets the CloudWatchLogGroupName field's value.

func (*ExecuteCommandLogConfiguration) SetS3BucketName added in v1.37.31 

func (s *ExecuteCommandLogConfiguration) SetS3BucketName(v string) *ExecuteCommandLogConfiguration

SetS3BucketName sets the S3BucketName field's value.

func (*ExecuteCommandLogConfiguration) SetS3EncryptionEnabled added in v1.37.31 

func (s *ExecuteCommandLogConfiguration) SetS3EncryptionEnabled(v bool) *ExecuteCommandLogConfiguration

SetS3EncryptionEnabled sets the S3EncryptionEnabled field's value.

func (*ExecuteCommandLogConfiguration) SetS3KeyPrefix added in v1.37.31 

func (s *ExecuteCommandLogConfiguration) SetS3KeyPrefix(v string) *ExecuteCommandLogConfiguration

SetS3KeyPrefix sets the S3KeyPrefix field's value.

func (ExecuteCommandLogConfiguration) String added in v1.37.31 

func (s ExecuteCommandLogConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecuteCommandOutput added in v1.37.31 

type ExecuteCommandOutput struct {

	// The Amazon Resource Name (ARN) of the cluster.
	ClusterArn *string `locationName:"clusterArn" type:"string"`

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

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

	// Determines whether the execute command session is running in interactive
	// mode. Amazon ECS only supports initiating interactive sessions, so you must
	// specify true for this value.
	Interactive *bool `locationName:"interactive" type:"boolean"`

	// The details of the SSM session that was created for this instance of execute-command.
	Session *Session `locationName:"session" type:"structure"`

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

func (ExecuteCommandOutput) GoString added in v1.37.31 

func (s ExecuteCommandOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteCommandOutput) SetClusterArn added in v1.37.31 

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

SetClusterArn sets the ClusterArn field's value.

func (*ExecuteCommandOutput) SetContainerArn added in v1.37.31 

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

SetContainerArn sets the ContainerArn field's value.

func (*ExecuteCommandOutput) SetContainerName added in v1.37.31 

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

SetContainerName sets the ContainerName field's value.

func (*ExecuteCommandOutput) SetInteractive added in v1.37.31 

func (s *ExecuteCommandOutput) SetInteractive(v bool) *ExecuteCommandOutput

SetInteractive sets the Interactive field's value.

func (*ExecuteCommandOutput) SetSession added in v1.37.31 

func (s *ExecuteCommandOutput) SetSession(v *Session) *ExecuteCommandOutput

SetSession sets the Session field's value.

func (*ExecuteCommandOutput) SetTaskArn added in v1.37.31 

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

SetTaskArn sets the TaskArn field's value.

func (ExecuteCommandOutput) String added in v1.37.31 

func (s ExecuteCommandOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FSxWindowsFileServerAuthorizationConfig added in v1.35.24 

type FSxWindowsFileServerAuthorizationConfig struct {

	// The authorization credential option to use. The authorization credential
	// options can be provided using either the Amazon Resource Name (ARN) of an
	// Secrets Manager secret or SSM Parameter Store parameter. The ARN refers to
	// the stored credentials.
	//
	// CredentialsParameter is a required field
	CredentialsParameter *string `locationName:"credentialsParameter" type:"string" required:"true"`

	// A fully qualified domain name hosted by an Directory Service (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html)
	// Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FSxWindowsFileServerVolumeConfiguration.html) in the Amazon ECS API Reference.

For more information and the input format, see Amazon FSx for Windows File Server Volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) in the Amazon Elastic Container Service Developer Guide.

func (FSxWindowsFileServerAuthorizationConfig) GoString added in v1.35.24 

func (s FSxWindowsFileServerAuthorizationConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FSxWindowsFileServerAuthorizationConfig) SetCredentialsParameter added in v1.35.24 

func (s *FSxWindowsFileServerAuthorizationConfig) SetCredentialsParameter(v string) *FSxWindowsFileServerAuthorizationConfig

SetCredentialsParameter sets the CredentialsParameter field's value.

func (*FSxWindowsFileServerAuthorizationConfig) SetDomain added in v1.35.24 

func (s *FSxWindowsFileServerAuthorizationConfig) SetDomain(v string) *FSxWindowsFileServerAuthorizationConfig

SetDomain sets the Domain field's value.

func (FSxWindowsFileServerAuthorizationConfig) String added in v1.35.24 

func (s FSxWindowsFileServerAuthorizationConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FSxWindowsFileServerAuthorizationConfig) Validate added in v1.35.24 

func (s *FSxWindowsFileServerAuthorizationConfig) Validate() error

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

type FSxWindowsFileServerVolumeConfiguration added in v1.35.24 

type FSxWindowsFileServerVolumeConfiguration struct {

	// The authorization configuration details for the Amazon FSx for Windows File
	// Server file system.
	//
	// AuthorizationConfig is a required field
	AuthorizationConfig *FSxWindowsFileServerAuthorizationConfig `locationName:"authorizationConfig" type:"structure" required:"true"`

	// The Amazon FSx for Windows File Server file system ID to use.
	//
	// FileSystemId is a required field
	FileSystemId *string `locationName:"fileSystemId" type:"string" required:"true"`

	// The directory within the Amazon FSx for Windows File Server file system to
	// mount as the root directory inside the host.
	//
	// RootDirectory is a required field
	RootDirectory *string `locationName:"rootDirectory" type:"string" required:"true"`
	// contains filtered or unexported fields
}

This parameter is specified when you're using Amazon FSx for Windows File Server (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html) file system for task storage.

For more information and the input format, see Amazon FSx for Windows File Server volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) in the Amazon Elastic Container Service Developer Guide.

func (FSxWindowsFileServerVolumeConfiguration) GoString added in v1.35.24 

func (s FSxWindowsFileServerVolumeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FSxWindowsFileServerVolumeConfiguration) SetAuthorizationConfig added in v1.35.24 

func (s *FSxWindowsFileServerVolumeConfiguration) SetAuthorizationConfig(v *FSxWindowsFileServerAuthorizationConfig) *FSxWindowsFileServerVolumeConfiguration

SetAuthorizationConfig sets the AuthorizationConfig field's value.

func (*FSxWindowsFileServerVolumeConfiguration) SetFileSystemId added in v1.35.24 

func (s *FSxWindowsFileServerVolumeConfiguration) SetFileSystemId(v string) *FSxWindowsFileServerVolumeConfiguration

SetFileSystemId sets the FileSystemId field's value.

func (*FSxWindowsFileServerVolumeConfiguration) SetRootDirectory added in v1.35.24 

func (s *FSxWindowsFileServerVolumeConfiguration) SetRootDirectory(v string) *FSxWindowsFileServerVolumeConfiguration

SetRootDirectory sets the RootDirectory field's value.

func (FSxWindowsFileServerVolumeConfiguration) String added in v1.35.24 

func (s FSxWindowsFileServerVolumeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FSxWindowsFileServerVolumeConfiguration) Validate added in v1.35.24 

func (s *FSxWindowsFileServerVolumeConfiguration) Validate() error

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

type Failure 

type Failure struct {

	// The Amazon Resource Name (ARN) of the failed resource.
	Arn *string `locationName:"arn" type:"string"`

	// The details of the failure.
	Detail *string `locationName:"detail" type:"string"`

	// The reason for the failure.
	Reason *string `locationName:"reason" type:"string"`
	// contains filtered or unexported fields
}

A failed resource. For a list of common causes, see API failure reasons (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) in the Amazon Elastic Container Service Developer Guide.

func (Failure) GoString added in v0.6.5 

func (s Failure) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Failure) SetArn added in v1.5.0 

func (s *Failure) SetArn(v string) *Failure

SetArn sets the Arn field's value.

func (*Failure) SetDetail added in v1.25.39 

func (s *Failure) SetDetail(v string) *Failure

SetDetail sets the Detail 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FirelensConfiguration added in v1.23.13 

type FirelensConfiguration struct {

	// The options to use when configuring the log router. This field is optional
	// and can be used to specify a custom configuration file or to add additional
	// metadata, such as the task, task definition, cluster, and container instance
	// details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}.
	// For more information, see Creating a task definition that uses a FireLens
	// configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// Tasks hosted on Fargate only support the file configuration file type.
	Options map[string]*string `locationName:"options" type:"map"`

	// The log router to use. The valid values are fluentd or fluentbit.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"FirelensConfigurationType"`
	// contains filtered or unexported fields
}

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the Amazon Elastic Container Service Developer Guide.

func (FirelensConfiguration) GoString added in v1.23.13 

func (s FirelensConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FirelensConfiguration) SetOptions added in v1.23.13 

func (s *FirelensConfiguration) SetOptions(v map[string]*string) *FirelensConfiguration

SetOptions sets the Options field's value.

func (*FirelensConfiguration) SetType added in v1.23.13 

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

SetType sets the Type field's value.

func (FirelensConfiguration) String added in v1.23.13 

func (s FirelensConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FirelensConfiguration) Validate added in v1.23.13 

func (s *FirelensConfiguration) Validate() error

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

type GetTaskProtectionInput added in v1.44.135 

type GetTaskProtectionInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts
	// the service that the task sets exist in.
	//
	// Cluster is a required field
	Cluster *string `locationName:"cluster" type:"string" required:"true"`

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

func (GetTaskProtectionInput) GoString added in v1.44.135 

func (s GetTaskProtectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTaskProtectionInput) SetCluster added in v1.44.135 

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

SetCluster sets the Cluster field's value.

func (*GetTaskProtectionInput) SetTasks added in v1.44.135 

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

SetTasks sets the Tasks field's value.

func (GetTaskProtectionInput) String added in v1.44.135 

func (s GetTaskProtectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTaskProtectionInput) Validate added in v1.44.135 

func (s *GetTaskProtectionInput) Validate() error

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

type GetTaskProtectionOutput added in v1.44.135 

type GetTaskProtectionOutput struct {

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

	// A list of tasks with the following information.
	//
	//    * taskArn: The task ARN.
	//
	//    * protectionEnabled: The protection status of the task. If scale-in protection
	//    is turned on for a task, the value is true. Otherwise, it is false.
	//
	//    * expirationDate: The epoch time when protection for the task will expire.
	ProtectedTasks []*ProtectedTask `locationName:"protectedTasks" type:"list"`
	// contains filtered or unexported fields
}

func (GetTaskProtectionOutput) GoString added in v1.44.135 

func (s GetTaskProtectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTaskProtectionOutput) SetFailures added in v1.44.135 

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

SetFailures sets the Failures field's value.

func (*GetTaskProtectionOutput) SetProtectedTasks added in v1.44.135 

func (s *GetTaskProtectionOutput) SetProtectedTasks(v []*ProtectedTask) *GetTaskProtectionOutput

SetProtectedTasks sets the ProtectedTasks field's value.

func (GetTaskProtectionOutput) String added in v1.44.135 

func (s GetTaskProtectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 run the command
	// arguments directly, or CMD-SHELL to run the command with the container's
	// default shell.
	//
	// When you use the Amazon Web Services Management Console JSON panel, the Command
	// Line Interface, or the APIs, enclose the list of commands in double quotes
	// and brackets.
	//
	// [ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
	//
	// You don't include the double quotes and brackets when you use the Amazon
	// Web Services Management Console.
	//
	// 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/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/).
	//
	// 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 *int64 `locationName:"retries" type:"integer"`

	// The optional grace period to provide containers time to bootstrap before
	// failed health checks count towards the maximum number of retries. You can
	// specify between 0 and 300 seconds. By default, the startPeriod is off.
	//
	// 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.
	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). This configuration maps to the HEALTHCHECK parameter of docker run (https://docs.docker.com/engine/reference/run/).

The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image 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.

You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console.

The health check is designed to make sure that your containers survive agent restarts, upgrades, or temporary unavailability.

Amazon ECS performs health checks on containers with the default that launched the container instance or the task.

The following describes the possible healthStatus values for a container:

  • HEALTHY-The container health check has passed successfully.

  • UNHEALTHY-The container health check has failed.

  • UNKNOWN-The container health check is being evaluated, there's no container health check defined, or Amazon ECS doesn't have the health status of the container.

The following describes the possible healthStatus values based on the container health checker status of essential containers in the task with the following priority order (high to low):

  • UNHEALTHY-One or more essential containers have failed their health check.

  • UNKNOWN-Any essential container running within the task is in an UNKNOWN state and no other essential containers have an UNHEALTHY state.

  • HEALTHY-All essential containers within the task have passed their health checks.

Consider the following task health example with 2 containers.

  • If Container1 is UNHEALTHY and Container2 is UNKNOWN, the task health is UNHEALTHY.

  • If Container1 is UNHEALTHY and Container2 is HEALTHY, the task health is UNHEALTHY.

  • If Container1 is HEALTHY and Container2 is UNKNOWN, the task health is UNKNOWN.

  • If Container1 is HEALTHY and Container2 is HEALTHY, the task health is HEALTHY.

Consider the following task health example with 3 containers.

  • If Container1 is UNHEALTHY and Container2 is UNKNOWN, and Container3 is UNKNOWN, the task health is UNHEALTHY.

  • If Container1 is UNHEALTHY and Container2 is UNKNOWN, and Container3 is HEALTHY, the task health is UNHEALTHY.

  • If Container1 is UNHEALTHY and Container2 is HEALTHY, and Container3 is HEALTHY, the task health is UNHEALTHY.

  • If Container1 is HEALTHY and Container2 is UNKNOWN, and Container3 is HEALTHY, the task health is UNKNOWN.

  • If Container1 is HEALTHY and Container2 is UNKNOWN, and Container3 is UNKNOWN, the task health is UNKNOWN.

  • If Container1 is HEALTHY and Container2 is HEALTHY, and Container3 is HEALTHY, the task health is HEALTHY.

If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.

The following are notes about container health check support:

  • If the Amazon ECS container agent becomes disconnected from the Amazon ECS service, this won't cause a container to transition to an UNHEALTHY status. This is by design, to ensure that containers remain running during agent restarts or temporary unavailability. The health check status is the "last heard from" response from the Amazon ECS agent, so if the container was considered HEALTHY prior to the disconnect, that status will remain until the agent reconnects and another health check occurs. There are no assumptions made about the status of the container health checks.

  • Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS container agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html).

  • Container health checks are supported for Fargate tasks if you're using platform version 1.1.0 or greater. For more information, see Fargate platform versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html).

  • Container health checks aren't supported for tasks that are part of a service that's configured to use a Classic Load Balancer.

func (HealthCheck) GoString added in v1.13.11 

func (s HealthCheck) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// When the host parameter is used, specify a sourcePath to declare the path
	// on the host container instance that's 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 doesn't 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're 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 bind mount host volume.

func (HostVolumeProperties) GoString added in v0.6.5 

func (s HostVolumeProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InferenceAccelerator added in v1.23.14 

type InferenceAccelerator struct {

	// The Elastic Inference accelerator device name. The deviceName must also be
	// referenced in a container definition as a ResourceRequirement (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html).
	//
	// DeviceName is a required field
	DeviceName *string `locationName:"deviceName" type:"string" required:"true"`

	// The Elastic Inference accelerator type to use.
	//
	// DeviceType is a required field
	DeviceType *string `locationName:"deviceType" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) in the Amazon Elastic Container Service Developer Guide.

func (InferenceAccelerator) GoString added in v1.23.14 

func (s InferenceAccelerator) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InferenceAccelerator) SetDeviceName added in v1.23.14 

func (s *InferenceAccelerator) SetDeviceName(v string) *InferenceAccelerator

SetDeviceName sets the DeviceName field's value.

func (*InferenceAccelerator) SetDeviceType added in v1.23.14 

func (s *InferenceAccelerator) SetDeviceType(v string) *InferenceAccelerator

SetDeviceType sets the DeviceType field's value.

func (InferenceAccelerator) String added in v1.23.14 

func (s InferenceAccelerator) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InferenceAccelerator) Validate added in v1.23.14 

func (s *InferenceAccelerator) Validate() error

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

type InferenceAcceleratorOverride added in v1.23.14 

type InferenceAcceleratorOverride struct {

	// The Elastic Inference accelerator device name to override for the task. This
	// parameter must match a deviceName specified in the task definition.
	DeviceName *string `locationName:"deviceName" type:"string"`

	// The Elastic Inference accelerator type to use.
	DeviceType *string `locationName:"deviceType" type:"string"`
	// contains filtered or unexported fields
}

Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) in the Amazon Elastic Container Service Developer Guide.

func (InferenceAcceleratorOverride) GoString added in v1.23.14 

func (s InferenceAcceleratorOverride) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InferenceAcceleratorOverride) SetDeviceName added in v1.23.14 

func (s *InferenceAcceleratorOverride) SetDeviceName(v string) *InferenceAcceleratorOverride

SetDeviceName sets the DeviceName field's value.

func (*InferenceAcceleratorOverride) SetDeviceType added in v1.23.14 

func (s *InferenceAcceleratorOverride) SetDeviceType(v string) *InferenceAcceleratorOverride

SetDeviceType sets the DeviceType field's value.

func (InferenceAcceleratorOverride) String added in v1.23.14 

func (s InferenceAcceleratorOverride) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceHealthCheckResult added in v1.42.2 

type InstanceHealthCheckResult struct {

	// The Unix timestamp for when the container instance health status last changed.
	LastStatusChange *time.Time `locationName:"lastStatusChange" type:"timestamp"`

	// The Unix timestamp for when the container instance health status was last
	// updated.
	LastUpdated *time.Time `locationName:"lastUpdated" type:"timestamp"`

	// The container instance health status.
	Status *string `locationName:"status" type:"string" enum:"InstanceHealthCheckState"`

	// The type of container instance health status that was verified.
	Type *string `locationName:"type" type:"string" enum:"InstanceHealthCheckType"`
	// contains filtered or unexported fields
}

An object representing the result of a container instance health status check.

func (InstanceHealthCheckResult) GoString added in v1.42.2 

func (s InstanceHealthCheckResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceHealthCheckResult) SetLastStatusChange added in v1.42.2 

func (s *InstanceHealthCheckResult) SetLastStatusChange(v time.Time) *InstanceHealthCheckResult

SetLastStatusChange sets the LastStatusChange field's value.

func (*InstanceHealthCheckResult) SetLastUpdated added in v1.42.2 

func (s *InstanceHealthCheckResult) SetLastUpdated(v time.Time) *InstanceHealthCheckResult

SetLastUpdated sets the LastUpdated field's value.

func (*InstanceHealthCheckResult) SetStatus added in v1.42.2 

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

SetStatus sets the Status field's value.

func (*InstanceHealthCheckResult) SetType added in v1.42.2 

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

SetType sets the Type field's value.

func (InstanceHealthCheckResult) String added in v1.42.2 

func (s InstanceHealthCheckResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidParameterException added in v1.28.0 

type InvalidParameterException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified parameter isn't valid. Review the available parameters for the API request.

func (*InvalidParameterException) Code added in v1.28.0 

func (s *InvalidParameterException) Code() string

Code returns the exception type name.

func (*InvalidParameterException) Error added in v1.28.0 

func (s *InvalidParameterException) Error() string

func (InvalidParameterException) GoString added in v1.28.0 

func (s InvalidParameterException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidParameterException) Message added in v1.28.0 

func (s *InvalidParameterException) Message() string

Message returns the exception's message.

func (*InvalidParameterException) OrigErr added in v1.28.0 

func (s *InvalidParameterException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidParameterException) RequestID added in v1.28.0 

func (s *InvalidParameterException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidParameterException) StatusCode added in v1.28.0 

func (s *InvalidParameterException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidParameterException) String added in v1.28.0 

func (s InvalidParameterException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --cap-add option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// Tasks launched on Fargate only support adding the SYS_PTRACE kernel capability.
	//
	// 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/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --cap-drop option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// 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 to add or remove from the default Docker configuration for a container defined in the task definition. For more information about 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 about 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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-value pair object.

func (KeyValuePair) GoString added in v0.6.5 

func (s KeyValuePair) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LimitExceededException added in v1.28.0 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The limit for the resource was exceeded.

func (*LimitExceededException) Code added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0 

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// For tasks that use the Fargate launch type, capabilities is supported for
	// all platform versions but the add parameter is only supported if using platform
	// version 1.4.0 or later.
	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/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --device option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// If you're using tasks that use the Fargate launch type, the devices parameter
	// isn't 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/#security-configuration).
	// 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 --format '{{.Server.APIVersion}}'
	InitProcessEnabled *bool `locationName:"initProcessEnabled" type:"boolean"`

	// The total amount of swap memory (in MiB) a container can use. This parameter
	// will be translated to the --memory-swap option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
	// where the value would be the sum of the container memory plus the maxSwap
	// value.
	//
	// If a maxSwap value of 0 is specified, the container will not use swap. Accepted
	// values are 0 or any positive integer. If the maxSwap parameter is omitted,
	// the container will use the swap configuration for the container instance
	// it is running on. A maxSwap value must be set for the swappiness parameter
	// to be used.
	//
	// If you're using tasks that use the Fargate launch type, the maxSwap parameter
	// isn't supported.
	//
	// If you're using tasks on Amazon Linux 2023 the swappiness parameter isn't
	// supported.
	MaxSwap *int64 `locationName:"maxSwap" type:"integer"`

	// 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/#security-configuration).
	//
	// If you are using tasks that use the Fargate launch type, the sharedMemorySize
	// parameter is not supported.
	SharedMemorySize *int64 `locationName:"sharedMemorySize" type:"integer"`

	// This allows you to tune a container's memory swappiness behavior. A swappiness
	// value of 0 will cause swapping to not happen unless absolutely necessary.
	// A swappiness value of 100 will cause pages to be swapped very aggressively.
	// Accepted values are whole numbers between 0 and 100. If the swappiness parameter
	// is not specified, a default value of 60 is used. If a value is not specified
	// for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness
	// option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).
	//
	// If you're using tasks that use the Fargate launch type, the swappiness parameter
	// isn't supported.
	//
	// If you're using tasks on Amazon Linux 2023 the swappiness parameter isn't
	// supported.
	Swappiness *int64 `locationName:"swappiness" 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/#security-configuration).
	//
	// If you're using tasks that use the Fargate launch type, the tmpfs parameter
	// isn't supported.
	Tmpfs []*Tmpfs `locationName:"tmpfs" type:"list"`
	// contains filtered or unexported fields
}

The Linux-specific options that are applied to the container, such as Linux KernelCapabilities (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html).

func (LinuxParameters) GoString added in v1.10.51 

func (s LinuxParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetMaxSwap added in v1.23.3 

func (s *LinuxParameters) SetMaxSwap(v int64) *LinuxParameters

SetMaxSwap sets the MaxSwap 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) SetSwappiness added in v1.23.3 

func (s *LinuxParameters) SetSwappiness(v int64) *LinuxParameters

SetSwappiness sets the Swappiness 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 ListAccountSettingsInput added in v1.15.77 

type ListAccountSettingsInput struct {

	// Determines whether to return the effective settings. If true, the account
	// settings for the root user or the default setting for the principalArn are
	// returned. If false, the account settings for the principalArn are returned
	// if they're set. Otherwise, no account settings are returned.
	EffectiveSettings *bool `locationName:"effectiveSettings" type:"boolean"`

	// The maximum number of account setting results returned by ListAccountSettings
	// in paginated output. When this parameter is used, ListAccountSettings 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 ListAccountSettings request with the returned nextToken value. This
	// value can be between 1 and 10. If this parameter isn't used, then ListAccountSettings
	// returns up to 10 results and a nextToken value if applicable.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The name of the account setting you want to list the settings for.
	Name *string `locationName:"name" type:"string" enum:"SettingName"`

	// The nextToken value returned from a ListAccountSettings request indicating
	// that more results are available to fulfill the request and further calls
	// will be needed. If maxResults was provided, it's possible the number of results
	// to be fewer than maxResults.
	//
	// 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 ARN of the principal, which can be a user, role, or the root user. If
	// this field is omitted, the account settings are listed only for the authenticated
	// user.
	//
	// Federated users assume the account setting of the root user and can't have
	// explicit account settings set for them.
	PrincipalArn *string `locationName:"principalArn" type:"string"`

	// The value of the account settings to filter results with. You must also specify
	// an account setting name to use this parameter.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

func (ListAccountSettingsInput) GoString added in v1.15.77 

func (s ListAccountSettingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAccountSettingsInput) SetEffectiveSettings added in v1.15.77 

func (s *ListAccountSettingsInput) SetEffectiveSettings(v bool) *ListAccountSettingsInput

SetEffectiveSettings sets the EffectiveSettings field's value.

func (*ListAccountSettingsInput) SetMaxResults added in v1.15.77 

func (s *ListAccountSettingsInput) SetMaxResults(v int64) *ListAccountSettingsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAccountSettingsInput) SetName added in v1.15.77 

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

SetName sets the Name field's value.

func (*ListAccountSettingsInput) SetNextToken added in v1.15.77 

func (s *ListAccountSettingsInput) SetNextToken(v string) *ListAccountSettingsInput

SetNextToken sets the NextToken field's value.

func (*ListAccountSettingsInput) SetPrincipalArn added in v1.15.77 

func (s *ListAccountSettingsInput) SetPrincipalArn(v string) *ListAccountSettingsInput

SetPrincipalArn sets the PrincipalArn field's value.

func (*ListAccountSettingsInput) SetValue added in v1.15.77 

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

SetValue sets the Value field's value.

func (ListAccountSettingsInput) String added in v1.15.77 

func (s ListAccountSettingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAccountSettingsOutput added in v1.15.77 

type ListAccountSettingsOutput struct {

	// The nextToken value to include in a future ListAccountSettings request. When
	// the results of a ListAccountSettings 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 account settings for the resource.
	Settings []*Setting `locationName:"settings" type:"list"`
	// contains filtered or unexported fields
}

func (ListAccountSettingsOutput) GoString added in v1.15.77 

func (s ListAccountSettingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAccountSettingsOutput) SetNextToken added in v1.15.77 

func (s *ListAccountSettingsOutput) SetNextToken(v string) *ListAccountSettingsOutput

SetNextToken sets the NextToken field's value.

func (*ListAccountSettingsOutput) SetSettings added in v1.15.77 

func (s *ListAccountSettingsOutput) SetSettings(v []*Setting) *ListAccountSettingsOutput

SetSettings sets the Settings field's value.

func (ListAccountSettingsOutput) String added in v1.15.77 

func (s ListAccountSettingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAttributesInput added in v1.6.9 

type ListAttributesInput struct {

	// The name of the attribute to filter the results with.
	AttributeName *string `locationName:"attributeName" type:"string"`

	// The value of the attribute to filter results with. 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 that ListAttributes returned 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 isn't 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 ListAttributes request indicating that
	// more results are available to fulfill the request and further calls are needed.
	// If maxResults was provided, it's possible the number of results to be fewer
	// than maxResults.
	//
	// 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 to list attributes with.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListClustersInput 

type ListClustersInput struct {

	// The maximum number of cluster results that ListClusters returned 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 isn't 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 ListClusters request indicating that
	// more results are available to fulfill the request and further calls are needed.
	// If maxResults was provided, it's possible the number of results to be fewer
	// than maxResults.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListClustersOutput 

type ListClustersOutput struct {

	// The list of full Amazon Resource Name (ARN) entries for each cluster that's
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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
	// (https://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 that ListContainerInstances
	// returned 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 isn't 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 ListContainerInstances request indicating
	// that more results are available to fulfill the request and further calls
	// are needed. If maxResults was provided, it's possible the number of results
	// to be fewer than maxResults.
	//
	// 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 don't specify
	// this parameter, the default is to include container instances set to all
	// states other than INACTIVE.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListServicesByNamespaceInput added in v1.44.146 

type ListServicesByNamespaceInput struct {

	// The maximum number of service results that ListServicesByNamespace returns
	// in paginated output. When this parameter is used, ListServicesByNamespace
	// 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 ListServicesByNamespace request with the returned nextToken value.
	// This value can be between 1 and 100. If this parameter isn't used, then ListServicesByNamespace
	// returns up to 10 results and a nextToken value if applicable.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace
	// to list the services in.
	//
	// Tasks that run in a namespace can use short names to connect to services
	// in the namespace. Tasks can connect to services across all of the clusters
	// in the namespace. Tasks connect through a managed proxy container that collects
	// logs and metrics for increased visibility. Only the tasks that Amazon ECS
	// services create are supported with Service Connect. For more information,
	// see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// Namespace is a required field
	Namespace *string `locationName:"namespace" type:"string" required:"true"`

	// The nextToken value that's returned from a ListServicesByNamespace request.
	// It indicates that more results are available to fulfill the request and further
	// calls are needed. If maxResults is returned, it is possible the number of
	// results is less than maxResults.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListServicesByNamespaceInput) GoString added in v1.44.146 

func (s ListServicesByNamespaceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListServicesByNamespaceInput) SetMaxResults added in v1.44.146 

func (s *ListServicesByNamespaceInput) SetMaxResults(v int64) *ListServicesByNamespaceInput

SetMaxResults sets the MaxResults field's value.

func (*ListServicesByNamespaceInput) SetNamespace added in v1.44.146 

func (s *ListServicesByNamespaceInput) SetNamespace(v string) *ListServicesByNamespaceInput

SetNamespace sets the Namespace field's value.

func (*ListServicesByNamespaceInput) SetNextToken added in v1.44.146 

func (s *ListServicesByNamespaceInput) SetNextToken(v string) *ListServicesByNamespaceInput

SetNextToken sets the NextToken field's value.

func (ListServicesByNamespaceInput) String added in v1.44.146 

func (s ListServicesByNamespaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListServicesByNamespaceInput) Validate added in v1.44.146 

func (s *ListServicesByNamespaceInput) Validate() error

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

type ListServicesByNamespaceOutput added in v1.44.146 

type ListServicesByNamespaceOutput struct {

	// The nextToken value to include in a future ListServicesByNamespace request.
	// When the results of a ListServicesByNamespace request exceed maxResults,
	// this value can be used to retrieve the next page of results. When there are
	// no more results to return, this value is null.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The list of full ARN entries for each service that's associated with the
	// specified namespace.
	ServiceArns []*string `locationName:"serviceArns" type:"list"`
	// contains filtered or unexported fields
}

func (ListServicesByNamespaceOutput) GoString added in v1.44.146 

func (s ListServicesByNamespaceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListServicesByNamespaceOutput) SetNextToken added in v1.44.146 

func (s *ListServicesByNamespaceOutput) SetNextToken(v string) *ListServicesByNamespaceOutput

SetNextToken sets the NextToken field's value.

func (*ListServicesByNamespaceOutput) SetServiceArns added in v1.44.146 

func (s *ListServicesByNamespaceOutput) SetServiceArns(v []*string) *ListServicesByNamespaceOutput

SetServiceArns sets the ServiceArns field's value.

func (ListServicesByNamespaceOutput) String added in v1.44.146 

func (s ListServicesByNamespaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListServicesInput 

type ListServicesInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster to use when
	// filtering the ListServices results. If you do not specify a cluster, the
	// default cluster is assumed.
	Cluster *string `locationName:"cluster" type:"string"`

	// The launch type to use when filtering the ListServices results.
	LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"`

	// The maximum number of service results that ListServices returned 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
	// 100. If this parameter isn't 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 ListServices request indicating that
	// more results are available to fulfill the request and further calls will
	// be needed. If maxResults was provided, it is possible the number of results
	// to be fewer than maxResults.
	//
	// 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 to use when filtering the ListServices results.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 that's 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.15.77 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) that identifies the resource to list the tags
	// for. Currently, the supported resources are Amazon ECS tasks, services, task
	// definitions, clusters, and container instances.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.15.77 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn added in v1.15.77 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.15.77 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.15.77 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.15.77 

type ListTagsForResourceOutput struct {

	// The tags for the resource.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.15.77 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags added in v1.15.77 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.15.77 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTaskDefinitionFamiliesInput 

type ListTaskDefinitionFamiliesInput struct {

	// The familyPrefix is a string that's 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 that ListTaskDefinitionFamilies
	// returned 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 isn't 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 ListTaskDefinitionFamilies request indicating
	// that more results are available to fulfill the request and further calls
	// will be needed. If maxResults was provided, it is possible the number of
	// results to be fewer than maxResults.
	//
	// 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 to filter the ListTaskDefinitionFamilies
	// results with. 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTaskDefinitionsInput 

type ListTaskDefinitionsInput struct {

	// The full family name to filter the ListTaskDefinitions results with. 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 that ListTaskDefinitions returned
	// 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 isn't 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 ListTaskDefinitions request indicating
	// that more results are available to fulfill the request and further calls
	// will be needed. If maxResults was provided, it is possible the number of
	// results to be fewer than maxResults.
	//
	// 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 to sort the results in. 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. This is so that the newest task definitions
	// in a family are listed first.
	Sort *string `locationName:"sort" type:"string" enum:"SortOrder"`

	// The task definition status to filter the ListTaskDefinitions results with.
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTasksInput 

type ListTasksInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster to use when
	// filtering the ListTasks results. 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 use when
	// filtering 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 to use when filtering the ListTasks results. Specifying
	// a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has
	// set the desired status to STOPPED. This can be useful for debugging tasks
	// that aren't 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
	// doesn't return any results. 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 task definition family to use when filtering 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 to use when filtering the ListTasks results.
	LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"`

	// The maximum number of task results that ListTasks returned 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 isn't 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 ListTasks request indicating that more
	// results are available to fulfill the request and further calls will be needed.
	// If maxResults was provided, it's possible the number of results to be fewer
	// than maxResults.
	//
	// 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 to use when filtering 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 to filter the task results with. Specifying a startedBy
	// value limits the results to tasks that were started with that value.
	//
	// When you specify startedBy as the filter, it must be the only filter that
	// you use.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LoadBalancer 

type LoadBalancer struct {

	// The name of the container (as it appears in a container definition) to associate
	// with the load balancer.
	//
	// You need to specify the container name when configuring the target group
	// for an Amazon ECS 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 task definition the tasks in the
	// service are using. For tasks that use the EC2 launch type, the container
	// instance they're launched on must allow ingress traffic on the hostPort of
	// the port mapping.
	ContainerPort *int64 `locationName:"containerPort" type:"integer"`

	// The name of the load balancer to associate with the Amazon ECS service or
	// task set.
	//
	// If you are using an Application Load Balancer or a Network Load Balancer
	// the load balancer name parameter should be omitted.
	LoadBalancerName *string `locationName:"loadBalancerName" type:"string"`

	// The full Amazon Resource Name (ARN) of the Elastic Load Balancing target
	// group or groups associated with a service or task set.
	//
	// A target group ARN is only specified when using an Application Load Balancer
	// or Network Load Balancer.
	//
	// For services using the ECS deployment controller, you can specify one or
	// multiple target groups. For more information, see Registering multiple target
	// groups with a service (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// For services using the CODE_DEPLOY deployment controller, you're required
	// to define two target groups for the load balancer. For more information,
	// see Blue/green deployment with CodeDeploy (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// If your service's task definition uses the awsvpc network mode, you must
	// choose ip as the target type, not instance. Do this when creating your target
	// groups because tasks that use the awsvpc network mode are associated with
	// an elastic network interface, not an Amazon EC2 instance. This network mode
	// is required for the Fargate launch type.
	TargetGroupArn *string `locationName:"targetGroupArn" type:"string"`
	// contains filtered or unexported fields
}

The load balancer configuration to use with a service or task set.

When you add, update, or remove a load balancer configuration, Amazon ECS starts a new deployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and deregister from load balancers.

We recommend that you verify this on a test environment before you update the Elastic Load Balancing configuration.

A service-linked role is required for services that use multiple target groups. For more information, see Using service-linked roles (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the Amazon Elastic Container Service Developer Guide.

func (LoadBalancer) GoString added in v0.6.5 

func (s LoadBalancer) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LogConfiguration added in v0.9.14 

type LogConfiguration struct {

	// The log driver to use for the container.
	//
	// For tasks on Fargate, the supported log drivers are awslogs, splunk, and
	// awsfirelens.
	//
	// For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs,
	// fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.
	//
	// For more information about using the awslogs log driver, see Using the awslogs
	// log driver (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// For more information about using the awsfirelens log driver, see Custom log
	// routing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// If you have a custom driver that isn't listed, you can fork the Amazon ECS
	// container agent project that's 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, we don't
	// currently provide support for running modified copies of this software.
	//
	// 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
	// --format '{{.Server.APIVersion}}'
	Options map[string]*string `locationName:"options" type:"map"`

	// The secrets to pass to the log configuration. For more information, see Specifying
	// sensitive data (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html)
	// in the Amazon Elastic Container Service Developer Guide.
	SecretOptions []*Secret `locationName:"secretOptions" type:"list"`
	// contains filtered or unexported fields
}

The log configuration for the container. This parameter maps to LogConfig in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the --log-driver option to docker run (https://docs.docker.com/engine/reference/commandline/run/).

By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation.

Understand the following when specifying a log configuration for your containers.

  • Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens. For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.

  • This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.

  • For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the Amazon Elastic Container Service Developer Guide.

  • For tasks that are on Fargate, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.

func (LogConfiguration) GoString added in v0.9.14 

func (s LogConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetSecretOptions added in v1.19.22 

func (s *LogConfiguration) SetSecretOptions(v []*Secret) *LogConfiguration

SetSecretOptions sets the SecretOptions field's value.

func (LogConfiguration) String added in v0.9.14 

func (s LogConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 ManagedAgent added in v1.37.31 

type ManagedAgent struct {

	// The Unix timestamp for the time when the managed agent was last started.
	LastStartedAt *time.Time `locationName:"lastStartedAt" type:"timestamp"`

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

	// The name of the managed agent. When the execute command feature is turned
	// on, the managed agent name is ExecuteCommandAgent.
	Name *string `locationName:"name" type:"string" enum:"ManagedAgentName"`

	// The reason for why the managed agent is in the state it is in.
	Reason *string `locationName:"reason" type:"string"`
	// contains filtered or unexported fields
}

Details about the managed agent status for the container.

func (ManagedAgent) GoString added in v1.37.31 

func (s ManagedAgent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ManagedAgent) SetLastStartedAt added in v1.37.31 

func (s *ManagedAgent) SetLastStartedAt(v time.Time) *ManagedAgent

SetLastStartedAt sets the LastStartedAt field's value.

func (*ManagedAgent) SetLastStatus added in v1.37.31 

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

SetLastStatus sets the LastStatus field's value.

func (*ManagedAgent) SetName added in v1.37.31 

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

SetName sets the Name field's value.

func (*ManagedAgent) SetReason added in v1.37.31 

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

SetReason sets the Reason field's value.

func (ManagedAgent) String added in v1.37.31 

func (s ManagedAgent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ManagedAgentStateChange added in v1.37.31 

type ManagedAgentStateChange struct {

	// The name of the container that's associated with the managed agent.
	//
	// ContainerName is a required field
	ContainerName *string `locationName:"containerName" type:"string" required:"true"`

	// The name of the managed agent.
	//
	// ManagedAgentName is a required field
	ManagedAgentName *string `locationName:"managedAgentName" type:"string" required:"true" enum:"ManagedAgentName"`

	// The reason for the status of the managed agent.
	Reason *string `locationName:"reason" type:"string"`

	// The status of the managed agent.
	//
	// 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 managed agent.

func (ManagedAgentStateChange) GoString added in v1.37.31 

func (s ManagedAgentStateChange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ManagedAgentStateChange) SetContainerName added in v1.37.31 

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

SetContainerName sets the ContainerName field's value.

func (*ManagedAgentStateChange) SetManagedAgentName added in v1.37.31 

func (s *ManagedAgentStateChange) SetManagedAgentName(v string) *ManagedAgentStateChange

SetManagedAgentName sets the ManagedAgentName field's value.

func (*ManagedAgentStateChange) SetReason added in v1.37.31 

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

SetReason sets the Reason field's value.

func (*ManagedAgentStateChange) SetStatus added in v1.37.31 

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

SetStatus sets the Status field's value.

func (ManagedAgentStateChange) String added in v1.37.31 

func (s ManagedAgentStateChange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ManagedAgentStateChange) Validate added in v1.37.31 

func (s *ManagedAgentStateChange) Validate() error

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

type ManagedScaling added in v1.25.46 

type ManagedScaling struct {

	// The period of time, in seconds, after a newly launched Amazon EC2 instance
	// can contribute to CloudWatch metrics for Auto Scaling group. If this parameter
	// is omitted, the default value of 300 seconds is used.
	InstanceWarmupPeriod *int64 `locationName:"instanceWarmupPeriod" type:"integer"`

	// The maximum number of Amazon EC2 instances that Amazon ECS will scale out
	// at one time. The scale in process is not affected by this parameter. If this
	// parameter is omitted, the default value of 10000 is used.
	MaximumScalingStepSize *int64 `locationName:"maximumScalingStepSize" min:"1" type:"integer"`

	// The minimum number of Amazon EC2 instances that Amazon ECS will scale out
	// at one time. The scale in process is not affected by this parameter If this
	// parameter is omitted, the default value of 1 is used.
	//
	// When additional capacity is required, Amazon ECS will scale up the minimum
	// scaling step size even if the actual demand is less than the minimum scaling
	// step size.
	//
	// If you use a capacity provider with an Auto Scaling group configured with
	// more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will
	// scale up by the exact minimum scaling step size value and will ignore both
	// the maximum scaling step size as well as the capacity demand.
	MinimumScalingStepSize *int64 `locationName:"minimumScalingStepSize" min:"1" type:"integer"`

	// Determines whether to use managed scaling for the capacity provider.
	Status *string `locationName:"status" type:"string" enum:"ManagedScalingStatus"`

	// The target capacity utilization as a percentage for the capacity provider.
	// The specified value must be greater than 0 and less than or equal to 100.
	// For example, if you want the capacity provider to maintain 10% spare capacity,
	// then that means the utilization is 90%, so use a targetCapacity of 90. The
	// default value of 100 percent results in the Amazon EC2 instances in your
	// Auto Scaling group being completely used.
	TargetCapacity *int64 `locationName:"targetCapacity" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

The managed scaling settings for the Auto Scaling group capacity provider.

When managed scaling is turned on, Amazon ECS manages the scale-in and scale-out actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS managed CloudWatch metric with the specified targetCapacity value as the target value for the metric. For more information, see Using managed scaling (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html#asg-capacity-providers-managed-scaling) in the Amazon Elastic Container Service Developer Guide.

If managed scaling is off, the user must manage the scaling of the Auto Scaling group.

func (ManagedScaling) GoString added in v1.25.46 

func (s ManagedScaling) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ManagedScaling) SetInstanceWarmupPeriod added in v1.35.34 

func (s *ManagedScaling) SetInstanceWarmupPeriod(v int64) *ManagedScaling

SetInstanceWarmupPeriod sets the InstanceWarmupPeriod field's value.

func (*ManagedScaling) SetMaximumScalingStepSize added in v1.25.46 

func (s *ManagedScaling) SetMaximumScalingStepSize(v int64) *ManagedScaling

SetMaximumScalingStepSize sets the MaximumScalingStepSize field's value.

func (*ManagedScaling) SetMinimumScalingStepSize added in v1.25.46 

func (s *ManagedScaling) SetMinimumScalingStepSize(v int64) *ManagedScaling

SetMinimumScalingStepSize sets the MinimumScalingStepSize field's value.

func (*ManagedScaling) SetStatus added in v1.25.46 

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

SetStatus sets the Status field's value.

func (*ManagedScaling) SetTargetCapacity added in v1.25.46 

func (s *ManagedScaling) SetTargetCapacity(v int64) *ManagedScaling

SetTargetCapacity sets the TargetCapacity field's value.

func (ManagedScaling) String added in v1.25.46 

func (s ManagedScaling) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ManagedScaling) Validate added in v1.25.46 

func (s *ManagedScaling) Validate() error

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

type ManagedStorageConfiguration added in v1.53.20 

type ManagedStorageConfiguration struct {

	// Specify the Key Management Service key ID for the Fargate ephemeral storage.
	FargateEphemeralStorageKmsKeyId *string `locationName:"fargateEphemeralStorageKmsKeyId" type:"string"`

	// Specify a Key Management Service key ID to encrypt the managed storage.
	KmsKeyId *string `locationName:"kmsKeyId" type:"string"`
	// contains filtered or unexported fields
}

The managed storage configuration for the cluster.

func (ManagedStorageConfiguration) GoString added in v1.53.20 

func (s ManagedStorageConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ManagedStorageConfiguration) SetFargateEphemeralStorageKmsKeyId added in v1.53.20 

func (s *ManagedStorageConfiguration) SetFargateEphemeralStorageKmsKeyId(v string) *ManagedStorageConfiguration

SetFargateEphemeralStorageKmsKeyId sets the FargateEphemeralStorageKmsKeyId field's value.

func (*ManagedStorageConfiguration) SetKmsKeyId added in v1.53.20 

func (s *ManagedStorageConfiguration) SetKmsKeyId(v string) *ManagedStorageConfiguration

SetKmsKeyId sets the KmsKeyId field's value.

func (ManagedStorageConfiguration) String added in v1.53.20 

func (s ManagedStorageConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MissingVersionException added in v1.28.0 

type MissingVersionException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Amazon ECS can't determine the current version of the Amazon ECS container agent on the container instance and doesn't have enough information to proceed with an update. This could be because the agent running on the container instance is a previous or custom version that doesn't use our version information.

func (*MissingVersionException) Code added in v1.28.0 

func (s *MissingVersionException) Code() string

Code returns the exception type name.

func (*MissingVersionException) Error added in v1.28.0 

func (s *MissingVersionException) Error() string

func (MissingVersionException) GoString added in v1.28.0 

func (s MissingVersionException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MissingVersionException) Message added in v1.28.0 

func (s *MissingVersionException) Message() string

Message returns the exception's message.

func (*MissingVersionException) OrigErr added in v1.28.0 

func (s *MissingVersionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MissingVersionException) RequestID added in v1.28.0 

func (s *MissingVersionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MissingVersionException) StatusCode added in v1.28.0 

func (s *MissingVersionException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MissingVersionException) String added in v1.28.0 

func (s MissingVersionException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. Must be a volume name referenced in the
	// name parameter of task definition volume.
	SourceVolume *string `locationName:"sourceVolume" type:"string"`
	// contains filtered or unexported fields
}

The details for a volume mount point that's used in a container definition.

func (MountPoint) GoString added in v0.6.5 

func (s MountPoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NamespaceNotFoundException added in v1.44.146 

type NamespaceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified namespace wasn't found.

func (*NamespaceNotFoundException) Code added in v1.44.146 

func (s *NamespaceNotFoundException) Code() string

Code returns the exception type name.

func (*NamespaceNotFoundException) Error added in v1.44.146 

func (s *NamespaceNotFoundException) Error() string

func (NamespaceNotFoundException) GoString added in v1.44.146 

func (s NamespaceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NamespaceNotFoundException) Message added in v1.44.146 

func (s *NamespaceNotFoundException) Message() string

Message returns the exception's message.

func (*NamespaceNotFoundException) OrigErr added in v1.44.146 

func (s *NamespaceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NamespaceNotFoundException) RequestID added in v1.44.146 

func (s *NamespaceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NamespaceNotFoundException) StatusCode added in v1.44.146 

func (s *NamespaceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NamespaceNotFoundException) String added in v1.44.146 

func (s NamespaceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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's used with the network binding.
	ContainerPort *int64 `locationName:"containerPort" type:"integer"`

	// The port number range on the container that's bound to the dynamically mapped
	// host port range.
	//
	// The following rules apply when you specify a containerPortRange:
	//
	//    * You must use either the bridge network mode or the awsvpc network mode.
	//
	//    * This parameter is available for both the EC2 and Fargate launch types.
	//
	//    * This parameter is available for both the Linux and Windows operating
	//    systems.
	//
	//    * The container instance must have at least version 1.67.0 of the container
	//    agent and at least version 1.67.0-1 of the ecs-init package
	//
	//    * You can specify a maximum of 100 port ranges per container.
	//
	//    * You do not specify a hostPortRange. The value of the hostPortRange is
	//    set as follows: For containers in a task with the awsvpc network mode,
	//    the hostPortRange is set to the same value as the containerPortRange.
	//    This is a static mapping strategy. For containers in a task with the bridge
	//    network mode, the Amazon ECS agent finds open host ports from the default
	//    ephemeral range and passes it to docker to bind them to the container
	//    ports.
	//
	//    * The containerPortRange valid values are between 1 and 65535.
	//
	//    * A port can only be included in one port mapping per container.
	//
	//    * You cannot specify overlapping port ranges.
	//
	//    * The first port in the range must be less than last port in the range.
	//
	//    * Docker recommends that you turn off the docker-proxy in the Docker daemon
	//    config file when you have a large number of ports. For more information,
	//    see Issue #11185 (https://github.com/moby/moby/issues/11185) on the Github
	//    website. For information about how to turn off the docker-proxy in the
	//    Docker daemon config file, see Docker daemon (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon)
	//    in the Amazon ECS Developer Guide.
	//
	// You can call DescribeTasks (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html)
	// to view the hostPortRange which are the host ports that are bound to the
	// container ports.
	ContainerPortRange *string `locationName:"containerPortRange" type:"string"`

	// The port number on the host that's used with the network binding.
	HostPort *int64 `locationName:"hostPort" type:"integer"`

	// The port number range on the host that's used with the network binding. This
	// is assigned is assigned by Docker and delivered by the Amazon ECS agent.
	HostPortRange *string `locationName:"hostPortRange" type:"string"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetContainerPortRange added in v1.44.161 

func (s *NetworkBinding) SetContainerPortRange(v string) *NetworkBinding

SetContainerPortRange sets the ContainerPortRange 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) SetHostPortRange added in v1.44.161 

func (s *NetworkBinding) SetHostPortRange(v string) *NetworkBinding

SetHostPortRange sets the HostPortRange 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NetworkConfiguration added in v1.12.27 

type NetworkConfiguration struct {

	// The VPC subnets and security groups that are associated with a task.
	//
	// All specified subnets and security groups must be from the same VPC.
	AwsvpcConfiguration *AwsVpcConfiguration `locationName:"awsvpcConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NoUpdateAvailableException added in v1.28.0 

type NoUpdateAvailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

There's no update available for this Amazon ECS container agent. This might be because the agent is already running the latest version or because it's so old that there's no update path to the current version.

func (*NoUpdateAvailableException) Code added in v1.28.0 

func (s *NoUpdateAvailableException) Code() string

Code returns the exception type name.

func (*NoUpdateAvailableException) Error added in v1.28.0 

func (s *NoUpdateAvailableException) Error() string

func (NoUpdateAvailableException) GoString added in v1.28.0 

func (s NoUpdateAvailableException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NoUpdateAvailableException) Message added in v1.28.0 

func (s *NoUpdateAvailableException) Message() string

Message returns the exception's message.

func (*NoUpdateAvailableException) OrigErr added in v1.28.0 

func (s *NoUpdateAvailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NoUpdateAvailableException) RequestID added in v1.28.0 

func (s *NoUpdateAvailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NoUpdateAvailableException) StatusCode added in v1.28.0 

func (s *NoUpdateAvailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NoUpdateAvailableException) String added in v1.28.0 

func (s NoUpdateAvailableException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PlacementConstraint added in v1.6.9 

type PlacementConstraint struct {

	// A cluster query language expression to apply to the constraint. The expression
	// can have a maximum length of 2000 characters. You can't specify an expression
	// if the constraint type is distinctInstance. For more information, see Cluster
	// query language (https://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.
	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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the Amazon Elastic Container Service Developer Guide.

If you're using the Fargate launch type, task placement constraints aren't supported.

func (PlacementConstraint) GoString added in v1.6.9 

func (s PlacementConstraint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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's 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's 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 (https://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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PlatformDevice added in v1.16.27 

type PlatformDevice struct {

	// The ID for the GPUs on the container instance. The available GPU IDs can
	// also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json
	// file.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The type of device that's available on the container instance. The only supported
	// value is GPU.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"PlatformDeviceType"`
	// contains filtered or unexported fields
}

The devices that are available on the container instance. The only supported device type is a GPU.

func (PlatformDevice) GoString added in v1.16.27 

func (s PlatformDevice) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PlatformDevice) SetId added in v1.16.27 

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

SetId sets the Id field's value.

func (*PlatformDevice) SetType added in v1.16.27 

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

SetType sets the Type field's value.

func (PlatformDevice) String added in v1.16.27 

func (s PlatformDevice) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PlatformDevice) Validate added in v1.16.27 

func (s *PlatformDevice) Validate() error

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

type PlatformTaskDefinitionIncompatibilityException added in v1.28.0 

type PlatformTaskDefinitionIncompatibilityException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified platform version doesn't satisfy the required capabilities of the task definition.

func (*PlatformTaskDefinitionIncompatibilityException) Code added in v1.28.0 

func (s *PlatformTaskDefinitionIncompatibilityException) Code() string

Code returns the exception type name.

func (*PlatformTaskDefinitionIncompatibilityException) Error added in v1.28.0 

func (s *PlatformTaskDefinitionIncompatibilityException) Error() string

func (PlatformTaskDefinitionIncompatibilityException) GoString added in v1.28.0 

func (s PlatformTaskDefinitionIncompatibilityException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PlatformTaskDefinitionIncompatibilityException) Message added in v1.28.0 

func (s *PlatformTaskDefinitionIncompatibilityException) Message() string

Message returns the exception's message.

func (*PlatformTaskDefinitionIncompatibilityException) OrigErr added in v1.28.0 

func (s *PlatformTaskDefinitionIncompatibilityException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*PlatformTaskDefinitionIncompatibilityException) RequestID added in v1.28.0 

func (s *PlatformTaskDefinitionIncompatibilityException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*PlatformTaskDefinitionIncompatibilityException) StatusCode added in v1.28.0 

func (s *PlatformTaskDefinitionIncompatibilityException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (PlatformTaskDefinitionIncompatibilityException) String added in v1.28.0 

func (s PlatformTaskDefinitionIncompatibilityException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PlatformUnknownException added in v1.28.0 

type PlatformUnknownException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified platform version doesn't exist.

func (*PlatformUnknownException) Code added in v1.28.0 

func (s *PlatformUnknownException) Code() string

Code returns the exception type name.

func (*PlatformUnknownException) Error added in v1.28.0 

func (s *PlatformUnknownException) Error() string

func (PlatformUnknownException) GoString added in v1.28.0 

func (s PlatformUnknownException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PlatformUnknownException) Message added in v1.28.0 

func (s *PlatformUnknownException) Message() string

Message returns the exception's message.

func (*PlatformUnknownException) OrigErr added in v1.28.0 

func (s *PlatformUnknownException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*PlatformUnknownException) RequestID added in v1.28.0 

func (s *PlatformUnknownException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*PlatformUnknownException) StatusCode added in v1.28.0 

func (s *PlatformUnknownException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (PlatformUnknownException) String added in v1.28.0 

func (s PlatformUnknownException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PortMapping 

type PortMapping struct {

	// The application protocol that's used for the port mapping. This parameter
	// only applies to Service Connect. We recommend that you set this parameter
	// to be consistent with the protocol that your application uses. If you set
	// this parameter, Amazon ECS adds protocol-specific connection handling to
	// the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific
	// telemetry in the Amazon ECS console and CloudWatch.
	//
	// If you don't set a value for this parameter, then TCP is used. However, Amazon
	// ECS doesn't add protocol-specific telemetry for TCP.
	//
	// appProtocol is immutable in a Service Connect service. Updating this field
	// requires a service deletion and redeployment.
	//
	// Tasks that run in a namespace can use short names to connect to services
	// in the namespace. Tasks can connect to services across all of the clusters
	// in the namespace. Tasks connect through a managed proxy container that collects
	// logs and metrics for increased visibility. Only the tasks that Amazon ECS
	// services create are supported with Service Connect. For more information,
	// see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
	// in the Amazon Elastic Container Service Developer Guide.
	AppProtocol *string `locationName:"appProtocol" type:"string" enum:"ApplicationProtocol"`

	// The port number on the container that's bound to the user-specified or automatically
	// assigned host port.
	//
	// If you use containers in a task with the awsvpc or host network mode, specify
	// the exposed ports using containerPort.
	//
	// If you use 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 range on the container that's bound to the dynamically mapped
	// host port range.
	//
	// The following rules apply when you specify a containerPortRange:
	//
	//    * You must use either the bridge network mode or the awsvpc network mode.
	//
	//    * This parameter is available for both the EC2 and Fargate launch types.
	//
	//    * This parameter is available for both the Linux and Windows operating
	//    systems.
	//
	//    * The container instance must have at least version 1.67.0 of the container
	//    agent and at least version 1.67.0-1 of the ecs-init package
	//
	//    * You can specify a maximum of 100 port ranges per container.
	//
	//    * You do not specify a hostPortRange. The value of the hostPortRange is
	//    set as follows: For containers in a task with the awsvpc network mode,
	//    the hostPortRange is set to the same value as the containerPortRange.
	//    This is a static mapping strategy. For containers in a task with the bridge
	//    network mode, the Amazon ECS agent finds open host ports from the default
	//    ephemeral range and passes it to docker to bind them to the container
	//    ports.
	//
	//    * The containerPortRange valid values are between 1 and 65535.
	//
	//    * A port can only be included in one port mapping per container.
	//
	//    * You cannot specify overlapping port ranges.
	//
	//    * The first port in the range must be less than last port in the range.
	//
	//    * Docker recommends that you turn off the docker-proxy in the Docker daemon
	//    config file when you have a large number of ports. For more information,
	//    see Issue #11185 (https://github.com/moby/moby/issues/11185) on the Github
	//    website. For information about how to turn off the docker-proxy in the
	//    Docker daemon config file, see Docker daemon (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon)
	//    in the Amazon ECS Developer Guide.
	//
	// You can call DescribeTasks (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html)
	// to view the hostPortRange which are the host ports that are bound to the
	// container ports.
	ContainerPortRange *string `locationName:"containerPortRange" type:"string"`

	// The port number on the container instance to reserve for your container.
	//
	// If you specify a containerPortRange, leave this field empty and the value
	// of the hostPort is set as follows:
	//
	//    * For containers in a task with the awsvpc network mode, the hostPort
	//    is set to the same value as the containerPort. This is a static mapping
	//    strategy.
	//
	//    * For containers in a task with the bridge network mode, the Amazon ECS
	//    agent finds open ports on the host and automatically binds them to the
	//    container ports. This is a dynamic mapping strategy.
	//
	// If you use 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 you use 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 (Linux) or 49152 through 65535 (Windows) is used. Do 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 reserved ports are 22 for SSH, the Docker ports 2375 and 2376,
	// and the Amazon ECS container agent ports 51678-51680. Any host port that
	// was previously specified in a running task is also reserved while the task
	// is running. That is, after a task stops, the host port is released. The current
	// reserved ports are displayed in the remainingResources of DescribeContainerInstances
	// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html)
	// output. A container instance can have up to 100 reserved ports at a time.
	// This number includes the default reserved ports. Automatically assigned ports
	// aren't included in the 100 reserved ports quota.
	HostPort *int64 `locationName:"hostPort" type:"integer"`

	// The name that's used for the port mapping. This parameter only applies to
	// Service Connect. This parameter is the name that you use in the serviceConnectConfiguration
	// of a service. The name can include up to 64 characters. The characters can
	// include lowercase letters, numbers, underscores (_), and hyphens (-). The
	// name can't start with a hyphen.
	//
	// For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
	// in the Amazon Elastic Container Service Developer Guide.
	Name *string `locationName:"name" type:"string"`

	// The protocol used for the port mapping. Valid values are tcp and udp. The
	// default is tcp. protocol is immutable in a Service Connect service. Updating
	// this field requires a service deletion and redeployment.
	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 you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Most fields of this parameter (containerPort, hostPort, protocol) maps to PortBindings in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the --publish option to docker run (https://docs.docker.com/engine/reference/commandline/run/). If the network mode of a task definition is set to host, host ports must either be undefined or match the container port in the port mapping.

You can't expose the same container port for multiple protocols. If you attempt this, an error is returned.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PortMapping) SetAppProtocol added in v1.44.146 

func (s *PortMapping) SetAppProtocol(v string) *PortMapping

SetAppProtocol sets the AppProtocol field's value.

func (*PortMapping) SetContainerPort added in v1.5.0 

func (s *PortMapping) SetContainerPort(v int64) *PortMapping

SetContainerPort sets the ContainerPort field's value.

func (*PortMapping) SetContainerPortRange added in v1.44.161 

func (s *PortMapping) SetContainerPortRange(v string) *PortMapping

SetContainerPortRange sets the ContainerPortRange 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) SetName added in v1.44.146 

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

SetName sets the Name 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProtectedTask added in v1.44.135 

type ProtectedTask struct {

	// The epoch time when protection for the task will expire.
	ExpirationDate *time.Time `locationName:"expirationDate" type:"timestamp"`

	// The protection status of the task. If scale-in protection is on for a task,
	// the value is true. Otherwise, it is false.
	ProtectionEnabled *bool `locationName:"protectionEnabled" type:"boolean"`

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

An object representing the protection status details for a task. You can set the protection status with the UpdateTaskProtection API and get the status of tasks with the GetTaskProtection API.

func (ProtectedTask) GoString added in v1.44.135 

func (s ProtectedTask) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProtectedTask) SetExpirationDate added in v1.44.135 

func (s *ProtectedTask) SetExpirationDate(v time.Time) *ProtectedTask

SetExpirationDate sets the ExpirationDate field's value.

func (*ProtectedTask) SetProtectionEnabled added in v1.44.135 

func (s *ProtectedTask) SetProtectionEnabled(v bool) *ProtectedTask

SetProtectionEnabled sets the ProtectionEnabled field's value.

func (*ProtectedTask) SetTaskArn added in v1.44.135 

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

SetTaskArn sets the TaskArn field's value.

func (ProtectedTask) String added in v1.44.135 

func (s ProtectedTask) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProxyConfiguration added in v1.17.13 

type ProxyConfiguration struct {

	// The name of the container that will serve as the App Mesh proxy.
	//
	// ContainerName is a required field
	ContainerName *string `locationName:"containerName" type:"string" required:"true"`

	// The set of network configuration parameters to provide the Container Network
	// Interface (CNI) plugin, specified as key-value pairs.
	//
	//    * IgnoredUID - (Required) The user ID (UID) of the proxy container as
	//    defined by the user parameter in a container definition. This is used
	//    to ensure the proxy ignores its own traffic. If IgnoredGID is specified,
	//    this field can be empty.
	//
	//    * IgnoredGID - (Required) The group ID (GID) of the proxy container as
	//    defined by the user parameter in a container definition. This is used
	//    to ensure the proxy ignores its own traffic. If IgnoredUID is specified,
	//    this field can be empty.
	//
	//    * AppPorts - (Required) The list of ports that the application uses. Network
	//    traffic to these ports is forwarded to the ProxyIngressPort and ProxyEgressPort.
	//
	//    * ProxyIngressPort - (Required) Specifies the port that incoming traffic
	//    to the AppPorts is directed to.
	//
	//    * ProxyEgressPort - (Required) Specifies the port that outgoing traffic
	//    from the AppPorts is directed to.
	//
	//    * EgressIgnoredPorts - (Required) The egress traffic going to the specified
	//    ports is ignored and not redirected to the ProxyEgressPort. It can be
	//    an empty list.
	//
	//    * EgressIgnoredIPs - (Required) The egress traffic going to the specified
	//    IP addresses is ignored and not redirected to the ProxyEgressPort. It
	//    can be an empty list.
	Properties []*KeyValuePair `locationName:"properties" type:"list"`

	// The proxy type. The only supported value is APPMESH.
	Type *string `locationName:"type" type:"string" enum:"ProxyConfigurationType"`
	// contains filtered or unexported fields
}

The configuration details for the App Mesh proxy.

For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)

func (ProxyConfiguration) GoString added in v1.17.13 

func (s ProxyConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProxyConfiguration) SetContainerName added in v1.17.13 

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

SetContainerName sets the ContainerName field's value.

func (*ProxyConfiguration) SetProperties added in v1.17.13 

func (s *ProxyConfiguration) SetProperties(v []*KeyValuePair) *ProxyConfiguration

SetProperties sets the Properties field's value.

func (*ProxyConfiguration) SetType added in v1.17.13 

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

SetType sets the Type field's value.

func (ProxyConfiguration) String added in v1.17.13 

func (s ProxyConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProxyConfiguration) Validate added in v1.17.13 

func (s *ProxyConfiguration) Validate() error

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

type PutAccountSettingDefaultInput added in v1.16.31 

type PutAccountSettingDefaultInput struct {

	// The resource name for which to modify the account setting.
	//
	// The following are the valid values for the account setting name.
	//
	//    * serviceLongArnFormat - When modified, the Amazon Resource Name (ARN)
	//    and resource ID format of the resource type for a specified user, role,
	//    or the root user for an account is affected. The opt-in and opt-out account
	//    setting must be set for each Amazon ECS resource separately. The ARN and
	//    resource ID format of a resource is defined by the opt-in status of the
	//    user or role that created the resource. You must turn on this setting
	//    to use Amazon ECS features such as resource tagging.
	//
	//    * taskLongArnFormat - When modified, the Amazon Resource Name (ARN) and
	//    resource ID format of the resource type for a specified user, role, or
	//    the root user for an account is affected. The opt-in and opt-out account
	//    setting must be set for each Amazon ECS resource separately. The ARN and
	//    resource ID format of a resource is defined by the opt-in status of the
	//    user or role that created the resource. You must turn on this setting
	//    to use Amazon ECS features such as resource tagging.
	//
	//    * containerInstanceLongArnFormat - When modified, the Amazon Resource
	//    Name (ARN) and resource ID format of the resource type for a specified
	//    user, role, or the root user for an account is affected. The opt-in and
	//    opt-out account setting must be set for each Amazon ECS resource separately.
	//    The ARN and resource ID format of a resource is defined by the opt-in
	//    status of the user or role that created the resource. You must turn on
	//    this setting to use Amazon ECS features such as resource tagging.
	//
	//    * awsvpcTrunking - When modified, the elastic network interface (ENI)
	//    limit for any new container instances that support the feature is changed.
	//    If awsvpcTrunking is turned on, any new container instances that support
	//    the feature are launched have the increased ENI limits available to them.
	//    For more information, see Elastic Network Interface Trunking (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html)
	//    in the Amazon Elastic Container Service Developer Guide.
	//
	//    * containerInsights - When modified, the default setting indicating whether
	//    Amazon Web Services CloudWatch Container Insights is turned on for your
	//    clusters is changed. If containerInsights is turned on, any new clusters
	//    that are created will have Container Insights turned on unless you disable
	//    it during cluster creation. For more information, see CloudWatch Container
	//    Insights (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html)
	//    in the Amazon Elastic Container Service Developer Guide.
	//
	//    * dualStackIPv6 - When turned on, when using a VPC in dual stack mode,
	//    your tasks using the awsvpc network mode can have an IPv6 address assigned.
	//    For more information on using IPv6 with tasks launched on Amazon EC2 instances,
	//    see Using a VPC in dual-stack mode (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking-awsvpc.html#task-networking-vpc-dual-stack).
	//    For more information on using IPv6 with tasks launched on Fargate, see
	//    Using a VPC in dual-stack mode (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-task-networking.html#fargate-task-networking-vpc-dual-stack).
	//
	//    * fargateFIPSMode - If you specify fargateFIPSMode, Fargate FIPS 140 compliance
	//    is affected.
	//
	//    * fargateTaskRetirementWaitPeriod - When Amazon Web Services determines
	//    that a security or infrastructure update is needed for an Amazon ECS task
	//    hosted on Fargate, the tasks need to be stopped and new tasks launched
	//    to replace them. Use fargateTaskRetirementWaitPeriod to configure the
	//    wait time to retire a Fargate task. For information about the Fargate
	//    tasks maintenance, see Amazon Web Services Fargate task maintenance (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html)
	//    in the Amazon ECS Developer Guide.
	//
	//    * tagResourceAuthorization - Amazon ECS is introducing tagging authorization
	//    for resource creation. Users must have permissions for actions that create
	//    the resource, such as ecsCreateCluster. If tags are specified when you
	//    create a resource, Amazon Web Services performs additional authorization
	//    to verify if users or roles have permissions to create tags. Therefore,
	//    you must grant explicit permissions to use the ecs:TagResource action.
	//    For more information, see Grant permission to tag resources on creation
	//    (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html)
	//    in the Amazon ECS Developer Guide.
	//
	//    * guardDutyActivate - The guardDutyActivate parameter is read-only in
	//    Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled
	//    or disabled by your security administrator in your Amazon ECS account.
	//    Amazon GuardDuty controls this account setting on your behalf. For more
	//    information, see Protecting Amazon ECS workloads with Amazon ECS Runtime
	//    Monitoring (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html).
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true" enum:"SettingName"`

	// The account setting value for the specified principal ARN. Accepted values
	// are enabled, disabled, on, and off.
	//
	// When you specify fargateTaskRetirementWaitPeriod for the name, the following
	// are the valid values:
	//
	//    * 0 - Amazon Web Services sends the notification, and immediately retires
	//    the affected tasks.
	//
	//    * 7 - Amazon Web Services sends the notification, and waits 7 calendar
	//    days to retire the tasks.
	//
	//    * 14 - Amazon Web Services sends the notification, and waits 14 calendar
	//    days to retire the tasks.
	//
	// Value is a required field
	Value *string `locationName:"value" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutAccountSettingDefaultInput) GoString added in v1.16.31 

func (s PutAccountSettingDefaultInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAccountSettingDefaultInput) SetName added in v1.16.31 

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

SetName sets the Name field's value.

func (*PutAccountSettingDefaultInput) SetValue added in v1.16.31 

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

SetValue sets the Value field's value.

func (PutAccountSettingDefaultInput) String added in v1.16.31 

func (s PutAccountSettingDefaultInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAccountSettingDefaultInput) Validate added in v1.16.31 

func (s *PutAccountSettingDefaultInput) Validate() error

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

type PutAccountSettingDefaultOutput added in v1.16.31 

type PutAccountSettingDefaultOutput struct {

	// The current setting for a resource.
	Setting *Setting `locationName:"setting" type:"structure"`
	// contains filtered or unexported fields
}

func (PutAccountSettingDefaultOutput) GoString added in v1.16.31 

func (s PutAccountSettingDefaultOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAccountSettingDefaultOutput) SetSetting added in v1.16.31 

func (s *PutAccountSettingDefaultOutput) SetSetting(v *Setting) *PutAccountSettingDefaultOutput

SetSetting sets the Setting field's value.

func (PutAccountSettingDefaultOutput) String added in v1.16.31 

func (s PutAccountSettingDefaultOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutAccountSettingInput added in v1.15.77 

type PutAccountSettingInput struct {

	// The Amazon ECS account setting name to modify.
	//
	// The following are the valid values for the account setting name.
	//
	//    * serviceLongArnFormat - When modified, the Amazon Resource Name (ARN)
	//    and resource ID format of the resource type for a specified user, role,
	//    or the root user for an account is affected. The opt-in and opt-out account
	//    setting must be set for each Amazon ECS resource separately. The ARN and
	//    resource ID format of a resource is defined by the opt-in status of the
	//    user or role that created the resource. You must turn on this setting
	//    to use Amazon ECS features such as resource tagging.
	//
	//    * taskLongArnFormat - When modified, the Amazon Resource Name (ARN) and
	//    resource ID format of the resource type for a specified user, role, or
	//    the root user for an account is affected. The opt-in and opt-out account
	//    setting must be set for each Amazon ECS resource separately. The ARN and
	//    resource ID format of a resource is defined by the opt-in status of the
	//    user or role that created the resource. You must turn on this setting
	//    to use Amazon ECS features such as resource tagging.
	//
	//    * containerInstanceLongArnFormat - When modified, the Amazon Resource
	//    Name (ARN) and resource ID format of the resource type for a specified
	//    user, role, or the root user for an account is affected. The opt-in and
	//    opt-out account setting must be set for each Amazon ECS resource separately.
	//    The ARN and resource ID format of a resource is defined by the opt-in
	//    status of the user or role that created the resource. You must turn on
	//    this setting to use Amazon ECS features such as resource tagging.
	//
	//    * awsvpcTrunking - When modified, the elastic network interface (ENI)
	//    limit for any new container instances that support the feature is changed.
	//    If awsvpcTrunking is turned on, any new container instances that support
	//    the feature are launched have the increased ENI limits available to them.
	//    For more information, see Elastic Network Interface Trunking (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html)
	//    in the Amazon Elastic Container Service Developer Guide.
	//
	//    * containerInsights - When modified, the default setting indicating whether
	//    Amazon Web Services CloudWatch Container Insights is turned on for your
	//    clusters is changed. If containerInsights is turned on, any new clusters
	//    that are created will have Container Insights turned on unless you disable
	//    it during cluster creation. For more information, see CloudWatch Container
	//    Insights (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html)
	//    in the Amazon Elastic Container Service Developer Guide.
	//
	//    * dualStackIPv6 - When turned on, when using a VPC in dual stack mode,
	//    your tasks using the awsvpc network mode can have an IPv6 address assigned.
	//    For more information on using IPv6 with tasks launched on Amazon EC2 instances,
	//    see Using a VPC in dual-stack mode (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking-awsvpc.html#task-networking-vpc-dual-stack).
	//    For more information on using IPv6 with tasks launched on Fargate, see
	//    Using a VPC in dual-stack mode (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-task-networking.html#fargate-task-networking-vpc-dual-stack).
	//
	//    * fargateFIPSMode - If you specify fargateFIPSMode, Fargate FIPS 140 compliance
	//    is affected.
	//
	//    * fargateTaskRetirementWaitPeriod - When Amazon Web Services determines
	//    that a security or infrastructure update is needed for an Amazon ECS task
	//    hosted on Fargate, the tasks need to be stopped and new tasks launched
	//    to replace them. Use fargateTaskRetirementWaitPeriod to configure the
	//    wait time to retire a Fargate task. For information about the Fargate
	//    tasks maintenance, see Amazon Web Services Fargate task maintenance (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html)
	//    in the Amazon ECS Developer Guide.
	//
	//    * tagResourceAuthorization - Amazon ECS is introducing tagging authorization
	//    for resource creation. Users must have permissions for actions that create
	//    the resource, such as ecsCreateCluster. If tags are specified when you
	//    create a resource, Amazon Web Services performs additional authorization
	//    to verify if users or roles have permissions to create tags. Therefore,
	//    you must grant explicit permissions to use the ecs:TagResource action.
	//    For more information, see Grant permission to tag resources on creation
	//    (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html)
	//    in the Amazon ECS Developer Guide.
	//
	//    * guardDutyActivate - The guardDutyActivate parameter is read-only in
	//    Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled
	//    or disabled by your security administrator in your Amazon ECS account.
	//    Amazon GuardDuty controls this account setting on your behalf. For more
	//    information, see Protecting Amazon ECS workloads with Amazon ECS Runtime
	//    Monitoring (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html).
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true" enum:"SettingName"`

	// The ARN of the principal, which can be a user, role, or the root user. If
	// you specify the root user, it modifies the account setting for all users,
	// roles, and the root user of the account unless a user or role explicitly
	// overrides these settings. If this field is omitted, the setting is changed
	// only for the authenticated user.
	//
	// You must use the root user when you set the Fargate wait time (fargateTaskRetirementWaitPeriod).
	//
	// Federated users assume the account setting of the root user and can't have
	// explicit account settings set for them.
	PrincipalArn *string `locationName:"principalArn" type:"string"`

	// The account setting value for the specified principal ARN. Accepted values
	// are enabled, disabled, on, and off.
	//
	// When you specify fargateTaskRetirementWaitPeriod for the name, the following
	// are the valid values:
	//
	//    * 0 - Amazon Web Services sends the notification, and immediately retires
	//    the affected tasks.
	//
	//    * 7 - Amazon Web Services sends the notification, and waits 7 calendar
	//    days to retire the tasks.
	//
	//    * 14 - Amazon Web Services sends the notification, and waits 14 calendar
	//    days to retire the tasks.
	//
	// Value is a required field
	Value *string `locationName:"value" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutAccountSettingInput) GoString added in v1.15.77 

func (s PutAccountSettingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAccountSettingInput) SetName added in v1.15.77 

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

SetName sets the Name field's value.

func (*PutAccountSettingInput) SetPrincipalArn added in v1.15.77 

func (s *PutAccountSettingInput) SetPrincipalArn(v string) *PutAccountSettingInput

SetPrincipalArn sets the PrincipalArn field's value.

func (*PutAccountSettingInput) SetValue added in v1.15.77 

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

SetValue sets the Value field's value.

func (PutAccountSettingInput) String added in v1.15.77 

func (s PutAccountSettingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAccountSettingInput) Validate added in v1.15.77 

func (s *PutAccountSettingInput) Validate() error

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

type PutAccountSettingOutput added in v1.15.77 

type PutAccountSettingOutput struct {

	// The current account setting for a resource.
	Setting *Setting `locationName:"setting" type:"structure"`
	// contains filtered or unexported fields
}

func (PutAccountSettingOutput) GoString added in v1.15.77 

func (s PutAccountSettingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAccountSettingOutput) SetSetting added in v1.15.77 

func (s *PutAccountSettingOutput) SetSetting(v *Setting) *PutAccountSettingOutput

SetSetting sets the Setting field's value.

func (PutAccountSettingOutput) String added in v1.15.77 

func (s PutAccountSettingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 for each 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutClusterCapacityProvidersInput added in v1.25.46 

type PutClusterCapacityProvidersInput struct {

	// The name of one or more capacity providers to associate with the cluster.
	//
	// If specifying a capacity provider that uses an Auto Scaling group, the capacity
	// provider must already be created. New capacity providers can be created with
	// the CreateCapacityProvider API operation.
	//
	// To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT
	// capacity providers. The Fargate capacity providers are available to all accounts
	// and only need to be associated with a cluster to be used.
	//
	// CapacityProviders is a required field
	CapacityProviders []*string `locationName:"capacityProviders" type:"list" required:"true"`

	// The short name or full Amazon Resource Name (ARN) of the cluster to modify
	// the capacity provider settings for. If you don't specify a cluster, the default
	// cluster is assumed.
	//
	// Cluster is a required field
	Cluster *string `locationName:"cluster" type:"string" required:"true"`

	// The capacity provider strategy to use by default for the cluster.
	//
	// When creating a service or running a task on a cluster, if no capacity provider
	// or launch type is specified then the default capacity provider strategy for
	// the cluster is used.
	//
	// A capacity provider strategy consists of one or more capacity providers along
	// with the base and weight to assign to them. A capacity provider must be associated
	// with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders
	// API is used to associate a capacity provider with a cluster. Only capacity
	// providers with an ACTIVE or UPDATING status can be used.
	//
	// If specifying a capacity provider that uses an Auto Scaling group, the capacity
	// provider must already be created. New capacity providers can be created with
	// the CreateCapacityProvider API operation.
	//
	// To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT
	// capacity providers. The Fargate capacity providers are available to all accounts
	// and only need to be associated with a cluster to be used.
	//
	// DefaultCapacityProviderStrategy is a required field
	DefaultCapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"defaultCapacityProviderStrategy" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutClusterCapacityProvidersInput) GoString added in v1.25.46 

func (s PutClusterCapacityProvidersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutClusterCapacityProvidersInput) SetCapacityProviders added in v1.25.46 

func (s *PutClusterCapacityProvidersInput) SetCapacityProviders(v []*string) *PutClusterCapacityProvidersInput

SetCapacityProviders sets the CapacityProviders field's value.

func (*PutClusterCapacityProvidersInput) SetCluster added in v1.25.46 

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

SetCluster sets the Cluster field's value.

func (*PutClusterCapacityProvidersInput) SetDefaultCapacityProviderStrategy added in v1.25.46 

func (s *PutClusterCapacityProvidersInput) SetDefaultCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *PutClusterCapacityProvidersInput

SetDefaultCapacityProviderStrategy sets the DefaultCapacityProviderStrategy field's value.

func (PutClusterCapacityProvidersInput) String added in v1.25.46 

func (s PutClusterCapacityProvidersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutClusterCapacityProvidersInput) Validate added in v1.25.46 

func (s *PutClusterCapacityProvidersInput) Validate() error

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

type PutClusterCapacityProvidersOutput added in v1.25.46 

type PutClusterCapacityProvidersOutput struct {

	// Details about the cluster.
	Cluster *Cluster `locationName:"cluster" type:"structure"`
	// contains filtered or unexported fields
}

func (PutClusterCapacityProvidersOutput) GoString added in v1.25.46 

func (s PutClusterCapacityProvidersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutClusterCapacityProvidersOutput) SetCluster added in v1.25.46 

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

SetCluster sets the Cluster field's value.

func (PutClusterCapacityProvidersOutput) String added in v1.25.46 

func (s PutClusterCapacityProvidersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 to register
	// your container instance with. 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 devices that are available on the container instance. The only supported
	// device type is a GPU.
	PlatformDevices []*PlatformDevice `locationName:"platformDevices" type:"list"`

	// The metadata that you apply to the container instance to help you categorize
	// and organize them. Each tag consists of a key and an optional value. You
	// define both.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case-sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for either keys or values as it is reserved for Amazon Web
	//    Services use. You cannot edit or delete tag keys or values with this prefix.
	//    Tags with this prefix do not count against your tags per resource limit.
	Tags []*Tag `locationName:"tags" type:"list"`

	// The resources available on the instance.
	TotalResources []*Resource `locationName:"totalResources" type:"list"`

	// The version information for the Amazon ECS container agent and Docker daemon
	// that runs 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetPlatformDevices added in v1.16.27 

func (s *RegisterContainerInstanceInput) SetPlatformDevices(v []*PlatformDevice) *RegisterContainerInstanceInput

SetPlatformDevices sets the PlatformDevices field's value.

func (*RegisterContainerInstanceInput) SetTags added in v1.15.77 

func (s *RegisterContainerInstanceInput) SetTags(v []*Tag) *RegisterContainerInstanceInput

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. String values are 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 you're 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
	// you do not specify a value, the parameter is ignored.
	//
	// If you're 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:
	//
	// The CPU units cannot be less than 1 vCPU when you use Windows containers
	// on Fargate.
	//
	//    * 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: 4096 (4 GB) and 16384 (16 GB)
	//    in increments of 1024 (1 GB)
	//
	//    * 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB)
	//    in increments of 1024 (1 GB)
	//
	//    * 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
	//    This option requires Linux platform 1.4.0 or later.
	//
	//    * 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
	//    This option requires Linux platform 1.4.0 or later.
	Cpu *string `locationName:"cpu" type:"string"`

	// The amount of ephemeral storage to allocate for the task. This parameter
	// is used to expand the total amount of ephemeral storage available, beyond
	// the default amount, for tasks hosted on Fargate. For more information, see
	// Using data volumes in tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html)
	// in the Amazon ECS Developer Guide.
	//
	// For tasks using the Fargate launch type, the task requires the following
	// platforms:
	//
	//    * Linux platform version 1.4.0 or later.
	//
	//    * Windows platform version 1.0.0 or later.
	EphemeralStorage *EphemeralStorage `locationName:"ephemeralStorage" type:"structure"`

	// The Amazon Resource Name (ARN) of the task execution role that grants the
	// Amazon ECS container agent permission to make Amazon Web Services API calls
	// on your behalf. The task execution IAM role is required depending on the
	// requirements of your task. For more information, see Amazon ECS task execution
	// IAM role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html)
	// in the Amazon Elastic Container Service Developer Guide.
	ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string"`

	// You must specify a family for a task definition. You can use it 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, underscores,
	// and hyphens are allowed.
	//
	// Family is a required field
	Family *string `locationName:"family" type:"string" required:"true"`

	// The Elastic Inference accelerators to use for the containers in the task.
	InferenceAccelerators []*InferenceAccelerator `locationName:"inferenceAccelerators" type:"list"`

	// The IPC resource namespace to use for the containers in the task. The valid
	// values are host, task, or none. If host is specified, then all containers
	// within the tasks that specified the host IPC mode on the same container instance
	// share the same IPC resources with the host Amazon EC2 instance. If task is
	// specified, all containers within the specified task share the same IPC resources.
	// If none is specified, then IPC resources within the containers of a task
	// are private and not shared with other containers in a task or on the container
	// instance. If no value is specified, then the IPC resource namespace sharing
	// depends on the Docker daemon setting on the container instance. For more
	// information, see IPC settings (https://docs.docker.com/engine/reference/run/#ipc-settings---ipc)
	// in the Docker run reference.
	//
	// If the host IPC mode is used, be aware that there is a heightened risk of
	// undesired IPC namespace expose. For more information, see Docker security
	// (https://docs.docker.com/engine/security/security/).
	//
	// If you are setting namespaced kernel parameters using systemControls for
	// the containers in the task, the following will apply to your IPC resource
	// namespace. For more information, see System Controls (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	//    * For tasks that use the host IPC mode, IPC namespace related systemControls
	//    are not supported.
	//
	//    * For tasks that use the task IPC mode, IPC namespace related systemControls
	//    will apply to all containers within a task.
	//
	// This parameter is not supported for Windows containers or tasks run on Fargate.
	IpcMode *string `locationName:"ipcMode" type:"string" enum:"IpcMode"`

	// 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. String values are 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. This determines your range of supported values
	// for the cpu parameter.
	//
	// The CPU units cannot be less than 1 vCPU when you use Windows containers
	// on Fargate.
	//
	//    * 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)
	//
	//    * Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192
	//    (8 vCPU) This option requires Linux platform 1.4.0 or later.
	//
	//    * Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384
	//    (16 vCPU) This option requires Linux platform 1.4.0 or later.
	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. If no network mode is specified,
	// the default is bridge.
	//
	// For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For
	// Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used.
	// For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc
	// can be used. If the network mode is set to none, you cannot specify port
	// mappings in your container definitions, and the tasks 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.
	//
	// When using the host network mode, you should not run containers using the
	// root user (UID 0). It is considered best practice to use a non-root user.
	//
	// If the network mode is awsvpc, the task is allocated an elastic network interface,
	// and you must specify a NetworkConfiguration value when you create a service
	// or run a task with the task definition. For more information, see Task Networking
	// (https://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 cannot run multiple instantiations of the
	// same task on a single container instance when port mappings are used.
	//
	// 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"`

	// The process namespace to use for the containers in the task. The valid values
	// are host or task. On Fargate for Linux containers, the only valid value is
	// task. For example, monitoring sidecars might need pidMode to access information
	// about other containers running in the same task.
	//
	// If host is specified, all containers within the tasks that specified the
	// host PID mode on the same container instance share the same process namespace
	// with the host Amazon EC2 instance.
	//
	// If task is specified, all containers within the specified task share the
	// same process namespace.
	//
	// If no value is specified, the default is a private namespace for each container.
	// For more information, see PID settings (https://docs.docker.com/engine/reference/run/#pid-settings---pid)
	// in the Docker run reference.
	//
	// If the host PID mode is used, there's a heightened risk of undesired process
	// namespace exposure. For more information, see Docker security (https://docs.docker.com/engine/security/security/).
	//
	// This parameter is not supported for Windows containers.
	//
	// This parameter is only supported for tasks that are hosted on Fargate if
	// the tasks are using platform version 1.4.0 or later (Linux). This isn't supported
	// for Windows containers on Fargate.
	PidMode *string `locationName:"pidMode" type:"string" enum:"PidMode"`

	// An array of placement constraint objects to use for the task. You can specify
	// a maximum of 10 constraints for each task. This limit includes constraints
	// in the task definition and those specified at runtime.
	PlacementConstraints []*TaskDefinitionPlacementConstraint `locationName:"placementConstraints" type:"list"`

	// The configuration details for the App Mesh proxy.
	//
	// For tasks hosted on Amazon EC2 instances, the container instances require
	// at least version 1.26.0 of the container agent and at least version 1.26.0-1
	// of the ecs-init package to use a proxy configuration. If your container instances
	// are launched from the Amazon ECS-optimized AMI version 20190301 or later,
	// then they contain the required versions of the container agent and ecs-init.
	// For more information, see Amazon ECS-optimized AMI versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-ami-versions.html)
	// in the Amazon Elastic Container Service Developer Guide.
	ProxyConfiguration *ProxyConfiguration `locationName:"proxyConfiguration" type:"structure"`

	// The task launch type that Amazon ECS validates the task definition against.
	// A client exception is returned if the task definition doesn't validate against
	// the compatibilities specified. If no value is specified, the parameter is
	// omitted from the response.
	RequiresCompatibilities []*string `locationName:"requiresCompatibilities" type:"list" enum:"Compatibility"`

	// The operating system that your tasks definitions run on. A platform family
	// is specified only for tasks using the Fargate launch type.
	RuntimePlatform *RuntimePlatform `locationName:"runtimePlatform" type:"structure"`

	// The metadata that you apply to the task definition to help you categorize
	// and organize them. Each tag consists of a key and an optional value. You
	// define both of them.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case-sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for either keys or values as it is reserved for Amazon Web
	//    Services use. You cannot edit or delete tag keys or values with this prefix.
	//    Tags with this prefix do not count against your tags per resource limit.
	Tags []*Tag `locationName:"tags" 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 (https://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
	// might 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetEphemeralStorage added in v1.38.29 

func (s *RegisterTaskDefinitionInput) SetEphemeralStorage(v *EphemeralStorage) *RegisterTaskDefinitionInput

SetEphemeralStorage sets the EphemeralStorage 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) SetInferenceAccelerators added in v1.23.14 

func (s *RegisterTaskDefinitionInput) SetInferenceAccelerators(v []*InferenceAccelerator) *RegisterTaskDefinitionInput

SetInferenceAccelerators sets the InferenceAccelerators field's value.

func (*RegisterTaskDefinitionInput) SetIpcMode added in v1.15.78 

func (s *RegisterTaskDefinitionInput) SetIpcMode(v string) *RegisterTaskDefinitionInput

SetIpcMode sets the IpcMode 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) SetPidMode added in v1.15.78 

func (s *RegisterTaskDefinitionInput) SetPidMode(v string) *RegisterTaskDefinitionInput

SetPidMode sets the PidMode 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) SetProxyConfiguration added in v1.17.13 

func (s *RegisterTaskDefinitionInput) SetProxyConfiguration(v *ProxyConfiguration) *RegisterTaskDefinitionInput

SetProxyConfiguration sets the ProxyConfiguration 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) SetRuntimePlatform added in v1.41.13 

func (s *RegisterTaskDefinitionInput) SetRuntimePlatform(v *RuntimePlatform) *RegisterTaskDefinitionInput

SetRuntimePlatform sets the RuntimePlatform field's value.

func (*RegisterTaskDefinitionInput) SetTags added in v1.15.77 

func (s *RegisterTaskDefinitionInput) SetTags(v []*Tag) *RegisterTaskDefinitionInput

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 list of tags associated with the task definition.
	Tags []*Tag `locationName:"tags" type:"list"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterTaskDefinitionOutput) SetTags added in v1.15.77 

func (s *RegisterTaskDefinitionOutput) SetTags(v []*Tag) *RegisterTaskDefinitionOutput

SetTags sets the Tags field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RepositoryCredentials added in v1.14.33 

type RepositoryCredentials struct {

	// The Amazon Resource Name (ARN) of the secret containing the private repository
	// credentials.
	//
	// When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the
	// secret exists in the same Region as the task that you're launching then you
	// can use either the full ARN or the name of the secret. When you use the Amazon
	// Web Services Management Console, you must specify the full ARN of the secret.
	//
	// CredentialsParameter is a required field
	CredentialsParameter *string `locationName:"credentialsParameter" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The repository credentials for private registry authentication.

func (RepositoryCredentials) GoString added in v1.14.33 

func (s RepositoryCredentials) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RepositoryCredentials) SetCredentialsParameter added in v1.14.33 

func (s *RepositoryCredentials) SetCredentialsParameter(v string) *RepositoryCredentials

SetCredentialsParameter sets the CredentialsParameter field's value.

func (RepositoryCredentials) String added in v1.14.33 

func (s RepositoryCredentials) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RepositoryCredentials) Validate added in v1.14.33 

func (s *RepositoryCredentials) Validate() error

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

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. Valid values: 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceInUseException added in v1.28.0 

type ResourceInUseException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified resource is in-use and can't be removed.

func (*ResourceInUseException) Code added in v1.28.0 

func (s *ResourceInUseException) Code() string

Code returns the exception type name.

func (*ResourceInUseException) Error added in v1.28.0 

func (s *ResourceInUseException) Error() string

func (ResourceInUseException) GoString added in v1.28.0 

func (s ResourceInUseException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceInUseException) Message added in v1.28.0 

func (s *ResourceInUseException) Message() string

Message returns the exception's message.

func (*ResourceInUseException) OrigErr added in v1.28.0 

func (s *ResourceInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceInUseException) RequestID added in v1.28.0 

func (s *ResourceInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceInUseException) StatusCode added in v1.28.0 

func (s *ResourceInUseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceInUseException) String added in v1.28.0 

func (s ResourceInUseException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified resource wasn't found.

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceRequirement added in v1.16.27 

type ResourceRequirement struct {

	// The type of resource to assign to a container.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"ResourceType"`

	// The value for the specified resource type.
	//
	// When the type is GPU, the value is the number of physical GPUs the Amazon
	// ECS container agent reserves for the container. The number of GPUs that's
	// reserved for all containers in a task can't exceed the number of available
	// GPUs on the container instance that the task is launched on.
	//
	// When the type is InferenceAccelerator, the value matches the deviceName for
	// an InferenceAccelerator (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html)
	// specified in a task definition.
	//
	// Value is a required field
	Value *string `locationName:"value" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html) or Working with Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) in the Amazon Elastic Container Service Developer Guide

func (ResourceRequirement) GoString added in v1.16.27 

func (s ResourceRequirement) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceRequirement) SetType added in v1.16.27 

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

SetType sets the Type field's value.

func (*ResourceRequirement) SetValue added in v1.16.27 

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

SetValue sets the Value field's value.

func (ResourceRequirement) String added in v1.16.27 

func (s ResourceRequirement) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceRequirement) Validate added in v1.16.27 

func (s *ResourceRequirement) Validate() error

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

type RunTaskInput 

type RunTaskInput struct {

	// The capacity provider strategy to use for the task.
	//
	// If a capacityProviderStrategy is specified, the launchType parameter must
	// be omitted. If no capacityProviderStrategy or launchType is specified, the
	// defaultCapacityProviderStrategy for the cluster is used.
	//
	// When you use cluster auto scaling, you must specify capacityProviderStrategy
	// and not launchType.
	//
	// A capacity provider strategy may contain a maximum of 6 capacity providers.
	CapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"capacityProviderStrategy" type:"list"`

	// An identifier that you provide to ensure the idempotency of the request.
	// It must be unique and is case sensitive. Up to 64 characters are allowed.
	// The valid characters are characters in the range of 33-126, inclusive. For
	// more information, see Ensuring idempotency (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/ECS_Idempotency.html).
	ClientToken *string `locationName:"clientToken" type:"string" idempotencyToken:"true"`

	// The short name or full Amazon Resource Name (ARN) of the cluster to run your
	// task on. 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 for each call.
	Count *int64 `locationName:"count" type:"integer"`

	// Specifies whether to use Amazon ECS managed tags for the task. For more information,
	// see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html)
	// in the Amazon Elastic Container Service Developer Guide.
	EnableECSManagedTags *bool `locationName:"enableECSManagedTags" type:"boolean"`

	// Determines whether to use the execute command functionality for the containers
	// in this task. If true, this enables execute command functionality on all
	// containers in the task.
	//
	// If true, then the task definition must have a task role, or you must provide
	// one as an override.
	EnableExecuteCommand *bool `locationName:"enableExecuteCommand" type:"boolean"`

	// 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 infrastructure to run your standalone task on. For more information,
	// see Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.
	//
	// Fargate Spot infrastructure is available for use but a capacity provider
	// strategy must be used. For more information, see Fargate capacity providers
	// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-capacity-providers.html)
	// in the Amazon ECS Developer Guide.
	//
	// The EC2 launch type runs your tasks on Amazon EC2 instances registered to
	// your cluster.
	//
	// The EXTERNAL launch type runs your tasks on your on-premises server or virtual
	// machine (VM) capacity registered to your cluster.
	//
	// A task can use either a launch type or a capacity provider strategy. If a
	// launchType is specified, the capacityProviderStrategy parameter must be omitted.
	//
	// When you use cluster auto scaling, you must specify capacityProviderStrategy
	// and not launchType.
	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 isn't supported for other network modes. For more
	// information, see Task networking (https://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's 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 for each task (including constraints in the task definition
	// and those specified at runtime).
	PlacementConstraints []*PlacementConstraint `locationName:"placementConstraints" type:"list"`

	// The placement strategy objects to use for the task. You can specify a maximum
	// of 5 strategy rules for each task.
	PlacementStrategy []*PlacementStrategy `locationName:"placementStrategy" type:"list"`

	// The platform version the task uses. A platform version is only specified
	// for tasks hosted on Fargate. If one isn't specified, the LATEST platform
	// version is used. For more information, see Fargate platform versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
	// in the Amazon Elastic Container Service Developer Guide.
	PlatformVersion *string `locationName:"platformVersion" type:"string"`

	// Specifies whether to propagate the tags from the task definition to the task.
	// If no value is specified, the tags aren't propagated. Tags can only be propagated
	// to the task during task creation. To add tags to a task after task creation,
	// use the TagResource API action.
	//
	// An error will be received if you specify the SERVICE option when running
	// a task.
	PropagateTags *string `locationName:"propagateTags" type:"string" enum:"PropagateTags"`

	// The reference ID to use for the task. The reference ID can have a maximum
	// length of 1024 characters.
	ReferenceId *string `locationName:"referenceId" 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 128 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 metadata that you apply to the task to help you categorize and organize
	// them. Each tag consists of a key and an optional value, both of which you
	// define.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case-sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for either keys or values as it is reserved for Amazon Web
	//    Services use. You cannot edit or delete tag keys or values with this prefix.
	//    Tags with this prefix do not count against your tags per resource limit.
	Tags []*Tag `locationName:"tags" type:"list"`

	// The family and revision (family:revision) or full ARN of the task definition
	// to run. If a revision isn't specified, the latest ACTIVE revision is used.
	//
	// The full ARN value must match the value that you specified as the Resource
	// of the principal's permissions policy.
	//
	// When you specify a task definition, you must either specify a specific revision,
	// or all revisions in the ARN.
	//
	// To specify a specific revision, include the revision number in the ARN. For
	// example, to specify revision 2, use arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2.
	//
	// To specify all revisions, use the wildcard (*) in the ARN. For example, to
	// specify all revisions, use arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*.
	//
	// For more information, see Policy Resources for Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-resources)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// TaskDefinition is a required field
	TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"`

	// The details of the volume that was configuredAtLaunch. You can configure
	// the size, volumeType, IOPS, throughput, snapshot and encryption in in TaskManagedEBSVolumeConfiguration
	// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskManagedEBSVolumeConfiguration.html).
	// The name of the volume must match the name from the task definition.
	VolumeConfigurations []*TaskVolumeConfiguration `locationName:"volumeConfigurations" type:"list"`
	// contains filtered or unexported fields
}

func (RunTaskInput) GoString added in v0.6.5 

func (s RunTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RunTaskInput) SetCapacityProviderStrategy added in v1.25.46 

func (s *RunTaskInput) SetCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *RunTaskInput

SetCapacityProviderStrategy sets the CapacityProviderStrategy field's value.

func (*RunTaskInput) SetClientToken added in v1.47.10 

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

SetClientToken sets the ClientToken field's value.

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) SetEnableECSManagedTags added in v1.15.77 

func (s *RunTaskInput) SetEnableECSManagedTags(v bool) *RunTaskInput

SetEnableECSManagedTags sets the EnableECSManagedTags field's value.

func (*RunTaskInput) SetEnableExecuteCommand added in v1.37.31 

func (s *RunTaskInput) SetEnableExecuteCommand(v bool) *RunTaskInput

SetEnableExecuteCommand sets the EnableExecuteCommand 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) SetPropagateTags added in v1.15.77 

func (s *RunTaskInput) SetPropagateTags(v string) *RunTaskInput

SetPropagateTags sets the PropagateTags field's value.

func (*RunTaskInput) SetReferenceId added in v1.25.39 

func (s *RunTaskInput) SetReferenceId(v string) *RunTaskInput

SetReferenceId sets the ReferenceId 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) SetTags added in v1.15.77 

func (s *RunTaskInput) SetTags(v []*Tag) *RunTaskInput

SetTags sets the Tags 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) SetVolumeConfigurations added in v1.49.19 

func (s *RunTaskInput) SetVolumeConfigurations(v []*TaskVolumeConfiguration) *RunTaskInput

SetVolumeConfigurations sets the VolumeConfigurations field's value.

func (RunTaskInput) String added in v0.6.5 

func (s RunTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// For information about how to address failures, see Service event messages
	// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages.html#service-event-messages-list)
	// and API failure reasons (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html)
	// in the Amazon Elastic Container Service Developer Guide.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuntimePlatform added in v1.41.13 

type RuntimePlatform struct {

	// The CPU architecture.
	//
	// You can run your Linux tasks on an ARM-based platform by setting the value
	// to ARM64. This option is available for tasks that run on Linux Amazon EC2
	// instance or Linux containers on Fargate.
	CpuArchitecture *string `locationName:"cpuArchitecture" type:"string" enum:"CPUArchitecture"`

	// The operating system.
	OperatingSystemFamily *string `locationName:"operatingSystemFamily" type:"string" enum:"OSFamily"`
	// contains filtered or unexported fields
}

Information about the platform for the Amazon ECS service or task.

For more information about RuntimePlatform, see RuntimePlatform (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform) in the Amazon Elastic Container Service Developer Guide.

func (RuntimePlatform) GoString added in v1.41.13 

func (s RuntimePlatform) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuntimePlatform) SetCpuArchitecture added in v1.41.13 

func (s *RuntimePlatform) SetCpuArchitecture(v string) *RuntimePlatform

SetCpuArchitecture sets the CpuArchitecture field's value.

func (*RuntimePlatform) SetOperatingSystemFamily added in v1.41.13 

func (s *RuntimePlatform) SetOperatingSystemFamily(v string) *RuntimePlatform

SetOperatingSystemFamily sets the OperatingSystemFamily field's value.

func (RuntimePlatform) String added in v1.41.13 

func (s RuntimePlatform) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Scale added in v1.15.84 

type Scale struct {

	// The unit of measure for the scale value.
	Unit *string `locationName:"unit" type:"string" enum:"ScaleUnit"`

	// The value, specified as a percent total of a service's desiredCount, to scale
	// the task set. Accepted values are numbers between 0 and 100.
	Value *float64 `locationName:"value" type:"double"`
	// contains filtered or unexported fields
}

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

func (Scale) GoString added in v1.15.84 

func (s Scale) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Scale) SetUnit added in v1.15.84 

func (s *Scale) SetUnit(v string) *Scale

SetUnit sets the Unit field's value.

func (*Scale) SetValue added in v1.15.84 

func (s *Scale) SetValue(v float64) *Scale

SetValue sets the Value field's value.

func (Scale) String added in v1.15.84 

func (s Scale) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Secret added in v1.15.77 

type Secret struct {

	// The name of the secret.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The secret to expose to the container. The supported values are either the
	// full ARN of the Secrets Manager secret or the full ARN of the parameter in
	// the SSM Parameter Store.
	//
	// For information about the require Identity and Access Management permissions,
	// see Required IAM permissions for Amazon ECS secrets (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam)
	// (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets
	// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html)
	// (for Systems Manager Parameter store) in the Amazon Elastic Container Service
	// Developer Guide.
	//
	// If the SSM Parameter Store parameter exists in the same Region as the task
	// you're launching, then you can use either the full ARN or name of the parameter.
	// If the parameter exists in a different Region, then the full ARN must be
	// specified.
	//
	// ValueFrom is a required field
	ValueFrom *string `locationName:"valueFrom" type:"string" required:"true"`
	// contains filtered or unexported fields
}

An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:

  • To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.

  • To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.

For more information, see Specifying sensitive data (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the Amazon Elastic Container Service Developer Guide.

func (Secret) GoString added in v1.15.77 

func (s Secret) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Secret) SetName added in v1.15.77 

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

SetName sets the Name field's value.

func (*Secret) SetValueFrom added in v1.15.77 

func (s *Secret) SetValueFrom(v string) *Secret

SetValueFrom sets the ValueFrom field's value.

func (Secret) String added in v1.15.77 

func (s Secret) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Secret) Validate added in v1.15.77 

func (s *Secret) Validate() error

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

type ServerException added in v1.28.0 

type ServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Message that describes the cause of the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

These errors are usually caused by a server issue.

func (*ServerException) Code added in v1.28.0 

func (s *ServerException) Code() string

Code returns the exception type name.

func (*ServerException) Error added in v1.28.0 

func (s *ServerException) Error() string

func (ServerException) GoString added in v1.28.0 

func (s ServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServerException) Message added in v1.28.0 

func (s *ServerException) Message() string

Message returns the exception's message.

func (*ServerException) OrigErr added in v1.28.0 

func (s *ServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServerException) RequestID added in v1.28.0 

func (s *ServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServerException) StatusCode added in v1.28.0 

func (s *ServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServerException) String added in v1.28.0 

func (s ServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Service 

type Service struct {

	// The capacity provider strategy the service uses. When using the DescribeServices
	// API, this field is omitted if the service was created using a launch type.
	CapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"capacityProviderStrategy" type:"list"`

	// The Amazon Resource Name (ARN) of the cluster that hosts the service.
	ClusterArn *string `locationName:"clusterArn" type:"string"`

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

	// The principal that created the service.
	CreatedBy *string `locationName:"createdBy" 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 deployment controller type the service is using.
	DeploymentController *DeploymentController `locationName:"deploymentController" 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"`

	// Determines whether to use Amazon ECS managed tags for the tasks in the service.
	// For more information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html)
	// in the Amazon Elastic Container Service Developer Guide.
	EnableECSManagedTags *bool `locationName:"enableECSManagedTags" type:"boolean"`

	// Determines whether the execute command functionality is turned on for the
	// service. If true, the execute command functionality is turned on for all
	// containers in tasks as part of the service.
	EnableExecuteCommand *bool `locationName:"enableExecuteCommand" type:"boolean"`

	// 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 the service is using. When using the DescribeServices API,
	// this field is omitted if the service was created using a capacity provider
	// strategy.
	LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"`

	// A list of Elastic Load Balancing load balancer objects. It contains the load
	// balancer name, the container name, and the container port to access from
	// the load balancer. The container name is as it appears in a container definition.
	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 operating system that your tasks in the service run on. A platform family
	// is specified only for tasks using the Fargate launch type.
	//
	// All tasks that run as part of this service must use the same platformFamily
	// value as the service (for example, LINUX).
	PlatformFamily *string `locationName:"platformFamily" type:"string"`

	// The platform version to run your service on. A platform version is only specified
	// for tasks that are hosted on Fargate. If one isn't specified, the LATEST
	// platform version is used. For more information, see Fargate Platform Versions
	// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
	// in the Amazon Elastic Container Service Developer Guide.
	PlatformVersion *string `locationName:"platformVersion" type:"string"`

	// Determines whether to propagate the tags from the task definition or the
	// service to the task. If no value is specified, the tags aren't propagated.
	PropagateTags *string `locationName:"propagateTags" type:"string" enum:"PropagateTags"`

	// The ARN of the IAM role that's associated with the service. It 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_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. This task meets all of the task placement constraints
	//    that you specify in your cluster. The service scheduler also evaluates
	//    the task placement constraints for running tasks. It stop tasks that don't
	//    meet the placement constraints. Fargate tasks don't support the DAEMON
	//    scheduling strategy.
	SchedulingStrategy *string `locationName:"schedulingStrategy" type:"string" enum:"SchedulingStrategy"`

	// The ARN that identifies the service. For more information about the ARN format,
	// see Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids)
	// in the Amazon ECS Developer Guide.
	ServiceArn *string `locationName:"serviceArn" type:"string"`

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

	// The details for the service discovery registries to assign to this service.
	// For more information, see Service Discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).
	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 metadata that you apply to the service to help you categorize and organize
	// them. Each tag consists of a key and an optional value. You define bot the
	// key and value.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case-sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for either keys or values as it is reserved for Amazon Web
	//    Services use. You cannot edit or delete tag keys or values with this prefix.
	//    Tags with this prefix do not count against your tags per resource limit.
	Tags []*Tag `locationName:"tags" type:"list"`

	// 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"`

	// Information about a set of Amazon ECS tasks in either an CodeDeploy or an
	// EXTERNAL deployment. An Amazon ECS task set includes details such as the
	// desired number of tasks, how many tasks are running, and whether the task
	// set serves production traffic.
	TaskSets []*TaskSet `locationName:"taskSets" type:"list"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Service) SetCapacityProviderStrategy added in v1.25.46 

func (s *Service) SetCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *Service

SetCapacityProviderStrategy sets the CapacityProviderStrategy field's value.

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) SetCreatedBy added in v1.15.77 

func (s *Service) SetCreatedBy(v string) *Service

SetCreatedBy sets the CreatedBy 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) SetDeploymentController added in v1.15.84 

func (s *Service) SetDeploymentController(v *DeploymentController) *Service

SetDeploymentController sets the DeploymentController 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) SetEnableECSManagedTags added in v1.15.77 

func (s *Service) SetEnableECSManagedTags(v bool) *Service

SetEnableECSManagedTags sets the EnableECSManagedTags field's value.

func (*Service) SetEnableExecuteCommand added in v1.37.31 

func (s *Service) SetEnableExecuteCommand(v bool) *Service

SetEnableExecuteCommand sets the EnableExecuteCommand 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) SetPlatformFamily added in v1.41.13 

func (s *Service) SetPlatformFamily(v string) *Service

SetPlatformFamily sets the PlatformFamily 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) SetPropagateTags added in v1.15.77 

func (s *Service) SetPropagateTags(v string) *Service

SetPropagateTags sets the PropagateTags 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) SetTags added in v1.15.77 

func (s *Service) SetTags(v []*Tag) *Service

SetTags sets the Tags 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) SetTaskSets added in v1.15.84 

func (s *Service) SetTaskSets(v []*TaskSet) *Service

SetTaskSets sets the TaskSets field's value.

func (Service) String added in v0.6.5 

func (s Service) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceConnectClientAlias added in v1.44.146 

type ServiceConnectClientAlias struct {

	// The dnsName is the name that you use in the applications of client tasks
	// to connect to this service. The name must be a valid DNS name but doesn't
	// need to be fully-qualified. The name can include up to 127 characters. The
	// name can include lowercase letters, numbers, underscores (_), hyphens (-),
	// and periods (.). The name can't start with a hyphen.
	//
	// If this parameter isn't specified, the default value of discoveryName.namespace
	// is used. If the discoveryName isn't specified, the port mapping name from
	// the task definition is used in portName.namespace.
	//
	// To avoid changing your applications in client Amazon ECS services, set this
	// to the same name that the client application uses by default. For example,
	// a few common names are database, db, or the lowercase name of a database,
	// such as mysql or redis. For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
	// in the Amazon Elastic Container Service Developer Guide.
	DnsName *string `locationName:"dnsName" type:"string"`

	// The listening port number for the Service Connect proxy. This port is available
	// inside of all of the tasks within the same namespace.
	//
	// To avoid changing your applications in client Amazon ECS services, set this
	// to the same port that the client application uses by default. For more information,
	// see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// Port is a required field
	Port *int64 `locationName:"port" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Each alias ("endpoint") is a fully-qualified name and port number that other tasks ("clients") can use to connect to this service.

Each name and port mapping must be unique within the namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the Amazon Elastic Container Service Developer Guide.

func (ServiceConnectClientAlias) GoString added in v1.44.146 

func (s ServiceConnectClientAlias) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceConnectClientAlias) SetDnsName added in v1.44.146 

func (s *ServiceConnectClientAlias) SetDnsName(v string) *ServiceConnectClientAlias

SetDnsName sets the DnsName field's value.

func (*ServiceConnectClientAlias) SetPort added in v1.44.146 

func (s *ServiceConnectClientAlias) SetPort(v int64) *ServiceConnectClientAlias

SetPort sets the Port field's value.

func (ServiceConnectClientAlias) String added in v1.44.146 

func (s ServiceConnectClientAlias) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceConnectClientAlias) Validate added in v1.44.146 

func (s *ServiceConnectClientAlias) Validate() error

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

type ServiceConnectConfiguration added in v1.44.146 

type ServiceConnectConfiguration struct {

	// Specifies whether to use Service Connect with this service.
	//
	// Enabled is a required field
	Enabled *bool `locationName:"enabled" type:"boolean" required:"true"`

	// The log configuration for the container. This parameter maps to LogConfig
	// in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
	// and the --log-driver option to docker run (https://docs.docker.com/engine/reference/commandline/run/).
	//
	// By default, containers use the same logging driver that the Docker daemon
	// uses. However, the container might use a different logging driver than the
	// Docker daemon by specifying a log driver configuration in the container definition.
	// For more information about the options for different supported log drivers,
	// see Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/)
	// in the Docker documentation.
	//
	// Understand the following when specifying a log configuration for your containers.
	//
	//    * Amazon ECS currently supports a subset of the logging drivers available
	//    to the Docker daemon. Additional log drivers may be available in future
	//    releases of the Amazon ECS container agent. For tasks on Fargate, the
	//    supported log drivers are awslogs, splunk, and awsfirelens. For tasks
	//    hosted on Amazon EC2 instances, the supported log drivers are awslogs,
	//    fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.
	//
	//    * This parameter requires version 1.18 of the Docker Remote API or greater
	//    on your container instance.
	//
	//    * For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container
	//    agent must register the available logging drivers 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)
	//    in the Amazon Elastic Container Service Developer Guide.
	//
	//    * For tasks that are on Fargate, because you don't have access to the
	//    underlying infrastructure your tasks are hosted on, any additional software
	//    needed must be installed outside of the task. For example, the Fluentd
	//    output aggregators or a remote host running Logstash to send Gelf logs
	//    to.
	LogConfiguration *LogConfiguration `locationName:"logConfiguration" type:"structure"`

	// The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace
	// for use with Service Connect. The namespace must be in the same Amazon Web
	// Services Region as the Amazon ECS service and cluster. The type of namespace
	// doesn't affect Service Connect. For more information about Cloud Map, see
	// Working with Services (https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html)
	// in the Cloud Map Developer Guide.
	Namespace *string `locationName:"namespace" type:"string"`

	// The list of Service Connect service objects. These are names and aliases
	// (also known as endpoints) that are used by other Amazon ECS services to connect
	// to this service.
	//
	// This field is not required for a "client" Amazon ECS service that's a member
	// of a namespace only to connect to other services within the namespace. An
	// example of this would be a frontend application that accepts incoming requests
	// from either a load balancer that's attached to the service or by other means.
	//
	// An object selects a port from the task definition, assigns a name for the
	// Cloud Map service, and a list of aliases (endpoints) and ports for client
	// applications to refer to this service.
	Services []*ServiceConnectService `locationName:"services" type:"list"`
	// contains filtered or unexported fields
}

The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the Amazon Elastic Container Service Developer Guide.

func (ServiceConnectConfiguration) GoString added in v1.44.146 

func (s ServiceConnectConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceConnectConfiguration) SetEnabled added in v1.44.146 

func (s *ServiceConnectConfiguration) SetEnabled(v bool) *ServiceConnectConfiguration

SetEnabled sets the Enabled field's value.

func (*ServiceConnectConfiguration) SetLogConfiguration added in v1.44.146 

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

SetLogConfiguration sets the LogConfiguration field's value.

func (*ServiceConnectConfiguration) SetNamespace added in v1.44.146 

func (s *ServiceConnectConfiguration) SetNamespace(v string) *ServiceConnectConfiguration

SetNamespace sets the Namespace field's value.

func (*ServiceConnectConfiguration) SetServices added in v1.44.146 

func (s *ServiceConnectConfiguration) SetServices(v []*ServiceConnectService) *ServiceConnectConfiguration

SetServices sets the Services field's value.

func (ServiceConnectConfiguration) String added in v1.44.146 

func (s ServiceConnectConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceConnectConfiguration) Validate added in v1.44.146 

func (s *ServiceConnectConfiguration) Validate() error

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

type ServiceConnectService added in v1.44.146 

type ServiceConnectService struct {

	// The list of client aliases for this Service Connect service. You use these
	// to assign names that can be used by client applications. The maximum number
	// of client aliases that you can have in this list is 1.
	//
	// Each alias ("endpoint") is a fully-qualified name and port number that other
	// Amazon ECS tasks ("clients") can use to connect to this service.
	//
	// Each name and port mapping must be unique within the namespace.
	//
	// For each ServiceConnectService, you must provide at least one clientAlias
	// with one port.
	ClientAliases []*ServiceConnectClientAlias `locationName:"clientAliases" type:"list"`

	// The discoveryName is the name of the new Cloud Map service that Amazon ECS
	// creates for this Amazon ECS service. This must be unique within the Cloud
	// Map namespace. The name can contain up to 64 characters. The name can include
	// lowercase letters, numbers, underscores (_), and hyphens (-). The name can't
	// start with a hyphen.
	//
	// If the discoveryName isn't specified, the port mapping name from the task
	// definition is used in portName.namespace.
	DiscoveryName *string `locationName:"discoveryName" type:"string"`

	// The port number for the Service Connect proxy to listen on.
	//
	// Use the value of this field to bypass the proxy for traffic on the port number
	// specified in the named portMapping in the task definition of this application,
	// and then use it in your VPC security groups to allow traffic into the proxy
	// for this Amazon ECS service.
	//
	// In awsvpc mode and Fargate, the default value is the container port number.
	// The container port number is in the portMapping in the task definition. In
	// bridge mode, the default value is the ephemeral port of the Service Connect
	// proxy.
	IngressPortOverride *int64 `locationName:"ingressPortOverride" type:"integer"`

	// The portName must match the name of one of the portMappings from all the
	// containers in the task definition of this Amazon ECS service.
	//
	// PortName is a required field
	PortName *string `locationName:"portName" type:"string" required:"true"`

	// A reference to an object that represents the configured timeouts for Service
	// Connect.
	Timeout *TimeoutConfiguration `locationName:"timeout" type:"structure"`

	// A reference to an object that represents a Transport Layer Security (TLS)
	// configuration.
	Tls *ServiceConnectTlsConfiguration `locationName:"tls" type:"structure"`
	// contains filtered or unexported fields
}

The Service Connect service object configuration. For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the Amazon Elastic Container Service Developer Guide.

func (ServiceConnectService) GoString added in v1.44.146 

func (s ServiceConnectService) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceConnectService) SetClientAliases added in v1.44.146 

func (s *ServiceConnectService) SetClientAliases(v []*ServiceConnectClientAlias) *ServiceConnectService

SetClientAliases sets the ClientAliases field's value.

func (*ServiceConnectService) SetDiscoveryName added in v1.44.146 

func (s *ServiceConnectService) SetDiscoveryName(v string) *ServiceConnectService

SetDiscoveryName sets the DiscoveryName field's value.

func (*ServiceConnectService) SetIngressPortOverride added in v1.44.146 

func (s *ServiceConnectService) SetIngressPortOverride(v int64) *ServiceConnectService

SetIngressPortOverride sets the IngressPortOverride field's value.

func (*ServiceConnectService) SetPortName added in v1.44.146 

func (s *ServiceConnectService) SetPortName(v string) *ServiceConnectService

SetPortName sets the PortName field's value.

func (*ServiceConnectService) SetTimeout added in v1.50.1 

func (s *ServiceConnectService) SetTimeout(v *TimeoutConfiguration) *ServiceConnectService

SetTimeout sets the Timeout field's value.

func (*ServiceConnectService) SetTls added in v1.50.1 

func (s *ServiceConnectService) SetTls(v *ServiceConnectTlsConfiguration) *ServiceConnectService

SetTls sets the Tls field's value.

func (ServiceConnectService) String added in v1.44.146 

func (s ServiceConnectService) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceConnectService) Validate added in v1.44.146 

func (s *ServiceConnectService) Validate() error

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

type ServiceConnectServiceResource added in v1.44.146 

type ServiceConnectServiceResource struct {

	// The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches
	// the discovery name for this Service Connect resource. You can use this ARN
	// in other integrations with Cloud Map. However, Service Connect can't ensure
	// connectivity outside of Amazon ECS.
	DiscoveryArn *string `locationName:"discoveryArn" type:"string"`

	// The discovery name of this Service Connect resource.
	//
	// The discoveryName is the name of the new Cloud Map service that Amazon ECS
	// creates for this Amazon ECS service. This must be unique within the Cloud
	// Map namespace. The name can contain up to 64 characters. The name can include
	// lowercase letters, numbers, underscores (_), and hyphens (-). The name can't
	// start with a hyphen.
	//
	// If the discoveryName isn't specified, the port mapping name from the task
	// definition is used in portName.namespace.
	DiscoveryName *string `locationName:"discoveryName" type:"string"`
	// contains filtered or unexported fields
}

The Service Connect resource. Each configuration maps a discovery name to a Cloud Map service name. The data is stored in Cloud Map as part of the Service Connect configuration for each discovery name of this Amazon ECS service.

A task can resolve the dnsName for each of the clientAliases of a service. However a task can't resolve the discovery names. If you want to connect to a service, refer to the ServiceConnectConfiguration of that service for the list of clientAliases that you can use.

func (ServiceConnectServiceResource) GoString added in v1.44.146 

func (s ServiceConnectServiceResource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceConnectServiceResource) SetDiscoveryArn added in v1.44.146 

func (s *ServiceConnectServiceResource) SetDiscoveryArn(v string) *ServiceConnectServiceResource

SetDiscoveryArn sets the DiscoveryArn field's value.

func (*ServiceConnectServiceResource) SetDiscoveryName added in v1.44.146 

func (s *ServiceConnectServiceResource) SetDiscoveryName(v string) *ServiceConnectServiceResource

SetDiscoveryName sets the DiscoveryName field's value.

func (ServiceConnectServiceResource) String added in v1.44.146 

func (s ServiceConnectServiceResource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceConnectTlsCertificateAuthority added in v1.50.1 

type ServiceConnectTlsCertificateAuthority struct {

	// The ARN of the Amazon Web Services Private Certificate Authority certificate.
	AwsPcaAuthorityArn *string `locationName:"awsPcaAuthorityArn" type:"string"`
	// contains filtered or unexported fields
}

The certificate root authority that secures your service.

func (ServiceConnectTlsCertificateAuthority) GoString added in v1.50.1 

func (s ServiceConnectTlsCertificateAuthority) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceConnectTlsCertificateAuthority) SetAwsPcaAuthorityArn added in v1.50.1 

func (s *ServiceConnectTlsCertificateAuthority) SetAwsPcaAuthorityArn(v string) *ServiceConnectTlsCertificateAuthority

SetAwsPcaAuthorityArn sets the AwsPcaAuthorityArn field's value.

func (ServiceConnectTlsCertificateAuthority) String added in v1.50.1 

func (s ServiceConnectTlsCertificateAuthority) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceConnectTlsConfiguration added in v1.50.1 

type ServiceConnectTlsConfiguration struct {

	// The signer certificate authority.
	//
	// IssuerCertificateAuthority is a required field
	IssuerCertificateAuthority *ServiceConnectTlsCertificateAuthority `locationName:"issuerCertificateAuthority" type:"structure" required:"true"`

	// The Amazon Web Services Key Management Service key.
	KmsKey *string `locationName:"kmsKey" type:"string"`

	// The Amazon Resource Name (ARN) of the IAM role that's associated with the
	// Service Connect TLS.
	RoleArn *string `locationName:"roleArn" type:"string"`
	// contains filtered or unexported fields
}

The key that encrypts and decrypts your resources for Service Connect TLS.

func (ServiceConnectTlsConfiguration) GoString added in v1.50.1 

func (s ServiceConnectTlsConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceConnectTlsConfiguration) SetIssuerCertificateAuthority added in v1.50.1 

func (s *ServiceConnectTlsConfiguration) SetIssuerCertificateAuthority(v *ServiceConnectTlsCertificateAuthority) *ServiceConnectTlsConfiguration

SetIssuerCertificateAuthority sets the IssuerCertificateAuthority field's value.

func (*ServiceConnectTlsConfiguration) SetKmsKey added in v1.50.1 

func (s *ServiceConnectTlsConfiguration) SetKmsKey(v string) *ServiceConnectTlsConfiguration

SetKmsKey sets the KmsKey field's value.

func (*ServiceConnectTlsConfiguration) SetRoleArn added in v1.50.1 

func (s *ServiceConnectTlsConfiguration) SetRoleArn(v string) *ServiceConnectTlsConfiguration

SetRoleArn sets the RoleArn field's value.

func (ServiceConnectTlsConfiguration) String added in v1.50.1 

func (s ServiceConnectTlsConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceConnectTlsConfiguration) Validate added in v1.50.1 

func (s *ServiceConnectTlsConfiguration) Validate() error

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

type ServiceEvent 

type ServiceEvent struct {

	// The Unix timestamp for the time when the event was triggered.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The ID string for the event.
	Id *string `locationName:"id" type:"string"`

	// The event message.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The details for an event that's associated with a service.

func (ServiceEvent) GoString added in v0.6.5 

func (s ServiceEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceManagedEBSVolumeConfiguration added in v1.49.19 

type ServiceManagedEBSVolumeConfiguration struct {

	// Indicates whether the volume should be encrypted. If no value is specified,
	// encryption is turned on by default. This parameter maps 1:1 with the Encrypted
	// parameter of the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html)
	// in the Amazon EC2 API Reference.
	Encrypted *bool `locationName:"encrypted" type:"boolean"`

	// The Linux filesystem type for the volume. For volumes created from a snapshot,
	// you must specify the same filesystem type that the volume was using when
	// the snapshot was created. If there is a filesystem type mismatch, the task
	// will fail to start.
	//
	// The available filesystem types are ext3, ext4, and xfs. If no value is specified,
	// the xfs filesystem type is used by default.
	FilesystemType *string `locationName:"filesystemType" type:"string" enum:"TaskFilesystemType"`

	// The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes,
	// this represents the number of IOPS that are provisioned for the volume. For
	// gp2 volumes, this represents the baseline performance of the volume and the
	// rate at which the volume accumulates I/O credits for bursting.
	//
	// The following are the supported values for each volume type.
	//
	//    * gp3: 3,000 - 16,000 IOPS
	//
	//    * io1: 100 - 64,000 IOPS
	//
	//    * io2: 100 - 256,000 IOPS
	//
	// This parameter is required for io1 and io2 volume types. The default for
	// gp3 volumes is 3,000 IOPS. This parameter is not supported for st1, sc1,
	// or standard volume types.
	//
	// This parameter maps 1:1 with the Iops parameter of the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html)
	// in the Amazon EC2 API Reference.
	Iops *int64 `locationName:"iops" type:"integer"`

	// The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key
	// Management Service key to use for Amazon EBS encryption. When encryption
	// is turned on and no Amazon Web Services Key Management Service key is specified,
	// the default Amazon Web Services managed key for Amazon EBS volumes is used.
	// This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API
	// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html)
	// in the Amazon EC2 API Reference.
	//
	// Amazon Web Services authenticates the Amazon Web Services Key Management
	// Service key asynchronously. Therefore, if you specify an ID, alias, or ARN
	// that is invalid, the action can appear to complete, but eventually fails.
	KmsKeyId *string `locationName:"kmsKeyId" type:"string"`

	// The ARN of the IAM role to associate with this volume. This is the Amazon
	// ECS infrastructure IAM role that is used to manage your Amazon Web Services
	// infrastructure. We recommend using the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes
	// IAM policy with this role. For more information, see Amazon ECS infrastructure
	// IAM role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html)
	// in the Amazon ECS Developer Guide.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The size of the volume in GiB. You must specify either a volume size or a
	// snapshot ID. If you specify a snapshot ID, the snapshot size is used for
	// the volume size by default. You can optionally specify a volume size greater
	// than or equal to the snapshot size. This parameter maps 1:1 with the Size
	// parameter of the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html)
	// in the Amazon EC2 API Reference.
	//
	// The following are the supported volume size values for each volume type.
	//
	//    * gp2 and gp3: 1-16,384
	//
	//    * io1 and io2: 4-16,384
	//
	//    * st1 and sc1: 125-16,384
	//
	//    * standard: 1-1,024
	SizeInGiB *int64 `locationName:"sizeInGiB" type:"integer"`

	// The snapshot that Amazon ECS uses to create the volume. You must specify
	// either a snapshot ID or a volume size. This parameter maps 1:1 with the SnapshotId
	// parameter of the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html)
	// in the Amazon EC2 API Reference.
	SnapshotId *string `locationName:"snapshotId" type:"string"`

	// The tags to apply to the volume. Amazon ECS applies service-managed tags
	// by default. This parameter maps 1:1 with the TagSpecifications.N parameter
	// of the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html)
	// in the Amazon EC2 API Reference.
	TagSpecifications []*EBSTagSpecification `locationName:"tagSpecifications" type:"list"`

	// The throughput to provision for a volume, in MiB/s, with a maximum of 1,000
	// MiB/s. This parameter maps 1:1 with the Throughput parameter of the CreateVolume
	// API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html)
	// in the Amazon EC2 API Reference.
	//
	// This parameter is only supported for the gp3 volume type.
	Throughput *int64 `locationName:"throughput" type:"integer"`

	// The volume type. This parameter maps 1:1 with the VolumeType parameter of
	// the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html)
	// in the Amazon EC2 API Reference. For more information, see Amazon EBS volume
	// types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html)
	// in the Amazon EC2 User Guide.
	//
	// The following are the supported volume types.
	//
	//    * General Purpose SSD: gp2|gp3
	//
	//    * Provisioned IOPS SSD: io1|io2
	//
	//    * Throughput Optimized HDD: st1
	//
	//    * Cold HDD: sc1
	//
	//    * Magnetic: standard The magnetic volume type is not supported on Fargate.
	VolumeType *string `locationName:"volumeType" type:"string"`
	// contains filtered or unexported fields
}

The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service.

Many of these parameters map 1:1 with the Amazon EBS CreateVolume API request parameters.

func (ServiceManagedEBSVolumeConfiguration) GoString added in v1.49.19 

func (s ServiceManagedEBSVolumeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceManagedEBSVolumeConfiguration) SetEncrypted added in v1.49.19 

func (s *ServiceManagedEBSVolumeConfiguration) SetEncrypted(v bool) *ServiceManagedEBSVolumeConfiguration

SetEncrypted sets the Encrypted field's value.

func (*ServiceManagedEBSVolumeConfiguration) SetFilesystemType added in v1.49.19 

func (s *ServiceManagedEBSVolumeConfiguration) SetFilesystemType(v string) *ServiceManagedEBSVolumeConfiguration

SetFilesystemType sets the FilesystemType field's value.

func (*ServiceManagedEBSVolumeConfiguration) SetIops added in v1.49.19 

func (s *ServiceManagedEBSVolumeConfiguration) SetIops(v int64) *ServiceManagedEBSVolumeConfiguration

SetIops sets the Iops field's value.

func (*ServiceManagedEBSVolumeConfiguration) SetKmsKeyId added in v1.49.19 

func (s *ServiceManagedEBSVolumeConfiguration) SetKmsKeyId(v string) *ServiceManagedEBSVolumeConfiguration

SetKmsKeyId sets the KmsKeyId field's value.

func (*ServiceManagedEBSVolumeConfiguration) SetRoleArn added in v1.49.19 

func (s *ServiceManagedEBSVolumeConfiguration) SetRoleArn(v string) *ServiceManagedEBSVolumeConfiguration

SetRoleArn sets the RoleArn field's value.

func (*ServiceManagedEBSVolumeConfiguration) SetSizeInGiB added in v1.49.19 

func (s *ServiceManagedEBSVolumeConfiguration) SetSizeInGiB(v int64) *ServiceManagedEBSVolumeConfiguration

SetSizeInGiB sets the SizeInGiB field's value.

func (*ServiceManagedEBSVolumeConfiguration) SetSnapshotId added in v1.49.19 

func (s *ServiceManagedEBSVolumeConfiguration) SetSnapshotId(v string) *ServiceManagedEBSVolumeConfiguration

SetSnapshotId sets the SnapshotId field's value.

func (*ServiceManagedEBSVolumeConfiguration) SetTagSpecifications added in v1.49.19 

func (s *ServiceManagedEBSVolumeConfiguration) SetTagSpecifications(v []*EBSTagSpecification) *ServiceManagedEBSVolumeConfiguration

SetTagSpecifications sets the TagSpecifications field's value.

func (*ServiceManagedEBSVolumeConfiguration) SetThroughput added in v1.49.19 

func (s *ServiceManagedEBSVolumeConfiguration) SetThroughput(v int64) *ServiceManagedEBSVolumeConfiguration

SetThroughput sets the Throughput field's value.

func (*ServiceManagedEBSVolumeConfiguration) SetVolumeType added in v1.49.19 

func (s *ServiceManagedEBSVolumeConfiguration) SetVolumeType(v string) *ServiceManagedEBSVolumeConfiguration

SetVolumeType sets the VolumeType field's value.

func (ServiceManagedEBSVolumeConfiguration) String added in v1.49.19 

func (s ServiceManagedEBSVolumeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceManagedEBSVolumeConfiguration) Validate added in v1.49.19 

func (s *ServiceManagedEBSVolumeConfiguration) Validate() error

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

type ServiceNotActiveException added in v1.28.0 

type ServiceNotActiveException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.

func (*ServiceNotActiveException) Code added in v1.28.0 

func (s *ServiceNotActiveException) Code() string

Code returns the exception type name.

func (*ServiceNotActiveException) Error added in v1.28.0 

func (s *ServiceNotActiveException) Error() string

func (ServiceNotActiveException) GoString added in v1.28.0 

func (s ServiceNotActiveException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceNotActiveException) Message added in v1.28.0 

func (s *ServiceNotActiveException) Message() string

Message returns the exception's message.

func (*ServiceNotActiveException) OrigErr added in v1.28.0 

func (s *ServiceNotActiveException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceNotActiveException) RequestID added in v1.28.0 

func (s *ServiceNotActiveException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceNotActiveException) StatusCode added in v1.28.0 

func (s *ServiceNotActiveException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceNotActiveException) String added in v1.28.0 

func (s ServiceNotActiveException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceNotFoundException added in v1.28.0 

type ServiceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

func (*ServiceNotFoundException) Code added in v1.28.0 

func (s *ServiceNotFoundException) Code() string

Code returns the exception type name.

func (*ServiceNotFoundException) Error added in v1.28.0 

func (s *ServiceNotFoundException) Error() string

func (ServiceNotFoundException) GoString added in v1.28.0 

func (s ServiceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceNotFoundException) Message added in v1.28.0 

func (s *ServiceNotFoundException) Message() string

Message returns the exception's message.

func (*ServiceNotFoundException) OrigErr added in v1.28.0 

func (s *ServiceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceNotFoundException) RequestID added in v1.28.0 

func (s *ServiceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceNotFoundException) StatusCode added in v1.28.0 

func (s *ServiceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceNotFoundException) String added in v1.28.0 

func (s ServiceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceRegistry added in v1.13.19 

type ServiceRegistry struct {

	// The container name value to be used for your service discovery service. It's
	// already specified in the task definition. 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. However, you can't specify
	// both.
	ContainerName *string `locationName:"containerName" type:"string"`

	// The port value to be used for your service discovery service. It's already
	// specified in the task definition. 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. However, you can't specify both.
	ContainerPort *int64 `locationName:"containerPort" type:"integer"`

	// The port value used if your service discovery service specified an SRV record.
	// This field might be used 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 Cloud Map. For more information, see CreateService (https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html).
	RegistryArn *string `locationName:"registryArn" type:"string"`
	// contains filtered or unexported fields
}

The details for the service registry.

Each service may be associated with one service registry. Multiple service registries for each service are not supported.

When you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment. New tasks are registered and deregistered to the updated service registry configuration.

func (ServiceRegistry) GoString added in v1.13.19 

func (s ServiceRegistry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceVolumeConfiguration added in v1.49.19 

type ServiceVolumeConfiguration struct {

	// The configuration for the Amazon EBS volume that Amazon ECS creates and manages
	// on your behalf. These settings are used to create each Amazon EBS volume,
	// with one volume created for each task in the service. The Amazon EBS volumes
	// are visible in your account in the Amazon EC2 console once they are created.
	ManagedEBSVolume *ServiceManagedEBSVolumeConfiguration `locationName:"managedEBSVolume" type:"structure"`

	// The name of the volume. This value must match the volume name from the Volume
	// object in the task definition.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.

func (ServiceVolumeConfiguration) GoString added in v1.49.19 

func (s ServiceVolumeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceVolumeConfiguration) SetManagedEBSVolume added in v1.49.19 

func (s *ServiceVolumeConfiguration) SetManagedEBSVolume(v *ServiceManagedEBSVolumeConfiguration) *ServiceVolumeConfiguration

SetManagedEBSVolume sets the ManagedEBSVolume field's value.

func (*ServiceVolumeConfiguration) SetName added in v1.49.19 

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

SetName sets the Name field's value.

func (ServiceVolumeConfiguration) String added in v1.49.19 

func (s ServiceVolumeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceVolumeConfiguration) Validate added in v1.49.19 

func (s *ServiceVolumeConfiguration) Validate() error

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

type Session added in v1.37.31 

type Session struct {

	// The ID of the execute command session.
	SessionId *string `locationName:"sessionId" type:"string"`

	// A URL to the managed agent on the container that the SSM Session Manager
	// client uses to send commands and receive output from the container.
	StreamUrl *string `locationName:"streamUrl" type:"string"`

	// An encrypted token value containing session and caller information. It's
	// used to authenticate the connection to the container.
	//
	// TokenValue is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Session's
	// String and GoString methods.
	TokenValue *string `locationName:"tokenValue" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

The details for the execute command session.

func (Session) GoString added in v1.37.31 

func (s Session) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Session) SetSessionId added in v1.37.31 

func (s *Session) SetSessionId(v string) *Session

SetSessionId sets the SessionId field's value.

func (*Session) SetStreamUrl added in v1.37.31 

func (s *Session) SetStreamUrl(v string) *Session

SetStreamUrl sets the StreamUrl field's value.

func (*Session) SetTokenValue added in v1.37.31 

func (s *Session) SetTokenValue(v string) *Session

SetTokenValue sets the TokenValue field's value.

func (Session) String added in v1.37.31 

func (s Session) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Setting added in v1.15.77 

type Setting struct {

	// The Amazon ECS resource name.
	Name *string `locationName:"name" type:"string" enum:"SettingName"`

	// The ARN of the principal. It can be a user, role, or the root user. If this
	// field is omitted, the authenticated user is assumed.
	PrincipalArn *string `locationName:"principalArn" type:"string"`

	// Indicates whether Amazon Web Services manages the account setting, or if
	// the user manages it.
	//
	// aws_managed account settings are read-only, as Amazon Web Services manages
	// such on the customer's behalf. Currently, the guardDutyActivate account setting
	// is the only one Amazon Web Services manages.
	Type *string `locationName:"type" type:"string" enum:"SettingType"`

	// Determines whether the account setting is on or off for the specified resource.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

The current account setting for a resource.

func (Setting) GoString added in v1.15.77 

func (s Setting) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Setting) SetName added in v1.15.77 

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

SetName sets the Name field's value.

func (*Setting) SetPrincipalArn added in v1.15.77 

func (s *Setting) SetPrincipalArn(v string) *Setting

SetPrincipalArn sets the PrincipalArn field's value.

func (*Setting) SetType added in v1.48.4 

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

SetType sets the Type field's value.

func (*Setting) SetValue added in v1.15.77 

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

SetValue sets the Value field's value.

func (Setting) String added in v1.15.77 

func (s Setting) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartTaskInput 

type StartTaskInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster where 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
	// where 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"`

	// Specifies whether to use Amazon ECS managed tags for the task. For more information,
	// see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html)
	// in the Amazon Elastic Container Service Developer Guide.
	EnableECSManagedTags *bool `locationName:"enableECSManagedTags" type:"boolean"`

	// Whether or not the execute command functionality is turned on for the task.
	// If true, this turns on the execute command functionality on all containers
	// in the task.
	EnableExecuteCommand *bool `locationName:"enableExecuteCommand" type:"boolean"`

	// 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 receives. You can override
	// the default command for a container (that's 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"`

	// Specifies whether to propagate the tags from the task definition or the service
	// to the task. If no value is specified, the tags aren't propagated.
	PropagateTags *string `locationName:"propagateTags" type:"string" enum:"PropagateTags"`

	// The reference ID to use for the task.
	ReferenceId *string `locationName:"referenceId" 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, the startedBy parameter contains
	// the deployment ID of the service that starts it.
	StartedBy *string `locationName:"startedBy" type:"string"`

	// The metadata that you apply to the task to help you categorize and organize
	// them. Each tag consists of a key and an optional value, both of which you
	// define.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case-sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for either keys or values as it is reserved for Amazon Web
	//    Services use. You cannot edit or delete tag keys or values with this prefix.
	//    Tags with this prefix do not count against your tags per resource limit.
	Tags []*Tag `locationName:"tags" type:"list"`

	// The family and revision (family:revision) or full ARN of the task definition
	// to start. If a revision isn't specified, the latest ACTIVE revision is used.
	//
	// TaskDefinition is a required field
	TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"`

	// The details of the volume that was configuredAtLaunch. You can configure
	// the size, volumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration
	// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskManagedEBSVolumeConfiguration.html).
	// The name of the volume must match the name from the task definition.
	VolumeConfigurations []*TaskVolumeConfiguration `locationName:"volumeConfigurations" type:"list"`
	// contains filtered or unexported fields
}

func (StartTaskInput) GoString added in v0.6.5 

func (s StartTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetEnableECSManagedTags added in v1.15.77 

func (s *StartTaskInput) SetEnableECSManagedTags(v bool) *StartTaskInput

SetEnableECSManagedTags sets the EnableECSManagedTags field's value.

func (*StartTaskInput) SetEnableExecuteCommand added in v1.37.31 

func (s *StartTaskInput) SetEnableExecuteCommand(v bool) *StartTaskInput

SetEnableExecuteCommand sets the EnableExecuteCommand 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) SetPropagateTags added in v1.15.77 

func (s *StartTaskInput) SetPropagateTags(v string) *StartTaskInput

SetPropagateTags sets the PropagateTags field's value.

func (*StartTaskInput) SetReferenceId added in v1.25.39 

func (s *StartTaskInput) SetReferenceId(v string) *StartTaskInput

SetReferenceId sets the ReferenceId 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) SetTags added in v1.15.77 

func (s *StartTaskInput) SetTags(v []*Tag) *StartTaskInput

SetTags sets the Tags 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) SetVolumeConfigurations added in v1.49.19 

func (s *StartTaskInput) SetVolumeConfigurations(v []*TaskVolumeConfiguration) *StartTaskInput

SetVolumeConfigurations sets the VolumeConfigurations field's value.

func (StartTaskInput) String added in v0.6.5 

func (s StartTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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're
	// 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.
	Reason *string `locationName:"reason" type:"string"`

	// The task ID 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SubmitAttachmentStateChangesInput added in v1.19.45 

type SubmitAttachmentStateChangesInput struct {

	// Any attachments associated with the state change request.
	//
	// Attachments is a required field
	Attachments []*AttachmentStateChange `locationName:"attachments" type:"list" required:"true"`

	// The short name or full ARN of the cluster that hosts the container instance
	// the attachment belongs to.
	Cluster *string `locationName:"cluster" type:"string"`
	// contains filtered or unexported fields
}

func (SubmitAttachmentStateChangesInput) GoString added in v1.19.45 

func (s SubmitAttachmentStateChangesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubmitAttachmentStateChangesInput) SetAttachments added in v1.19.45 

func (s *SubmitAttachmentStateChangesInput) SetAttachments(v []*AttachmentStateChange) *SubmitAttachmentStateChangesInput

SetAttachments sets the Attachments field's value.

func (*SubmitAttachmentStateChangesInput) SetCluster added in v1.19.45 

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

SetCluster sets the Cluster field's value.

func (SubmitAttachmentStateChangesInput) String added in v1.19.45 

func (s SubmitAttachmentStateChangesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubmitAttachmentStateChangesInput) Validate added in v1.19.45 

func (s *SubmitAttachmentStateChangesInput) Validate() error

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

type SubmitAttachmentStateChangesOutput added in v1.19.45 

type SubmitAttachmentStateChangesOutput struct {

	// Acknowledgement of the state change.
	Acknowledgment *string `locationName:"acknowledgment" type:"string"`
	// contains filtered or unexported fields
}

func (SubmitAttachmentStateChangesOutput) GoString added in v1.19.45 

func (s SubmitAttachmentStateChangesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubmitAttachmentStateChangesOutput) SetAcknowledgment added in v1.19.45 

func (s *SubmitAttachmentStateChangesOutput) SetAcknowledgment(v string) *SubmitAttachmentStateChangesOutput

SetAcknowledgment sets the Acknowledgment field's value.

func (SubmitAttachmentStateChangesOutput) String added in v1.19.45 

func (s SubmitAttachmentStateChangesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 that's 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 ID of the Docker container.
	RuntimeId *string `locationName:"runtimeId" 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetRuntimeId added in v1.23.12 

func (s *SubmitContainerStateChangeInput) SetRuntimeId(v string) *SubmitContainerStateChangeInput

SetRuntimeId sets the RuntimeId 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 that's associated with the state change request.
	Containers []*ContainerStateChange `locationName:"containers" type:"list"`

	// The Unix timestamp for the time when the task execution stopped.
	ExecutionStoppedAt *time.Time `locationName:"executionStoppedAt" type:"timestamp"`

	// The details for the managed agent that's associated with the task.
	ManagedAgents []*ManagedAgentStateChange `locationName:"managedAgents" type:"list"`

	// The Unix timestamp for the time when the container image pull started.
	PullStartedAt *time.Time `locationName:"pullStartedAt" type:"timestamp"`

	// The Unix timestamp for the time when the container image pull completed.
	PullStoppedAt *time.Time `locationName:"pullStoppedAt" type:"timestamp"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetManagedAgents added in v1.37.31 

func (s *SubmitTaskStateChangeInput) SetManagedAgents(v []*ManagedAgentStateChange) *SubmitTaskStateChangeInput

SetManagedAgents sets the ManagedAgents 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SystemControl added in v1.15.36 

type SystemControl struct {

	// The namespaced kernel parameter to set a value for.
	Namespace *string `locationName:"namespace" type:"string"`

	// The namespaced kernel parameter to set a value for.
	//
	// Valid IPC namespace values: "kernel.msgmax" | "kernel.msgmnb" | "kernel.msgmni"
	// | "kernel.sem" | "kernel.shmall" | "kernel.shmmax" | "kernel.shmmni" | "kernel.shm_rmid_forced",
	// and Sysctls that start with "fs.mqueue.*"
	//
	// Valid network namespace values: Sysctls that start with "net.*"
	//
	// All of these values are supported by Fargate.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the --sysctl option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration). For example, you can configure net.ipv4.tcp_keepalive_time setting to maintain longer lived connections.

We don't recommend that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network mode. Doing this has the following disadvantages:

  • For tasks that use the awsvpc network mode including Fargate, if you set systemControls for any container, it applies to all containers in the task. If you set different systemControls for multiple containers in a single task, the container that's started last determines which systemControls take effect.

  • For tasks that use the host network mode, the network namespace systemControls aren't supported.

If you're setting an IPC resource namespace to use for the containers in the task, the following conditions apply to your system controls. For more information, see IPC mode (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_definition_ipcmode).

  • For tasks that use the host IPC mode, IPC namespace systemControls aren't supported.

  • For tasks that use the task IPC mode, IPC namespace systemControls values apply to all containers within a task.

This parameter is not supported for Windows containers.

This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.

func (SystemControl) GoString added in v1.15.36 

func (s SystemControl) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SystemControl) SetNamespace added in v1.15.36 

func (s *SystemControl) SetNamespace(v string) *SystemControl

SetNamespace sets the Namespace field's value.

func (*SystemControl) SetValue added in v1.15.36 

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

SetValue sets the Value field's value.

func (SystemControl) String added in v1.15.36 

func (s SystemControl) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag added in v1.15.77 

type Tag struct {

	// One part of a key-value pair that make up a tag. A key is a general label
	// that acts like a category for more specific tag values.
	Key *string `locationName:"key" min:"1" type:"string"`

	// The optional part of a key-value pair that make up a tag. A value acts as
	// a descriptor within a tag category (key).
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

func (Tag) GoString added in v1.15.77 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey added in v1.15.77 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.15.77 

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

SetValue sets the Value field's value.

func (Tag) String added in v1.15.77 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate added in v1.15.77 

func (s *Tag) Validate() error

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

type TagResourceInput added in v1.15.77 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to add tags to. Currently,
	// the supported resources are Amazon ECS capacity providers, tasks, services,
	// task definitions, clusters, and container instances.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"`

	// The tags to add to the resource. A tag is an array of key-value pairs.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case-sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for either keys or values as it is reserved for Amazon Web
	//    Services use. You cannot edit or delete tag keys or values with this prefix.
	//    Tags with this prefix do not count against your tags per resource limit.
	//
	// Tags is a required field
	Tags []*Tag `locationName:"tags" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.15.77 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn added in v1.15.77 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.15.77 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.15.77 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.15.77 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.15.77 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString added in v1.15.77 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.15.77 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TargetNotConnectedException added in v1.37.31 

type TargetNotConnectedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The execute command cannot run. This error can be caused by any of the following configuration issues:

  • Incorrect IAM permissions

  • The SSM agent is not installed or is not running

  • There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for Systems Manager Session Manager

For information about how to troubleshoot the issues, see Troubleshooting issues with ECS Exec (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html) in the Amazon Elastic Container Service Developer Guide.

func (*TargetNotConnectedException) Code added in v1.37.31 

func (s *TargetNotConnectedException) Code() string

Code returns the exception type name.

func (*TargetNotConnectedException) Error added in v1.37.31 

func (s *TargetNotConnectedException) Error() string

func (TargetNotConnectedException) GoString added in v1.37.31 

func (s TargetNotConnectedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetNotConnectedException) Message added in v1.37.31 

func (s *TargetNotConnectedException) Message() string

Message returns the exception's message.

func (*TargetNotConnectedException) OrigErr added in v1.37.31 

func (s *TargetNotConnectedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TargetNotConnectedException) RequestID added in v1.37.31 

func (s *TargetNotConnectedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TargetNotConnectedException) StatusCode added in v1.37.31 

func (s *TargetNotConnectedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TargetNotConnectedException) String added in v1.37.31 

func (s TargetNotConnectedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TargetNotFoundException added in v1.28.0 

type TargetNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified target wasn't found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.

func (*TargetNotFoundException) Code added in v1.28.0 

func (s *TargetNotFoundException) Code() string

Code returns the exception type name.

func (*TargetNotFoundException) Error added in v1.28.0 

func (s *TargetNotFoundException) Error() string

func (TargetNotFoundException) GoString added in v1.28.0 

func (s TargetNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetNotFoundException) Message added in v1.28.0 

func (s *TargetNotFoundException) Message() string

Message returns the exception's message.

func (*TargetNotFoundException) OrigErr added in v1.28.0 

func (s *TargetNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TargetNotFoundException) RequestID added in v1.28.0 

func (s *TargetNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TargetNotFoundException) StatusCode added in v1.28.0 

func (s *TargetNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TargetNotFoundException) String added in v1.28.0 

func (s TargetNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Task 

type Task struct {

	// The Elastic Network Adapter that's associated with the task if the task uses
	// the awsvpc network mode.
	Attachments []*Attachment `locationName:"attachments" type:"list"`

	// The attributes of the task
	Attributes []*Attribute `locationName:"attributes" type:"list"`

	// The Availability Zone for the task.
	AvailabilityZone *string `locationName:"availabilityZone" type:"string"`

	// The capacity provider that's associated with the task.
	CapacityProviderName *string `locationName:"capacityProviderName" type:"string"`

	// 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 timestamp for the time when the task last went into CONNECTED status.
	ConnectivityAt *time.Time `locationName:"connectivityAt" type:"timestamp"`

	// The ARN of the container instances that host the task.
	ContainerInstanceArn *string `locationName:"containerInstanceArn" type:"string"`

	// The containers that's associated with the task.
	Containers []*Container `locationName:"containers" type:"list"`

	// The number of CPU units used by the task as expressed in a task definition.
	// It can be expressed as an integer using CPU units (for example, 1024). It
	// can also be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu).
	// String values are converted to an integer that indicates the CPU units when
	// the task definition is registered.
	//
	// If you use 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 you use the Fargate launch type, this field is required. You must use
	// one of the following values. These values determine the range of supported
	// values for the memory parameter:
	//
	// The CPU units cannot be less than 1 vCPU when you use Windows containers
	// on Fargate.
	//
	//    * 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: 4096 (4 GB) and 16384 (16 GB)
	//    in increments of 1024 (1 GB)
	//
	//    * 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB)
	//    in increments of 1024 (1 GB)
	//
	//    * 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
	//    This option requires Linux platform 1.4.0 or later.
	//
	//    * 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
	//    This option requires Linux platform 1.4.0 or later.
	Cpu *string `locationName:"cpu" type:"string"`

	// The Unix timestamp for the time when the task was created. More specifically,
	// it's for the time when the task entered the PENDING state.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The desired status of the task. For more information, see Task Lifecycle
	// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html).
	DesiredStatus *string `locationName:"desiredStatus" type:"string"`

	// Determines whether execute command functionality is turned on for this task.
	// If true, execute command functionality is turned on all the containers in
	// the task.
	EnableExecuteCommand *bool `locationName:"enableExecuteCommand" type:"boolean"`

	// The ephemeral storage settings for the task.
	EphemeralStorage *EphemeralStorage `locationName:"ephemeralStorage" type:"structure"`

	// The Unix timestamp for the time when the task execution stopped.
	ExecutionStoppedAt *time.Time `locationName:"executionStoppedAt" type:"timestamp"`

	// The Fargate ephemeral storage settings for the task.
	FargateEphemeralStorage *TaskEphemeralStorage `locationName:"fargateEphemeralStorage" type:"structure"`

	// The name of the task group that's associated with the task.
	Group *string `locationName:"group" type:"string"`

	// The health status for the task. It's determined by the health of the essential
	// containers in the task. If all essential containers in the task are reporting
	// as HEALTHY, the task status also reports as HEALTHY. If any essential containers
	// in the task are reporting as UNHEALTHY or UNKNOWN, the task status also reports
	// as UNHEALTHY or UNKNOWN.
	//
	// The Amazon ECS container agent doesn't monitor or report on Docker health
	// checks that are embedded in a container image and not specified in the container
	// definition. For example, this includes those specified in a parent image
	// or from the image's Dockerfile. Health check parameters that are specified
	// in a container definition override any Docker health checks that are found
	// in the container image.
	HealthStatus *string `locationName:"healthStatus" type:"string" enum:"HealthStatus"`

	// The Elastic Inference accelerator that's associated with the task.
	InferenceAccelerators []*InferenceAccelerator `locationName:"inferenceAccelerators" type:"list"`

	// The last known status for the task. For more information, see Task Lifecycle
	// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html).
	LastStatus *string `locationName:"lastStatus" type:"string"`

	// The infrastructure where your task runs on. For more information, see Amazon
	// ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)
	// in the Amazon Elastic Container Service Developer Guide.
	LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"`

	// The amount of memory (in MiB) that the task uses as expressed in a task definition.
	// It can be expressed as an integer using MiB (for example, 1024). If it's
	// expressed as a string using GB (for example, 1GB or 1 GB), it's converted
	// to an integer indicating the MiB when the task definition is registered.
	//
	// If you use the EC2 launch type, this field is optional.
	//
	// If you use the Fargate launch type, this field is required. You must use
	// one of the following values. The value that you choose determines the 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)
	//
	//    * Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192
	//    (8 vCPU) This option requires Linux platform 1.4.0 or later.
	//
	//    * Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384
	//    (16 vCPU) This option requires Linux platform 1.4.0 or later.
	Memory *string `locationName:"memory" type:"string"`

	// One or more container overrides.
	Overrides *TaskOverride `locationName:"overrides" type:"structure"`

	// The operating system that your tasks are running on. A platform family is
	// specified only for tasks that use the Fargate launch type.
	//
	// All tasks that run as part of this service must use the same platformFamily
	// value as the service (for example, LINUX.).
	PlatformFamily *string `locationName:"platformFamily" type:"string"`

	// The platform version where your task runs on. A platform version is only
	// specified for tasks that use the Fargate launch type. If you didn't specify
	// one, the LATEST platform version is used. For more information, see Fargate
	// Platform Versions (https://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 timestamp for the time when the container image pull began.
	PullStartedAt *time.Time `locationName:"pullStartedAt" type:"timestamp"`

	// The Unix timestamp for the time when the container image pull completed.
	PullStoppedAt *time.Time `locationName:"pullStoppedAt" type:"timestamp"`

	// The Unix timestamp for the time when the task started. More specifically,
	// it's for the time when the task transitioned from the PENDING state to the
	// RUNNING state.
	StartedAt *time.Time `locationName:"startedAt" type:"timestamp"`

	// The tag specified when a task is started. If an Amazon ECS service started
	// the task, the startedBy parameter contains the deployment ID of that service.
	StartedBy *string `locationName:"startedBy" type:"string"`

	// The stop code indicating why a task was stopped. The stoppedReason might
	// contain additional details.
	//
	// For more information about stop code, see Stopped tasks error codes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/stopped-task-error-codes.html)
	// in the Amazon ECS Developer Guide.
	StopCode *string `locationName:"stopCode" type:"string" enum:"TaskStopCode"`

	// The Unix timestamp for the time when the task was stopped. More specifically,
	// it's for the time when the task transitioned from the RUNNING state to the
	// STOPPED state.
	StoppedAt *time.Time `locationName:"stoppedAt" type:"timestamp"`

	// The reason that the task was stopped.
	StoppedReason *string `locationName:"stoppedReason" type:"string"`

	// The Unix timestamp for the time when the task stops. More specifically, it's
	// for the time when the task transitions from the RUNNING state to STOPPING.
	StoppingAt *time.Time `locationName:"stoppingAt" type:"timestamp"`

	// The metadata that you apply to the task to help you categorize and organize
	// the task. Each tag consists of a key and an optional value. You define both
	// the key and value.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case-sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for either keys or values as it is reserved for Amazon Web
	//    Services use. You cannot edit or delete tag keys or values with this prefix.
	//    Tags with this prefix do not count against your tags per resource limit.
	Tags []*Tag `locationName:"tags" type:"list"`

	// 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 starts a CloudWatch event, the version counter is incremented. If you
	// replicate your Amazon ECS task state with CloudWatch Events, you can compare
	// the version of a task reported by the Amazon ECS API actions 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Task) SetAttachments added in v1.12.27 

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

SetAttachments sets the Attachments field's value.

func (*Task) SetAttributes added in v1.25.39 

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

SetAttributes sets the Attributes field's value.

func (*Task) SetAvailabilityZone added in v1.25.39 

func (s *Task) SetAvailabilityZone(v string) *Task

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*Task) SetCapacityProviderName added in v1.25.46 

func (s *Task) SetCapacityProviderName(v string) *Task

SetCapacityProviderName sets the CapacityProviderName 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) SetEnableExecuteCommand added in v1.37.31 

func (s *Task) SetEnableExecuteCommand(v bool) *Task

SetEnableExecuteCommand sets the EnableExecuteCommand field's value.

func (*Task) SetEphemeralStorage added in v1.38.29 

func (s *Task) SetEphemeralStorage(v *EphemeralStorage) *Task

SetEphemeralStorage sets the EphemeralStorage 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) SetFargateEphemeralStorage added in v1.53.20 

func (s *Task) SetFargateEphemeralStorage(v *TaskEphemeralStorage) *Task

SetFargateEphemeralStorage sets the FargateEphemeralStorage 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) SetInferenceAccelerators added in v1.23.14 

func (s *Task) SetInferenceAccelerators(v []*InferenceAccelerator) *Task

SetInferenceAccelerators sets the InferenceAccelerators 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) SetPlatformFamily added in v1.41.13 

func (s *Task) SetPlatformFamily(v string) *Task

SetPlatformFamily sets the PlatformFamily 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) SetStopCode added in v1.15.77 

func (s *Task) SetStopCode(v string) *Task

SetStopCode sets the StopCode 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) SetTags added in v1.15.77 

func (s *Task) SetTags(v []*Tag) *Task

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskDefinition 

type TaskDefinition struct {

	// The task launch types the task definition validated against during task definition
	// registration. For more information, see Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)
	// in the Amazon Elastic Container Service Developer Guide.
	Compatibilities []*string `locationName:"compatibilities" type:"list" enum:"Compatibility"`

	// 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 (https://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 you use the EC2 launch type,
	// this field is optional. Any value can be used. If you use the Fargate launch
	// type, this field is required. You must use one of the following values. The
	// value that you choose determines your range of valid values for the memory
	// parameter.
	//
	// The CPU units cannot be less than 1 vCPU when you use Windows containers
	// on Fargate.
	//
	//    * 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: 4096 (4 GB) and 16384 (16 GB)
	//    in increments of 1024 (1 GB)
	//
	//    * 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB)
	//    in increments of 1024 (1 GB)
	//
	//    * 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
	//    This option requires Linux platform 1.4.0 or later.
	//
	//    * 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
	//    This option requires Linux platform 1.4.0 or later.
	Cpu *string `locationName:"cpu" type:"string"`

	// The Unix timestamp for the time when the task definition was deregistered.
	DeregisteredAt *time.Time `locationName:"deregisteredAt" type:"timestamp"`

	// The ephemeral storage settings to use for tasks run with the task definition.
	EphemeralStorage *EphemeralStorage `locationName:"ephemeralStorage" type:"structure"`

	// The Amazon Resource Name (ARN) of the task execution role that grants the
	// Amazon ECS container agent permission to make Amazon Web Services API calls
	// on your behalf. The task execution IAM role is required depending on the
	// requirements of your task. For more information, see Amazon ECS task execution
	// IAM role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html)
	// in the Amazon Elastic Container Service Developer Guide.
	ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string"`

	// The name of a family that this task definition is registered to. Up to 255
	// characters are allowed. Letters (both uppercase and lowercase letters), numbers,
	// hyphens (-), and underscores (_) are allowed.
	//
	// A family groups multiple versions of a task definition. Amazon ECS gives
	// the first task definition that you registered to a family a revision number
	// of 1. Amazon ECS gives sequential revision numbers to each task definition
	// that you add.
	Family *string `locationName:"family" type:"string"`

	// The Elastic Inference accelerator that's associated with the task.
	InferenceAccelerators []*InferenceAccelerator `locationName:"inferenceAccelerators" type:"list"`

	// The IPC resource namespace to use for the containers in the task. The valid
	// values are host, task, or none. If host is specified, then all containers
	// within the tasks that specified the host IPC mode on the same container instance
	// share the same IPC resources with the host Amazon EC2 instance. If task is
	// specified, all containers within the specified task share the same IPC resources.
	// If none is specified, then IPC resources within the containers of a task
	// are private and not shared with other containers in a task or on the container
	// instance. If no value is specified, then the IPC resource namespace sharing
	// depends on the Docker daemon setting on the container instance. For more
	// information, see IPC settings (https://docs.docker.com/engine/reference/run/#ipc-settings---ipc)
	// in the Docker run reference.
	//
	// If the host IPC mode is used, be aware that there is a heightened risk of
	// undesired IPC namespace expose. For more information, see Docker security
	// (https://docs.docker.com/engine/security/security/).
	//
	// If you are setting namespaced kernel parameters using systemControls for
	// the containers in the task, the following will apply to your IPC resource
	// namespace. For more information, see System Controls (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	//    * For tasks that use the host IPC mode, IPC namespace related systemControls
	//    are not supported.
	//
	//    * For tasks that use the task IPC mode, IPC namespace related systemControls
	//    will apply to all containers within a task.
	//
	// This parameter is not supported for Windows containers or tasks run on Fargate.
	IpcMode *string `locationName:"ipcMode" type:"string" enum:"IpcMode"`

	// The amount (in MiB) of memory used by the task.
	//
	// If your tasks runs on Amazon EC2 instances, you must specify either a task-level
	// memory value or a container-level memory value. This field is optional and
	// any value can be used. If a task-level memory value is specified, the container-level
	// memory value is optional. For more information regarding container-level
	// memory and memory reservation, see ContainerDefinition (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html).
	//
	// If your tasks runs on Fargate, this field is required. You must use one of
	// the following values. The value you choose 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)
	//
	//    * Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192
	//    (8 vCPU) This option requires Linux platform 1.4.0 or later.
	//
	//    * Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384
	//    (16 vCPU) This option requires Linux platform 1.4.0 or later.
	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. If no network mode is specified,
	// the default is bridge.
	//
	// For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For
	// Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used.
	// For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc
	// can be used. If the network mode is set to none, you cannot specify port
	// mappings in your container definitions, and the tasks 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.
	//
	// When using the host network mode, you should not run containers using the
	// root user (UID 0). It is considered best practice to use a non-root user.
	//
	// If the network mode is awsvpc, the task is allocated an elastic network interface,
	// and you must specify a NetworkConfiguration value when you create a service
	// or run a task with the task definition. For more information, see Task Networking
	// (https://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 cannot run multiple instantiations of the
	// same task on a single container instance when port mappings are used.
	//
	// 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"`

	// The process namespace to use for the containers in the task. The valid values
	// are host or task. On Fargate for Linux containers, the only valid value is
	// task. For example, monitoring sidecars might need pidMode to access information
	// about other containers running in the same task.
	//
	// If host is specified, all containers within the tasks that specified the
	// host PID mode on the same container instance share the same process namespace
	// with the host Amazon EC2 instance.
	//
	// If task is specified, all containers within the specified task share the
	// same process namespace.
	//
	// If no value is specified, the default is a private namespace for each container.
	// For more information, see PID settings (https://docs.docker.com/engine/reference/run/#pid-settings---pid)
	// in the Docker run reference.
	//
	// If the host PID mode is used, there's a heightened risk of undesired process
	// namespace exposure. For more information, see Docker security (https://docs.docker.com/engine/security/security/).
	//
	// This parameter is not supported for Windows containers.
	//
	// This parameter is only supported for tasks that are hosted on Fargate if
	// the tasks are using platform version 1.4.0 or later (Linux). This isn't supported
	// for Windows containers on Fargate.
	PidMode *string `locationName:"pidMode" type:"string" enum:"PidMode"`

	// An array of placement constraint objects to use for tasks.
	//
	// This parameter isn't supported for tasks run on Fargate.
	PlacementConstraints []*TaskDefinitionPlacementConstraint `locationName:"placementConstraints" type:"list"`

	// The configuration details for the App Mesh proxy.
	//
	// Your Amazon ECS container instances require at least version 1.26.0 of the
	// container agent and at least version 1.26.0-1 of the ecs-init package to
	// use a proxy configuration. If your container instances are launched from
	// the Amazon ECS optimized AMI version 20190301 or later, they contain the
	// required versions of the container agent and ecs-init. For more information,
	// see Amazon ECS-optimized Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)
	// in the Amazon Elastic Container Service Developer Guide.
	ProxyConfiguration *ProxyConfiguration `locationName:"proxyConfiguration" type:"structure"`

	// The Unix timestamp for the time when the task definition was registered.
	RegisteredAt *time.Time `locationName:"registeredAt" type:"timestamp"`

	// The principal that registered the task definition.
	RegisteredBy *string `locationName:"registeredBy" type:"string"`

	// The container instance attributes required by your task. When an Amazon EC2
	// instance is registered to your cluster, the Amazon ECS container agent assigns
	// some standard attributes to the instance. You can apply custom attributes.
	// These are specified as key-value pairs using the Amazon ECS console or the
	// PutAttributes API. These attributes are used when determining task placement
	// for tasks hosted on Amazon EC2 instances. For more information, see Attributes
	// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// This parameter isn't supported for tasks run on Fargate.
	RequiresAttributes []*Attribute `locationName:"requiresAttributes" type:"list"`

	// The task launch types the task definition was validated against. The valid
	// values are EC2, FARGATE, and EXTERNAL. For more information, see Amazon ECS
	// launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)
	// in the Amazon Elastic Container Service Developer Guide.
	RequiresCompatibilities []*string `locationName:"requiresCompatibilities" type:"list" enum:"Compatibility"`

	// 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 that you register a new
	// revision of a task definition in the same family, the revision value always
	// increases by one. This is even if you deregistered previous revisions in
	// this family.
	Revision *int64 `locationName:"revision" type:"integer"`

	// The operating system that your task definitions are running on. A platform
	// family is specified only for tasks using the Fargate launch type.
	//
	// When you specify a task in a service, this value must match the runtimePlatform
	// value of the service.
	RuntimePlatform *RuntimePlatform `locationName:"runtimePlatform" type:"structure"`

	// 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 short name or full Amazon Resource Name (ARN) of the Identity and Access
	// Management role that grants containers in the task permission to call Amazon
	// Web Services APIs on your behalf. For more information, see Amazon ECS Task
	// Role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// 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 to use the feature. For more information,
	// see Windows IAM roles for tasks (https://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 data volume definitions for the task. For more information, see
	// Using data volumes in tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// The host and sourcePath parameters aren't supported for tasks run on Fargate.
	Volumes []*Volume `locationName:"volumes" type:"list"`
	// contains filtered or unexported fields
}

The details of a task definition which describes the container and volume definitions of an Amazon Elastic Container Service task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.

func (TaskDefinition) GoString added in v0.6.5 

func (s TaskDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetDeregisteredAt added in v1.36.29 

func (s *TaskDefinition) SetDeregisteredAt(v time.Time) *TaskDefinition

SetDeregisteredAt sets the DeregisteredAt field's value.

func (*TaskDefinition) SetEphemeralStorage added in v1.38.29 

func (s *TaskDefinition) SetEphemeralStorage(v *EphemeralStorage) *TaskDefinition

SetEphemeralStorage sets the EphemeralStorage 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) SetInferenceAccelerators added in v1.25.39 

func (s *TaskDefinition) SetInferenceAccelerators(v []*InferenceAccelerator) *TaskDefinition

SetInferenceAccelerators sets the InferenceAccelerators field's value.

func (*TaskDefinition) SetIpcMode added in v1.15.78 

func (s *TaskDefinition) SetIpcMode(v string) *TaskDefinition

SetIpcMode sets the IpcMode 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) SetPidMode added in v1.15.78 

func (s *TaskDefinition) SetPidMode(v string) *TaskDefinition

SetPidMode sets the PidMode 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) SetProxyConfiguration added in v1.17.13 

func (s *TaskDefinition) SetProxyConfiguration(v *ProxyConfiguration) *TaskDefinition

SetProxyConfiguration sets the ProxyConfiguration field's value.

func (*TaskDefinition) SetRegisteredAt added in v1.36.29 

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

SetRegisteredAt sets the RegisteredAt field's value.

func (*TaskDefinition) SetRegisteredBy added in v1.36.29 

func (s *TaskDefinition) SetRegisteredBy(v string) *TaskDefinition

SetRegisteredBy sets the RegisteredBy 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) SetRuntimePlatform added in v1.41.13 

func (s *TaskDefinition) SetRuntimePlatform(v *RuntimePlatform) *TaskDefinition

SetRuntimePlatform sets the RuntimePlatform 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 (https://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 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
}

The constraint on task placement in the task definition. For more information, see Task placement constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the Amazon Elastic Container Service Developer Guide.

Task placement constraints aren't supported for tasks run on Fargate.

func (TaskDefinitionPlacementConstraint) GoString added in v1.6.9 

func (s TaskDefinitionPlacementConstraint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskEphemeralStorage added in v1.53.20 

type TaskEphemeralStorage struct {

	// Specify an Key Management Service key ID to encrypt the ephemeral storage
	// for the task.
	KmsKeyId *string `locationName:"kmsKeyId" type:"string"`

	// The total amount, in GiB, of the ephemeral storage to set for the task. The
	// minimum supported value is 20 GiB and the maximum supported value is 200
	// GiB.
	SizeInGiB *int64 `locationName:"sizeInGiB" type:"integer"`
	// contains filtered or unexported fields
}

The amount of ephemeral storage to allocate for the task.

func (TaskEphemeralStorage) GoString added in v1.53.20 

func (s TaskEphemeralStorage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskEphemeralStorage) SetKmsKeyId added in v1.53.20 

func (s *TaskEphemeralStorage) SetKmsKeyId(v string) *TaskEphemeralStorage

SetKmsKeyId sets the KmsKeyId field's value.

func (*TaskEphemeralStorage) SetSizeInGiB added in v1.53.20 

func (s *TaskEphemeralStorage) SetSizeInGiB(v int64) *TaskEphemeralStorage

SetSizeInGiB sets the SizeInGiB field's value.

func (TaskEphemeralStorage) String added in v1.53.20 

func (s TaskEphemeralStorage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskManagedEBSVolumeConfiguration added in v1.49.19 

type TaskManagedEBSVolumeConfiguration struct {

	// Indicates whether the volume should be encrypted. If no value is specified,
	// encryption is turned on by default. This parameter maps 1:1 with the Encrypted
	// parameter of the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html)
	// in the Amazon EC2 API Reference.
	Encrypted *bool `locationName:"encrypted" type:"boolean"`

	// The Linux filesystem type for the volume. For volumes created from a snapshot,
	// you must specify the same filesystem type that the volume was using when
	// the snapshot was created. If there is a filesystem type mismatch, the task
	// will fail to start.
	//
	// The available filesystem types are ext3, ext4, and xfs. If no value is specified,
	// the xfs filesystem type is used by default.
	FilesystemType *string `locationName:"filesystemType" type:"string" enum:"TaskFilesystemType"`

	// The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes,
	// this represents the number of IOPS that are provisioned for the volume. For
	// gp2 volumes, this represents the baseline performance of the volume and the
	// rate at which the volume accumulates I/O credits for bursting.
	//
	// The following are the supported values for each volume type.
	//
	//    * gp3: 3,000 - 16,000 IOPS
	//
	//    * io1: 100 - 64,000 IOPS
	//
	//    * io2: 100 - 256,000 IOPS
	//
	// This parameter is required for io1 and io2 volume types. The default for
	// gp3 volumes is 3,000 IOPS. This parameter is not supported for st1, sc1,
	// or standard volume types.
	//
	// This parameter maps 1:1 with the Iops parameter of the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html)
	// in the Amazon EC2 API Reference.
	Iops *int64 `locationName:"iops" type:"integer"`

	// The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key
	// Management Service key to use for Amazon EBS encryption. When encryption
	// is turned on and no Amazon Web Services Key Management Service key is specified,
	// the default Amazon Web Services managed key for Amazon EBS volumes is used.
	// This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API
	// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html)
	// in the Amazon EC2 API Reference.
	//
	// Amazon Web Services authenticates the Amazon Web Services Key Management
	// Service key asynchronously. Therefore, if you specify an ID, alias, or ARN
	// that is invalid, the action can appear to complete, but eventually fails.
	KmsKeyId *string `locationName:"kmsKeyId" type:"string"`

	// The ARN of the IAM role to associate with this volume. This is the Amazon
	// ECS infrastructure IAM role that is used to manage your Amazon Web Services
	// infrastructure. We recommend using the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes
	// IAM policy with this role. For more information, see Amazon ECS infrastructure
	// IAM role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html)
	// in the Amazon ECS Developer Guide.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The size of the volume in GiB. You must specify either a volume size or a
	// snapshot ID. If you specify a snapshot ID, the snapshot size is used for
	// the volume size by default. You can optionally specify a volume size greater
	// than or equal to the snapshot size. This parameter maps 1:1 with the Size
	// parameter of the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html)
	// in the Amazon EC2 API Reference.
	//
	// The following are the supported volume size values for each volume type.
	//
	//    * gp2 and gp3: 1-16,384
	//
	//    * io1 and io2: 4-16,384
	//
	//    * st1 and sc1: 125-16,384
	//
	//    * standard: 1-1,024
	SizeInGiB *int64 `locationName:"sizeInGiB" type:"integer"`

	// The snapshot that Amazon ECS uses to create the volume. You must specify
	// either a snapshot ID or a volume size. This parameter maps 1:1 with the SnapshotId
	// parameter of the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html)
	// in the Amazon EC2 API Reference.
	SnapshotId *string `locationName:"snapshotId" type:"string"`

	// The tags to apply to the volume. Amazon ECS applies service-managed tags
	// by default. This parameter maps 1:1 with the TagSpecifications.N parameter
	// of the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html)
	// in the Amazon EC2 API Reference.
	TagSpecifications []*EBSTagSpecification `locationName:"tagSpecifications" type:"list"`

	// The termination policy for the volume when the task exits. This provides
	// a way to control whether Amazon ECS terminates the Amazon EBS volume when
	// the task stops.
	TerminationPolicy *TaskManagedEBSVolumeTerminationPolicy `locationName:"terminationPolicy" type:"structure"`

	// The throughput to provision for a volume, in MiB/s, with a maximum of 1,000
	// MiB/s. This parameter maps 1:1 with the Throughput parameter of the CreateVolume
	// API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html)
	// in the Amazon EC2 API Reference.
	//
	// This parameter is only supported for the gp3 volume type.
	Throughput *int64 `locationName:"throughput" type:"integer"`

	// The volume type. This parameter maps 1:1 with the VolumeType parameter of
	// the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html)
	// in the Amazon EC2 API Reference. For more information, see Amazon EBS volume
	// types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html)
	// in the Amazon EC2 User Guide.
	//
	// The following are the supported volume types.
	//
	//    * General Purpose SSD: gp2|gp3
	//
	//    * Provisioned IOPS SSD: io1|io2
	//
	//    * Throughput Optimized HDD: st1
	//
	//    * Cold HDD: sc1
	//
	//    * Magnetic: standard The magnetic volume type is not supported on Fargate.
	VolumeType *string `locationName:"volumeType" type:"string"`
	// contains filtered or unexported fields
}

The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task.

func (TaskManagedEBSVolumeConfiguration) GoString added in v1.49.19 

func (s TaskManagedEBSVolumeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskManagedEBSVolumeConfiguration) SetEncrypted added in v1.49.19 

func (s *TaskManagedEBSVolumeConfiguration) SetEncrypted(v bool) *TaskManagedEBSVolumeConfiguration

SetEncrypted sets the Encrypted field's value.

func (*TaskManagedEBSVolumeConfiguration) SetFilesystemType added in v1.49.19 

func (s *TaskManagedEBSVolumeConfiguration) SetFilesystemType(v string) *TaskManagedEBSVolumeConfiguration

SetFilesystemType sets the FilesystemType field's value.

func (*TaskManagedEBSVolumeConfiguration) SetIops added in v1.49.19 

func (s *TaskManagedEBSVolumeConfiguration) SetIops(v int64) *TaskManagedEBSVolumeConfiguration

SetIops sets the Iops field's value.

func (*TaskManagedEBSVolumeConfiguration) SetKmsKeyId added in v1.49.19 

func (s *TaskManagedEBSVolumeConfiguration) SetKmsKeyId(v string) *TaskManagedEBSVolumeConfiguration

SetKmsKeyId sets the KmsKeyId field's value.

func (*TaskManagedEBSVolumeConfiguration) SetRoleArn added in v1.49.19 

func (s *TaskManagedEBSVolumeConfiguration) SetRoleArn(v string) *TaskManagedEBSVolumeConfiguration

SetRoleArn sets the RoleArn field's value.

func (*TaskManagedEBSVolumeConfiguration) SetSizeInGiB added in v1.49.19 

func (s *TaskManagedEBSVolumeConfiguration) SetSizeInGiB(v int64) *TaskManagedEBSVolumeConfiguration

SetSizeInGiB sets the SizeInGiB field's value.

func (*TaskManagedEBSVolumeConfiguration) SetSnapshotId added in v1.49.19 

func (s *TaskManagedEBSVolumeConfiguration) SetSnapshotId(v string) *TaskManagedEBSVolumeConfiguration

SetSnapshotId sets the SnapshotId field's value.

func (*TaskManagedEBSVolumeConfiguration) SetTagSpecifications added in v1.49.19 

func (s *TaskManagedEBSVolumeConfiguration) SetTagSpecifications(v []*EBSTagSpecification) *TaskManagedEBSVolumeConfiguration

SetTagSpecifications sets the TagSpecifications field's value.

func (*TaskManagedEBSVolumeConfiguration) SetTerminationPolicy added in v1.49.19 

func (s *TaskManagedEBSVolumeConfiguration) SetTerminationPolicy(v *TaskManagedEBSVolumeTerminationPolicy) *TaskManagedEBSVolumeConfiguration

SetTerminationPolicy sets the TerminationPolicy field's value.

func (*TaskManagedEBSVolumeConfiguration) SetThroughput added in v1.49.19 

func (s *TaskManagedEBSVolumeConfiguration) SetThroughput(v int64) *TaskManagedEBSVolumeConfiguration

SetThroughput sets the Throughput field's value.

func (*TaskManagedEBSVolumeConfiguration) SetVolumeType added in v1.49.19 

func (s *TaskManagedEBSVolumeConfiguration) SetVolumeType(v string) *TaskManagedEBSVolumeConfiguration

SetVolumeType sets the VolumeType field's value.

func (TaskManagedEBSVolumeConfiguration) String added in v1.49.19 

func (s TaskManagedEBSVolumeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskManagedEBSVolumeConfiguration) Validate added in v1.49.19 

func (s *TaskManagedEBSVolumeConfiguration) Validate() error

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

type TaskManagedEBSVolumeTerminationPolicy added in v1.49.19 

type TaskManagedEBSVolumeTerminationPolicy struct {

	// Indicates whether the volume should be deleted on when the task stops. If
	// a value of true is specified, Amazon ECS deletes the Amazon EBS volume on
	// your behalf when the task goes into the STOPPED state. If no value is specified,
	// the default value is true is used. When set to false, Amazon ECS leaves the
	// volume in your account.
	//
	// DeleteOnTermination is a required field
	DeleteOnTermination *bool `locationName:"deleteOnTermination" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

The termination policy for the Amazon EBS volume when the task exits. For more information, see Amazon ECS volume termination policy (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types).

func (TaskManagedEBSVolumeTerminationPolicy) GoString added in v1.49.19 

func (s TaskManagedEBSVolumeTerminationPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskManagedEBSVolumeTerminationPolicy) SetDeleteOnTermination added in v1.49.19 

func (s *TaskManagedEBSVolumeTerminationPolicy) SetDeleteOnTermination(v bool) *TaskManagedEBSVolumeTerminationPolicy

SetDeleteOnTermination sets the DeleteOnTermination field's value.

func (TaskManagedEBSVolumeTerminationPolicy) String added in v1.49.19 

func (s TaskManagedEBSVolumeTerminationPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskManagedEBSVolumeTerminationPolicy) Validate added in v1.49.19 

func (s *TaskManagedEBSVolumeTerminationPolicy) Validate() error

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

type TaskOverride 

type TaskOverride struct {

	// One or more container overrides that are sent to a task.
	ContainerOverrides []*ContainerOverride `locationName:"containerOverrides" type:"list"`

	// The CPU override for the task.
	Cpu *string `locationName:"cpu" type:"string"`

	// The ephemeral storage setting override for the task.
	//
	// This parameter is only supported for tasks hosted on Fargate that use the
	// following platform versions:
	//
	//    * Linux platform version 1.4.0 or later.
	//
	//    * Windows platform version 1.0.0 or later.
	EphemeralStorage *EphemeralStorage `locationName:"ephemeralStorage" type:"structure"`

	// The Amazon Resource Name (ARN) of the task execution role override for the
	// task. For more information, see Amazon ECS task execution IAM role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html)
	// in the Amazon Elastic Container Service Developer Guide.
	ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string"`

	// The Elastic Inference accelerator override for the task.
	InferenceAcceleratorOverrides []*InferenceAcceleratorOverride `locationName:"inferenceAcceleratorOverrides" type:"list"`

	// The memory override for the task.
	Memory *string `locationName:"memory" type:"string"`

	// The Amazon Resource Name (ARN) of the 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 Role for Tasks (https://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"`
	// contains filtered or unexported fields
}

The overrides that are associated with a task.

func (TaskOverride) GoString added in v0.6.5 

func (s TaskOverride) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskOverride) SetContainerOverrides added in v1.5.0 

func (s *TaskOverride) SetContainerOverrides(v []*ContainerOverride) *TaskOverride

SetContainerOverrides sets the ContainerOverrides field's value.

func (*TaskOverride) SetCpu added in v1.25.39 

func (s *TaskOverride) SetCpu(v string) *TaskOverride

SetCpu sets the Cpu field's value.

func (*TaskOverride) SetEphemeralStorage added in v1.38.29 

func (s *TaskOverride) SetEphemeralStorage(v *EphemeralStorage) *TaskOverride

SetEphemeralStorage sets the EphemeralStorage 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) SetInferenceAcceleratorOverrides added in v1.23.14 

func (s *TaskOverride) SetInferenceAcceleratorOverrides(v []*InferenceAcceleratorOverride) *TaskOverride

SetInferenceAcceleratorOverrides sets the InferenceAcceleratorOverrides field's value.

func (*TaskOverride) SetMemory added in v1.25.39 

func (s *TaskOverride) SetMemory(v string) *TaskOverride

SetMemory sets the Memory 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskOverride) Validate added in v1.16.27 

func (s *TaskOverride) Validate() error

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

type TaskSet added in v1.15.84 

type TaskSet struct {

	// The capacity provider strategy that are associated with the task set.
	CapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"capacityProviderStrategy" type:"list"`

	// The Amazon Resource Name (ARN) of the cluster that the service that hosts
	// the task set exists in.
	ClusterArn *string `locationName:"clusterArn" type:"string"`

	// The computed desired count for the task set. This is calculated by multiplying
	// the service's desiredCount by the task set's scale percentage. The result
	// is always rounded up. For example, if the computed desired count is 1.2,
	// it rounds up to 2 tasks.
	ComputedDesiredCount *int64 `locationName:"computedDesiredCount" type:"integer"`

	// The Unix timestamp for the time when the task set was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The external ID associated with the task set.
	//
	// If an CodeDeploy deployment created a task set, the externalId parameter
	// contains the CodeDeploy deployment ID.
	//
	// If a task set is created for an external deployment and is associated with
	// a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID
	// Cloud Map attribute.
	ExternalId *string `locationName:"externalId" type:"string"`

	// The Fargate ephemeral storage settings for the task set.
	FargateEphemeralStorage *DeploymentEphemeralStorage `locationName:"fargateEphemeralStorage" type:"structure"`

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

	// The launch type the tasks in the task set are using. For more information,
	// see Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)
	// in the Amazon Elastic Container Service Developer Guide.
	LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"`

	// Details on a load balancer that are used with a task set.
	LoadBalancers []*LoadBalancer `locationName:"loadBalancers" type:"list"`

	// The network configuration for the task set.
	NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"`

	// The number of tasks in the task set that are in the PENDING status during
	// a deployment. A task in the PENDING state is preparing to enter the RUNNING
	// state. A task set enters the PENDING status when it launches for the first
	// time or when it's restarted after being in the STOPPED state.
	PendingCount *int64 `locationName:"pendingCount" type:"integer"`

	// The operating system that your tasks in the set are running on. A platform
	// family is specified only for tasks that use the Fargate launch type.
	//
	// All tasks in the set must have the same value.
	PlatformFamily *string `locationName:"platformFamily" type:"string"`

	// The Fargate platform version where the tasks in the task set are running.
	// A platform version is only specified for tasks run on Fargate. For more information,
	// see Fargate platform versions (https://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 number of tasks in the task set that are in the RUNNING status during
	// a deployment. A task in the RUNNING state is running and ready for use.
	RunningCount *int64 `locationName:"runningCount" type:"integer"`

	// A floating-point percentage of your desired number of tasks to place and
	// keep running in the task set.
	Scale *Scale `locationName:"scale" type:"structure"`

	// The Amazon Resource Name (ARN) of the service the task set exists in.
	ServiceArn *string `locationName:"serviceArn" type:"string"`

	// The details for the service discovery registries to assign to this task set.
	// For more information, see Service discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).
	ServiceRegistries []*ServiceRegistry `locationName:"serviceRegistries" type:"list"`

	// The stability status. This indicates whether the task set has reached a steady
	// state. If the following conditions are met, the task set are in STEADY_STATE:
	//
	//    * The task runningCount is equal to the computedDesiredCount.
	//
	//    * The pendingCount is 0.
	//
	//    * There are no tasks that are running on container instances in the DRAINING
	//    status.
	//
	//    * All tasks are reporting a healthy status from the load balancers, service
	//    discovery, and container health checks.
	//
	// If any of those conditions aren't met, the stability status returns STABILIZING.
	StabilityStatus *string `locationName:"stabilityStatus" type:"string" enum:"StabilityStatus"`

	// The Unix timestamp for the time when the task set stability status was retrieved.
	StabilityStatusAt *time.Time `locationName:"stabilityStatusAt" type:"timestamp"`

	// The tag specified when a task set is started. If an CodeDeploy deployment
	// created the task set, the startedBy parameter is CODE_DEPLOY. If an external
	// deployment created the task set, the startedBy field isn't used.
	StartedBy *string `locationName:"startedBy" type:"string"`

	// The status of the task set. The following describes each state.
	//
	// PRIMARY
	//
	// The task set is serving production traffic.
	//
	// ACTIVE
	//
	// The task set isn't serving production traffic.
	//
	// DRAINING
	//
	// The tasks in the task set are being stopped, and their corresponding targets
	// are being deregistered from their target group.
	Status *string `locationName:"status" type:"string"`

	// The metadata that you apply to the task set to help you categorize and organize
	// them. Each tag consists of a key and an optional value. You define both.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case-sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for either keys or values as it is reserved for Amazon Web
	//    Services use. You cannot edit or delete tag keys or values with this prefix.
	//    Tags with this prefix do not count against your tags per resource limit.
	Tags []*Tag `locationName:"tags" type:"list"`

	// The task definition that the task set is using.
	TaskDefinition *string `locationName:"taskDefinition" type:"string"`

	// The Amazon Resource Name (ARN) of the task set.
	TaskSetArn *string `locationName:"taskSetArn" type:"string"`

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

Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

func (TaskSet) GoString added in v1.15.84 

func (s TaskSet) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskSet) SetCapacityProviderStrategy added in v1.25.46 

func (s *TaskSet) SetCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *TaskSet

SetCapacityProviderStrategy sets the CapacityProviderStrategy field's value.

func (*TaskSet) SetClusterArn added in v1.19.3 

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

SetClusterArn sets the ClusterArn field's value.

func (*TaskSet) SetComputedDesiredCount added in v1.15.84 

func (s *TaskSet) SetComputedDesiredCount(v int64) *TaskSet

SetComputedDesiredCount sets the ComputedDesiredCount field's value.

func (*TaskSet) SetCreatedAt added in v1.15.84 

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

SetCreatedAt sets the CreatedAt field's value.

func (*TaskSet) SetExternalId added in v1.15.84 

func (s *TaskSet) SetExternalId(v string) *TaskSet

SetExternalId sets the ExternalId field's value.

func (*TaskSet) SetFargateEphemeralStorage added in v1.53.20 

func (s *TaskSet) SetFargateEphemeralStorage(v *DeploymentEphemeralStorage) *TaskSet

SetFargateEphemeralStorage sets the FargateEphemeralStorage field's value.

func (*TaskSet) SetId added in v1.15.84 

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

SetId sets the Id field's value.

func (*TaskSet) SetLaunchType added in v1.15.84 

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

SetLaunchType sets the LaunchType field's value.

func (*TaskSet) SetLoadBalancers added in v1.15.84 

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

SetLoadBalancers sets the LoadBalancers field's value.

func (*TaskSet) SetNetworkConfiguration added in v1.15.84 

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

SetNetworkConfiguration sets the NetworkConfiguration field's value.

func (*TaskSet) SetPendingCount added in v1.15.84 

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

SetPendingCount sets the PendingCount field's value.

func (*TaskSet) SetPlatformFamily added in v1.41.13 

func (s *TaskSet) SetPlatformFamily(v string) *TaskSet

SetPlatformFamily sets the PlatformFamily field's value.

func (*TaskSet) SetPlatformVersion added in v1.15.84 

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

SetPlatformVersion sets the PlatformVersion field's value.

func (*TaskSet) SetRunningCount added in v1.15.84 

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

SetRunningCount sets the RunningCount field's value.

func (*TaskSet) SetScale added in v1.15.84 

func (s *TaskSet) SetScale(v *Scale) *TaskSet

SetScale sets the Scale field's value.

func (*TaskSet) SetServiceArn added in v1.19.3 

func (s *TaskSet) SetServiceArn(v string) *TaskSet

SetServiceArn sets the ServiceArn field's value.

func (*TaskSet) SetServiceRegistries added in v1.19.3 

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

SetServiceRegistries sets the ServiceRegistries field's value.

func (*TaskSet) SetStabilityStatus added in v1.15.84 

func (s *TaskSet) SetStabilityStatus(v string) *TaskSet

SetStabilityStatus sets the StabilityStatus field's value.

func (*TaskSet) SetStabilityStatusAt added in v1.15.84 

func (s *TaskSet) SetStabilityStatusAt(v time.Time) *TaskSet

SetStabilityStatusAt sets the StabilityStatusAt field's value.

func (*TaskSet) SetStartedBy added in v1.15.84 

func (s *TaskSet) SetStartedBy(v string) *TaskSet

SetStartedBy sets the StartedBy field's value.

func (*TaskSet) SetStatus added in v1.15.84 

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

SetStatus sets the Status field's value.

func (*TaskSet) SetTags added in v1.28.9 

func (s *TaskSet) SetTags(v []*Tag) *TaskSet

SetTags sets the Tags field's value.

func (*TaskSet) SetTaskDefinition added in v1.15.84 

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

SetTaskDefinition sets the TaskDefinition field's value.

func (*TaskSet) SetTaskSetArn added in v1.15.84 

func (s *TaskSet) SetTaskSetArn(v string) *TaskSet

SetTaskSetArn sets the TaskSetArn field's value.

func (*TaskSet) SetUpdatedAt added in v1.15.84 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (TaskSet) String added in v1.15.84 

func (s TaskSet) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskSetNotFoundException added in v1.28.0 

type TaskSetNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.

func (*TaskSetNotFoundException) Code added in v1.28.0 

func (s *TaskSetNotFoundException) Code() string

Code returns the exception type name.

func (*TaskSetNotFoundException) Error added in v1.28.0 

func (s *TaskSetNotFoundException) Error() string

func (TaskSetNotFoundException) GoString added in v1.28.0 

func (s TaskSetNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskSetNotFoundException) Message added in v1.28.0 

func (s *TaskSetNotFoundException) Message() string

Message returns the exception's message.

func (*TaskSetNotFoundException) OrigErr added in v1.28.0 

func (s *TaskSetNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TaskSetNotFoundException) RequestID added in v1.28.0 

func (s *TaskSetNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TaskSetNotFoundException) StatusCode added in v1.28.0 

func (s *TaskSetNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TaskSetNotFoundException) String added in v1.28.0 

func (s TaskSetNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskVolumeConfiguration added in v1.49.19 

type TaskVolumeConfiguration struct {

	// The configuration for the Amazon EBS volume that Amazon ECS creates and manages
	// on your behalf. These settings are used to create each Amazon EBS volume,
	// with one volume created for each task. The Amazon EBS volumes are visible
	// in your account in the Amazon EC2 console once they are created.
	ManagedEBSVolume *TaskManagedEBSVolumeConfiguration `locationName:"managedEBSVolume" type:"structure"`

	// The name of the volume. This value must match the volume name from the Volume
	// object in the task definition.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Configuration settings for the task volume that was configuredAtLaunch that weren't set during RegisterTaskDef.

func (TaskVolumeConfiguration) GoString added in v1.49.19 

func (s TaskVolumeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskVolumeConfiguration) SetManagedEBSVolume added in v1.49.19 

func (s *TaskVolumeConfiguration) SetManagedEBSVolume(v *TaskManagedEBSVolumeConfiguration) *TaskVolumeConfiguration

SetManagedEBSVolume sets the ManagedEBSVolume field's value.

func (*TaskVolumeConfiguration) SetName added in v1.49.19 

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

SetName sets the Name field's value.

func (TaskVolumeConfiguration) String added in v1.49.19 

func (s TaskVolumeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskVolumeConfiguration) Validate added in v1.49.19 

func (s *TaskVolumeConfiguration) Validate() error

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

type TimeoutConfiguration added in v1.50.1 

type TimeoutConfiguration struct {

	// The amount of time in seconds a connection will stay active while idle. A
	// value of 0 can be set to disable idleTimeout.
	//
	// The idleTimeout default for HTTP/HTTP2/GRPC is 5 minutes.
	//
	// The idleTimeout default for TCP is 1 hour.
	IdleTimeoutSeconds *int64 `locationName:"idleTimeoutSeconds" type:"integer"`

	// The amount of time waiting for the upstream to respond with a complete response
	// per request. A value of 0 can be set to disable perRequestTimeout. perRequestTimeout
	// can only be set if Service Connect appProtocol isn't TCP. Only idleTimeout
	// is allowed for TCP appProtocol.
	PerRequestTimeoutSeconds *int64 `locationName:"perRequestTimeoutSeconds" type:"integer"`
	// contains filtered or unexported fields
}

An object that represents the timeout configurations for Service Connect.

If idleTimeout is set to a time that is less than perRequestTimeout, the connection will close when the idleTimeout is reached and not the perRequestTimeout.

func (TimeoutConfiguration) GoString added in v1.50.1 

func (s TimeoutConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeoutConfiguration) SetIdleTimeoutSeconds added in v1.50.1 

func (s *TimeoutConfiguration) SetIdleTimeoutSeconds(v int64) *TimeoutConfiguration

SetIdleTimeoutSeconds sets the IdleTimeoutSeconds field's value.

func (*TimeoutConfiguration) SetPerRequestTimeoutSeconds added in v1.50.1 

func (s *TimeoutConfiguration) SetPerRequestTimeoutSeconds(v int64) *TimeoutConfiguration

SetPerRequestTimeoutSeconds sets the PerRequestTimeoutSeconds field's value.

func (TimeoutConfiguration) String added in v1.50.1 

func (s TimeoutConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tmpfs added in v1.13.17 

type Tmpfs struct {

	// The absolute file path where the tmpfs volume is to 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"
	// | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"
	MountOptions []*string `locationName:"mountOptions" type:"list"`

	// The maximum 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and the default hard limit is 65535.

You can specify the ulimit settings for a container in a task definition.

func (Ulimit) GoString added in v0.9.14 

func (s Ulimit) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 UnsupportedFeatureException added in v1.28.0 

type UnsupportedFeatureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified task isn't supported in this Region.

func (*UnsupportedFeatureException) Code added in v1.28.0 

func (s *UnsupportedFeatureException) Code() string

Code returns the exception type name.

func (*UnsupportedFeatureException) Error added in v1.28.0 

func (s *UnsupportedFeatureException) Error() string

func (UnsupportedFeatureException) GoString added in v1.28.0 

func (s UnsupportedFeatureException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnsupportedFeatureException) Message added in v1.28.0 

func (s *UnsupportedFeatureException) Message() string

Message returns the exception's message.

func (*UnsupportedFeatureException) OrigErr added in v1.28.0 

func (s *UnsupportedFeatureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedFeatureException) RequestID added in v1.28.0 

func (s *UnsupportedFeatureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedFeatureException) StatusCode added in v1.28.0 

func (s *UnsupportedFeatureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnsupportedFeatureException) String added in v1.28.0 

func (s UnsupportedFeatureException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.15.77 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to delete tags from. Currently,
	// the supported resources are Amazon ECS capacity providers, tasks, services,
	// task definitions, clusters, and container instances.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"`

	// The keys of the tags to be removed.
	//
	// TagKeys is a required field
	TagKeys []*string `locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.15.77 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn added in v1.15.77 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.15.77 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.15.77 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.15.77 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.15.77 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString added in v1.15.77 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.15.77 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateCapacityProviderInput added in v1.35.34 

type UpdateCapacityProviderInput struct {

	// An object that represent the parameters to update for the Auto Scaling group
	// capacity provider.
	//
	// AutoScalingGroupProvider is a required field
	AutoScalingGroupProvider *AutoScalingGroupProviderUpdate `locationName:"autoScalingGroupProvider" type:"structure" required:"true"`

	// The name of the capacity provider to update.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateCapacityProviderInput) GoString added in v1.35.34 

func (s UpdateCapacityProviderInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateCapacityProviderInput) SetAutoScalingGroupProvider added in v1.35.34 

func (s *UpdateCapacityProviderInput) SetAutoScalingGroupProvider(v *AutoScalingGroupProviderUpdate) *UpdateCapacityProviderInput

SetAutoScalingGroupProvider sets the AutoScalingGroupProvider field's value.

func (*UpdateCapacityProviderInput) SetName added in v1.35.34 

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

SetName sets the Name field's value.

func (UpdateCapacityProviderInput) String added in v1.35.34 

func (s UpdateCapacityProviderInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateCapacityProviderInput) Validate added in v1.35.34 

func (s *UpdateCapacityProviderInput) Validate() error

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

type UpdateCapacityProviderOutput added in v1.35.34 

type UpdateCapacityProviderOutput struct {

	// Details about the capacity provider.
	CapacityProvider *CapacityProvider `locationName:"capacityProvider" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateCapacityProviderOutput) GoString added in v1.35.34 

func (s UpdateCapacityProviderOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateCapacityProviderOutput) SetCapacityProvider added in v1.35.34 

func (s *UpdateCapacityProviderOutput) SetCapacityProvider(v *CapacityProvider) *UpdateCapacityProviderOutput

SetCapacityProvider sets the CapacityProvider field's value.

func (UpdateCapacityProviderOutput) String added in v1.35.34 

func (s UpdateCapacityProviderOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateClusterInput added in v1.37.31 

type UpdateClusterInput struct {

	// The name of the cluster to modify the settings for.
	//
	// Cluster is a required field
	Cluster *string `locationName:"cluster" type:"string" required:"true"`

	// The execute command configuration for the cluster.
	Configuration *ClusterConfiguration `locationName:"configuration" type:"structure"`

	// Use this parameter to set a default Service Connect namespace. After you
	// set a default Service Connect namespace, any new services with Service Connect
	// turned on that are created in the cluster are added as client services in
	// the namespace. This setting only applies to new services that set the enabled
	// parameter to true in the ServiceConnectConfiguration. You can set the namespace
	// of each service individually in the ServiceConnectConfiguration to override
	// this default parameter.
	//
	// Tasks that run in a namespace can use short names to connect to services
	// in the namespace. Tasks can connect to services across all of the clusters
	// in the namespace. Tasks connect through a managed proxy container that collects
	// logs and metrics for increased visibility. Only the tasks that Amazon ECS
	// services create are supported with Service Connect. For more information,
	// see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
	// in the Amazon Elastic Container Service Developer Guide.
	ServiceConnectDefaults *ClusterServiceConnectDefaultsRequest `locationName:"serviceConnectDefaults" type:"structure"`

	// The cluster settings for your cluster.
	Settings []*ClusterSetting `locationName:"settings" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateClusterInput) GoString added in v1.37.31 

func (s UpdateClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateClusterInput) SetCluster added in v1.37.31 

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

SetCluster sets the Cluster field's value.

func (*UpdateClusterInput) SetConfiguration added in v1.37.31 

func (s *UpdateClusterInput) SetConfiguration(v *ClusterConfiguration) *UpdateClusterInput

SetConfiguration sets the Configuration field's value.

func (*UpdateClusterInput) SetServiceConnectDefaults added in v1.44.146 

func (s *UpdateClusterInput) SetServiceConnectDefaults(v *ClusterServiceConnectDefaultsRequest) *UpdateClusterInput

SetServiceConnectDefaults sets the ServiceConnectDefaults field's value.

func (*UpdateClusterInput) SetSettings added in v1.37.31 

func (s *UpdateClusterInput) SetSettings(v []*ClusterSetting) *UpdateClusterInput

SetSettings sets the Settings field's value.

func (UpdateClusterInput) String added in v1.37.31 

func (s UpdateClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateClusterInput) Validate added in v1.37.31 

func (s *UpdateClusterInput) Validate() error

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

type UpdateClusterOutput added in v1.37.31 

type UpdateClusterOutput struct {

	// Details about the cluster.
	Cluster *Cluster `locationName:"cluster" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateClusterOutput) GoString added in v1.37.31 

func (s UpdateClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateClusterOutput) SetCluster added in v1.37.31 

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

SetCluster sets the Cluster field's value.

func (UpdateClusterOutput) String added in v1.37.31 

func (s UpdateClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateClusterSettingsInput added in v1.23.13 

type UpdateClusterSettingsInput struct {

	// The name of the cluster to modify the settings for.
	//
	// Cluster is a required field
	Cluster *string `locationName:"cluster" type:"string" required:"true"`

	// The setting to use by default for a cluster. This parameter is used to turn
	// on CloudWatch Container Insights for a cluster. If this value is specified,
	// it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
	//
	// Currently, if you delete an existing cluster that does not have Container
	// Insights turned on, and then create a new cluster with the same name with
	// Container Insights tuned on, Container Insights will not actually be turned
	// on. If you want to preserve the same name for your existing cluster and turn
	// on Container Insights, you must wait 7 days before you can re-create it.
	//
	// Settings is a required field
	Settings []*ClusterSetting `locationName:"settings" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateClusterSettingsInput) GoString added in v1.23.13 

func (s UpdateClusterSettingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateClusterSettingsInput) SetCluster added in v1.23.13 

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

SetCluster sets the Cluster field's value.

func (*UpdateClusterSettingsInput) SetSettings added in v1.23.13 

func (s *UpdateClusterSettingsInput) SetSettings(v []*ClusterSetting) *UpdateClusterSettingsInput

SetSettings sets the Settings field's value.

func (UpdateClusterSettingsInput) String added in v1.23.13 

func (s UpdateClusterSettingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateClusterSettingsInput) Validate added in v1.23.13 

func (s *UpdateClusterSettingsInput) Validate() error

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

type UpdateClusterSettingsOutput added in v1.23.13 

type UpdateClusterSettingsOutput struct {

	// Details about the cluster
	Cluster *Cluster `locationName:"cluster" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateClusterSettingsOutput) GoString added in v1.23.13 

func (s UpdateClusterSettingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateClusterSettingsOutput) SetCluster added in v1.23.13 

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

SetCluster sets the Cluster field's value.

func (UpdateClusterSettingsOutput) String added in v1.23.13 

func (s UpdateClusterSettingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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
	// where 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 that the container agent was updated for.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 up to 10 container instance IDs or full ARN entries.
	//
	// ContainerInstances is a required field
	ContainerInstances []*string `locationName:"containerInstances" type:"list" required:"true"`

	// The container instance state to update the container instance with. The only
	// valid values for this action are ACTIVE and DRAINING. A container instance
	// can only be updated to DRAINING status once it has reached an ACTIVE state.
	// If a container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED
	// state you can describe the container instance but can't update the container
	// instance state.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateInProgressException added in v1.28.0 

type UpdateInProgressException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.

func (*UpdateInProgressException) Code added in v1.28.0 

func (s *UpdateInProgressException) Code() string

Code returns the exception type name.

func (*UpdateInProgressException) Error added in v1.28.0 

func (s *UpdateInProgressException) Error() string

func (UpdateInProgressException) GoString added in v1.28.0 

func (s UpdateInProgressException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateInProgressException) Message added in v1.28.0 

func (s *UpdateInProgressException) Message() string

Message returns the exception's message.

func (*UpdateInProgressException) OrigErr added in v1.28.0 

func (s *UpdateInProgressException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UpdateInProgressException) RequestID added in v1.28.0 

func (s *UpdateInProgressException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UpdateInProgressException) StatusCode added in v1.28.0 

func (s *UpdateInProgressException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UpdateInProgressException) String added in v1.28.0 

func (s UpdateInProgressException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateServiceInput 

type UpdateServiceInput struct {

	// The capacity provider strategy to update the service to use.
	//
	// if the service uses the default capacity provider strategy for the cluster,
	// the service can be updated to use one or more capacity providers as opposed
	// to the default capacity provider strategy. However, when a service is using
	// a capacity provider strategy that's not the default capacity provider strategy,
	// the service can't be updated to use the cluster's default capacity provider
	// strategy.
	//
	// A capacity provider strategy consists of one or more capacity providers along
	// with the base and weight to assign to them. A capacity provider must be associated
	// with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders
	// API is used to associate a capacity provider with a cluster. Only capacity
	// providers with an ACTIVE or UPDATING status can be used.
	//
	// If specifying a capacity provider that uses an Auto Scaling group, the capacity
	// provider must already be created. New capacity providers can be created with
	// the CreateCapacityProvider API operation.
	//
	// To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT
	// capacity providers. The Fargate capacity providers are available to all accounts
	// and only need to be associated with a cluster to be used.
	//
	// The PutClusterCapacityProviders API operation is used to update the list
	// of available capacity providers for a cluster after the cluster is created.
	CapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"capacityProviderStrategy" type:"list"`

	// The short name or full Amazon Resource Name (ARN) of the cluster that your
	// service runs 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"`

	// Determines whether to turn on Amazon ECS managed tags for the tasks in the
	// service. For more information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// Only tasks launched after the update will reflect the update. To update the
	// tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts
	// new tasks with the updated tags.
	EnableECSManagedTags *bool `locationName:"enableECSManagedTags" type:"boolean"`

	// If true, this enables execute command functionality on all task containers.
	//
	// If you do not want to override the value that was set when the service was
	// created, you can set this to null when performing this action.
	EnableExecuteCommand *bool `locationName:"enableExecuteCommand" type:"boolean"`

	// Determines whether to force a new deployment of the service. By default,
	// deployments aren't forced. You can use this option to start 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 ignores
	// 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 2,147,483,647 seconds. During that time, the Amazon 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"`

	// A list of Elastic Load Balancing load balancer objects. It contains the load
	// balancer name, the container name, and the container port to access from
	// the load balancer. The container name is as it appears in a container definition.
	//
	// When you add, update, or remove a load balancer configuration, Amazon ECS
	// starts new tasks with the updated Elastic Load Balancing configuration, and
	// then stops the old tasks when the new tasks are running.
	//
	// For services that use rolling updates, you can add, update, or remove Elastic
	// Load Balancing target groups. You can update from a single target group to
	// multiple target groups and from multiple target groups to a single target
	// group.
	//
	// For services that use blue/green deployments, you can update Elastic Load
	// Balancing target groups by using CreateDeployment (https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html)
	// through CodeDeploy. Note that multiple target groups are not supported for
	// blue/green deployments. For more information see Register multiple target
	// groups with a service (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// For services that use the external deployment controller, you can add, update,
	// or remove load balancers by using CreateTaskSet (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html).
	// Note that multiple target groups are not supported for external deployments.
	// For more information see Register multiple target groups with a service (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html)
	// in the Amazon Elastic Container Service Developer Guide.
	//
	// You can remove existing loadBalancers by passing an empty list.
	LoadBalancers []*LoadBalancer `locationName:"loadBalancers" type:"list"`

	// An object representing the network configuration for the service.
	NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"`

	// An array of task placement constraint objects to update the service to use.
	// If no value is specified, the existing placement constraints for the service
	// will remain unchanged. If this value is specified, it will override any existing
	// placement constraints defined for the service. To remove all existing placement
	// constraints, specify an empty array.
	//
	// You can specify a maximum of 10 constraints for each task. This limit includes
	// constraints in the task definition and those specified at runtime.
	PlacementConstraints []*PlacementConstraint `locationName:"placementConstraints" type:"list"`

	// The task placement strategy objects to update the service to use. If no value
	// is specified, the existing placement strategy for the service will remain
	// unchanged. If this value is specified, it will override the existing placement
	// strategy defined for the service. To remove an existing placement strategy,
	// specify an empty object.
	//
	// You can specify a maximum of five strategy rules for each service.
	PlacementStrategy []*PlacementStrategy `locationName:"placementStrategy" type:"list"`

	// The platform version that your tasks in the service run on. A platform version
	// is only specified for tasks using the Fargate launch type. If a platform
	// version is not specified, the LATEST platform version is used. For more information,
	// see Fargate Platform Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
	// in the Amazon Elastic Container Service Developer Guide.
	PlatformVersion *string `locationName:"platformVersion" type:"string"`

	// Determines whether to propagate the tags from the task definition or the
	// service to the task. If no value is specified, the tags aren't propagated.
	//
	// Only tasks launched after the update will reflect the update. To update the
	// tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts
	// new tasks with the updated tags.
	PropagateTags *string `locationName:"propagateTags" type:"string" enum:"PropagateTags"`

	// The name of the service to update.
	//
	// Service is a required field
	Service *string `locationName:"service" type:"string" required:"true"`

	// The configuration for this service to discover and connect to services, and
	// be discovered by, and connected from, other services within a namespace.
	//
	// Tasks that run in a namespace can use short names to connect to services
	// in the namespace. Tasks can connect to services across all of the clusters
	// in the namespace. Tasks connect through a managed proxy container that collects
	// logs and metrics for increased visibility. Only the tasks that Amazon ECS
	// services create are supported with Service Connect. For more information,
	// see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
	// in the Amazon Elastic Container Service Developer Guide.
	ServiceConnectConfiguration *ServiceConnectConfiguration `locationName:"serviceConnectConfiguration" type:"structure"`

	// The details for the service discovery registries to assign to this service.
	// For more information, see Service Discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).
	//
	// When you add, update, or remove the service registries configuration, Amazon
	// ECS starts new tasks with the updated service registries configuration, and
	// then stops the old tasks when the new tasks are running.
	//
	// You can remove existing serviceRegistries by passing an empty list.
	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. 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"`

	// The details of the volume that was configuredAtLaunch. You can configure
	// the size, volumeType, IOPS, throughput, snapshot and encryption in ServiceManagedEBSVolumeConfiguration
	// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ServiceManagedEBSVolumeConfiguration.html).
	// The name of the volume must match the name from the task definition. If set
	// to null, no new deployment is triggered. Otherwise, if this configuration
	// differs from the existing one, it triggers a new deployment.
	VolumeConfigurations []*ServiceVolumeConfiguration `locationName:"volumeConfigurations" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateServiceInput) GoString added in v0.6.5 

func (s UpdateServiceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateServiceInput) SetCapacityProviderStrategy added in v1.25.46 

func (s *UpdateServiceInput) SetCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *UpdateServiceInput

SetCapacityProviderStrategy sets the CapacityProviderStrategy field's value.

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) SetEnableECSManagedTags added in v1.43.13 

func (s *UpdateServiceInput) SetEnableECSManagedTags(v bool) *UpdateServiceInput

SetEnableECSManagedTags sets the EnableECSManagedTags field's value.

func (*UpdateServiceInput) SetEnableExecuteCommand added in v1.37.31 

func (s *UpdateServiceInput) SetEnableExecuteCommand(v bool) *UpdateServiceInput

SetEnableExecuteCommand sets the EnableExecuteCommand 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) SetLoadBalancers added in v1.43.13 

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

SetLoadBalancers sets the LoadBalancers 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) SetPlacementConstraints added in v1.29.25 

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

SetPlacementConstraints sets the PlacementConstraints field's value.

func (*UpdateServiceInput) SetPlacementStrategy added in v1.29.25 

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

SetPlacementStrategy sets the PlacementStrategy 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) SetPropagateTags added in v1.43.13 

func (s *UpdateServiceInput) SetPropagateTags(v string) *UpdateServiceInput

SetPropagateTags sets the PropagateTags 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) SetServiceConnectConfiguration added in v1.44.146 

func (s *UpdateServiceInput) SetServiceConnectConfiguration(v *ServiceConnectConfiguration) *UpdateServiceInput

SetServiceConnectConfiguration sets the ServiceConnectConfiguration field's value.

func (*UpdateServiceInput) SetServiceRegistries added in v1.43.13 

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

SetServiceRegistries sets the ServiceRegistries 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) SetVolumeConfigurations added in v1.49.19 

func (s *UpdateServiceInput) SetVolumeConfigurations(v []*ServiceVolumeConfiguration) *UpdateServiceInput

SetVolumeConfigurations sets the VolumeConfigurations field's value.

func (UpdateServiceInput) String added in v0.6.5 

func (s UpdateServiceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateServicePrimaryTaskSetInput added in v1.19.3 

type UpdateServicePrimaryTaskSetInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts
	// the service that the task set exists in.
	//
	// Cluster is a required field
	Cluster *string `locationName:"cluster" type:"string" required:"true"`

	// The short name or full Amazon Resource Name (ARN) of the task set to set
	// as the primary task set in the deployment.
	//
	// PrimaryTaskSet is a required field
	PrimaryTaskSet *string `locationName:"primaryTaskSet" type:"string" required:"true"`

	// The short name or full Amazon Resource Name (ARN) of the service that the
	// task set exists in.
	//
	// Service is a required field
	Service *string `locationName:"service" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateServicePrimaryTaskSetInput) GoString added in v1.19.3 

func (s UpdateServicePrimaryTaskSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateServicePrimaryTaskSetInput) SetCluster added in v1.19.3 

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

SetCluster sets the Cluster field's value.

func (*UpdateServicePrimaryTaskSetInput) SetPrimaryTaskSet added in v1.19.3 

func (s *UpdateServicePrimaryTaskSetInput) SetPrimaryTaskSet(v string) *UpdateServicePrimaryTaskSetInput

SetPrimaryTaskSet sets the PrimaryTaskSet field's value.

func (*UpdateServicePrimaryTaskSetInput) SetService added in v1.19.3 

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

SetService sets the Service field's value.

func (UpdateServicePrimaryTaskSetInput) String added in v1.19.3 

func (s UpdateServicePrimaryTaskSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateServicePrimaryTaskSetInput) Validate added in v1.19.3 

func (s *UpdateServicePrimaryTaskSetInput) Validate() error

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

type UpdateServicePrimaryTaskSetOutput added in v1.19.3 

type UpdateServicePrimaryTaskSetOutput struct {

	// The details about the task set.
	TaskSet *TaskSet `locationName:"taskSet" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateServicePrimaryTaskSetOutput) GoString added in v1.19.3 

func (s UpdateServicePrimaryTaskSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateServicePrimaryTaskSetOutput) SetTaskSet added in v1.19.3 

func (s *UpdateServicePrimaryTaskSetOutput) SetTaskSet(v *TaskSet) *UpdateServicePrimaryTaskSetOutput

SetTaskSet sets the TaskSet field's value.

func (UpdateServicePrimaryTaskSetOutput) String added in v1.19.3 

func (s UpdateServicePrimaryTaskSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateTaskProtectionInput added in v1.44.135 

type UpdateTaskProtectionInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts
	// the service that the task sets exist in.
	//
	// Cluster is a required field
	Cluster *string `locationName:"cluster" type:"string" required:"true"`

	// If you set protectionEnabled to true, you can specify the duration for task
	// protection in minutes. You can specify a value from 1 minute to up to 2,880
	// minutes (48 hours). During this time, your task will not be terminated by
	// scale-in events from Service Auto Scaling or deployments. After this time
	// period lapses, protectionEnabled will be reset to false.
	//
	// If you don’t specify the time, then the task is automatically protected
	// for 120 minutes (2 hours).
	ExpiresInMinutes *int64 `locationName:"expiresInMinutes" type:"integer"`

	// Specify true to mark a task for protection and false to unset protection,
	// making it eligible for termination.
	//
	// ProtectionEnabled is a required field
	ProtectionEnabled *bool `locationName:"protectionEnabled" type:"boolean" required:"true"`

	// A list of up to 10 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 (UpdateTaskProtectionInput) GoString added in v1.44.135 

func (s UpdateTaskProtectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTaskProtectionInput) SetCluster added in v1.44.135 

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

SetCluster sets the Cluster field's value.

func (*UpdateTaskProtectionInput) SetExpiresInMinutes added in v1.44.135 

func (s *UpdateTaskProtectionInput) SetExpiresInMinutes(v int64) *UpdateTaskProtectionInput

SetExpiresInMinutes sets the ExpiresInMinutes field's value.

func (*UpdateTaskProtectionInput) SetProtectionEnabled added in v1.44.135 

func (s *UpdateTaskProtectionInput) SetProtectionEnabled(v bool) *UpdateTaskProtectionInput

SetProtectionEnabled sets the ProtectionEnabled field's value.

func (*UpdateTaskProtectionInput) SetTasks added in v1.44.135 

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

SetTasks sets the Tasks field's value.

func (UpdateTaskProtectionInput) String added in v1.44.135 

func (s UpdateTaskProtectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTaskProtectionInput) Validate added in v1.44.135 

func (s *UpdateTaskProtectionInput) Validate() error

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

type UpdateTaskProtectionOutput added in v1.44.135 

type UpdateTaskProtectionOutput struct {

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

	// A list of tasks with the following information.
	//
	//    * taskArn: The task ARN.
	//
	//    * protectionEnabled: The protection status of the task. If scale-in protection
	//    is turned on for a task, the value is true. Otherwise, it is false.
	//
	//    * expirationDate: The epoch time when protection for the task will expire.
	ProtectedTasks []*ProtectedTask `locationName:"protectedTasks" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateTaskProtectionOutput) GoString added in v1.44.135 

func (s UpdateTaskProtectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTaskProtectionOutput) SetFailures added in v1.44.135 

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

SetFailures sets the Failures field's value.

func (*UpdateTaskProtectionOutput) SetProtectedTasks added in v1.44.135 

func (s *UpdateTaskProtectionOutput) SetProtectedTasks(v []*ProtectedTask) *UpdateTaskProtectionOutput

SetProtectedTasks sets the ProtectedTasks field's value.

func (UpdateTaskProtectionOutput) String added in v1.44.135 

func (s UpdateTaskProtectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateTaskSetInput added in v1.19.3 

type UpdateTaskSetInput struct {

	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts
	// the service that the task set is found in.
	//
	// Cluster is a required field
	Cluster *string `locationName:"cluster" type:"string" required:"true"`

	// A floating-point percentage of the desired number of tasks to place and keep
	// running in the task set.
	//
	// Scale is a required field
	Scale *Scale `locationName:"scale" type:"structure" required:"true"`

	// The short name or full Amazon Resource Name (ARN) of the service that the
	// task set is found in.
	//
	// Service is a required field
	Service *string `locationName:"service" type:"string" required:"true"`

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

func (UpdateTaskSetInput) GoString added in v1.19.3 

func (s UpdateTaskSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTaskSetInput) SetCluster added in v1.19.3 

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

SetCluster sets the Cluster field's value.

func (*UpdateTaskSetInput) SetScale added in v1.19.3 

func (s *UpdateTaskSetInput) SetScale(v *Scale) *UpdateTaskSetInput

SetScale sets the Scale field's value.

func (*UpdateTaskSetInput) SetService added in v1.19.3 

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

SetService sets the Service field's value.

func (*UpdateTaskSetInput) SetTaskSet added in v1.19.3 

func (s *UpdateTaskSetInput) SetTaskSet(v string) *UpdateTaskSetInput

SetTaskSet sets the TaskSet field's value.

func (UpdateTaskSetInput) String added in v1.19.3 

func (s UpdateTaskSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTaskSetInput) Validate added in v1.19.3 

func (s *UpdateTaskSetInput) Validate() error

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

type UpdateTaskSetOutput added in v1.19.3 

type UpdateTaskSetOutput struct {

	// Details about the task set.
	TaskSet *TaskSet `locationName:"taskSet" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateTaskSetOutput) GoString added in v1.19.3 

func (s UpdateTaskSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTaskSetOutput) SetTaskSet added in v1.19.3 

func (s *UpdateTaskSetOutput) SetTaskSet(v *TaskSet) *UpdateTaskSetOutput

SetTaskSet sets the TaskSet field's value.

func (UpdateTaskSetOutput) String added in v1.19.3 

func (s UpdateTaskSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 that's 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Volume 

type Volume struct {

	// Indicates whether the volume should be configured at launch time. This is
	// used to create Amazon EBS volumes for standalone tasks or tasks created as
	// part of a service. Each task definition revision may only have one volume
	// configured at launch in the volume configuration.
	//
	// To configure a volume at launch time, use this task definition revision and
	// specify a volumeConfigurations object when calling the CreateService, UpdateService,
	// RunTask or StartTask APIs.
	ConfiguredAtLaunch *bool `locationName:"configuredAtLaunch" type:"boolean"`

	// This parameter is specified when you use Docker volumes.
	//
	// Windows containers only support the use of the local driver. To use bind
	// mounts, specify the host parameter instead.
	//
	// Docker volumes aren't supported by tasks run on Fargate.
	DockerVolumeConfiguration *DockerVolumeConfiguration `locationName:"dockerVolumeConfiguration" type:"structure"`

	// This parameter is specified when you use an Amazon Elastic File System file
	// system for task storage.
	EfsVolumeConfiguration *EFSVolumeConfiguration `locationName:"efsVolumeConfiguration" type:"structure"`

	// This parameter is specified when you use Amazon FSx for Windows File Server
	// file system for task storage.
	FsxWindowsFileServerVolumeConfiguration *FSxWindowsFileServerVolumeConfiguration `locationName:"fsxWindowsFileServerVolumeConfiguration" type:"structure"`

	// This parameter is specified when you use bind mount host volumes. The contents
	// of the host parameter determine whether your bind mount host volume persists
	// on the host container instance and where it's stored. If the host parameter
	// is empty, then the Docker daemon assigns a host path for your data volume.
	// However, the data isn't guaranteed to persist after the containers that are
	// associated with it stop running.
	//
	// Windows containers can mount whole directories on the same drive as $env:ProgramData.
	// Windows containers can't mount directories on a different drive, and mount
	// point can't 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,
	// underscores, and hyphens are allowed.
	//
	// When using a volume configured at launch, the name is required and must also
	// be specified as the volume name in the ServiceVolumeConfiguration or TaskVolumeConfiguration
	// parameter when creating your service or standalone task.
	//
	// For all other types of volumes, this name is referenced in the sourceVolume
	// parameter of the mountPoints object in the container definition.
	//
	// When a volume is using the efsVolumeConfiguration, the name is required.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

The data volume configuration for tasks launched using this task definition. Specifying a volume configuration in a task definition is optional. The volume configuration may contain multiple volumes but only one volume configured at launch is supported. Each volume defined in the volume configuration may only specify a name and one of either configuredAtLaunch, dockerVolumeConfiguration, efsVolumeConfiguration, fsxWindowsFileServerVolumeConfiguration, or host. If an empty volume configuration is specified, by default Amazon ECS uses a host volume. For more information, see Using data volumes in tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html).

func (Volume) GoString added in v0.6.5 

func (s Volume) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Volume) SetConfiguredAtLaunch added in v1.49.19 

func (s *Volume) SetConfiguredAtLaunch(v bool) *Volume

SetConfiguredAtLaunch sets the ConfiguredAtLaunch field's value.

func (*Volume) SetDockerVolumeConfiguration added in v1.15.9 

func (s *Volume) SetDockerVolumeConfiguration(v *DockerVolumeConfiguration) *Volume

SetDockerVolumeConfiguration sets the DockerVolumeConfiguration field's value.

func (*Volume) SetEfsVolumeConfiguration added in v1.28.5 

func (s *Volume) SetEfsVolumeConfiguration(v *EFSVolumeConfiguration) *Volume

SetEfsVolumeConfiguration sets the EfsVolumeConfiguration field's value.

func (*Volume) SetFsxWindowsFileServerVolumeConfiguration added in v1.35.24 

func (s *Volume) SetFsxWindowsFileServerVolumeConfiguration(v *FSxWindowsFileServerVolumeConfiguration) *Volume

SetFsxWindowsFileServerVolumeConfiguration sets the FsxWindowsFileServerVolumeConfiguration field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Volume) Validate added in v1.28.5 

func (s *Volume) Validate() error

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.