func AgentUpdateStatus_Values() []string
AgentUpdateStatus_Values returns all elements of the AgentUpdateStatus enum
func AssignPublicIp_Values() []string
AssignPublicIp_Values returns all elements of the AssignPublicIp enum
func CapacityProviderField_Values() []string
CapacityProviderField_Values returns all elements of the CapacityProviderField enum
func CapacityProviderStatus_Values() []string
CapacityProviderStatus_Values returns all elements of the CapacityProviderStatus enum
func CapacityProviderUpdateStatus_Values() []string
CapacityProviderUpdateStatus_Values returns all elements of the CapacityProviderUpdateStatus enum
func ClusterField_Values() []string
ClusterField_Values returns all elements of the ClusterField enum
func ClusterSettingName_Values() []string
ClusterSettingName_Values returns all elements of the ClusterSettingName enum
func Compatibility_Values() []string
Compatibility_Values returns all elements of the Compatibility enum
func Connectivity_Values() []string
Connectivity_Values returns all elements of the Connectivity enum
func ContainerCondition_Values() []string
ContainerCondition_Values returns all elements of the ContainerCondition enum
func ContainerInstanceField_Values() []string
ContainerInstanceField_Values returns all elements of the ContainerInstanceField enum
func ContainerInstanceStatus_Values() []string
ContainerInstanceStatus_Values returns all elements of the ContainerInstanceStatus enum
func DeploymentControllerType_Values() []string
DeploymentControllerType_Values returns all elements of the DeploymentControllerType enum
func DeploymentRolloutState_Values() []string
DeploymentRolloutState_Values returns all elements of the DeploymentRolloutState enum
func DesiredStatus_Values() []string
DesiredStatus_Values returns all elements of the DesiredStatus enum
func DeviceCgroupPermission_Values() []string
DeviceCgroupPermission_Values returns all elements of the DeviceCgroupPermission enum
func EFSAuthorizationConfigIAM_Values() []string
EFSAuthorizationConfigIAM_Values returns all elements of the EFSAuthorizationConfigIAM enum
func EFSTransitEncryption_Values() []string
EFSTransitEncryption_Values returns all elements of the EFSTransitEncryption enum
func EnvironmentFileType_Values() []string
EnvironmentFileType_Values returns all elements of the EnvironmentFileType enum
func FirelensConfigurationType_Values() []string
FirelensConfigurationType_Values returns all elements of the FirelensConfigurationType enum
func HealthStatus_Values() []string
HealthStatus_Values returns all elements of the HealthStatus enum
func IpcMode_Values() []string
IpcMode_Values returns all elements of the IpcMode enum
func LaunchType_Values() []string
LaunchType_Values returns all elements of the LaunchType enum
func LogDriver_Values() []string
LogDriver_Values returns all elements of the LogDriver enum
func ManagedScalingStatus_Values() []string
ManagedScalingStatus_Values returns all elements of the ManagedScalingStatus enum
func ManagedTerminationProtection_Values() []string
ManagedTerminationProtection_Values returns all elements of the ManagedTerminationProtection enum
func NetworkMode_Values() []string
NetworkMode_Values returns all elements of the NetworkMode enum
func PidMode_Values() []string
PidMode_Values returns all elements of the PidMode enum
func PlacementConstraintType_Values() []string
PlacementConstraintType_Values returns all elements of the PlacementConstraintType enum
func PlacementStrategyType_Values() []string
PlacementStrategyType_Values returns all elements of the PlacementStrategyType enum
func PlatformDeviceType_Values() []string
PlatformDeviceType_Values returns all elements of the PlatformDeviceType enum
func PropagateTags_Values() []string
PropagateTags_Values returns all elements of the PropagateTags enum
func ProxyConfigurationType_Values() []string
ProxyConfigurationType_Values returns all elements of the ProxyConfigurationType enum
func ResourceType_Values() []string
ResourceType_Values returns all elements of the ResourceType enum
func ScaleUnit_Values() []string
ScaleUnit_Values returns all elements of the ScaleUnit enum
func SchedulingStrategy_Values() []string
SchedulingStrategy_Values returns all elements of the SchedulingStrategy enum
func Scope_Values() []string
Scope_Values returns all elements of the Scope enum
func ServiceField_Values() []string
ServiceField_Values returns all elements of the ServiceField enum
func SettingName_Values() []string
SettingName_Values returns all elements of the SettingName enum
func SortOrder_Values() []string
SortOrder_Values returns all elements of the SortOrder enum
func StabilityStatus_Values() []string
StabilityStatus_Values returns all elements of the StabilityStatus enum
func TargetType_Values() []string
TargetType_Values returns all elements of the TargetType enum
func TaskDefinitionFamilyStatus_Values() []string
TaskDefinitionFamilyStatus_Values returns all elements of the TaskDefinitionFamilyStatus enum
func TaskDefinitionField_Values() []string
TaskDefinitionField_Values returns all elements of the TaskDefinitionField enum
func TaskDefinitionPlacementConstraintType_Values() []string
TaskDefinitionPlacementConstraintType_Values returns all elements of the TaskDefinitionPlacementConstraintType enum
func TaskDefinitionStatus_Values() []string
TaskDefinitionStatus_Values returns all elements of the TaskDefinitionStatus enum
func TaskField_Values() []string
TaskField_Values returns all elements of the TaskField enum
func TaskSetField_Values() []string
TaskSetField_Values returns all elements of the TaskSetField enum
func TaskStopCode_Values() []string
TaskStopCode_Values returns all elements of the TaskStopCode enum
func TransportProtocol_Values() []string
TransportProtocol_Values returns all elements of the TransportProtocol enum
func UlimitName_Values() []string
UlimitName_Values returns all elements of the UlimitName enum
type AccessDeniedException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
You do not have authorization to perform the requested action.
func (s *AccessDeniedException) Code() string
Code returns the exception type name.
func (s *AccessDeniedException) Error() string
func (s AccessDeniedException) GoString() string
GoString returns the string representation
func (s *AccessDeniedException) Message() string
Message returns the exception's message.
func (s *AccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *AccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *AccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s AccessDeniedException) String() string
String returns the string representation
type Attachment struct { // Details of the attachment. For elastic network interfaces, this includes // the network interface ID, the MAC address, the subnet ID, and the private // IPv4 address. Details []*KeyValuePair `locationName:"details" type:"list"` // The unique identifier for the attachment. Id *string `locationName:"id" type:"string"` // The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, // ATTACHED, DETACHING, DETACHED, and DELETED. Status *string `locationName:"status" type:"string"` // The type of the attachment, such as ElasticNetworkInterface. Type *string `locationName:"type" type:"string"` // contains filtered or unexported fields }
An object representing a container instance or task attachment.
func (s Attachment) GoString() string
GoString returns the string representation
func (s *Attachment) SetDetails(v []*KeyValuePair) *Attachment
SetDetails sets the Details field's value.
func (s *Attachment) SetId(v string) *Attachment
SetId sets the Id field's value.
func (s *Attachment) SetStatus(v string) *Attachment
SetStatus sets the Status field's value.
func (s *Attachment) SetType(v string) *Attachment
SetType sets the Type field's value.
func (s Attachment) String() string
String returns the string representation
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 (s AttachmentStateChange) GoString() string
GoString returns the string representation
func (s *AttachmentStateChange) SetAttachmentArn(v string) *AttachmentStateChange
SetAttachmentArn sets the AttachmentArn field's value.
func (s *AttachmentStateChange) SetStatus(v string) *AttachmentStateChange
SetStatus sets the Status field's value.
func (s AttachmentStateChange) String() string
String returns the string representation
func (s *AttachmentStateChange) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Attribute struct { // The name of the attribute. The name must contain between 1 and 128 characters // and 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 with which to attach the attribute. This parameter // is required if you use the short form ID for a resource instead of the full // ARN. TargetType *string `locationName:"targetType" type:"string" enum:"TargetType"` // The value of the attribute. The value must contain between 1 and 128 characters // and may contain letters (uppercase and lowercase), numbers, hyphens, underscores, // periods, at signs (@), forward slashes, back slashes, colons, or spaces. // The value cannot contain any leading or trailing whitespace. Value *string `locationName:"value" type:"string"` // contains filtered or unexported fields }
An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes) in the Amazon Elastic Container Service Developer Guide.
func (s Attribute) GoString() string
GoString returns the string representation
func (s *Attribute) SetName(v string) *Attribute
SetName sets the Name field's value.
func (s *Attribute) SetTargetId(v string) *Attribute
SetTargetId sets the TargetId field's value.
func (s *Attribute) SetTargetType(v string) *Attribute
SetTargetType sets the TargetType field's value.
func (s *Attribute) SetValue(v string) *Attribute
SetValue sets the Value field's value.
func (s Attribute) String() string
String returns the string representation
func (s *Attribute) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 per resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.
func (s *AttributeLimitExceededException) Code() string
Code returns the exception type name.
func (s *AttributeLimitExceededException) Error() string
func (s AttributeLimitExceededException) GoString() string
GoString returns the string representation
func (s *AttributeLimitExceededException) Message() string
Message returns the exception's message.
func (s *AttributeLimitExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *AttributeLimitExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *AttributeLimitExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s AttributeLimitExceededException) String() string
String returns the string representation
type AutoScalingGroupProvider struct { // The Amazon Resource Name (ARN) that identifies the Auto Scaling group. // // AutoScalingGroupArn is a required field AutoScalingGroupArn *string `locationName:"autoScalingGroupArn" type:"string" required:"true"` // 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 will not work. // // When managed termination protection is enabled, 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 enabled // as well. For more information, see Instance Protection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) // in the AWS Auto Scaling User Guide. // // When managed termination protection is disabled, your Amazon EC2 instances // are not 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 (s AutoScalingGroupProvider) GoString() string
GoString returns the string representation
func (s *AutoScalingGroupProvider) SetAutoScalingGroupArn(v string) *AutoScalingGroupProvider
SetAutoScalingGroupArn sets the AutoScalingGroupArn field's value.
func (s *AutoScalingGroupProvider) SetManagedScaling(v *ManagedScaling) *AutoScalingGroupProvider
SetManagedScaling sets the ManagedScaling field's value.
func (s *AutoScalingGroupProvider) SetManagedTerminationProtection(v string) *AutoScalingGroupProvider
SetManagedTerminationProtection sets the ManagedTerminationProtection field's value.
func (s AutoScalingGroupProvider) String() string
String returns the string representation
func (s *AutoScalingGroupProvider) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AutoScalingGroupProviderUpdate struct { // The managed scaling settings for the Auto Scaling group capacity provider. // // When managed scaling is enabled, 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 disabled, the user must manage the scaling of the Auto // Scaling group. 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 will not work. // // When managed termination protection is enabled, 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 enabled // as well. For more information, see Instance Protection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) // in the AWS Auto Scaling User Guide. // // When managed termination protection is disabled, your Amazon EC2 instances // are not 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 (s AutoScalingGroupProviderUpdate) GoString() string
GoString returns the string representation
func (s *AutoScalingGroupProviderUpdate) SetManagedScaling(v *ManagedScaling) *AutoScalingGroupProviderUpdate
SetManagedScaling sets the ManagedScaling field's value.
func (s *AutoScalingGroupProviderUpdate) SetManagedTerminationProtection(v string) *AutoScalingGroupProviderUpdate
SetManagedTerminationProtection sets the ManagedTerminationProtection field's value.
func (s AutoScalingGroupProviderUpdate) String() string
String returns the string representation
func (s *AutoScalingGroupProviderUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 // do not specify a security group, the default security group for the VPC is // used. There is 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 is 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.
func (s AwsVpcConfiguration) GoString() string
GoString returns the string representation
func (s *AwsVpcConfiguration) SetAssignPublicIp(v string) *AwsVpcConfiguration
SetAssignPublicIp sets the AssignPublicIp field's value.
func (s *AwsVpcConfiguration) SetSecurityGroups(v []*string) *AwsVpcConfiguration
SetSecurityGroups sets the SecurityGroups field's value.
func (s *AwsVpcConfiguration) SetSubnets(v []*string) *AwsVpcConfiguration
SetSubnets sets the Subnets field's value.
func (s AwsVpcConfiguration) String() string
String returns the string representation
func (s *AwsVpcConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BlockedException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
Your AWS account has been blocked. For more information, contact AWS Support (http://aws.amazon.com/contact-us/).
func (s *BlockedException) Code() string
Code returns the exception type name.
func (s *BlockedException) Error() string
func (s BlockedException) GoString() string
GoString returns the string representation
func (s *BlockedException) Message() string
Message returns the exception's message.
func (s *BlockedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *BlockedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *BlockedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s BlockedException) String() string
String returns the string representation
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 will have 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, 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 AWS 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 will be returned. // // DELETE_IN_PROGRESS // // The capacity provider is in the process of being deleted. // // DELETE_COMPLETE // // The capacity provider has been successfully deleted and will have an INACTIVE // status. // // DELETE_FAILED // // The capacity provider was unable to be deleted. The update status reason // will provide 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 of a capacity provider.
func (s CapacityProvider) GoString() string
GoString returns the string representation
func (s *CapacityProvider) SetAutoScalingGroupProvider(v *AutoScalingGroupProvider) *CapacityProvider
SetAutoScalingGroupProvider sets the AutoScalingGroupProvider field's value.
func (s *CapacityProvider) SetCapacityProviderArn(v string) *CapacityProvider
SetCapacityProviderArn sets the CapacityProviderArn field's value.
func (s *CapacityProvider) SetName(v string) *CapacityProvider
SetName sets the Name field's value.
func (s *CapacityProvider) SetStatus(v string) *CapacityProvider
SetStatus sets the Status field's value.
func (s *CapacityProvider) SetTags(v []*Tag) *CapacityProvider
SetTags sets the Tags field's value.
func (s *CapacityProvider) SetUpdateStatus(v string) *CapacityProvider
SetUpdateStatus sets the UpdateStatus field's value.
func (s *CapacityProvider) SetUpdateStatusReason(v string) *CapacityProvider
SetUpdateStatusReason sets the UpdateStatusReason field's value.
func (s CapacityProvider) String() string
String returns the string representation
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. 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. // // For example, if you have 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 is 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.
func (s CapacityProviderStrategyItem) GoString() string
GoString returns the string representation
func (s *CapacityProviderStrategyItem) SetBase(v int64) *CapacityProviderStrategyItem
SetBase sets the Base field's value.
func (s *CapacityProviderStrategyItem) SetCapacityProvider(v string) *CapacityProviderStrategyItem
SetCapacityProvider sets the CapacityProvider field's value.
func (s *CapacityProviderStrategyItem) SetWeight(v int64) *CapacityProviderStrategyItem
SetWeight sets the Weight field's value.
func (s CapacityProviderStrategyItem) String() string
String returns the string representation
func (s *CapacityProviderStrategyItem) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ClientException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
func (s *ClientException) Code() string
Code returns the exception type name.
func (s *ClientException) Error() string
func (s ClientException) GoString() string
GoString returns the string representation
func (s *ClientException) Message() string
Message returns the exception's message.
func (s *ClientException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ClientException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ClientException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ClientException) String() string
String returns the string representation
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 Auto Scaling plan that is created will be returned as a cluster // attachment. Attachments []*Attachment `locationName:"attachments" type:"list"` // The status of the capacity providers associated with the cluster. The following // are the states that will be returned: // // UPDATE_IN_PROGRESS // // The available capacity providers for the cluster are updating. This occurs // when the Auto Scaling plan is provisioning or deprovisioning. // // 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. The ARN contains // the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS // account ID of the cluster owner, the cluster namespace, and then the cluster // name. For example, arn:aws:ecs:region:012345678910:cluster/test. ClusterArn *string `locationName:"clusterArn" type:"string"` // A user-generated string that you use to identify your cluster. ClusterName *string `locationName:"clusterName" type:"string"` // The 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"` // The settings for the cluster. This parameter indicates whether CloudWatch // Container Insights is enabled or disabled for a cluster. Settings []*ClusterSetting `locationName:"settings" type:"list"` // Additional information about your clusters that are separated by launch type, // including: // // * runningEC2TasksCount // // * RunningFargateTasksCount // // * pendingEC2TasksCount // // * pendingFargateTasksCount // // * activeEC2ServiceCount // // * activeFargateServiceCount // // * drainingEC2ServiceCount // // * drainingFargateServiceCount Statistics []*KeyValuePair `locationName:"statistics" type:"list"` // The status of the cluster. The following are the possible states that will // be 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 associated with it and the resources needed // for the capacity provider are being created. // // DEPROVISIONING // // The cluster has capacity providers associated with it and the resources needed // for the capacity provider are being deleted. // // FAILED // // The cluster has capacity providers 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, so you should not 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, 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 AWS 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 on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
func (s Cluster) GoString() string
GoString returns the string representation
func (s *Cluster) SetActiveServicesCount(v int64) *Cluster
SetActiveServicesCount sets the ActiveServicesCount field's value.
func (s *Cluster) SetAttachments(v []*Attachment) *Cluster
SetAttachments sets the Attachments field's value.
func (s *Cluster) SetAttachmentsStatus(v string) *Cluster
SetAttachmentsStatus sets the AttachmentsStatus field's value.
func (s *Cluster) SetCapacityProviders(v []*string) *Cluster
SetCapacityProviders sets the CapacityProviders field's value.
func (s *Cluster) SetClusterArn(v string) *Cluster
SetClusterArn sets the ClusterArn field's value.
func (s *Cluster) SetClusterName(v string) *Cluster
SetClusterName sets the ClusterName field's value.
func (s *Cluster) SetDefaultCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *Cluster
SetDefaultCapacityProviderStrategy sets the DefaultCapacityProviderStrategy field's value.
func (s *Cluster) SetPendingTasksCount(v int64) *Cluster
SetPendingTasksCount sets the PendingTasksCount field's value.
func (s *Cluster) SetRegisteredContainerInstancesCount(v int64) *Cluster
SetRegisteredContainerInstancesCount sets the RegisteredContainerInstancesCount field's value.
func (s *Cluster) SetRunningTasksCount(v int64) *Cluster
SetRunningTasksCount sets the RunningTasksCount field's value.
func (s *Cluster) SetSettings(v []*ClusterSetting) *Cluster
SetSettings sets the Settings field's value.
func (s *Cluster) SetStatistics(v []*KeyValuePair) *Cluster
SetStatistics sets the Statistics field's value.
func (s *Cluster) SetStatus(v string) *Cluster
SetStatus sets the Status field's value.
func (s *Cluster) SetTags(v []*Tag) *Cluster
SetTags sets the Tags field's value.
func (s Cluster) String() string
String returns the string representation
type ClusterContainsContainerInstancesException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
You cannot 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 (s *ClusterContainsContainerInstancesException) Code() string
Code returns the exception type name.
func (s *ClusterContainsContainerInstancesException) Error() string
func (s ClusterContainsContainerInstancesException) GoString() string
GoString returns the string representation
func (s *ClusterContainsContainerInstancesException) Message() string
Message returns the exception's message.
func (s *ClusterContainsContainerInstancesException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ClusterContainsContainerInstancesException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ClusterContainsContainerInstancesException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ClusterContainsContainerInstancesException) String() string
String returns the string representation
type ClusterContainsServicesException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
You cannot 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 (s *ClusterContainsServicesException) Code() string
Code returns the exception type name.
func (s *ClusterContainsServicesException) Error() string
func (s ClusterContainsServicesException) GoString() string
GoString returns the string representation
func (s *ClusterContainsServicesException) Message() string
Message returns the exception's message.
func (s *ClusterContainsServicesException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ClusterContainsServicesException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ClusterContainsServicesException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ClusterContainsServicesException) String() string
String returns the string representation
type ClusterContainsTasksException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
You cannot delete a cluster that has active tasks.
func (s *ClusterContainsTasksException) Code() string
Code returns the exception type name.
func (s *ClusterContainsTasksException) Error() string
func (s ClusterContainsTasksException) GoString() string
GoString returns the string representation
func (s *ClusterContainsTasksException) Message() string
Message returns the exception's message.
func (s *ClusterContainsTasksException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ClusterContainsTasksException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ClusterContainsTasksException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ClusterContainsTasksException) String() string
String returns the string representation
type ClusterNotFoundException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
func (s *ClusterNotFoundException) Code() string
Code returns the exception type name.
func (s *ClusterNotFoundException) Error() string
func (s ClusterNotFoundException) GoString() string
GoString returns the string representation
func (s *ClusterNotFoundException) Message() string
Message returns the exception's message.
func (s *ClusterNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ClusterNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ClusterNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ClusterNotFoundException) String() string
String returns the string representation
type ClusterSetting struct { // The name of the cluster setting. The only supported 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 enabled is specified, CloudWatch Container Insights will // be enabled for the cluster, otherwise it will be disabled unless the containerInsights // account setting is enabled. If a cluster value is specified, it will override // the containerInsights value set with PutAccountSetting or PutAccountSettingDefault. Value *string `locationName:"value" type:"string"` // contains filtered or unexported fields }
The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.
func (s ClusterSetting) GoString() string
GoString returns the string representation
func (s *ClusterSetting) SetName(v string) *ClusterSetting
SetName sets the Name field's value.
func (s *ClusterSetting) SetValue(v string) *ClusterSetting
SetValue sets the Value field's value.
func (s ClusterSetting) String() string
String returns the string representation
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 will be 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 are not 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. // // The imageDigest is only returned if the container is using an image hosted // in Amazon ECR, otherwise it is omitted. ImageDigest *string `locationName:"imageDigest" type:"string"` // The last known status of the container. LastStatus *string `locationName:"lastStatus" type:"string"` // 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 is part of a task.
func (s Container) GoString() string
GoString returns the string representation
func (s *Container) SetContainerArn(v string) *Container
SetContainerArn sets the ContainerArn field's value.
func (s *Container) SetCpu(v string) *Container
SetCpu sets the Cpu field's value.
func (s *Container) SetExitCode(v int64) *Container
SetExitCode sets the ExitCode field's value.
func (s *Container) SetGpuIds(v []*string) *Container
SetGpuIds sets the GpuIds field's value.
func (s *Container) SetHealthStatus(v string) *Container
SetHealthStatus sets the HealthStatus field's value.
func (s *Container) SetImage(v string) *Container
SetImage sets the Image field's value.
func (s *Container) SetImageDigest(v string) *Container
SetImageDigest sets the ImageDigest field's value.
func (s *Container) SetLastStatus(v string) *Container
SetLastStatus sets the LastStatus field's value.
func (s *Container) SetMemory(v string) *Container
SetMemory sets the Memory field's value.
func (s *Container) SetMemoryReservation(v string) *Container
SetMemoryReservation sets the MemoryReservation field's value.
func (s *Container) SetName(v string) *Container
SetName sets the Name field's value.
func (s *Container) SetNetworkBindings(v []*NetworkBinding) *Container
SetNetworkBindings sets the NetworkBindings field's value.
func (s *Container) SetNetworkInterfaces(v []*NetworkInterface) *Container
SetNetworkInterfaces sets the NetworkInterfaces field's value.
func (s *Container) SetReason(v string) *Container
SetReason sets the Reason field's value.
func (s *Container) SetRuntimeId(v string) *Container
SetRuntimeId sets the RuntimeId field's value.
func (s *Container) SetTaskArn(v string) *Container
SetTaskArn sets the TaskArn field's value.
func (s Container) String() string
String returns the string representation
type ContainerDefinition struct { // The command that is passed to the container. This parameter maps to Cmd in // the Create a container (https://docs.docker.com/engine/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 should be 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 is the only task running // on the container instance, that container could use the full 1,024 CPU unit // share at any given time. However, if you launched another copy of the same // task on that container instance, each task would be guaranteed a minimum // of 512 CPU units when needed, and each container could float to higher CPU // usage if the other container was not using it, but if both tasks were 100% // active all of the time, they would be limited to 512 CPU units. // // On Linux container instances, the Docker daemon on the container instance // uses the CPU value to calculate the relative CPU share ratios for running // containers. For more information, see CPU share constraint (https://docs.docker.com/engine/reference/run/#cpu-share-constraint) // in the Docker documentation. The minimum valid CPU share value that the Linux // kernel allows is 2. However, the CPU parameter is not required, and you can // use CPU values below 2 in your container definitions. For CPU values below // 2 (including null), the behavior varies based on your Amazon ECS container // agent version: // // * Agent versions less than or equal to 1.1.0: Null and zero CPU values // are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. // CPU values of 1 are passed to Docker as 1, which the Linux kernel converts // to 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 is 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"` // 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. // // For tasks using the EC2 launch type, the container instances require at least // version 1.26.0 of the container agent to enable 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 are 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 platform // version 1.3.0 or later. DependsOn []*ContainerDependency `locationName:"dependsOn" type:"list"` // When this parameter is true, networking is disabled within the container. // This parameter maps to NetworkDisabled in the Create a container (https://docs.docker.com/engine/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 or tasks that use // the awsvpc network mode. 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 or tasks that use // the awsvpc network mode. 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 or tasks that use // the awsvpc network mode. 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 labels for SELinux and AppArmor multi-level // security systems. This field is not valid for containers in tasks using the // Fargate launch type. // // With Windows containers, this parameter can be used to reference a credential // spec file when configuring 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) // 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 do not properly handle entryPoint // parameters. If you have problems using entryPoint, update your container // agent or enter your commands and arguments as command array items instead. // // The entry point that is passed to the container. This parameter maps to Entrypoint // in the Create a container (https://docs.docker.com/engine/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 do not recommend using 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 should contain an environment // variable in VARIABLE=VALUE format. Lines beginning with # are treated as // comments and are ignored. For more information on 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 are processed from the top down. It is recommended // to 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, then its failure does not affect the rest of the containers in a task. // If this parameter is omitted, a container is assumed to be essential. // // All tasks must have at least one essential container. If you have an application // that is composed of multiple containers, you should group containers that // are used for a common purpose into components, and separate the different // components into multiple task definitions. For more information, see Application // Architecture (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 is not 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 are 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. Images in the Docker Hub registry are available by default. // Other repositories are specified with either repository-url/image:tag or // repository-url/image@digest . Up to 255 letters (uppercase and lowercase), // numbers, hyphens, underscores, colons, periods, forward slashes, and number // signs are allowed. This parameter maps to Image in the Create a container // (https://docs.docker.com/engine/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 are not propagated to already // running tasks. // // * Images in Amazon ECR repositories can be specified by either using the // full registry/repository:tag or registry/repository@digest. For example, // 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest // or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. // // * Images in official repositories on Docker Hub use a single name (for // example, ubuntu or mongo). // // * Images in other repositories on Docker Hub are qualified with an organization // name (for example, amazon/amazon-ecs-agent). // // * Images in other online repositories are qualified further by a domain // name (for example, quay.io/assemblyline/ubuntu). Image *string `locationName:"image" type:"string"` // When this parameter is true, this allows you to 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, 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 or tasks that use // the awsvpc network mode. // // 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 may use a different logging driver than the Docker // daemon by specifying a log driver with this parameter in the container definition. // To use a different logging driver for a container, the log system must be // configured properly on the container instance (or on a different log server // for remote logging options). For more information on the options for different // supported log drivers, see Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/) // in the Docker documentation. // // Amazon ECS currently supports a subset of the logging drivers available to // the Docker daemon (shown in the LogConfiguration data type). Additional log // drivers may be available in future releases of the Amazon ECS container agent. // // This parameter requires version 1.18 of the Docker Remote API or greater // on your container instance. To check the Docker Remote API version on your // container instance, log in to your container instance and run the following // command: sudo docker version --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 on which the container // is placed. Otherwise, the value of memory is used. // // The Docker daemon reserves a minimum of 4 MiB of memory for a container, // so you should not specify fewer than 4 MiB of memory for your containers. Memory *int64 `locationName:"memory" type:"integer"` // The soft limit (in MiB) of memory to reserve for the container. When system // memory is under heavy contention, Docker attempts to keep the container memory // to this soft limit. However, your container can consume more memory when // it needs to, up to either the hard limit specified with the memory parameter // (if applicable), or all of the available memory on the container instance, // whichever comes first. This parameter maps to MemoryReservation in the Create // a container (https://docs.docker.com/engine/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 on which the container is placed. // Otherwise, the value of memory is used. // // For example, if your container normally uses 128 MiB of memory, but occasionally // bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation // of 128 MiB, and a memory hard limit of 300 MiB. This configuration would // allow the container to only reserve 128 MiB of memory from the remaining // resources on the container instance, but also allow the container to consume // more memory resources when needed. // // The Docker daemon reserves a minimum of 4 MiB of memory for a container, // so you should not specify fewer than 4 MiB of memory for your containers. MemoryReservation *int64 `locationName:"memoryReservation" type:"integer"` // The mount points for data volumes in your container. // // This parameter maps to Volumes in the Create a container (https://docs.docker.com/engine/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 cannot mount directories on a different drive, and mount // point cannot be across drives. MountPoints []*MountPoint `locationName:"mountPoints" type:"list"` // The name of a container. If you are linking multiple containers together // in a task definition, the name of one container can be entered in the links // of another container to connect the containers. Up to 255 letters (uppercase // and lowercase), numbers, 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, you should only specify // the containerPort. The hostPort can be left blank or it must be the same // value as the containerPort. // // Port mappings on Windows use the NetNAT gateway address rather than localhost. // There is no loopback for port mappings on Windows, so you cannot access a // container's mapped port from the host itself. // // This parameter maps to PortBindings in the Create a container (https://docs.docker.com/engine/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 using the // Fargate launch type. 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 or tasks that use // the awsvpc network mode. 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 does not reach the desired status within that time then containerA will // give 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 is enforced indendently from this start timeout value. // // For tasks using the Fargate launch type, this parameter requires that the // task or service uses platform version 1.3.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 enable 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 are 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. 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 platform // version 1.3.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 using the EC2 launch type, if the stopTimeout parameter is not // specified, the value set for the Amazon ECS container agent configuration // variable ECS_CONTAINER_STOP_TIMEOUT is used by default. 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 enable 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 are 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. 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). // // It is not recommended that you specify network-related systemControls parameters // for multiple containers in a single task that also uses either the awsvpc // or host network modes. For tasks that use the awsvpc network mode, the container // that is started last determines which systemControls parameters take effect. // For tasks that use the host network mode, it changes the container instance's // namespaced kernel parameters as well as the containers. 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 will override 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. 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 or tasks that use // the awsvpc network mode. 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, you should not run containers // using the root user (UID 0). It is considered best practice to use a non-root // user. // // 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 or tasks that use // the awsvpc network mode. 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 in which to run commands inside the container. 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 (s ContainerDefinition) GoString() string
GoString returns the string representation
func (s *ContainerDefinition) SetCommand(v []*string) *ContainerDefinition
SetCommand sets the Command field's value.
func (s *ContainerDefinition) SetCpu(v int64) *ContainerDefinition
SetCpu sets the Cpu field's value.
func (s *ContainerDefinition) SetDependsOn(v []*ContainerDependency) *ContainerDefinition
SetDependsOn sets the DependsOn field's value.
func (s *ContainerDefinition) SetDisableNetworking(v bool) *ContainerDefinition
SetDisableNetworking sets the DisableNetworking field's value.
func (s *ContainerDefinition) SetDnsSearchDomains(v []*string) *ContainerDefinition
SetDnsSearchDomains sets the DnsSearchDomains field's value.
func (s *ContainerDefinition) SetDnsServers(v []*string) *ContainerDefinition
SetDnsServers sets the DnsServers field's value.
func (s *ContainerDefinition) SetDockerLabels(v map[string]*string) *ContainerDefinition
SetDockerLabels sets the DockerLabels field's value.
func (s *ContainerDefinition) SetDockerSecurityOptions(v []*string) *ContainerDefinition
SetDockerSecurityOptions sets the DockerSecurityOptions field's value.
func (s *ContainerDefinition) SetEntryPoint(v []*string) *ContainerDefinition
SetEntryPoint sets the EntryPoint field's value.
func (s *ContainerDefinition) SetEnvironment(v []*KeyValuePair) *ContainerDefinition
SetEnvironment sets the Environment field's value.
func (s *ContainerDefinition) SetEnvironmentFiles(v []*EnvironmentFile) *ContainerDefinition
SetEnvironmentFiles sets the EnvironmentFiles field's value.
func (s *ContainerDefinition) SetEssential(v bool) *ContainerDefinition
SetEssential sets the Essential field's value.
func (s *ContainerDefinition) SetExtraHosts(v []*HostEntry) *ContainerDefinition
SetExtraHosts sets the ExtraHosts field's value.
func (s *ContainerDefinition) SetFirelensConfiguration(v *FirelensConfiguration) *ContainerDefinition
SetFirelensConfiguration sets the FirelensConfiguration field's value.
func (s *ContainerDefinition) SetHealthCheck(v *HealthCheck) *ContainerDefinition
SetHealthCheck sets the HealthCheck field's value.
func (s *ContainerDefinition) SetHostname(v string) *ContainerDefinition
SetHostname sets the Hostname field's value.
func (s *ContainerDefinition) SetImage(v string) *ContainerDefinition
SetImage sets the Image field's value.
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 (s *ContainerDefinition) SetLinuxParameters(v *LinuxParameters) *ContainerDefinition
SetLinuxParameters sets the LinuxParameters field's value.
func (s *ContainerDefinition) SetLogConfiguration(v *LogConfiguration) *ContainerDefinition
SetLogConfiguration sets the LogConfiguration field's value.
func (s *ContainerDefinition) SetMemory(v int64) *ContainerDefinition
SetMemory sets the Memory field's value.
func (s *ContainerDefinition) SetMemoryReservation(v int64) *ContainerDefinition
SetMemoryReservation sets the MemoryReservation field's value.
func (s *ContainerDefinition) SetMountPoints(v []*MountPoint) *ContainerDefinition
SetMountPoints sets the MountPoints field's value.
func (s *ContainerDefinition) SetName(v string) *ContainerDefinition
SetName sets the Name field's value.
func (s *ContainerDefinition) SetPortMappings(v []*PortMapping) *ContainerDefinition
SetPortMappings sets the PortMappings field's value.
func (s *ContainerDefinition) SetPrivileged(v bool) *ContainerDefinition
SetPrivileged sets the Privileged field's value.
func (s *ContainerDefinition) SetPseudoTerminal(v bool) *ContainerDefinition
SetPseudoTerminal sets the PseudoTerminal field's value.
func (s *ContainerDefinition) SetReadonlyRootFilesystem(v bool) *ContainerDefinition
SetReadonlyRootFilesystem sets the ReadonlyRootFilesystem field's value.
func (s *ContainerDefinition) SetRepositoryCredentials(v *RepositoryCredentials) *ContainerDefinition
SetRepositoryCredentials sets the RepositoryCredentials field's value.
func (s *ContainerDefinition) SetResourceRequirements(v []*ResourceRequirement) *ContainerDefinition
SetResourceRequirements sets the ResourceRequirements field's value.
func (s *ContainerDefinition) SetSecrets(v []*Secret) *ContainerDefinition
SetSecrets sets the Secrets field's value.
func (s *ContainerDefinition) SetStartTimeout(v int64) *ContainerDefinition
SetStartTimeout sets the StartTimeout field's value.
func (s *ContainerDefinition) SetStopTimeout(v int64) *ContainerDefinition
SetStopTimeout sets the StopTimeout field's value.
func (s *ContainerDefinition) SetSystemControls(v []*SystemControl) *ContainerDefinition
SetSystemControls sets the SystemControls field's value.
func (s *ContainerDefinition) SetUlimits(v []*Ulimit) *ContainerDefinition
SetUlimits sets the Ulimits field's value.
func (s *ContainerDefinition) SetUser(v string) *ContainerDefinition
SetUser sets the User field's value.
func (s *ContainerDefinition) SetVolumesFrom(v []*VolumeFrom) *ContainerDefinition
SetVolumesFrom sets the VolumesFrom field's value.
func (s *ContainerDefinition) SetWorkingDirectory(v string) *ContainerDefinition
SetWorkingDirectory sets the WorkingDirectory field's value.
func (s ContainerDefinition) String() string
String returns the string representation
func (s *ContainerDefinition) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 cannot 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 cannot 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 enable 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 are 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, this parameter requires that the task or service uses platform version 1.3.0 or later.
func (s ContainerDependency) GoString() string
GoString returns the string representation
func (s *ContainerDependency) SetCondition(v string) *ContainerDependency
SetCondition sets the Condition field's value.
func (s *ContainerDependency) SetContainerName(v string) *ContainerDependency
SetContainerName sets the ContainerName field's value.
func (s ContainerDependency) String() string
String returns the string representation
func (s *ContainerDependency) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ContainerInstance struct { // This parameter returns true if the agent is connected to Amazon ECS. Registered // instances with an agent that may be unhealthy or stopped return false. Only // instances connected to an agent can accept placement requests. AgentConnected *bool `locationName:"agentConnected" type:"boolean"` // The status of the most recent agent update. If an update has never been requested, // this value is NULL. AgentUpdateStatus *string `locationName:"agentUpdateStatus" type:"string" enum:"AgentUpdateStatus"` // The resources attached to a container instance, such as elastic network interfaces. 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 associated with the container instance. CapacityProviderName *string `locationName:"capacityProviderName" type:"string"` // The Amazon Resource Name (ARN) of the container instance. The ARN contains // the arn:aws:ecs namespace, followed by the Region of the container instance, // the AWS account ID of the container instance owner, the container-instance // namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID. ContainerInstanceArn *string `locationName:"containerInstanceArn" type:"string"` // The EC2 instance ID of the container instance. Ec2InstanceId *string `locationName:"ec2InstanceId" type:"string"` // The number of tasks on the container instance that are in the PENDING status. PendingTasksCount *int64 `locationName:"pendingTasksCount" type:"integer"` // The Unix timestamp for 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 has not already been allocated to tasks and is therefore // available for new tasks. For port resource types, this parameter describes // the ports that were reserved by the Amazon ECS container agent (at instance // registration time) and any task containers that have reserved port mappings // on the host (with the host or bridge network mode). Any port that is not // specified here is available for new tasks. RemainingResources []*Resource `locationName:"remainingResources" type:"list"` // The number of tasks on the container instance that are in the RUNNING status. RunningTasksCount *int64 `locationName:"runningTasksCount" type:"integer"` // The status of the container instance. The valid values are 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 are not placed on the container instance // and any service tasks running on the container instance are removed if possible. // For more information, see Container Instance Draining (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, 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 AWS 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 are replicating your Amazon ECS container instance // state with CloudWatch Events, you can compare the version of a container // instance reported by the Amazon ECS APIs with the version reported in CloudWatch // Events for the container instance (inside the detail object) to verify that // the version in your event stream is current. Version *int64 `locationName:"version" type:"long"` // The version information for the Amazon ECS container agent and Docker daemon // running on the container instance. VersionInfo *VersionInfo `locationName:"versionInfo" type:"structure"` // contains filtered or unexported fields }
An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
func (s ContainerInstance) GoString() string
GoString returns the string representation
func (s *ContainerInstance) SetAgentConnected(v bool) *ContainerInstance
SetAgentConnected sets the AgentConnected field's value.
func (s *ContainerInstance) SetAgentUpdateStatus(v string) *ContainerInstance
SetAgentUpdateStatus sets the AgentUpdateStatus field's value.
func (s *ContainerInstance) SetAttachments(v []*Attachment) *ContainerInstance
SetAttachments sets the Attachments field's value.
func (s *ContainerInstance) SetAttributes(v []*Attribute) *ContainerInstance
SetAttributes sets the Attributes field's value.
func (s *ContainerInstance) SetCapacityProviderName(v string) *ContainerInstance
SetCapacityProviderName sets the CapacityProviderName field's value.
func (s *ContainerInstance) SetContainerInstanceArn(v string) *ContainerInstance
SetContainerInstanceArn sets the ContainerInstanceArn field's value.
func (s *ContainerInstance) SetEc2InstanceId(v string) *ContainerInstance
SetEc2InstanceId sets the Ec2InstanceId field's value.
func (s *ContainerInstance) SetPendingTasksCount(v int64) *ContainerInstance
SetPendingTasksCount sets the PendingTasksCount field's value.
func (s *ContainerInstance) SetRegisteredAt(v time.Time) *ContainerInstance
SetRegisteredAt sets the RegisteredAt field's value.
func (s *ContainerInstance) SetRegisteredResources(v []*Resource) *ContainerInstance
SetRegisteredResources sets the RegisteredResources field's value.
func (s *ContainerInstance) SetRemainingResources(v []*Resource) *ContainerInstance
SetRemainingResources sets the RemainingResources field's value.
func (s *ContainerInstance) SetRunningTasksCount(v int64) *ContainerInstance
SetRunningTasksCount sets the RunningTasksCount field's value.
func (s *ContainerInstance) SetStatus(v string) *ContainerInstance
SetStatus sets the Status field's value.
func (s *ContainerInstance) SetStatusReason(v string) *ContainerInstance
SetStatusReason sets the StatusReason field's value.
func (s *ContainerInstance) SetTags(v []*Tag) *ContainerInstance
SetTags sets the Tags field's value.
func (s *ContainerInstance) SetVersion(v int64) *ContainerInstance
SetVersion sets the Version field's value.
func (s *ContainerInstance) SetVersionInfo(v *VersionInfo) *ContainerInstance
SetVersionInfo sets the VersionInfo field's value.
func (s ContainerInstance) String() string
String returns the string representation
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 should be sent to a container. An empty container override can be passed in. An example of an empty container override would be {"containerOverrides": [ ] }. If a non-empty container override is specified, the name parameter must be included.
func (s ContainerOverride) GoString() string
GoString returns the string representation
func (s *ContainerOverride) SetCommand(v []*string) *ContainerOverride
SetCommand sets the Command field's value.
func (s *ContainerOverride) SetCpu(v int64) *ContainerOverride
SetCpu sets the Cpu field's value.
func (s *ContainerOverride) SetEnvironment(v []*KeyValuePair) *ContainerOverride
SetEnvironment sets the Environment field's value.
func (s *ContainerOverride) SetEnvironmentFiles(v []*EnvironmentFile) *ContainerOverride
SetEnvironmentFiles sets the EnvironmentFiles field's value.
func (s *ContainerOverride) SetMemory(v int64) *ContainerOverride
SetMemory sets the Memory field's value.
func (s *ContainerOverride) SetMemoryReservation(v int64) *ContainerOverride
SetMemoryReservation sets the MemoryReservation field's value.
func (s *ContainerOverride) SetName(v string) *ContainerOverride
SetName sets the Name field's value.
func (s *ContainerOverride) SetResourceRequirements(v []*ResourceRequirement) *ContainerOverride
SetResourceRequirements sets the ResourceRequirements field's value.
func (s ContainerOverride) String() string
String returns the string representation
func (s *ContainerOverride) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 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 representing a change in state for a container.
func (s ContainerStateChange) GoString() string
GoString returns the string representation
func (s *ContainerStateChange) SetContainerName(v string) *ContainerStateChange
SetContainerName sets the ContainerName field's value.
func (s *ContainerStateChange) SetExitCode(v int64) *ContainerStateChange
SetExitCode sets the ExitCode field's value.
func (s *ContainerStateChange) SetImageDigest(v string) *ContainerStateChange
SetImageDigest sets the ImageDigest field's value.
func (s *ContainerStateChange) SetNetworkBindings(v []*NetworkBinding) *ContainerStateChange
SetNetworkBindings sets the NetworkBindings field's value.
func (s *ContainerStateChange) SetReason(v string) *ContainerStateChange
SetReason sets the Reason field's value.
func (s *ContainerStateChange) SetRuntimeId(v string) *ContainerStateChange
SetRuntimeId sets the RuntimeId field's value.
func (s *ContainerStateChange) SetStatus(v string) *ContainerStateChange
SetStatus sets the Status field's value.
func (s ContainerStateChange) String() string
String returns the string representation
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, including // letters (upper and lowercase), numbers, underscores, and hyphens. The name // cannot 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 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 AWS 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 (s CreateCapacityProviderInput) GoString() string
GoString returns the string representation
func (s *CreateCapacityProviderInput) SetAutoScalingGroupProvider(v *AutoScalingGroupProvider) *CreateCapacityProviderInput
SetAutoScalingGroupProvider sets the AutoScalingGroupProvider field's value.
func (s *CreateCapacityProviderInput) SetName(v string) *CreateCapacityProviderInput
SetName sets the Name field's value.
func (s *CreateCapacityProviderInput) SetTags(v []*Tag) *CreateCapacityProviderInput
SetTags sets the Tags field's value.
func (s CreateCapacityProviderInput) String() string
String returns the string representation
func (s *CreateCapacityProviderInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateCapacityProviderOutput struct { // The full description of the new capacity provider. CapacityProvider *CapacityProvider `locationName:"capacityProvider" type:"structure"` // contains filtered or unexported fields }
func (s CreateCapacityProviderOutput) GoString() string
GoString returns the string representation
func (s *CreateCapacityProviderOutput) SetCapacityProvider(v *CapacityProvider) *CreateCapacityProviderOutput
SetCapacityProvider sets the CapacityProvider field's value.
func (s CreateCapacityProviderOutput) String() string
String returns the string representation
type CreateClusterInput struct { // The short 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 and not already associated with another // cluster. New capacity providers can be created with the CreateCapacityProvider // API operation. // // To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT // capacity providers. The AWS 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. CapacityProviders []*string `locationName:"capacityProviders" type:"list"` // The name of your cluster. If you do not specify a name for your cluster, // you create a cluster named default. Up to 255 letters (uppercase and lowercase), // numbers, and hyphens are allowed. ClusterName *string `locationName:"clusterName" type:"string"` // 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 AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT // capacity providers. The AWS Fargate capacity providers are available to all // accounts and only need to be associated with a cluster to be used. // // If a default capacity provider strategy is not defined for a cluster during // creation, it can be defined later with the PutClusterCapacityProviders API // operation. DefaultCapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"defaultCapacityProviderStrategy" type:"list"` // The setting to use when creating a cluster. This parameter is used to enable // CloudWatch Container Insights for a cluster. If this value is specified, // it will override 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, 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 AWS 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 (s CreateClusterInput) GoString() string
GoString returns the string representation
func (s *CreateClusterInput) SetCapacityProviders(v []*string) *CreateClusterInput
SetCapacityProviders sets the CapacityProviders field's value.
func (s *CreateClusterInput) SetClusterName(v string) *CreateClusterInput
SetClusterName sets the ClusterName field's value.
func (s *CreateClusterInput) SetDefaultCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *CreateClusterInput
SetDefaultCapacityProviderStrategy sets the DefaultCapacityProviderStrategy field's value.
func (s *CreateClusterInput) SetSettings(v []*ClusterSetting) *CreateClusterInput
SetSettings sets the Settings field's value.
func (s *CreateClusterInput) SetTags(v []*Tag) *CreateClusterInput
SetTags sets the Tags field's value.
func (s CreateClusterInput) String() string
String returns the string representation
func (s *CreateClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateClusterOutput struct { // The full description of your new cluster. Cluster *Cluster `locationName:"cluster" type:"structure"` // contains filtered or unexported fields }
func (s CreateClusterOutput) GoString() string
GoString returns the string representation
func (s *CreateClusterOutput) SetCluster(v *Cluster) *CreateClusterOutput
SetCluster sets the Cluster field's value.
func (s CreateClusterOutput) String() string
String returns the string representation
type CreateServiceInput struct { // The capacity provider strategy to use for the service. // // 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 AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT // capacity providers. The AWS 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"` // Unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. Up to 32 ASCII characters are allowed. ClientToken *string `locationName:"clientToken" type:"string"` // The short name or full Amazon Resource Name (ARN) of the cluster on which // to run your service. If you do not specify a cluster, the default cluster // is assumed. Cluster *string `locationName:"cluster" type:"string"` // Optional deployment parameters that control how many tasks run during the // deployment and the ordering of stopping and starting tasks. DeploymentConfiguration *DeploymentConfiguration `locationName:"deploymentConfiguration" type:"structure"` // The deployment controller to use for the service. DeploymentController *DeploymentController `locationName:"deploymentController" type:"structure"` // The number of instantiations of the specified task definition to place and // keep running on your cluster. // // This is required if schedulingStrategy is REPLICA or is not specified. If // schedulingStrategy is DAEMON then this is not required. DesiredCount *int64 `locationName:"desiredCount" type:"integer"` // Specifies whether to enable 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. EnableECSManagedTags *bool `locationName:"enableECSManagedTags" type:"boolean"` // The period of time, in seconds, that the Amazon ECS service scheduler should // ignore unhealthy Elastic Load Balancing target health checks after a task // has first started. This is only 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 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 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 launch type on which to run your service. 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 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 is using 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 make use of 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 is using the CODE_DEPLOY deployment controller, the service // is required to use either an Application Load Balancer or Network Load Balancer. // When creating an AWS CodeDeploy deployment group, you specify two target // groups (referred to as a targetGroupPair). During a deployment, AWS CodeDeploy // determines which task set in your service has the status PRIMARY and associates // one target group with it, and then 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 // allows you perform validation tests with Lambda functions before routing // production traffic to it. // // After you create a service using the ECS deployment controller, the load // balancer name or target group ARN, container name, and container port specified // in the service definition are immutable. If you are using 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 (as it appears // in a container definition), and the container port to access from the load // balancer. 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 specified // here. // // For Classic Load Balancers, this object must contain the load balancer name, // the container name (as it appears in a container definition), and the container // port to access from the load balancer. 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 specified here. // // Services with tasks that use the awsvpc network mode (for example, those // with the Fargate launch type) only support Application Load Balancers and // Network Load Balancers. Classic Load Balancers are not supported. Also, when // you create any target groups for these services, you must choose ip as the // target type, not instance, because tasks that use the awsvpc network mode // are associated with an elastic network interface, not an Amazon EC2 instance. LoadBalancers []*LoadBalancer `locationName:"loadBalancers" type:"list"` // The network configuration for the service. This parameter is required for // task definitions that use the awsvpc network mode to receive their own elastic // network interface, and it is not supported for other network modes. For more // information, see Task Networking (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 per 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 five strategy rules per 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 by default. For more // information, see AWS 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 or the service // to the tasks in the service. If no value is specified, the tags are not propagated. // Tags can only be propagated to the tasks within the service during service // creation. To add tags to a task after service creation, use the TagResource // API action. 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 does not use the awsvpc network mode. If you specify the // role parameter, you must also specify a load balancer object with the loadBalancers // parameter. // // If your account has already created the Amazon ECS service-linked role, that // role is used by default for your service unless you specify a role here. // The service-linked role is required if your task definition uses the awsvpc // network mode 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 should not 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 is using 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 // do not 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 name of your service. Up to 255 letters (uppercase and lowercase), numbers, // 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 registries to assign to this service. // For more information, see Service Discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). // // Service discovery is supported for Fargate tasks if you are using platform // version v1.1.0 or later. For more information, see AWS Fargate Platform Versions // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html). 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 AWS 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 is not specified, the latest ACTIVE // revision is used. // // A task definition must be specified if the service is using either the ECS // or CODE_DEPLOY deployment controllers. TaskDefinition *string `locationName:"taskDefinition" type:"string"` // contains filtered or unexported fields }
func (s CreateServiceInput) GoString() string
GoString returns the string representation
func (s *CreateServiceInput) SetCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *CreateServiceInput
SetCapacityProviderStrategy sets the CapacityProviderStrategy field's value.
func (s *CreateServiceInput) SetClientToken(v string) *CreateServiceInput
SetClientToken sets the ClientToken field's value.
func (s *CreateServiceInput) SetCluster(v string) *CreateServiceInput
SetCluster sets the Cluster field's value.
func (s *CreateServiceInput) SetDeploymentConfiguration(v *DeploymentConfiguration) *CreateServiceInput
SetDeploymentConfiguration sets the DeploymentConfiguration field's value.
func (s *CreateServiceInput) SetDeploymentController(v *DeploymentController) *CreateServiceInput
SetDeploymentController sets the DeploymentController field's value.
func (s *CreateServiceInput) SetDesiredCount(v int64) *CreateServiceInput
SetDesiredCount sets the DesiredCount field's value.
func (s *CreateServiceInput) SetEnableECSManagedTags(v bool) *CreateServiceInput
SetEnableECSManagedTags sets the EnableECSManagedTags field's value.
func (s *CreateServiceInput) SetHealthCheckGracePeriodSeconds(v int64) *CreateServiceInput
SetHealthCheckGracePeriodSeconds sets the HealthCheckGracePeriodSeconds field's value.
func (s *CreateServiceInput) SetLaunchType(v string) *CreateServiceInput
SetLaunchType sets the LaunchType field's value.
func (s *CreateServiceInput) SetLoadBalancers(v []*LoadBalancer) *CreateServiceInput
SetLoadBalancers sets the LoadBalancers field's value.
func (s *CreateServiceInput) SetNetworkConfiguration(v *NetworkConfiguration) *CreateServiceInput
SetNetworkConfiguration sets the NetworkConfiguration field's value.
func (s *CreateServiceInput) SetPlacementConstraints(v []*PlacementConstraint) *CreateServiceInput
SetPlacementConstraints sets the PlacementConstraints field's value.
func (s *CreateServiceInput) SetPlacementStrategy(v []*PlacementStrategy) *CreateServiceInput
SetPlacementStrategy sets the PlacementStrategy field's value.
func (s *CreateServiceInput) SetPlatformVersion(v string) *CreateServiceInput
SetPlatformVersion sets the PlatformVersion field's value.
func (s *CreateServiceInput) SetPropagateTags(v string) *CreateServiceInput
SetPropagateTags sets the PropagateTags field's value.
func (s *CreateServiceInput) SetRole(v string) *CreateServiceInput
SetRole sets the Role field's value.
func (s *CreateServiceInput) SetSchedulingStrategy(v string) *CreateServiceInput
SetSchedulingStrategy sets the SchedulingStrategy field's value.
func (s *CreateServiceInput) SetServiceName(v string) *CreateServiceInput
SetServiceName sets the ServiceName field's value.
func (s *CreateServiceInput) SetServiceRegistries(v []*ServiceRegistry) *CreateServiceInput
SetServiceRegistries sets the ServiceRegistries field's value.
func (s *CreateServiceInput) SetTags(v []*Tag) *CreateServiceInput
SetTags sets the Tags field's value.
func (s *CreateServiceInput) SetTaskDefinition(v string) *CreateServiceInput
SetTaskDefinition sets the TaskDefinition field's value.
func (s CreateServiceInput) String() string
String returns the string representation
func (s *CreateServiceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateServiceOutput struct { // The full description of your service following the create call. // // If a service is using the ECS deployment controller, the deploymentController // and taskSets parameters will not be returned. // // If the service is using 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 (s CreateServiceOutput) GoString() string
GoString returns the string representation
func (s *CreateServiceOutput) SetService(v *Service) *CreateServiceOutput
SetService sets the Service field's value.
func (s CreateServiceOutput) String() string
String returns the string representation
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 AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT // capacity providers. The AWS 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"` // Unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. Up to 32 ASCII characters are allowed. ClientToken *string `locationName:"clientToken" type:"string"` // The short name or full Amazon Resource Name (ARN) of the cluster 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 AWS Cloud Map attribute // set to the provided value. ExternalId *string `locationName:"externalId" type:"string"` // The launch type that new tasks in the task set will use. 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 or service. NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"` // The platform version that the tasks in the task set should use. A platform // version is specified only for tasks using the Fargate launch type. If one // isn't specified, the LATEST platform version is used by default. 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, 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 AWS 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. // // TaskDefinition is a required field TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"` // contains filtered or unexported fields }
func (s CreateTaskSetInput) GoString() string
GoString returns the string representation
func (s *CreateTaskSetInput) SetCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *CreateTaskSetInput
SetCapacityProviderStrategy sets the CapacityProviderStrategy field's value.
func (s *CreateTaskSetInput) SetClientToken(v string) *CreateTaskSetInput
SetClientToken sets the ClientToken field's value.
func (s *CreateTaskSetInput) SetCluster(v string) *CreateTaskSetInput
SetCluster sets the Cluster field's value.
func (s *CreateTaskSetInput) SetExternalId(v string) *CreateTaskSetInput
SetExternalId sets the ExternalId field's value.
func (s *CreateTaskSetInput) SetLaunchType(v string) *CreateTaskSetInput
SetLaunchType sets the LaunchType field's value.
func (s *CreateTaskSetInput) SetLoadBalancers(v []*LoadBalancer) *CreateTaskSetInput
SetLoadBalancers sets the LoadBalancers field's value.
func (s *CreateTaskSetInput) SetNetworkConfiguration(v *NetworkConfiguration) *CreateTaskSetInput
SetNetworkConfiguration sets the NetworkConfiguration field's value.
func (s *CreateTaskSetInput) SetPlatformVersion(v string) *CreateTaskSetInput
SetPlatformVersion sets the PlatformVersion field's value.
func (s *CreateTaskSetInput) SetScale(v *Scale) *CreateTaskSetInput
SetScale sets the Scale field's value.
func (s *CreateTaskSetInput) SetService(v string) *CreateTaskSetInput
SetService sets the Service field's value.
func (s *CreateTaskSetInput) SetServiceRegistries(v []*ServiceRegistry) *CreateTaskSetInput
SetServiceRegistries sets the ServiceRegistries field's value.
func (s *CreateTaskSetInput) SetTags(v []*Tag) *CreateTaskSetInput
SetTags sets the Tags field's value.
func (s *CreateTaskSetInput) SetTaskDefinition(v string) *CreateTaskSetInput
SetTaskDefinition sets the TaskDefinition field's value.
func (s CreateTaskSetInput) String() string
String returns the string representation
func (s *CreateTaskSetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateTaskSetOutput struct { // Information about a set of Amazon ECS tasks in either an AWS 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. TaskSet *TaskSet `locationName:"taskSet" type:"structure"` // contains filtered or unexported fields }
func (s CreateTaskSetOutput) GoString() string
GoString returns the string representation
func (s *CreateTaskSetOutput) SetTaskSet(v *TaskSet) *CreateTaskSetOutput
SetTaskSet sets the TaskSet field's value.
func (s CreateTaskSetOutput) String() string
String returns the string representation
type DeleteAccountSettingInput struct { // The resource name for which to disable the account setting. 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 ARN of the principal, which can be an IAM user, IAM role, or the root // user. If you specify the root user, it disables the account setting for all // IAM users, IAM roles, and the root user of the account unless an IAM 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 (s DeleteAccountSettingInput) GoString() string
GoString returns the string representation
func (s *DeleteAccountSettingInput) SetName(v string) *DeleteAccountSettingInput
SetName sets the Name field's value.
func (s *DeleteAccountSettingInput) SetPrincipalArn(v string) *DeleteAccountSettingInput
SetPrincipalArn sets the PrincipalArn field's value.
func (s DeleteAccountSettingInput) String() string
String returns the string representation
func (s *DeleteAccountSettingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteAccountSettingOutput struct { // The account setting for the specified principal ARN. Setting *Setting `locationName:"setting" type:"structure"` // contains filtered or unexported fields }
func (s DeleteAccountSettingOutput) GoString() string
GoString returns the string representation
func (s *DeleteAccountSettingOutput) SetSetting(v *Setting) *DeleteAccountSettingOutput
SetSetting sets the Setting field's value.
func (s DeleteAccountSettingOutput) String() string
String returns the string representation
type DeleteAttributesInput struct { // The attributes to delete from your resource. You can specify up to 10 attributes // per request. For custom attributes, specify the attribute name and target // ID, but do not specify the value. If you specify the target ID using the // short form, you must also specify the target type. // // Attributes is a required field Attributes []*Attribute `locationName:"attributes" type:"list" required:"true"` // The short name or full Amazon Resource Name (ARN) of the cluster that contains // the resource to delete attributes. If you do not specify a cluster, the default // cluster is assumed. Cluster *string `locationName:"cluster" type:"string"` // contains filtered or unexported fields }
func (s DeleteAttributesInput) GoString() string
GoString returns the string representation
func (s *DeleteAttributesInput) SetAttributes(v []*Attribute) *DeleteAttributesInput
SetAttributes sets the Attributes field's value.
func (s *DeleteAttributesInput) SetCluster(v string) *DeleteAttributesInput
SetCluster sets the Cluster field's value.
func (s DeleteAttributesInput) String() string
String returns the string representation
func (s *DeleteAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s DeleteAttributesOutput) GoString() string
GoString returns the string representation
func (s *DeleteAttributesOutput) SetAttributes(v []*Attribute) *DeleteAttributesOutput
SetAttributes sets the Attributes field's value.
func (s DeleteAttributesOutput) String() string
String returns the string representation
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 (s DeleteCapacityProviderInput) GoString() string
GoString returns the string representation
func (s *DeleteCapacityProviderInput) SetCapacityProvider(v string) *DeleteCapacityProviderInput
SetCapacityProvider sets the CapacityProvider field's value.
func (s DeleteCapacityProviderInput) String() string
String returns the string representation
func (s *DeleteCapacityProviderInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteCapacityProviderOutput struct { // The details of a capacity provider. CapacityProvider *CapacityProvider `locationName:"capacityProvider" type:"structure"` // contains filtered or unexported fields }
func (s DeleteCapacityProviderOutput) GoString() string
GoString returns the string representation
func (s *DeleteCapacityProviderOutput) SetCapacityProvider(v *CapacityProvider) *DeleteCapacityProviderOutput
SetCapacityProvider sets the CapacityProvider field's value.
func (s DeleteCapacityProviderOutput) String() string
String returns the string representation
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 (s DeleteClusterInput) GoString() string
GoString returns the string representation
func (s *DeleteClusterInput) SetCluster(v string) *DeleteClusterInput
SetCluster sets the Cluster field's value.
func (s DeleteClusterInput) String() string
String returns the string representation
func (s *DeleteClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteClusterOutput struct { // The full description of the deleted cluster. Cluster *Cluster `locationName:"cluster" type:"structure"` // contains filtered or unexported fields }
func (s DeleteClusterOutput) GoString() string
GoString returns the string representation
func (s *DeleteClusterOutput) SetCluster(v *Cluster) *DeleteClusterOutput
SetCluster sets the Cluster field's value.
func (s DeleteClusterOutput) String() string
String returns the string representation
type DeleteServiceInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the service to delete. If you do not specify a cluster, the default cluster // is assumed. Cluster *string `locationName:"cluster" type:"string"` // If true, allows you to delete a service even if it has not been scaled down // to zero tasks. It is only necessary to use this if the service is using the // REPLICA scheduling strategy. Force *bool `locationName:"force" type:"boolean"` // The name of the service to delete. // // Service is a required field Service *string `locationName:"service" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteServiceInput) GoString() string
GoString returns the string representation
func (s *DeleteServiceInput) SetCluster(v string) *DeleteServiceInput
SetCluster sets the Cluster field's value.
func (s *DeleteServiceInput) SetForce(v bool) *DeleteServiceInput
SetForce sets the Force field's value.
func (s *DeleteServiceInput) SetService(v string) *DeleteServiceInput
SetService sets the Service field's value.
func (s DeleteServiceInput) String() string
String returns the string representation
func (s *DeleteServiceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteServiceOutput struct { // The full description of the deleted service. Service *Service `locationName:"service" type:"structure"` // contains filtered or unexported fields }
func (s DeleteServiceOutput) GoString() string
GoString returns the string representation
func (s *DeleteServiceOutput) SetService(v *Service) *DeleteServiceOutput
SetService sets the Service field's value.
func (s DeleteServiceOutput) String() string
String returns the string representation
type DeleteTaskSetInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the service that the task set exists in to delete. // // Cluster is a required field Cluster *string `locationName:"cluster" type:"string" required:"true"` // If true, this allows you to 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 (s DeleteTaskSetInput) GoString() string
GoString returns the string representation
func (s *DeleteTaskSetInput) SetCluster(v string) *DeleteTaskSetInput
SetCluster sets the Cluster field's value.
func (s *DeleteTaskSetInput) SetForce(v bool) *DeleteTaskSetInput
SetForce sets the Force field's value.
func (s *DeleteTaskSetInput) SetService(v string) *DeleteTaskSetInput
SetService sets the Service field's value.
func (s *DeleteTaskSetInput) SetTaskSet(v string) *DeleteTaskSetInput
SetTaskSet sets the TaskSet field's value.
func (s DeleteTaskSetInput) String() string
String returns the string representation
func (s *DeleteTaskSetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteTaskSetOutput struct { // Information about a set of Amazon ECS tasks in either an AWS 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. TaskSet *TaskSet `locationName:"taskSet" type:"structure"` // contains filtered or unexported fields }
func (s DeleteTaskSetOutput) GoString() string
GoString returns the string representation
func (s *DeleteTaskSetOutput) SetTaskSet(v *TaskSet) *DeleteTaskSetOutput
SetTaskSet sets the TaskSet field's value.
func (s DeleteTaskSetOutput) String() string
String returns the string representation
type Deployment struct { // The capacity provider strategy that the deployment is using. CapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"capacityProviderStrategy" type:"list"` // The Unix timestamp for 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 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 platform version on which your tasks in the service are running. A platform // version is only specified for tasks using the Fargate launch type. If one // is not specified, the LATEST platform version is used by default. For more // information, see AWS 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 are not 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 will transition to a COMPLETED state. If the service fails // to reach a steady state and circuit breaker is enabled, the deployment will // transition to a FAILED state. A deployment in FAILED state will launch no // 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 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 when the service deployment was last updated. UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"` // 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 (s Deployment) GoString() string
GoString returns the string representation
func (s *Deployment) SetCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *Deployment
SetCapacityProviderStrategy sets the CapacityProviderStrategy field's value.
func (s *Deployment) SetCreatedAt(v time.Time) *Deployment
SetCreatedAt sets the CreatedAt field's value.
func (s *Deployment) SetDesiredCount(v int64) *Deployment
SetDesiredCount sets the DesiredCount field's value.
func (s *Deployment) SetFailedTasks(v int64) *Deployment
SetFailedTasks sets the FailedTasks field's value.
func (s *Deployment) SetId(v string) *Deployment
SetId sets the Id field's value.
func (s *Deployment) SetLaunchType(v string) *Deployment
SetLaunchType sets the LaunchType field's value.
func (s *Deployment) SetNetworkConfiguration(v *NetworkConfiguration) *Deployment
SetNetworkConfiguration sets the NetworkConfiguration field's value.
func (s *Deployment) SetPendingCount(v int64) *Deployment
SetPendingCount sets the PendingCount field's value.
func (s *Deployment) SetPlatformVersion(v string) *Deployment
SetPlatformVersion sets the PlatformVersion field's value.
func (s *Deployment) SetRolloutState(v string) *Deployment
SetRolloutState sets the RolloutState field's value.
func (s *Deployment) SetRolloutStateReason(v string) *Deployment
SetRolloutStateReason sets the RolloutStateReason field's value.
func (s *Deployment) SetRunningCount(v int64) *Deployment
SetRunningCount sets the RunningCount field's value.
func (s *Deployment) SetStatus(v string) *Deployment
SetStatus sets the Status field's value.
func (s *Deployment) SetTaskDefinition(v string) *Deployment
SetTaskDefinition sets the TaskDefinition field's value.
func (s *Deployment) SetUpdatedAt(v time.Time) *Deployment
SetUpdatedAt sets the UpdatedAt field's value.
func (s Deployment) String() string
String returns the string representation
type DeploymentCircuitBreaker struct { // Whether to enable the deployment circuit breaker logic for the service. // // Enable is a required field Enable *bool `locationName:"enable" type:"boolean" required:"true"` // Whether to enable Amazon ECS to roll back the service if a service deployment // fails. If rollback is enabled, 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 that are not behind a Classic Load Balancer.
The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If enabled, a service deployment will transition to a failed state and stop launching new tasks. You can also enable 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.
func (s DeploymentCircuitBreaker) GoString() string
GoString returns the string representation
func (s *DeploymentCircuitBreaker) SetEnable(v bool) *DeploymentCircuitBreaker
SetEnable sets the Enable field's value.
func (s *DeploymentCircuitBreaker) SetRollback(v bool) *DeploymentCircuitBreaker
SetRollback sets the Rollback field's value.
func (s DeploymentCircuitBreaker) String() string
String returns the string representation
func (s *DeploymentCircuitBreaker) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeploymentConfiguration struct { // // 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 deployment circuit breaker // is enabled, a service deployment will transition to a failed state and stop // launching new tasks. If rollback is enabled, when a service deployment fails, // the service is rolled back to the last deployment that completed successfully. DeploymentCircuitBreaker *DeploymentCircuitBreaker `locationName:"deploymentCircuitBreaker" type:"structure"` // If a service is using the rolling update (ECS) deployment type, 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, as // a percentage of the desired number of tasks (rounded down to the nearest // integer), and while any container instances are in the DRAINING state if // the service contains tasks using the EC2 launch type. This parameter enables // you to 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 is using 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 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, as a percentage // of the desired number of tasks (rounded up to the nearest integer), and while // any container instances are in the DRAINING state if the service contains // tasks using the EC2 launch type. This parameter enables you to deploy without // using additional cluster capacity. For example, if your service has a desired // number of four tasks and a minimum healthy percent of 50%, the scheduler // may stop two existing tasks to free up cluster capacity before starting two // new tasks. Tasks for services that do not use a load balancer are considered // healthy if they are in the RUNNING state; tasks for services that do use // a load balancer are considered healthy if they are in the RUNNING state and // they are reported as healthy by the load balancer. The default value for // minimum healthy percent is 100%. // // If a service is using the blue/green (CODE_DEPLOY) or EXTERNAL deployment // types and 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 the tasks in the service // 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 (s DeploymentConfiguration) GoString() string
GoString returns the string representation
func (s *DeploymentConfiguration) SetDeploymentCircuitBreaker(v *DeploymentCircuitBreaker) *DeploymentConfiguration
SetDeploymentCircuitBreaker sets the DeploymentCircuitBreaker field's value.
func (s *DeploymentConfiguration) SetMaximumPercent(v int64) *DeploymentConfiguration
SetMaximumPercent sets the MaximumPercent field's value.
func (s *DeploymentConfiguration) SetMinimumHealthyPercent(v int64) *DeploymentConfiguration
SetMinimumHealthyPercent sets the MinimumHealthyPercent field's value.
func (s DeploymentConfiguration) String() string
String returns the string representation
func (s *DeploymentConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 AWS 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 (s DeploymentController) GoString() string
GoString returns the string representation
func (s *DeploymentController) SetType(v string) *DeploymentController
SetType sets the Type field's value.
func (s DeploymentController) String() string
String returns the string representation
func (s *DeploymentController) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeregisterContainerInstanceInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the container instance to deregister. If you do not specify a cluster, the // default cluster is assumed. Cluster *string `locationName:"cluster" type:"string"` // The container instance ID or full ARN of the container instance to deregister. // The ARN contains the arn:aws:ecs namespace, followed by the Region of the // container instance, the AWS account ID of the container instance owner, the // container-instance namespace, and then the container instance ID. For example, // arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID. // // ContainerInstance is a required field ContainerInstance *string `locationName:"containerInstance" type:"string" required:"true"` // Forces the deregistration of the container instance. If you have tasks running // on the container instance when you deregister it with the force option, these // tasks remain running until you terminate the instance or the tasks stop through // some other means, but they are orphaned (no longer monitored or accounted // for by Amazon ECS). If an orphaned task on your container instance is part // of an Amazon ECS service, then the service scheduler starts another copy // of that task, on a different container instance if possible. // // Any containers in orphaned service tasks that are registered with a Classic // Load Balancer or an Application Load Balancer target group are deregistered. // They begin connection draining according to the settings on the load balancer // or target group. Force *bool `locationName:"force" type:"boolean"` // contains filtered or unexported fields }
func (s DeregisterContainerInstanceInput) GoString() string
GoString returns the string representation
func (s *DeregisterContainerInstanceInput) SetCluster(v string) *DeregisterContainerInstanceInput
SetCluster sets the Cluster field's value.
func (s *DeregisterContainerInstanceInput) SetContainerInstance(v string) *DeregisterContainerInstanceInput
SetContainerInstance sets the ContainerInstance field's value.
func (s *DeregisterContainerInstanceInput) SetForce(v bool) *DeregisterContainerInstanceInput
SetForce sets the Force field's value.
func (s DeregisterContainerInstanceInput) String() string
String returns the string representation
func (s *DeregisterContainerInstanceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeregisterContainerInstanceOutput struct { // The container instance that was deregistered. ContainerInstance *ContainerInstance `locationName:"containerInstance" type:"structure"` // contains filtered or unexported fields }
func (s DeregisterContainerInstanceOutput) GoString() string
GoString returns the string representation
func (s *DeregisterContainerInstanceOutput) SetContainerInstance(v *ContainerInstance) *DeregisterContainerInstanceOutput
SetContainerInstance sets the ContainerInstance field's value.
func (s DeregisterContainerInstanceOutput) String() string
String returns the string representation
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 (s DeregisterTaskDefinitionInput) GoString() string
GoString returns the string representation
func (s *DeregisterTaskDefinitionInput) SetTaskDefinition(v string) *DeregisterTaskDefinitionInput
SetTaskDefinition sets the TaskDefinition field's value.
func (s DeregisterTaskDefinitionInput) String() string
String returns the string representation
func (s *DeregisterTaskDefinitionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeregisterTaskDefinitionOutput struct { // The full description of the deregistered task. TaskDefinition *TaskDefinition `locationName:"taskDefinition" type:"structure"` // contains filtered or unexported fields }
func (s DeregisterTaskDefinitionOutput) GoString() string
GoString returns the string representation
func (s *DeregisterTaskDefinitionOutput) SetTaskDefinition(v *TaskDefinition) *DeregisterTaskDefinitionOutput
SetTaskDefinition sets the TaskDefinition field's value.
func (s DeregisterTaskDefinitionOutput) String() string
String returns the string representation
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 are not included in the response. Include []*string `locationName:"include" type:"list"` // 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 (s DescribeCapacityProvidersInput) GoString() string
GoString returns the string representation
func (s *DescribeCapacityProvidersInput) SetCapacityProviders(v []*string) *DescribeCapacityProvidersInput
SetCapacityProviders sets the CapacityProviders field's value.
func (s *DescribeCapacityProvidersInput) SetInclude(v []*string) *DescribeCapacityProvidersInput
SetInclude sets the Include field's value.
func (s *DescribeCapacityProvidersInput) SetMaxResults(v int64) *DescribeCapacityProvidersInput
SetMaxResults sets the MaxResults field's value.
func (s *DescribeCapacityProvidersInput) SetNextToken(v string) *DescribeCapacityProvidersInput
SetNextToken sets the NextToken field's value.
func (s DescribeCapacityProvidersInput) String() string
String returns the string representation
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 (s DescribeCapacityProvidersOutput) GoString() string
GoString returns the string representation
func (s *DescribeCapacityProvidersOutput) SetCapacityProviders(v []*CapacityProvider) *DescribeCapacityProvidersOutput
SetCapacityProviders sets the CapacityProviders field's value.
func (s *DescribeCapacityProvidersOutput) SetFailures(v []*Failure) *DescribeCapacityProvidersOutput
SetFailures sets the Failures field's value.
func (s *DescribeCapacityProvidersOutput) SetNextToken(v string) *DescribeCapacityProvidersOutput
SetNextToken sets the NextToken field's value.
func (s DescribeCapacityProvidersOutput) String() string
String returns the string representation
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"` // Whether to include additional information about your clusters in the response. // If this field is omitted, the attachments, statistics, and tags are not included. // // If ATTACHMENTS is specified, the attachments for the container instances // or tasks within the cluster are included. // // If SETTINGS is specified, the settings for the cluster are included. // // If STATISTICS is specified, the following additional information, separated // by launch type, is included: // // * runningEC2TasksCount // // * runningFargateTasksCount // // * pendingEC2TasksCount // // * pendingFargateTasksCount // // * activeEC2ServiceCount // // * activeFargateServiceCount // // * drainingEC2ServiceCount // // * drainingFargateServiceCount // // If TAGS is specified, the metadata tags associated with the cluster are included. Include []*string `locationName:"include" type:"list"` // contains filtered or unexported fields }
func (s DescribeClustersInput) GoString() string
GoString returns the string representation
func (s *DescribeClustersInput) SetClusters(v []*string) *DescribeClustersInput
SetClusters sets the Clusters field's value.
func (s *DescribeClustersInput) SetInclude(v []*string) *DescribeClustersInput
SetInclude sets the Include field's value.
func (s DescribeClustersInput) String() string
String returns the string representation
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 (s DescribeClustersOutput) GoString() string
GoString returns the string representation
func (s *DescribeClustersOutput) SetClusters(v []*Cluster) *DescribeClustersOutput
SetClusters sets the Clusters field's value.
func (s *DescribeClustersOutput) SetFailures(v []*Failure) *DescribeClustersOutput
SetFailures sets the Failures field's value.
func (s DescribeClustersOutput) String() string
String returns the string representation
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 this field // is omitted, tags are not included in the response. Include []*string `locationName:"include" type:"list"` // contains filtered or unexported fields }
func (s DescribeContainerInstancesInput) GoString() string
GoString returns the string representation
func (s *DescribeContainerInstancesInput) SetCluster(v string) *DescribeContainerInstancesInput
SetCluster sets the Cluster field's value.
func (s *DescribeContainerInstancesInput) SetContainerInstances(v []*string) *DescribeContainerInstancesInput
SetContainerInstances sets the ContainerInstances field's value.
func (s *DescribeContainerInstancesInput) SetInclude(v []*string) *DescribeContainerInstancesInput
SetInclude sets the Include field's value.
func (s DescribeContainerInstancesInput) String() string
String returns the string representation
func (s *DescribeContainerInstancesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s DescribeContainerInstancesOutput) GoString() string
GoString returns the string representation
func (s *DescribeContainerInstancesOutput) SetContainerInstances(v []*ContainerInstance) *DescribeContainerInstancesOutput
SetContainerInstances sets the ContainerInstances field's value.
func (s *DescribeContainerInstancesOutput) SetFailures(v []*Failure) *DescribeContainerInstancesOutput
SetFailures sets the Failures field's value.
func (s DescribeContainerInstancesOutput) String() string
String returns the string representation
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"` // Specifies 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 are not included in the response. Include []*string `locationName:"include" type:"list"` // 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 (s DescribeServicesInput) GoString() string
GoString returns the string representation
func (s *DescribeServicesInput) SetCluster(v string) *DescribeServicesInput
SetCluster sets the Cluster field's value.
func (s *DescribeServicesInput) SetInclude(v []*string) *DescribeServicesInput
SetInclude sets the Include field's value.
func (s *DescribeServicesInput) SetServices(v []*string) *DescribeServicesInput
SetServices sets the Services field's value.
func (s DescribeServicesInput) String() string
String returns the string representation
func (s *DescribeServicesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s DescribeServicesOutput) GoString() string
GoString returns the string representation
func (s *DescribeServicesOutput) SetFailures(v []*Failure) *DescribeServicesOutput
SetFailures sets the Failures field's value.
func (s *DescribeServicesOutput) SetServices(v []*Service) *DescribeServicesOutput
SetServices sets the Services field's value.
func (s DescribeServicesOutput) String() string
String returns the string representation
type DescribeTaskDefinitionInput struct { // Specifies 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 are not included in the response. Include []*string `locationName:"include" type:"list"` // 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 (s DescribeTaskDefinitionInput) GoString() string
GoString returns the string representation
func (s *DescribeTaskDefinitionInput) SetInclude(v []*string) *DescribeTaskDefinitionInput
SetInclude sets the Include field's value.
func (s *DescribeTaskDefinitionInput) SetTaskDefinition(v string) *DescribeTaskDefinitionInput
SetTaskDefinition sets the TaskDefinition field's value.
func (s DescribeTaskDefinitionInput) String() string
String returns the string representation
func (s *DescribeTaskDefinitionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeTaskDefinitionOutput struct { // The metadata that is applied to the task definition 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 AWS 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 (s DescribeTaskDefinitionOutput) GoString() string
GoString returns the string representation
func (s *DescribeTaskDefinitionOutput) SetTags(v []*Tag) *DescribeTaskDefinitionOutput
SetTags sets the Tags field's value.
func (s *DescribeTaskDefinitionOutput) SetTaskDefinition(v *TaskDefinition) *DescribeTaskDefinitionOutput
SetTaskDefinition sets the TaskDefinition field's value.
func (s DescribeTaskDefinitionOutput) String() string
String returns the string representation
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 are // not included in the response. Include []*string `locationName:"include" type:"list"` // 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 (s DescribeTaskSetsInput) GoString() string
GoString returns the string representation
func (s *DescribeTaskSetsInput) SetCluster(v string) *DescribeTaskSetsInput
SetCluster sets the Cluster field's value.
func (s *DescribeTaskSetsInput) SetInclude(v []*string) *DescribeTaskSetsInput
SetInclude sets the Include field's value.
func (s *DescribeTaskSetsInput) SetService(v string) *DescribeTaskSetsInput
SetService sets the Service field's value.
func (s *DescribeTaskSetsInput) SetTaskSets(v []*string) *DescribeTaskSetsInput
SetTaskSets sets the TaskSets field's value.
func (s DescribeTaskSetsInput) String() string
String returns the string representation
func (s *DescribeTaskSetsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s DescribeTaskSetsOutput) GoString() string
GoString returns the string representation
func (s *DescribeTaskSetsOutput) SetFailures(v []*Failure) *DescribeTaskSetsOutput
SetFailures sets the Failures field's value.
func (s *DescribeTaskSetsOutput) SetTaskSets(v []*TaskSet) *DescribeTaskSetsOutput
SetTaskSets sets the TaskSets field's value.
func (s DescribeTaskSetsOutput) String() string
String returns the string representation
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 are not included in the response. Include []*string `locationName:"include" type:"list"` // 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 (s DescribeTasksInput) GoString() string
GoString returns the string representation
func (s *DescribeTasksInput) SetCluster(v string) *DescribeTasksInput
SetCluster sets the Cluster field's value.
func (s *DescribeTasksInput) SetInclude(v []*string) *DescribeTasksInput
SetInclude sets the Include field's value.
func (s *DescribeTasksInput) SetTasks(v []*string) *DescribeTasksInput
SetTasks sets the Tasks field's value.
func (s DescribeTasksInput) String() string
String returns the string representation
func (s *DescribeTasksInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s DescribeTasksOutput) GoString() string
GoString returns the string representation
func (s *DescribeTasksOutput) SetFailures(v []*Failure) *DescribeTasksOutput
SetFailures sets the Failures field's value.
func (s *DescribeTasksOutput) SetTasks(v []*Task) *DescribeTasksOutput
SetTasks sets the Tasks field's value.
func (s DescribeTasksOutput) String() string
String returns the string representation
type Device struct { // The path inside the container at which to expose the host device. ContainerPath *string `locationName:"containerPath" type:"string"` // The path for the device on the host container instance. // // HostPath is a required field HostPath *string `locationName:"hostPath" type:"string" required:"true"` // The explicit permissions to provide to the container for the device. By default, // the container has permissions for read, write, and mknod for the device. Permissions []*string `locationName:"permissions" type:"list"` // contains filtered or unexported fields }
An object representing a container instance host device.
func (s Device) GoString() string
GoString returns the string representation
func (s *Device) SetContainerPath(v string) *Device
SetContainerPath sets the ContainerPath field's value.
func (s *Device) SetHostPath(v string) *Device
SetHostPath sets the HostPath field's value.
func (s *Device) SetPermissions(v []*string) *Device
SetPermissions sets the Permissions field's value.
func (s Device) String() string
String returns the string representation
func (s *Device) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DiscoverPollEndpointInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster to which // the container instance belongs. Cluster *string `locationName:"cluster" type:"string"` // The container instance ID or full ARN of the container instance. The ARN // contains the arn:aws:ecs namespace, followed by the Region of the container // instance, the AWS account ID of the container instance owner, the container-instance // namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID. ContainerInstance *string `locationName:"containerInstance" type:"string"` // contains filtered or unexported fields }
func (s DiscoverPollEndpointInput) GoString() string
GoString returns the string representation
func (s *DiscoverPollEndpointInput) SetCluster(v string) *DiscoverPollEndpointInput
SetCluster sets the Cluster field's value.
func (s *DiscoverPollEndpointInput) SetContainerInstance(v string) *DiscoverPollEndpointInput
SetContainerInstance sets the ContainerInstance field's value.
func (s DiscoverPollEndpointInput) String() string
String returns the string representation
type DiscoverPollEndpointOutput struct { // The endpoint for the Amazon ECS agent to poll. Endpoint *string `locationName:"endpoint" type:"string"` // The telemetry endpoint for the Amazon ECS agent. TelemetryEndpoint *string `locationName:"telemetryEndpoint" type:"string"` // contains filtered or unexported fields }
func (s DiscoverPollEndpointOutput) GoString() string
GoString returns the string representation
func (s *DiscoverPollEndpointOutput) SetEndpoint(v string) *DiscoverPollEndpointOutput
SetEndpoint sets the Endpoint field's value.
func (s *DiscoverPollEndpointOutput) SetTelemetryEndpoint(v string) *DiscoverPollEndpointOutput
SetTelemetryEndpoint sets the TelemetryEndpoint field's value.
func (s DiscoverPollEndpointOutput) String() string
String returns the string representation
type DockerVolumeConfiguration struct { // If this value is true, the Docker volume is created if it does not 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 are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.
func (s DockerVolumeConfiguration) GoString() string
GoString returns the string representation
func (s *DockerVolumeConfiguration) SetAutoprovision(v bool) *DockerVolumeConfiguration
SetAutoprovision sets the Autoprovision field's value.
func (s *DockerVolumeConfiguration) SetDriver(v string) *DockerVolumeConfiguration
SetDriver sets the Driver field's value.
func (s *DockerVolumeConfiguration) SetDriverOpts(v map[string]*string) *DockerVolumeConfiguration
SetDriverOpts sets the DriverOpts field's value.
func (s *DockerVolumeConfiguration) SetLabels(v map[string]*string) *DockerVolumeConfiguration
SetLabels sets the Labels field's value.
func (s *DockerVolumeConfiguration) SetScope(v string) *DockerVolumeConfiguration
SetScope sets the Scope field's value.
func (s DockerVolumeConfiguration) String() string
String returns the string representation
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(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 (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 using an Auto Scaling group can be created. Amazon ECS tasks on AWS Fargate use the FARGATE and FARGATE_SPOT capacity providers which are already created and available to all accounts in Regions supported by AWS Fargate.
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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * LimitExceededException The limit for the resource has been exceeded. * UpdateInProgressException There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateCapacityProvider
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 (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 (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 so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateCluster
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 (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 (c *ECS) CreateService(input *CreateServiceInput) (*CreateServiceOutput, error)
CreateService API operation for Amazon EC2 Container Service.
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.
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.
Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and the container instance that they're hosted on is reported as healthy by the load balancer.
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. 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 and will stop tasks that do not 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 triggered by changing properties, such as the task definition or the desired count of a service, 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 is using 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, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a 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. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and they're reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using 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, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to 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 is using 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 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, although 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 in your cluster using the following logic:
* Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes). * By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the placementStrategy parameter): Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon EC2 Container Service's API operation CreateService for usage and error information.
Returned Error Types:
* ServerException These errors are usually caused by a server issue. * ClientException These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * UnsupportedFeatureException The specified task is not supported in this Region. * PlatformUnknownException The specified platform version does not exist. * PlatformTaskDefinitionIncompatibilityException The specified platform version does not satisfy the task definition's required capabilities. * AccessDeniedException You do not have authorization to perform the requested action.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateService
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 (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 (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.
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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * UnsupportedFeatureException The specified task is not supported in this Region. * PlatformUnknownException The specified platform version does not exist. * PlatformTaskDefinitionIncompatibilityException The specified platform version does not satisfy the task definition's required capabilities. * AccessDeniedException You do not have authorization to perform the requested action. * ServiceNotFoundException The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific. * ServiceNotActiveException The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateTaskSet
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 (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 (c *ECS) DeleteAccountSetting(input *DeleteAccountSettingInput) (*DeleteAccountSettingOutput, error)
DeleteAccountSetting API operation for Amazon EC2 Container Service.
Disables an account setting for a specified IAM user, IAM 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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteAccountSetting
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 (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 (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 could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * TargetNotFoundException The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteAttributes
func (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 (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 (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 cannot 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 are not 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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteCapacityProvider
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 (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 (c *ECS) DeleteCluster(input *DeleteClusterInput) (*DeleteClusterOutput, error)
DeleteCluster API operation for Amazon EC2 Container Service.
Deletes the specified cluster. The cluster will transition to the INACTIVE state. 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, so you should not 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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * ClusterContainsContainerInstancesException You cannot 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 cannot 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 cannot delete a cluster that has active tasks. * UpdateInProgressException There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteCluster
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 (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 (c *ECS) DeleteService(input *DeleteServiceInput) (*DeleteServiceOutput, error)
DeleteService API operation for Amazon EC2 Container Service.
Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.
When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in 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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * ServiceNotFoundException The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteService
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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * UnsupportedFeatureException The specified task is not supported in this Region. * AccessDeniedException You do not have authorization to perform the requested action. * ServiceNotFoundException The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific. * ServiceNotActiveException The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService. * TaskSetNotFoundException The specified task set could not be 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 (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 (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 (c *ECS) DeregisterContainerInstance(input *DeregisterContainerInstanceInput) (*DeregisterContainerInstanceOutput, error)
DeregisterContainerInstance API operation for Amazon EC2 Container Service.
Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.
If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.
Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.
If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon EC2 Container Service's API operation DeregisterContainerInstance for usage and error information.
Returned Error Types:
* ServerException These errors are usually caused by a server issue. * ClientException These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterContainerInstance
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 (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 (c *ECS) DeregisterTaskDefinition(input *DeregisterTaskDefinitionInput) (*DeregisterTaskDefinitionOutput, error)
DeregisterTaskDefinition API operation for Amazon EC2 Container Service.
Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count.
You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition. 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, so you should not rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon EC2 Container Service's API operation DeregisterTaskDefinition for usage and error information.
Returned Error Types:
* ServerException These errors are usually caused by a server issue. * ClientException These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterTaskDefinition
func (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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeCapacityProviders
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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeClusters
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 (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 (c *ECS) DescribeContainerInstances(input *DescribeContainerInstancesInput) (*DescribeContainerInstancesOutput, error)
DescribeContainerInstances API operation for Amazon EC2 Container Service.
Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon EC2 Container Service's API operation DescribeContainerInstances for usage and error information.
Returned Error Types:
* ServerException These errors are usually caused by a server issue. * ClientException These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeContainerInstances
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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServices
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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskDefinition
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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * UnsupportedFeatureException The specified task is not supported in this Region. * AccessDeniedException You do not have authorization to perform the requested action. * ServiceNotFoundException The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific. * ServiceNotActiveException The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskSets
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 (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 (c *ECS) DescribeTasks(input *DescribeTasksInput) (*DescribeTasksOutput, error)
DescribeTasks API operation for Amazon EC2 Container Service.
Describes a specified task or tasks.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon EC2 Container Service's API operation DescribeTasks for usage and error information.
Returned Error Types:
* ServerException These errors are usually caused by a server issue. * ClientException These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTasks
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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DiscoverPollEndpoint
func (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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListAccountSettings
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 (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 (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 (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 (c *ECS) ListAttributes(input *ListAttributesInput) (*ListAttributesOutput, error)
ListAttributes API operation for Amazon EC2 Container Service.
Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon EC2 Container Service's API operation ListAttributes for usage and error information.
Returned Error Types:
* ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListAttributes
func (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 (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 (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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListClusters
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 (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 (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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListContainerInstances
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 (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 (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 (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 (c *ECS) ListServices(input *ListServicesInput) (*ListServicesOutput, error)
ListServices API operation for Amazon EC2 Container Service.
Lists the services that are running in a specified cluster.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon EC2 Container Service's API operation ListServices for usage and error information.
Returned Error Types:
* ServerException These errors are usually caused by a server issue. * ClientException These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListServices
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 (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 (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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTagsForResource
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 (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 (c *ECS) ListTaskDefinitionFamilies(input *ListTaskDefinitionFamiliesInput) (*ListTaskDefinitionFamiliesOutput, error)
ListTaskDefinitionFamilies API operation for Amazon EC2 Container Service.
Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definition revisions).
You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon EC2 Container Service's API operation ListTaskDefinitionFamilies for usage and error information.
Returned Error Types:
* ServerException These errors are usually caused by a server issue. * ClientException These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTaskDefinitionFamilies
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 (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 (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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTaskDefinitions
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 (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 (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 (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 (c *ECS) ListTasks(input *ListTasksInput) (*ListTasksOutput, error)
ListTasks API operation for Amazon EC2 Container Service.
Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters.
Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon EC2 Container Service's API operation ListTasks for usage and error information.
Returned Error Types:
* ServerException These errors are usually caused by a server issue. * ClientException These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * ServiceNotFoundException The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTasks
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 (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 (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 (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 (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 account setting for the root user, the default settings for all of the IAM users and roles for which no individual account setting has been specified are reset. 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.
When serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat are specified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified IAM user, IAM 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 will be defined by the opt-in status of the IAM user or role that created the resource. You must enable this setting to use Amazon ECS features such as resource tagging.
When awsvpcTrunking is specified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is enabled, 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.
When containerInsights is specified, the default setting indicating whether CloudWatch Container Insights is enabled for your clusters is changed. If containerInsights is enabled, any new clusters that are created will have Container Insights enabled 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.
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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutAccountSetting
func (c *ECS) PutAccountSettingDefault(input *PutAccountSettingDefaultInput) (*PutAccountSettingDefaultOutput, error)
PutAccountSettingDefault API operation for Amazon EC2 Container Service.
Modifies an account setting for all IAM 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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutAccountSettingDefault
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 (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 (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 (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 (c *ECS) PutAttributes(input *PutAttributesInput) (*PutAttributesOutput, error)
PutAttributes API operation for Amazon EC2 Container Service.
Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes (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 could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * TargetNotFoundException The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific. * AttributeLimitExceededException You can apply up to 10 custom attributes per resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutAttributes
func (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 (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 (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 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. It is recommended to define a default capacity provider strategy for your cluster, however you may 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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * ResourceInUseException The specified resource is in-use and cannot be removed. * UpdateInProgressException There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutClusterCapacityProviders
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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterContainerInstance
func (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 (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 (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 an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterTaskDefinition
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 (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 (c *ECS) RunTask(input *RunTaskInput) (*RunTaskOutput, error)
RunTask API operation for Amazon EC2 Container Service.
Starts a new task using the specified task definition.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks (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.
The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. 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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * UnsupportedFeatureException The specified task is not supported in this Region. * PlatformUnknownException The specified platform version does not exist. * PlatformTaskDefinitionIncompatibilityException The specified platform version does not satisfy the task definition's required capabilities. * AccessDeniedException You do not have authorization to perform the requested action. * BlockedException Your AWS account has been blocked. For more information, contact AWS Support (http://aws.amazon.com/contact-us/).
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RunTask
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 (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 (c *ECS) StartTask(input *StartTaskInput) (*StartTaskOutput, error)
StartTask API operation for Amazon EC2 Container Service.
Starts a new task from the specified task definition on the specified container instance or instances.
Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html) in the Amazon Elastic Container Service Developer Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon EC2 Container Service's API operation StartTask for usage and error information.
Returned Error Types:
* ServerException These errors are usually caused by a server issue. * ClientException These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StartTask
func (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 (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 (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.
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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StopTask
func (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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * AccessDeniedException You do not have authorization to perform the requested action. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitAttachmentStateChanges
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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * AccessDeniedException You do not have authorization to perform the requested action.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitContainerStateChange
func (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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * AccessDeniedException You do not have authorization to perform the requested action. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitTaskStateChange
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 (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 (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 are not specified in the request parameters, they are not changed. When a resource is deleted, the tags 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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * ResourceNotFoundException The specified resource could not be found. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TagResource
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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * ResourceNotFoundException The specified resource could not be found. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UntagResource
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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateCapacityProvider
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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateClusterSettings
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 (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 (c *ECS) UpdateContainerAgent(input *UpdateContainerAgentInput) (*UpdateContainerAgentOutput, error)
UpdateContainerAgent API operation for Amazon EC2 Container Service.
Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.
UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * UpdateInProgressException There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously. * NoUpdateAvailableException There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version. * MissingVersionException Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerAgent
func (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 (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 (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 cannot 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 are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer. * The maximumPercent parameter represents an upper limit on the number of running tasks during task replacement, which enables you to define the replacement batch size. For example, if desiredCount 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 are not affected. You must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks.
When 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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerInstancesState
func (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 (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 (c *ECS) UpdateService(input *UpdateServiceInput) (*UpdateServiceOutput, error)
UpdateService API operation for Amazon EC2 Container Service.
Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at https://aws.amazon.com/service-terms (https://aws.amazon.com/service-terms) ("Beta Terms"). These Beta Terms apply to your participation in this preview.
Modifies the parameters of a service.
For services using the rolling update (ECS) deployment controller, the desired count, deployment configuration, network configuration, task placement constraints and strategies, or task definition used can be updated.
For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, task placement constraints and strategies, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy deployment should be created. For more information, see CreateDeployment (https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html) in the AWS CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, and health check grace period using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, you should 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.
If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.
If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you do not need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.
You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.
* If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer. * The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).
When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:
* Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes). * By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy): Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:
* Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination. * Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon EC2 Container Service's API operation UpdateService for usage and error information.
Returned Error Types:
* ServerException These errors are usually caused by a server issue. * ClientException These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * ServiceNotFoundException The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific. * ServiceNotActiveException The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService. * PlatformUnknownException The specified platform version does not exist. * PlatformTaskDefinitionIncompatibilityException The specified platform version does not satisfy the task definition's required capabilities. * AccessDeniedException You do not have authorization to perform the requested action.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateService
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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * UnsupportedFeatureException The specified task is not supported in this Region. * ServiceNotFoundException The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific. * ServiceNotActiveException The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService. * TaskSetNotFoundException The specified task set could not be found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region. * AccessDeniedException You do not have authorization to perform the requested action.
See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateServicePrimaryTaskSet
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 (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 (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 (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 (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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. * InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request. * ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific. * UnsupportedFeatureException The specified task is not supported in this Region. * AccessDeniedException You do not have authorization to perform the requested action. * ServiceNotFoundException The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific. * ServiceNotActiveException The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService. * TaskSetNotFoundException The specified task set could not be 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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 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 enabled 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"` // Whether or not to use the Amazon ECS task IAM role defined in a task definition // when mounting the Amazon EFS file system. If enabled, transit encryption // must be enabled 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 (s EFSAuthorizationConfig) GoString() string
GoString returns the string representation
func (s *EFSAuthorizationConfig) SetAccessPointId(v string) *EFSAuthorizationConfig
SetAccessPointId sets the AccessPointId field's value.
func (s *EFSAuthorizationConfig) SetIam(v string) *EFSAuthorizationConfig
SetIam sets the Iam field's value.
func (s EFSAuthorizationConfig) String() string
String returns the string representation
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"` // Whether or not to enable encryption for Amazon EFS data in transit between // the Amazon ECS host and the Amazon EFS server. Transit encryption must be // enabled 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 are 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 (s EFSVolumeConfiguration) GoString() string
GoString returns the string representation
func (s *EFSVolumeConfiguration) SetAuthorizationConfig(v *EFSAuthorizationConfig) *EFSVolumeConfiguration
SetAuthorizationConfig sets the AuthorizationConfig field's value.
func (s *EFSVolumeConfiguration) SetFileSystemId(v string) *EFSVolumeConfiguration
SetFileSystemId sets the FileSystemId field's value.
func (s *EFSVolumeConfiguration) SetRootDirectory(v string) *EFSVolumeConfiguration
SetRootDirectory sets the RootDirectory field's value.
func (s *EFSVolumeConfiguration) SetTransitEncryption(v string) *EFSVolumeConfiguration
SetTransitEncryption sets the TransitEncryption field's value.
func (s *EFSVolumeConfiguration) SetTransitEncryptionPort(v int64) *EFSVolumeConfiguration
SetTransitEncryptionPort sets the TransitEncryptionPort field's value.
func (s EFSVolumeConfiguration) String() string
String returns the string representation
func (s *EFSVolumeConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EnvironmentFile struct { // The file type to use. 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. For more information on 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 are processed from the top down. It is recommended to 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.
This field is not valid for containers in tasks using the Fargate launch type.
func (s EnvironmentFile) GoString() string
GoString returns the string representation
func (s *EnvironmentFile) SetType(v string) *EnvironmentFile
SetType sets the Type field's value.
func (s *EnvironmentFile) SetValue(v string) *EnvironmentFile
SetValue sets the Value field's value.
func (s EnvironmentFile) String() string
String returns the string representation
func (s *EnvironmentFile) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 // AWS Secrets Manager secret or AWS Systems Manager Parameter Store parameter. // The ARNs refer 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 AWS 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 Elastic Container Service 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 (s FSxWindowsFileServerAuthorizationConfig) GoString() string
GoString returns the string representation
func (s *FSxWindowsFileServerAuthorizationConfig) SetCredentialsParameter(v string) *FSxWindowsFileServerAuthorizationConfig
SetCredentialsParameter sets the CredentialsParameter field's value.
func (s *FSxWindowsFileServerAuthorizationConfig) SetDomain(v string) *FSxWindowsFileServerAuthorizationConfig
SetDomain sets the Domain field's value.
func (s FSxWindowsFileServerAuthorizationConfig) String() string
String returns the string representation
func (s *FSxWindowsFileServerAuthorizationConfig) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 are 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 (s FSxWindowsFileServerVolumeConfiguration) GoString() string
GoString returns the string representation
func (s *FSxWindowsFileServerVolumeConfiguration) SetAuthorizationConfig(v *FSxWindowsFileServerAuthorizationConfig) *FSxWindowsFileServerVolumeConfiguration
SetAuthorizationConfig sets the AuthorizationConfig field's value.
func (s *FSxWindowsFileServerVolumeConfiguration) SetFileSystemId(v string) *FSxWindowsFileServerVolumeConfiguration
SetFileSystemId sets the FileSystemId field's value.
func (s *FSxWindowsFileServerVolumeConfiguration) SetRootDirectory(v string) *FSxWindowsFileServerVolumeConfiguration
SetRootDirectory sets the RootDirectory field's value.
func (s FSxWindowsFileServerVolumeConfiguration) String() string
String returns the string representation
func (s *FSxWindowsFileServerVolumeConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s Failure) GoString() string
GoString returns the string representation
func (s *Failure) SetArn(v string) *Failure
SetArn sets the Arn field's value.
func (s *Failure) SetDetail(v string) *Failure
SetDetail sets the Detail field's value.
func (s *Failure) SetReason(v string) *Failure
SetReason sets the Reason field's value.
func (s Failure) String() string
String returns the string representation
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. 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 (s FirelensConfiguration) GoString() string
GoString returns the string representation
func (s *FirelensConfiguration) SetOptions(v map[string]*string) *FirelensConfiguration
SetOptions sets the Options field's value.
func (s *FirelensConfiguration) SetType(v string) *FirelensConfiguration
SetType sets the Type field's value.
func (s FirelensConfiguration) String() string
String returns the string representation
func (s *FirelensConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type HealthCheck struct { // A string array representing the command that the container runs to determine // if it is healthy. The string array must start with CMD to execute the command // arguments directly, or CMD-SHELL to run the command with the container's // default shell. For example: // // [ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ] // // An exit code of 0 indicates success, and non-zero exit code indicates failure. // For more information, see HealthCheck in the Create a container (https://docs.docker.com/engine/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 within which to provide containers time to bootstrap // before failed health checks count towards the maximum number of retries. // You may specify between 0 and 300 seconds. The startPeriod is disabled by // default. // // If a health check succeeds within the startPeriod, then the container is // considered healthy and any subsequent failures count toward the maximum number // of retries. StartPeriod *int64 `locationName:"startPeriod" type:"integer"` // The time period in seconds to wait for a health check to succeed before it // is considered a failure. You may specify between 2 and 60 seconds. The default // value is 5. 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).
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 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 or there is no container health check defined.
The following describes the possible healthStatus values for a task. The container health check status of nonessential containers do not have an effect on the health status of a task.
* HEALTHY-All essential containers within the task have passed their health checks. * UNHEALTHY-One or more essential containers have failed their health check. * UNKNOWN-The essential containers within the task are still having their health checks evaluated or there are no container health checks defined.
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:
* 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 are using platform version 1.1.0 or greater. For more information, see AWS Fargate Platform Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html). * Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.
func (s HealthCheck) GoString() string
GoString returns the string representation
func (s *HealthCheck) SetCommand(v []*string) *HealthCheck
SetCommand sets the Command field's value.
func (s *HealthCheck) SetInterval(v int64) *HealthCheck
SetInterval sets the Interval field's value.
func (s *HealthCheck) SetRetries(v int64) *HealthCheck
SetRetries sets the Retries field's value.
func (s *HealthCheck) SetStartPeriod(v int64) *HealthCheck
SetStartPeriod sets the StartPeriod field's value.
func (s *HealthCheck) SetTimeout(v int64) *HealthCheck
SetTimeout sets the Timeout field's value.
func (s HealthCheck) String() string
String returns the string representation
func (s *HealthCheck) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s HostEntry) GoString() string
GoString returns the string representation
func (s *HostEntry) SetHostname(v string) *HostEntry
SetHostname sets the Hostname field's value.
func (s *HostEntry) SetIpAddress(v string) *HostEntry
SetIpAddress sets the IpAddress field's value.
func (s HostEntry) String() string
String returns the string representation
func (s *HostEntry) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type HostVolumeProperties struct { // When the host parameter is used, specify a sourcePath to declare the path // on the host container instance that is presented to the container. If this // parameter is empty, then the Docker daemon has assigned a host path for you. // If the host parameter contains a sourcePath file location, then the data // volume persists at the specified location on the host container instance // until you delete it manually. If the sourcePath value does not exist on the // host container instance, the Docker daemon creates it. If the location does // exist, the contents of the source path folder are exported. // // If you are using the Fargate launch type, the sourcePath parameter is not // supported. SourcePath *string `locationName:"sourcePath" type:"string"` // contains filtered or unexported fields }
Details on a container instance bind mount host volume.
func (s HostVolumeProperties) GoString() string
GoString returns the string representation
func (s *HostVolumeProperties) SetSourcePath(v string) *HostVolumeProperties
SetSourcePath sets the SourcePath field's value.
func (s HostVolumeProperties) String() string
String returns the string representation
type InferenceAccelerator struct { // The Elastic Inference accelerator device name. The deviceName must also be // referenced in a container definition as a ResourceRequirement. // // 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 a Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-eia.html) in the Amazon Elastic Container Service Developer Guide.
func (s InferenceAccelerator) GoString() string
GoString returns the string representation
func (s *InferenceAccelerator) SetDeviceName(v string) *InferenceAccelerator
SetDeviceName sets the DeviceName field's value.
func (s *InferenceAccelerator) SetDeviceType(v string) *InferenceAccelerator
SetDeviceType sets the DeviceType field's value.
func (s InferenceAccelerator) String() string
String returns the string representation
func (s *InferenceAccelerator) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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-eia.html) in the Amazon Elastic Container Service Developer Guide.
func (s InferenceAcceleratorOverride) GoString() string
GoString returns the string representation
func (s *InferenceAcceleratorOverride) SetDeviceName(v string) *InferenceAcceleratorOverride
SetDeviceName sets the DeviceName field's value.
func (s *InferenceAcceleratorOverride) SetDeviceType(v string) *InferenceAcceleratorOverride
SetDeviceType sets the DeviceType field's value.
func (s InferenceAcceleratorOverride) String() string
String returns the string representation
type InvalidParameterException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The specified parameter is invalid. Review the available parameters for the API request.
func (s *InvalidParameterException) Code() string
Code returns the exception type name.
func (s *InvalidParameterException) Error() string
func (s InvalidParameterException) GoString() string
GoString returns the string representation
func (s *InvalidParameterException) Message() string
Message returns the exception's message.
func (s *InvalidParameterException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidParameterException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidParameterException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidParameterException) String() string
String returns the string representation
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 AWS 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 for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities (https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) in the Docker run reference. For more detailed information on these Linux capabilities, see the capabilities(7) (http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page.
func (s KernelCapabilities) GoString() string
GoString returns the string representation
func (s *KernelCapabilities) SetAdd(v []*string) *KernelCapabilities
SetAdd sets the Add field's value.
func (s *KernelCapabilities) SetDrop(v []*string) *KernelCapabilities
SetDrop sets the Drop field's value.
func (s KernelCapabilities) String() string
String returns the string representation
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 (s KeyValuePair) GoString() string
GoString returns the string representation
func (s *KeyValuePair) SetName(v string) *KeyValuePair
SetName sets the Name field's value.
func (s *KeyValuePair) SetValue(v string) *KeyValuePair
SetValue sets the Value field's value.
func (s KeyValuePair) String() string
String returns the string representation
type LimitExceededException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The limit for the resource has been exceeded.
func (s *LimitExceededException) Code() string
Code returns the exception type name.
func (s *LimitExceededException) Error() string
func (s LimitExceededException) GoString() string
GoString returns the string representation
func (s *LimitExceededException) Message() string
Message returns the exception's message.
func (s *LimitExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *LimitExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *LimitExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s LimitExceededException) String() string
String returns the string representation
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 are using tasks that use the Fargate launch type, the devices parameter // is not supported. Devices []*Device `locationName:"devices" type:"list"` // Run an init process inside the container that forwards signals and reaps // processes. This parameter maps to the --init option to docker run (https://docs.docker.com/engine/reference/run/#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 are using tasks that use the Fargate launch type, the maxSwap parameter // is not 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 are using tasks that use the Fargate launch type, the swappiness parameter // is not 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 are using tasks that use the Fargate launch type, the tmpfs parameter // is not supported. Tmpfs []*Tmpfs `locationName:"tmpfs" type:"list"` // contains filtered or unexported fields }
Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
func (s LinuxParameters) GoString() string
GoString returns the string representation
func (s *LinuxParameters) SetCapabilities(v *KernelCapabilities) *LinuxParameters
SetCapabilities sets the Capabilities field's value.
func (s *LinuxParameters) SetDevices(v []*Device) *LinuxParameters
SetDevices sets the Devices field's value.
func (s *LinuxParameters) SetInitProcessEnabled(v bool) *LinuxParameters
SetInitProcessEnabled sets the InitProcessEnabled field's value.
func (s *LinuxParameters) SetMaxSwap(v int64) *LinuxParameters
SetMaxSwap sets the MaxSwap field's value.
func (s *LinuxParameters) SetSharedMemorySize(v int64) *LinuxParameters
SetSharedMemorySize sets the SharedMemorySize field's value.
func (s *LinuxParameters) SetSwappiness(v int64) *LinuxParameters
SetSwappiness sets the Swappiness field's value.
func (s *LinuxParameters) SetTmpfs(v []*Tmpfs) *LinuxParameters
SetTmpfs sets the Tmpfs field's value.
func (s LinuxParameters) String() string
String returns the string representation
func (s *LinuxParameters) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListAccountSettingsInput struct { // Specifies 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 are 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 is not 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 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 ARN of the principal, which can be an IAM user, IAM role, or the root // user. If this field is omitted, the account settings are listed only for // the authenticated user. PrincipalArn *string `locationName:"principalArn" type:"string"` // The value of the account settings with which to filter results. You must // also specify an account setting name to use this parameter. Value *string `locationName:"value" type:"string"` // contains filtered or unexported fields }
func (s ListAccountSettingsInput) GoString() string
GoString returns the string representation
func (s *ListAccountSettingsInput) SetEffectiveSettings(v bool) *ListAccountSettingsInput
SetEffectiveSettings sets the EffectiveSettings field's value.
func (s *ListAccountSettingsInput) SetMaxResults(v int64) *ListAccountSettingsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListAccountSettingsInput) SetName(v string) *ListAccountSettingsInput
SetName sets the Name field's value.
func (s *ListAccountSettingsInput) SetNextToken(v string) *ListAccountSettingsInput
SetNextToken sets the NextToken field's value.
func (s *ListAccountSettingsInput) SetPrincipalArn(v string) *ListAccountSettingsInput
SetPrincipalArn sets the PrincipalArn field's value.
func (s *ListAccountSettingsInput) SetValue(v string) *ListAccountSettingsInput
SetValue sets the Value field's value.
func (s ListAccountSettingsInput) String() string
String returns the string representation
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 (s ListAccountSettingsOutput) GoString() string
GoString returns the string representation
func (s *ListAccountSettingsOutput) SetNextToken(v string) *ListAccountSettingsOutput
SetNextToken sets the NextToken field's value.
func (s *ListAccountSettingsOutput) SetSettings(v []*Setting) *ListAccountSettingsOutput
SetSettings sets the Settings field's value.
func (s ListAccountSettingsOutput) String() string
String returns the string representation
type ListAttributesInput struct { // The name of the attribute with which to filter the results. AttributeName *string `locationName:"attributeName" type:"string"` // The value of the attribute with which to filter results. You must also specify // an attribute name to use this parameter. AttributeValue *string `locationName:"attributeValue" type:"string"` // The short name or full Amazon Resource Name (ARN) of the cluster to list // attributes. If you do not specify a cluster, the default cluster is assumed. Cluster *string `locationName:"cluster" type:"string"` // The maximum number of cluster results returned by ListAttributes in paginated // output. When this parameter is used, ListAttributes only returns maxResults // results in a single page along with a nextToken response element. The remaining // results of the initial request can be seen by sending another ListAttributes // request with the returned nextToken value. This value can be between 1 and // 100. If this parameter is not used, then ListAttributes returns up to 100 // results and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a ListAttributes 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 type of the target with which to list attributes. // // TargetType is a required field TargetType *string `locationName:"targetType" type:"string" required:"true" enum:"TargetType"` // contains filtered or unexported fields }
func (s ListAttributesInput) GoString() string
GoString returns the string representation
func (s *ListAttributesInput) SetAttributeName(v string) *ListAttributesInput
SetAttributeName sets the AttributeName field's value.
func (s *ListAttributesInput) SetAttributeValue(v string) *ListAttributesInput
SetAttributeValue sets the AttributeValue field's value.
func (s *ListAttributesInput) SetCluster(v string) *ListAttributesInput
SetCluster sets the Cluster field's value.
func (s *ListAttributesInput) SetMaxResults(v int64) *ListAttributesInput
SetMaxResults sets the MaxResults field's value.
func (s *ListAttributesInput) SetNextToken(v string) *ListAttributesInput
SetNextToken sets the NextToken field's value.
func (s *ListAttributesInput) SetTargetType(v string) *ListAttributesInput
SetTargetType sets the TargetType field's value.
func (s ListAttributesInput) String() string
String returns the string representation
func (s *ListAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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