Documentation ¶
Overview ¶
Package ecs provides a client for Amazon EC2 Container Service.
Index ¶
- type Cluster
- type Container
- type ContainerDefinition
- type ContainerInstance
- type ContainerOverride
- type CreateClusterInput
- type CreateClusterOutput
- type DeleteClusterInput
- type DeleteClusterOutput
- type DeregisterContainerInstanceInput
- type DeregisterContainerInstanceOutput
- type DeregisterTaskDefinitionInput
- type DeregisterTaskDefinitionOutput
- type DescribeClustersInput
- type DescribeClustersOutput
- type DescribeContainerInstancesInput
- type DescribeContainerInstancesOutput
- type DescribeTaskDefinitionInput
- type DescribeTaskDefinitionOutput
- type DescribeTasksInput
- type DescribeTasksOutput
- type DiscoverPollEndpointInput
- type DiscoverPollEndpointOutput
- type ECS
- func (c *ECS) CreateCluster(input *CreateClusterInput) (output *CreateClusterOutput, err error)
- func (c *ECS) CreateClusterRequest(input *CreateClusterInput) (req *aws.Request, output *CreateClusterOutput)
- func (c *ECS) DeleteCluster(input *DeleteClusterInput) (output *DeleteClusterOutput, err error)
- func (c *ECS) DeleteClusterRequest(input *DeleteClusterInput) (req *aws.Request, output *DeleteClusterOutput)
- func (c *ECS) DeregisterContainerInstance(input *DeregisterContainerInstanceInput) (output *DeregisterContainerInstanceOutput, err error)
- func (c *ECS) DeregisterContainerInstanceRequest(input *DeregisterContainerInstanceInput) (req *aws.Request, output *DeregisterContainerInstanceOutput)
- func (c *ECS) DeregisterTaskDefinition(input *DeregisterTaskDefinitionInput) (output *DeregisterTaskDefinitionOutput, err error)
- func (c *ECS) DeregisterTaskDefinitionRequest(input *DeregisterTaskDefinitionInput) (req *aws.Request, output *DeregisterTaskDefinitionOutput)
- func (c *ECS) DescribeClusters(input *DescribeClustersInput) (output *DescribeClustersOutput, err error)
- func (c *ECS) DescribeClustersRequest(input *DescribeClustersInput) (req *aws.Request, output *DescribeClustersOutput)
- func (c *ECS) DescribeContainerInstances(input *DescribeContainerInstancesInput) (output *DescribeContainerInstancesOutput, err error)
- func (c *ECS) DescribeContainerInstancesRequest(input *DescribeContainerInstancesInput) (req *aws.Request, output *DescribeContainerInstancesOutput)
- func (c *ECS) DescribeTaskDefinition(input *DescribeTaskDefinitionInput) (output *DescribeTaskDefinitionOutput, err error)
- func (c *ECS) DescribeTaskDefinitionRequest(input *DescribeTaskDefinitionInput) (req *aws.Request, output *DescribeTaskDefinitionOutput)
- func (c *ECS) DescribeTasks(input *DescribeTasksInput) (output *DescribeTasksOutput, err error)
- func (c *ECS) DescribeTasksRequest(input *DescribeTasksInput) (req *aws.Request, output *DescribeTasksOutput)
- func (c *ECS) DiscoverPollEndpoint(input *DiscoverPollEndpointInput) (output *DiscoverPollEndpointOutput, err error)
- func (c *ECS) DiscoverPollEndpointRequest(input *DiscoverPollEndpointInput) (req *aws.Request, output *DiscoverPollEndpointOutput)
- func (c *ECS) ListClusters(input *ListClustersInput) (output *ListClustersOutput, err error)
- func (c *ECS) ListClustersRequest(input *ListClustersInput) (req *aws.Request, output *ListClustersOutput)
- func (c *ECS) ListContainerInstances(input *ListContainerInstancesInput) (output *ListContainerInstancesOutput, err error)
- func (c *ECS) ListContainerInstancesRequest(input *ListContainerInstancesInput) (req *aws.Request, output *ListContainerInstancesOutput)
- func (c *ECS) ListTaskDefinitionFamilies(input *ListTaskDefinitionFamiliesInput) (output *ListTaskDefinitionFamiliesOutput, err error)
- func (c *ECS) ListTaskDefinitionFamiliesRequest(input *ListTaskDefinitionFamiliesInput) (req *aws.Request, output *ListTaskDefinitionFamiliesOutput)
- func (c *ECS) ListTaskDefinitions(input *ListTaskDefinitionsInput) (output *ListTaskDefinitionsOutput, err error)
- func (c *ECS) ListTaskDefinitionsRequest(input *ListTaskDefinitionsInput) (req *aws.Request, output *ListTaskDefinitionsOutput)
- func (c *ECS) ListTasks(input *ListTasksInput) (output *ListTasksOutput, err error)
- func (c *ECS) ListTasksRequest(input *ListTasksInput) (req *aws.Request, output *ListTasksOutput)
- func (c *ECS) RegisterContainerInstance(input *RegisterContainerInstanceInput) (output *RegisterContainerInstanceOutput, err error)
- func (c *ECS) RegisterContainerInstanceRequest(input *RegisterContainerInstanceInput) (req *aws.Request, output *RegisterContainerInstanceOutput)
- func (c *ECS) RegisterTaskDefinition(input *RegisterTaskDefinitionInput) (output *RegisterTaskDefinitionOutput, err error)
- func (c *ECS) RegisterTaskDefinitionRequest(input *RegisterTaskDefinitionInput) (req *aws.Request, output *RegisterTaskDefinitionOutput)
- func (c *ECS) RunTask(input *RunTaskInput) (output *RunTaskOutput, err error)
- func (c *ECS) RunTaskRequest(input *RunTaskInput) (req *aws.Request, output *RunTaskOutput)
- func (c *ECS) StartTask(input *StartTaskInput) (output *StartTaskOutput, err error)
- func (c *ECS) StartTaskRequest(input *StartTaskInput) (req *aws.Request, output *StartTaskOutput)
- func (c *ECS) StopTask(input *StopTaskInput) (output *StopTaskOutput, err error)
- func (c *ECS) StopTaskRequest(input *StopTaskInput) (req *aws.Request, output *StopTaskOutput)
- func (c *ECS) SubmitContainerStateChange(input *SubmitContainerStateChangeInput) (output *SubmitContainerStateChangeOutput, err error)
- func (c *ECS) SubmitContainerStateChangeRequest(input *SubmitContainerStateChangeInput) (req *aws.Request, output *SubmitContainerStateChangeOutput)
- func (c *ECS) SubmitTaskStateChange(input *SubmitTaskStateChangeInput) (output *SubmitTaskStateChangeOutput, err error)
- func (c *ECS) SubmitTaskStateChangeRequest(input *SubmitTaskStateChangeInput) (req *aws.Request, output *SubmitTaskStateChangeOutput)
- type Failure
- type HostVolumeProperties
- type KeyValuePair
- type ListClustersInput
- type ListClustersOutput
- type ListContainerInstancesInput
- type ListContainerInstancesOutput
- type ListTaskDefinitionFamiliesInput
- type ListTaskDefinitionFamiliesOutput
- type ListTaskDefinitionsInput
- type ListTaskDefinitionsOutput
- type ListTasksInput
- type ListTasksOutput
- type MountPoint
- type NetworkBinding
- type PortMapping
- type RegisterContainerInstanceInput
- type RegisterContainerInstanceOutput
- type RegisterTaskDefinitionInput
- type RegisterTaskDefinitionOutput
- type Resource
- type RunTaskInput
- type RunTaskOutput
- type StartTaskInput
- type StartTaskOutput
- type StopTaskInput
- type StopTaskOutput
- type SubmitContainerStateChangeInput
- type SubmitContainerStateChangeOutput
- type SubmitTaskStateChangeInput
- type SubmitTaskStateChangeOutput
- type Task
- type TaskDefinition
- type TaskOverride
- type Volume
- type VolumeFrom
Examples ¶
- ECS.CreateCluster
- ECS.DeleteCluster
- ECS.DeregisterContainerInstance
- ECS.DeregisterTaskDefinition
- ECS.DescribeClusters
- ECS.DescribeContainerInstances
- ECS.DescribeTaskDefinition
- ECS.DescribeTasks
- ECS.DiscoverPollEndpoint
- ECS.ListClusters
- ECS.ListContainerInstances
- ECS.ListTaskDefinitionFamilies
- ECS.ListTaskDefinitions
- ECS.ListTasks
- ECS.RegisterContainerInstance
- ECS.RegisterTaskDefinition
- ECS.RunTask
- ECS.StartTask
- ECS.StopTask
- ECS.SubmitContainerStateChange
- ECS.SubmitTaskStateChange
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Cluster ¶
type Cluster struct { // 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 can use to identify your cluster. ClusterName *string `locationName:"clusterName" type:"string"` // The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE // indicates that you can register container instances with the cluster and // the associated instances can accept tasks. Status *string `locationName:"status" type:"string"` // contains filtered or unexported fields }
A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
During the preview, each account is limited to two clusters.
type Container ¶
type Container struct { // The Amazon Resource Name (ARN) of the container. ContainerARN *string `locationName:"containerArn" type:"string"` // The exit code returned from the container. ExitCode *int64 `locationName:"exitCode" type:"integer"` // The last known status of the container. LastStatus *string `locationName:"lastStatus" type:"string"` // The name of the container. Name *string `locationName:"name" type:"string"` NetworkBindings []*NetworkBinding `locationName:"networkBindings" type:"list"` // A short (255 max characters) human-readable string to provide additional // detail about a running or stopped container. Reason *string `locationName:"reason" type:"string"` // The Amazon Resource Name (ARN) of the task. TaskARN *string `locationName:"taskArn" type:"string"` // contains filtered or unexported fields }
type ContainerDefinition ¶
type ContainerDefinition struct { // The number of cpu units reserved for the container. A container instance // has 1,024 cpu units for every CPU core. CPU *int64 `locationName:"cpu" type:"integer"` // The CMD that is passed to the container. For more information on the Docker // CMD parameter, see https://docs.docker.com/reference/builder/#cmd (https://docs.docker.com/reference/builder/#cmd). Command []*string `locationName:"command" 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 ENTRYPOINT that is passed to the container. For more information on // the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint // (https://docs.docker.com/reference/builder/#entrypoint). EntryPoint []*string `locationName:"entryPoint" type:"list"` // The environment variables to pass to a container. Environment []*KeyValuePair `locationName:"environment" type:"list"` // If the essential parameter of a container is marked as true, the failure // of that container will stop the task. If the essential parameter of a container // is marked as false, then its failure will not affect the rest of the containers // in a task. Essential *bool `locationName:"essential" type:"boolean"` // 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 repository-url/image:tag. Image *string `locationName:"image" type:"string"` // The link parameter allows containers to communicate with each other without // the need for port mappings, using the name parameter. For more information // on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/ // (https://docs.docker.com/userguide/dockerlinks/). Links []*string `locationName:"links" type:"list"` // The number of MiB of memory reserved for the container. Docker will allocate // a minimum of 4 MiB of memory to a container. Memory *int64 `locationName:"memory" type:"integer"` // The mount points for data volumes in your container. 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. Name *string `locationName:"name" type:"string"` // The list of port mappings for the container. PortMappings []*PortMapping `locationName:"portMappings" type:"list"` // Data volumes to mount from another container. VolumesFrom []*VolumeFrom `locationName:"volumesFrom" type:"list"` // 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.
type ContainerInstance ¶
type ContainerInstance struct { // This parameter returns true if the agent is actually connected to Amazon // ECS. Registered instances with an agent that may be unhealthy or stopped // will return false, and instances without a connected agent cannot accept // placement request. AgentConnected *bool `locationName:"agentConnected" type:"boolean"` // 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 UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID. ContainerInstanceARN *string `locationName:"containerInstanceArn" type:"string"` // The Amazon EC2 instance ID of the container instance. EC2InstanceID *string `locationName:"ec2InstanceId" type:"string"` // The registered resources on the container instance that are in use by current // tasks. RegisteredResources []*Resource `locationName:"registeredResources" type:"list"` // The remaining resources of the container instance that are available for // new tasks. RemainingResources []*Resource `locationName:"remainingResources" type:"list"` // The status of the container instance. The valid values are ACTIVE or INACTIVE. // ACTIVE indicates that the container instance can accept tasks. Status *string `locationName:"status" type:"string"` // contains filtered or unexported fields }
An Amazon EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
type ContainerOverride ¶
type ContainerOverride struct { // The command to send to the container that receives the override. Command []*string `locationName:"command" type:"list"` // The name of the container that receives the override. Name *string `locationName:"name" type:"string"` // contains filtered or unexported fields }
type CreateClusterInput ¶
type CreateClusterInput struct { // The name of your cluster. If you do not specify a name for your cluster, // you will create a cluster named default. ClusterName *string `locationName:"clusterName" type:"string"` // contains filtered or unexported fields }
type CreateClusterOutput ¶
type CreateClusterOutput struct { // The full description of your new cluster. Cluster *Cluster `locationName:"cluster" type:"structure"` // contains filtered or unexported fields }
type DeleteClusterInput ¶
type DeleteClusterInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that you // want to delete. Cluster *string `locationName:"cluster" type:"string" required:"true"` // contains filtered or unexported fields }
type DeleteClusterOutput ¶
type DeleteClusterOutput struct { // The full description of the deleted cluster. Cluster *Cluster `locationName:"cluster" type:"structure"` // contains filtered or unexported fields }
type DeregisterContainerInstanceInput ¶
type DeregisterContainerInstanceInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the container instance you want to deregister. If you do not specify a cluster, // the default cluster is assumed. Cluster *string `locationName:"cluster" type:"string"` // The container instance UUID or full Amazon Resource Name (ARN) of the container // instance you want 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 UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID. ContainerInstance *string `locationName:"containerInstance" type:"string" required:"true"` // Force the deregistration of the container instance. You can use the force // parameter if you have several tasks running on a container instance and you // don't want to run StopTask for each task before deregistering the container // instance. Force *bool `locationName:"force" type:"boolean"` // contains filtered or unexported fields }
type DeregisterContainerInstanceOutput ¶
type DeregisterContainerInstanceOutput struct { // An Amazon EC2 instance that is running the Amazon ECS agent and has been // registered with a cluster. ContainerInstance *ContainerInstance `locationName:"containerInstance" type:"structure"` // contains filtered or unexported fields }
type DeregisterTaskDefinitionInput ¶
type DeregisterTaskDefinitionInput struct { // The family and revision (family:revision) or full Amazon Resource Name (ARN) // of the task definition that you want to deregister. TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"` // contains filtered or unexported fields }
type DeregisterTaskDefinitionOutput ¶
type DeregisterTaskDefinitionOutput struct { // The full description of the deregistered task. TaskDefinition *TaskDefinition `locationName:"taskDefinition" type:"structure"` // contains filtered or unexported fields }
type DescribeClustersInput ¶
type DescribeClustersInput struct { // A space-separated list of 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"` // contains filtered or unexported fields }
type DescribeClustersOutput ¶
type DescribeContainerInstancesInput ¶
type DescribeContainerInstancesInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the container instances you want to describe. If you do not specify a cluster, // the default cluster is assumed. Cluster *string `locationName:"cluster" type:"string"` // A space-separated list of container instance UUIDs or full Amazon Resource // Name (ARN) entries. ContainerInstances []*string `locationName:"containerInstances" type:"list" required:"true"` // contains filtered or unexported fields }
type DescribeContainerInstancesOutput ¶
type DescribeContainerInstancesOutput struct { // The list of container instances. ContainerInstances []*ContainerInstance `locationName:"containerInstances" type:"list"` Failures []*Failure `locationName:"failures" type:"list"` // contains filtered or unexported fields }
type DescribeTaskDefinitionInput ¶
type DescribeTaskDefinitionInput struct { // The family for the latest revision, family and revision (family:revision) // for a specific revision in the family, or full Amazon Resource Name (ARN) // of the task definition that you want to describe. TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"` // contains filtered or unexported fields }
type DescribeTaskDefinitionOutput ¶
type DescribeTaskDefinitionOutput struct { // The full task definition description. TaskDefinition *TaskDefinition `locationName:"taskDefinition" type:"structure"` // contains filtered or unexported fields }
type DescribeTasksInput ¶
type DescribeTasksInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the task you want to describe. If you do not specify a cluster, the default // cluster is assumed. Cluster *string `locationName:"cluster" type:"string"` // A space-separated list of task UUIDs or full Amazon Resource Name (ARN) entries. Tasks []*string `locationName:"tasks" type:"list" required:"true"` // contains filtered or unexported fields }
type DescribeTasksOutput ¶
type DiscoverPollEndpointInput ¶
type DiscoverPollEndpointInput struct { // The cluster that the container instance belongs to. Cluster *string `locationName:"cluster" type:"string"` // The container instance UUID or full 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 UUID. For // example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID. ContainerInstance *string `locationName:"containerInstance" type:"string"` // contains filtered or unexported fields }
type DiscoverPollEndpointOutput ¶
type DiscoverPollEndpointOutput struct { // The endpoint for the Amazon ECS agent to poll. Endpoint *string `locationName:"endpoint" type:"string"` // contains filtered or unexported fields }
type ECS ¶
ECS is a client for Amazon ECS.
func (*ECS) CreateCluster ¶
func (c *ECS) CreateCluster(input *CreateClusterInput) (output *CreateClusterOutput, err error)
Creates a new Amazon ECS cluster. By default, your account will receive 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.
During the preview, each account is limited to two clusters.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.CreateClusterInput{ ClusterName: aws.String("String"), } resp, err := svc.CreateCluster(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) CreateClusterRequest ¶
func (c *ECS) CreateClusterRequest(input *CreateClusterInput) (req *aws.Request, output *CreateClusterOutput)
CreateClusterRequest generates a request for the CreateCluster operation.
func (*ECS) DeleteCluster ¶
func (c *ECS) DeleteCluster(input *DeleteClusterInput) (output *DeleteClusterOutput, err error)
Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.DeleteClusterInput{ Cluster: aws.String("String"), // Required } resp, err := svc.DeleteCluster(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) DeleteClusterRequest ¶
func (c *ECS) DeleteClusterRequest(input *DeleteClusterInput) (req *aws.Request, output *DeleteClusterOutput)
DeleteClusterRequest generates a request for the DeleteCluster operation.
func (*ECS) DeregisterContainerInstance ¶
func (c *ECS) DeregisterContainerInstance(input *DeregisterContainerInstanceInput) (output *DeregisterContainerInstanceOutput, err error)
Deregisters an Amazon ECS container instance from the specified cluster. This instance will no longer be available to run tasks.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.DeregisterContainerInstanceInput{ ContainerInstance: aws.String("String"), // Required Cluster: aws.String("String"), Force: aws.Boolean(true), } resp, err := svc.DeregisterContainerInstance(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) DeregisterContainerInstanceRequest ¶
func (c *ECS) DeregisterContainerInstanceRequest(input *DeregisterContainerInstanceInput) (req *aws.Request, output *DeregisterContainerInstanceOutput)
DeregisterContainerInstanceRequest generates a request for the DeregisterContainerInstance operation.
func (*ECS) DeregisterTaskDefinition ¶
func (c *ECS) DeregisterTaskDefinition(input *DeregisterTaskDefinitionInput) (output *DeregisterTaskDefinitionOutput, err error)
NOT YET IMPLEMENTED.
Deregisters the specified task definition. You will no longer be able to run tasks from this definition after deregistration.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.DeregisterTaskDefinitionInput{ TaskDefinition: aws.String("String"), // Required } resp, err := svc.DeregisterTaskDefinition(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) DeregisterTaskDefinitionRequest ¶
func (c *ECS) DeregisterTaskDefinitionRequest(input *DeregisterTaskDefinitionInput) (req *aws.Request, output *DeregisterTaskDefinitionOutput)
DeregisterTaskDefinitionRequest generates a request for the DeregisterTaskDefinition operation.
func (*ECS) DescribeClusters ¶
func (c *ECS) DescribeClusters(input *DescribeClustersInput) (output *DescribeClustersOutput, err error)
Describes one or more of your clusters.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.DescribeClustersInput{ Clusters: []*string{ aws.String("String"), // Required // More values... }, } resp, err := svc.DescribeClusters(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) DescribeClustersRequest ¶
func (c *ECS) DescribeClustersRequest(input *DescribeClustersInput) (req *aws.Request, output *DescribeClustersOutput)
DescribeClustersRequest generates a request for the DescribeClusters operation.
func (*ECS) DescribeContainerInstances ¶
func (c *ECS) DescribeContainerInstances(input *DescribeContainerInstancesInput) (output *DescribeContainerInstancesOutput, err error)
Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.DescribeContainerInstancesInput{ ContainerInstances: []*string{ // Required aws.String("String"), // Required // More values... }, Cluster: aws.String("String"), } resp, err := svc.DescribeContainerInstances(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) DescribeContainerInstancesRequest ¶
func (c *ECS) DescribeContainerInstancesRequest(input *DescribeContainerInstancesInput) (req *aws.Request, output *DescribeContainerInstancesOutput)
DescribeContainerInstancesRequest generates a request for the DescribeContainerInstances operation.
func (*ECS) DescribeTaskDefinition ¶
func (c *ECS) DescribeTaskDefinition(input *DescribeTaskDefinitionInput) (output *DescribeTaskDefinitionOutput, err error)
Describes a task definition. You can specify a family and revision to find information on a specific task definition, or you can simply specify the family to find the latest revision in that family.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.DescribeTaskDefinitionInput{ TaskDefinition: aws.String("String"), // Required } resp, err := svc.DescribeTaskDefinition(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) DescribeTaskDefinitionRequest ¶
func (c *ECS) DescribeTaskDefinitionRequest(input *DescribeTaskDefinitionInput) (req *aws.Request, output *DescribeTaskDefinitionOutput)
DescribeTaskDefinitionRequest generates a request for the DescribeTaskDefinition operation.
func (*ECS) DescribeTasks ¶
func (c *ECS) DescribeTasks(input *DescribeTasksInput) (output *DescribeTasksOutput, err error)
Describes a specified task or tasks.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.DescribeTasksInput{ Tasks: []*string{ // Required aws.String("String"), // Required // More values... }, Cluster: aws.String("String"), } resp, err := svc.DescribeTasks(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) DescribeTasksRequest ¶
func (c *ECS) DescribeTasksRequest(input *DescribeTasksInput) (req *aws.Request, output *DescribeTasksOutput)
DescribeTasksRequest generates a request for the DescribeTasks operation.
func (*ECS) DiscoverPollEndpoint ¶
func (c *ECS) DiscoverPollEndpoint(input *DiscoverPollEndpointInput) (output *DiscoverPollEndpointOutput, err error)
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.DiscoverPollEndpointInput{ Cluster: aws.String("String"), ContainerInstance: aws.String("String"), } resp, err := svc.DiscoverPollEndpoint(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) DiscoverPollEndpointRequest ¶
func (c *ECS) DiscoverPollEndpointRequest(input *DiscoverPollEndpointInput) (req *aws.Request, output *DiscoverPollEndpointOutput)
DiscoverPollEndpointRequest generates a request for the DiscoverPollEndpoint operation.
func (*ECS) ListClusters ¶
func (c *ECS) ListClusters(input *ListClustersInput) (output *ListClustersOutput, err error)
Returns a list of existing clusters.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.ListClustersInput{ MaxResults: aws.Long(1), NextToken: aws.String("String"), } resp, err := svc.ListClusters(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) ListClustersRequest ¶
func (c *ECS) ListClustersRequest(input *ListClustersInput) (req *aws.Request, output *ListClustersOutput)
ListClustersRequest generates a request for the ListClusters operation.
func (*ECS) ListContainerInstances ¶
func (c *ECS) ListContainerInstances(input *ListContainerInstancesInput) (output *ListContainerInstancesOutput, err error)
Returns a list of container instances in a specified cluster.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.ListContainerInstancesInput{ Cluster: aws.String("String"), MaxResults: aws.Long(1), NextToken: aws.String("String"), } resp, err := svc.ListContainerInstances(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) ListContainerInstancesRequest ¶
func (c *ECS) ListContainerInstancesRequest(input *ListContainerInstancesInput) (req *aws.Request, output *ListContainerInstancesOutput)
ListContainerInstancesRequest generates a request for the ListContainerInstances operation.
func (*ECS) ListTaskDefinitionFamilies ¶
func (c *ECS) ListTaskDefinitionFamilies(input *ListTaskDefinitionFamiliesInput) (output *ListTaskDefinitionFamiliesOutput, err error)
Returns a list of task definition families that are registered to your account. You can filter the results with the familyPrefix parameter.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.ListTaskDefinitionFamiliesInput{ FamilyPrefix: aws.String("String"), MaxResults: aws.Long(1), NextToken: aws.String("String"), } resp, err := svc.ListTaskDefinitionFamilies(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) ListTaskDefinitionFamiliesRequest ¶
func (c *ECS) ListTaskDefinitionFamiliesRequest(input *ListTaskDefinitionFamiliesInput) (req *aws.Request, output *ListTaskDefinitionFamiliesOutput)
ListTaskDefinitionFamiliesRequest generates a request for the ListTaskDefinitionFamilies operation.
func (*ECS) ListTaskDefinitions ¶
func (c *ECS) ListTaskDefinitions(input *ListTaskDefinitionsInput) (output *ListTaskDefinitionsOutput, err error)
Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.ListTaskDefinitionsInput{ FamilyPrefix: aws.String("String"), MaxResults: aws.Long(1), NextToken: aws.String("String"), } resp, err := svc.ListTaskDefinitions(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) ListTaskDefinitionsRequest ¶
func (c *ECS) ListTaskDefinitionsRequest(input *ListTaskDefinitionsInput) (req *aws.Request, output *ListTaskDefinitionsOutput)
ListTaskDefinitionsRequest generates a request for the ListTaskDefinitions operation.
func (*ECS) ListTasks ¶
func (c *ECS) ListTasks(input *ListTasksInput) (output *ListTasksOutput, err error)
Returns a list of tasks for a specified cluster. You can filter the results by family name or by a particular container instance with the family and containerInstance parameters.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.ListTasksInput{ Cluster: aws.String("String"), ContainerInstance: aws.String("String"), Family: aws.String("String"), MaxResults: aws.Long(1), NextToken: aws.String("String"), } resp, err := svc.ListTasks(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) ListTasksRequest ¶
func (c *ECS) ListTasksRequest(input *ListTasksInput) (req *aws.Request, output *ListTasksOutput)
ListTasksRequest generates a request for the ListTasks operation.
func (*ECS) RegisterContainerInstance ¶
func (c *ECS) RegisterContainerInstance(input *RegisterContainerInstanceInput) (output *RegisterContainerInstanceOutput, err error)
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Registers an Amazon EC2 instance into the specified cluster. This instance will become available to place containers on.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.RegisterContainerInstanceInput{ Cluster: aws.String("String"), InstanceIdentityDocument: aws.String("String"), InstanceIdentityDocumentSignature: aws.String("String"), TotalResources: []*ecs.Resource{ &ecs.Resource{ // Required DoubleValue: aws.Double(1.0), IntegerValue: aws.Long(1), LongValue: aws.Long(1), Name: aws.String("String"), StringSetValue: []*string{ aws.String("String"), // Required // More values... }, Type: aws.String("String"), }, // More values... }, } resp, err := svc.RegisterContainerInstance(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) RegisterContainerInstanceRequest ¶
func (c *ECS) RegisterContainerInstanceRequest(input *RegisterContainerInstanceInput) (req *aws.Request, output *RegisterContainerInstanceOutput)
RegisterContainerInstanceRequest generates a request for the RegisterContainerInstance operation.
func (*ECS) RegisterTaskDefinition ¶
func (c *ECS) RegisterTaskDefinition(input *RegisterTaskDefinitionInput) (output *RegisterTaskDefinitionOutput, err error)
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 on task definition parameters and defaults, see Amazon ECS Task Definitions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the Amazon EC2 Container Service Developer Guide.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.RegisterTaskDefinitionInput{ ContainerDefinitions: []*ecs.ContainerDefinition{ // Required &ecs.ContainerDefinition{ // Required CPU: aws.Long(1), Command: []*string{ aws.String("String"), // Required // More values... }, EntryPoint: []*string{ aws.String("String"), // Required // More values... }, Environment: []*ecs.KeyValuePair{ &ecs.KeyValuePair{ // Required Name: aws.String("String"), Value: aws.String("String"), }, // More values... }, Essential: aws.Boolean(true), Image: aws.String("String"), Links: []*string{ aws.String("String"), // Required // More values... }, Memory: aws.Long(1), MountPoints: []*ecs.MountPoint{ &ecs.MountPoint{ // Required ContainerPath: aws.String("String"), ReadOnly: aws.Boolean(true), SourceVolume: aws.String("String"), }, // More values... }, Name: aws.String("String"), PortMappings: []*ecs.PortMapping{ &ecs.PortMapping{ // Required ContainerPort: aws.Long(1), HostPort: aws.Long(1), }, // More values... }, VolumesFrom: []*ecs.VolumeFrom{ &ecs.VolumeFrom{ // Required ReadOnly: aws.Boolean(true), SourceContainer: aws.String("String"), }, // More values... }, }, // More values... }, Family: aws.String("String"), // Required Volumes: []*ecs.Volume{ &ecs.Volume{ // Required Host: &ecs.HostVolumeProperties{ SourcePath: aws.String("String"), }, Name: aws.String("String"), }, // More values... }, } resp, err := svc.RegisterTaskDefinition(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) RegisterTaskDefinitionRequest ¶
func (c *ECS) RegisterTaskDefinitionRequest(input *RegisterTaskDefinitionInput) (req *aws.Request, output *RegisterTaskDefinitionOutput)
RegisterTaskDefinitionRequest generates a request for the RegisterTaskDefinition operation.
func (*ECS) RunTask ¶
func (c *ECS) RunTask(input *RunTaskInput) (output *RunTaskOutput, err error)
Start a task using random placement and the default Amazon ECS scheduler. If you want to use your own scheduler or place a task on a specific container instance, use StartTask instead.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.RunTaskInput{ TaskDefinition: aws.String("String"), // Required Cluster: aws.String("String"), Count: aws.Long(1), Overrides: &ecs.TaskOverride{ ContainerOverrides: []*ecs.ContainerOverride{ &ecs.ContainerOverride{ // Required Command: []*string{ aws.String("String"), // Required // More values... }, Name: aws.String("String"), }, // More values... }, }, } resp, err := svc.RunTask(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) RunTaskRequest ¶
func (c *ECS) RunTaskRequest(input *RunTaskInput) (req *aws.Request, output *RunTaskOutput)
RunTaskRequest generates a request for the RunTask operation.
func (*ECS) StartTask ¶
func (c *ECS) StartTask(input *StartTaskInput) (output *StartTaskOutput, err error)
Starts a new task from the specified task definition on the specified container instance or instances. If you want to use the default Amazon ECS scheduler to place your task, use RunTask instead.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.StartTaskInput{ ContainerInstances: []*string{ // Required aws.String("String"), // Required // More values... }, TaskDefinition: aws.String("String"), // Required Cluster: aws.String("String"), Overrides: &ecs.TaskOverride{ ContainerOverrides: []*ecs.ContainerOverride{ &ecs.ContainerOverride{ // Required Command: []*string{ aws.String("String"), // Required // More values... }, Name: aws.String("String"), }, // More values... }, }, } resp, err := svc.StartTask(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) StartTaskRequest ¶
func (c *ECS) StartTaskRequest(input *StartTaskInput) (req *aws.Request, output *StartTaskOutput)
StartTaskRequest generates a request for the StartTask operation.
func (*ECS) StopTask ¶
func (c *ECS) StopTask(input *StopTaskInput) (output *StopTaskOutput, err error)
Stops a running task.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.StopTaskInput{ Task: aws.String("String"), // Required Cluster: aws.String("String"), } resp, err := svc.StopTask(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) StopTaskRequest ¶
func (c *ECS) StopTaskRequest(input *StopTaskInput) (req *aws.Request, output *StopTaskOutput)
StopTaskRequest generates a request for the StopTask operation.
func (*ECS) SubmitContainerStateChange ¶
func (c *ECS) SubmitContainerStateChange(input *SubmitContainerStateChangeInput) (output *SubmitContainerStateChangeOutput, err error)
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.SubmitContainerStateChangeInput{ Cluster: aws.String("String"), ContainerName: aws.String("String"), ExitCode: aws.Long(1), NetworkBindings: []*ecs.NetworkBinding{ &ecs.NetworkBinding{ // Required BindIP: aws.String("String"), ContainerPort: aws.Long(1), HostPort: aws.Long(1), }, // More values... }, Reason: aws.String("String"), Status: aws.String("String"), Task: aws.String("String"), } resp, err := svc.SubmitContainerStateChange(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) SubmitContainerStateChangeRequest ¶
func (c *ECS) SubmitContainerStateChangeRequest(input *SubmitContainerStateChangeInput) (req *aws.Request, output *SubmitContainerStateChangeOutput)
SubmitContainerStateChangeRequest generates a request for the SubmitContainerStateChange operation.
func (*ECS) SubmitTaskStateChange ¶
func (c *ECS) SubmitTaskStateChange(input *SubmitTaskStateChangeInput) (output *SubmitTaskStateChangeOutput, err error)
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
Example ¶
package main import ( "fmt" "github.com/awslabs/aws-sdk-go/aws" "github.com/awslabs/aws-sdk-go/aws/awsutil" "github.com/awslabs/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(nil) params := &ecs.SubmitTaskStateChangeInput{ Cluster: aws.String("String"), Reason: aws.String("String"), Status: aws.String("String"), Task: aws.String("String"), } resp, err := svc.SubmitTaskStateChange(params) if awserr := aws.Error(err); awserr != nil { // A service error occurred. fmt.Println("Error:", awserr.Code, awserr.Message) } else if err != nil { // A non-service error occurred. panic(err) } // Pretty-print the response data. fmt.Println(awsutil.StringValue(resp)) }
Output:
func (*ECS) SubmitTaskStateChangeRequest ¶
func (c *ECS) SubmitTaskStateChangeRequest(input *SubmitTaskStateChangeInput) (req *aws.Request, output *SubmitTaskStateChangeOutput)
SubmitTaskStateChangeRequest generates a request for the SubmitTaskStateChange operation.
type HostVolumeProperties ¶
type HostVolumeProperties struct { // The path on the host container instance that is presented to the container. // If this parameter is empty, then the Docker daemon has assigned a host path // for you. SourcePath *string `locationName:"sourcePath" type:"string"` // contains filtered or unexported fields }
type KeyValuePair ¶
type ListClustersInput ¶
type ListClustersInput struct { // The maximum number of cluster results returned by ListClusters in paginated // output. When this parameter is used, ListClusters only returns maxResults // results in a single page along with a nextToken response element. The remaining // results of the initial request can be seen by sending another ListClusters // request with the returned nextToken value. This value can be between 1 and // 100. If this parameter is not used, then ListClusters returns up to 100 results // and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a previous paginated ListClusters request // where maxResults was used and the results exceeded the value of that parameter. // Pagination continues from the end of the previous results that returned the // nextToken value. This value is null when there are no more results to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
type ListClustersOutput ¶
type ListClustersOutput struct { // The list of full Amazon Resource Name (ARN) entries for each cluster associated // with your account. ClusterARNs []*string `locationName:"clusterArns" type:"list"` // The nextToken value to include in a future ListClusters request. When the // results of a ListClusters request exceed maxResults, this value can be used // to retrieve the next page of results. This value is null when there are no // more results to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
type ListContainerInstancesInput ¶
type ListContainerInstancesInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the container instances you want to list. If you do not specify a cluster, // the default cluster is assumed.. Cluster *string `locationName:"cluster" type:"string"` // The maximum number of container instance results returned by ListContainerInstances // in paginated output. When this parameter is used, ListContainerInstances // only returns maxResults results in a single page along with a nextToken response // element. The remaining results of the initial request can be seen by sending // another ListContainerInstances request with the returned nextToken value. // This value can be between 1 and 100. If this parameter is not used, then // ListContainerInstances returns up to 100 results and a nextToken value if // applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a previous paginated ListContainerInstances // request where maxResults was used and the results exceeded the value of that // parameter. Pagination continues from the end of the previous results that // returned the nextToken value. This value is null when there are no more results // to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
type ListContainerInstancesOutput ¶
type ListContainerInstancesOutput struct { // The list of container instance full Amazon Resource Name (ARN) entries for // each container instance associated with the specified cluster. ContainerInstanceARNs []*string `locationName:"containerInstanceArns" type:"list"` // The nextToken value to include in a future ListContainerInstances request. // When the results of a ListContainerInstances request exceed maxResults, this // value can be used to retrieve the next page of results. This value is null // when there are no more results to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
type ListTaskDefinitionFamiliesInput ¶
type ListTaskDefinitionFamiliesInput struct { // The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. // If you specify a familyPrefix, only task definition family names that begin // with the familyPrefix string are returned. FamilyPrefix *string `locationName:"familyPrefix" type:"string"` // The maximum number of task definition family results returned by ListTaskDefinitionFamilies // in paginated output. When this parameter is used, ListTaskDefinitions only // returns maxResults results in a single page along with a nextToken response // element. The remaining results of the initial request can be seen by sending // another ListTaskDefinitionFamilies request with the returned nextToken value. // This value can be between 1 and 100. If this parameter is not used, then // ListTaskDefinitionFamilies returns up to 100 results and a nextToken value // if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a previous paginated ListTaskDefinitionFamilies // request where maxResults was used and the results exceeded the value of that // parameter. Pagination continues from the end of the previous results that // returned the nextToken value. This value is null when there are no more results // to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
type ListTaskDefinitionFamiliesOutput ¶
type ListTaskDefinitionFamiliesOutput struct { // The list of task definition family names that match the ListTaskDefinitionFamilies // request. Families []*string `locationName:"families" type:"list"` // The nextToken value to include in a future ListTaskDefinitionFamilies request. // When the results of a ListTaskDefinitionFamilies request exceed maxResults, // this value can be used to retrieve the next page of results. This value is // null when there are no more results to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
type ListTaskDefinitionsInput ¶
type ListTaskDefinitionsInput struct { // The full family name that you want to filter the ListTaskDefinitions results // with. Specifying a familyPrefix will limit the listed task definitions to // task definition revisions that belong to that family. FamilyPrefix *string `locationName:"familyPrefix" type:"string"` // The maximum number of task definition results returned by ListTaskDefinitions // in paginated output. When this parameter is used, ListTaskDefinitions only // returns maxResults results in a single page along with a nextToken response // element. The remaining results of the initial request can be seen by sending // another ListTaskDefinitions request with the returned nextToken value. This // value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions // returns up to 100 results and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a previous paginated ListTaskDefinitions // request where maxResults was used and the results exceeded the value of that // parameter. Pagination continues from the end of the previous results that // returned the nextToken value. This value is null when there are no more results // to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
type ListTaskDefinitionsOutput ¶
type ListTaskDefinitionsOutput struct { // The nextToken value to include in a future ListTaskDefinitions request. When // the results of a ListTaskDefinitions request exceed maxResults, this value // can be used to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string `locationName:"nextToken" type:"string"` // The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefintions // request. TaskDefinitionARNs []*string `locationName:"taskDefinitionArns" type:"list"` // contains filtered or unexported fields }
type ListTasksInput ¶
type ListTasksInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the tasks you want to list. If you do not specify a cluster, the default // cluster is assumed.. Cluster *string `locationName:"cluster" type:"string"` // The container instance UUID or full Amazon Resource Name (ARN) of the container // instance that you want to filter the ListTasks results with. Specifying a // containerInstance will limit the results to tasks that belong to that container // instance. ContainerInstance *string `locationName:"containerInstance" type:"string"` // The name of the family that you want to filter the ListTasks results with. // Specifying a family will limit the results to tasks that belong to that family. Family *string `locationName:"family" type:"string"` // The maximum number of task results returned by ListTasks in paginated output. // When this parameter is used, ListTasks only returns maxResults results in // a single page along with a nextToken response element. The remaining results // of the initial request can be seen by sending another ListTasks request with // the returned nextToken value. This value can be between 1 and 100. If this // parameter is not used, then ListTasks returns up to 100 results and a nextToken // value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a previous paginated ListTasks request // where maxResults was used and the results exceeded the value of that parameter. // Pagination continues from the end of the previous results that returned the // nextToken value. This value is null when there are no more results to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
type ListTasksOutput ¶
type ListTasksOutput struct { // The nextToken value to include in a future ListTasks request. When the results // of a ListTasks request exceed maxResults, this value can be used to retrieve // the next page of results. This value is null when there are no more results // to return. NextToken *string `locationName:"nextToken" type:"string"` // The list of task Amazon Resource Name (ARN) entries for the ListTasks request. TaskARNs []*string `locationName:"taskArns" type:"list"` // contains filtered or unexported fields }
type MountPoint ¶
type MountPoint struct { // The path on the container to mount the host volume at. ContainerPath *string `locationName:"containerPath" type:"string"` // If this value is true, the container has read-only access to the volume. // If this value is false, then the container can write to the volume. The default // value is false. ReadOnly *bool `locationName:"readOnly" type:"boolean"` // The name of the volume to mount. SourceVolume *string `locationName:"sourceVolume" type:"string"` // contains filtered or unexported fields }
type NetworkBinding ¶
type NetworkBinding struct { // The IP address that the container is bound to on the container instance. BindIP *string `locationName:"bindIP" type:"string"` // The port number on the container that is be used with the network binding. ContainerPort *int64 `locationName:"containerPort" type:"integer"` // The port number on the host that is used with the network binding. HostPort *int64 `locationName:"hostPort" type:"integer"` // contains filtered or unexported fields }
type PortMapping ¶
type PortMapping struct { // The port number on the container that is bound to the user-specified or automatically // assigned host port. If you specify a container port and not a host port, // your container will automatically receive a host port in the 49153 to 65535 // port range. ContainerPort *int64 `locationName:"containerPort" type:"integer"` // The port number on the container instance to reserve for your container. // You can specify a non-reserved host port for your container port mapping, // or you can omit the hostPort while specifying a containerPort and your container // will automatically receive a port in the 49153 to 65535 port range. You should // not attempt to specify a host port in the 49153 to 65535 port range, since // these are reserved for automatic assignment. // // The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, // and the Amazon ECS Container Agent port 51678. Any host port that was previously // specified in a running task is also reserved while the task is running (once // a task stops, the host port is released).The current reserved ports are displayed // in the remainingResources of DescribeContainerInstances output, and a container // instance may have up to 50 reserved ports at a time, including the default // reserved ports (automatically assigned ports do not count toward this limit). HostPort *int64 `locationName:"hostPort" type:"integer"` // contains filtered or unexported fields }
Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.
type RegisterContainerInstanceInput ¶
type RegisterContainerInstanceInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that you // want to register your container instance with. If you do not specify a cluster, // the default cluster is assumed.. Cluster *string `locationName:"cluster" type:"string"` InstanceIdentityDocument *string `locationName:"instanceIdentityDocument" type:"string"` InstanceIdentityDocumentSignature *string `locationName:"instanceIdentityDocumentSignature" type:"string"` TotalResources []*Resource `locationName:"totalResources" type:"list"` // contains filtered or unexported fields }
type RegisterContainerInstanceOutput ¶
type RegisterContainerInstanceOutput struct { // An Amazon EC2 instance that is running the Amazon ECS agent and has been // registered with a cluster. ContainerInstance *ContainerInstance `locationName:"containerInstance" type:"structure"` // contains filtered or unexported fields }
type RegisterTaskDefinitionInput ¶
type RegisterTaskDefinitionInput struct { // A list of container definitions in JSON format that describe the different // containers that make up your task. ContainerDefinitions []*ContainerDefinition `locationName:"containerDefinitions" type:"list" required:"true"` // You must specify a family for a task definition, which allows you to track // multiple versions of the same task definition. You can think of the family // as a name for your task definition. Family *string `locationName:"family" type:"string" required:"true"` // A list of volume definitions in JSON format that containers in your task // may use. Volumes []*Volume `locationName:"volumes" type:"list"` // contains filtered or unexported fields }
type RegisterTaskDefinitionOutput ¶
type RegisterTaskDefinitionOutput struct { TaskDefinition *TaskDefinition `locationName:"taskDefinition" type:"structure"` // contains filtered or unexported fields }
type Resource ¶
type Resource struct { // When the doubleValue type is set, the value of the resource must be a double // precision floating-point type. DoubleValue *float64 `locationName:"doubleValue" type:"double"` // When the integerValue type is set, the value of the resource must be an integer. IntegerValue *int64 `locationName:"integerValue" type:"integer"` // When the longValue type is set, the value of the resource must be an extended // precision floating-point type. LongValue *int64 `locationName:"longValue" type:"long"` // The name of the resource, such as CPU, MEMORY, PORTS, or a user-defined resource. Name *string `locationName:"name" type:"string"` // When the stringSetValue type is set, the value of the resource must be a // string type. StringSetValue []*string `locationName:"stringSetValue" type:"list"` // The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET. Type *string `locationName:"type" type:"string"` // contains filtered or unexported fields }
Describes the resources available for a container instance.
type RunTaskInput ¶
type RunTaskInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that you // want to run your task on. If you do not specify a cluster, the default cluster // is assumed.. Cluster *string `locationName:"cluster" type:"string"` // The number of instances of the specified task that you would like to place // on your cluster. Count *int64 `locationName:"count" type:"integer"` Overrides *TaskOverride `locationName:"overrides" type:"structure"` // The family and revision (family:revision) or full Amazon Resource Name (ARN) // of the task definition that you want to run. TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"` // contains filtered or unexported fields }
type RunTaskOutput ¶
type RunTaskOutput struct { // Any failed tasks from your RunTask action are listed here. Failures []*Failure `locationName:"failures" type:"list"` // A full description of the tasks that were run. Each task that was successfully // placed on your cluster will be described here. Tasks []*Task `locationName:"tasks" type:"list"` // contains filtered or unexported fields }
type StartTaskInput ¶
type StartTaskInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that you // want to start your task on. If you do not specify a cluster, the default // cluster is assumed.. Cluster *string `locationName:"cluster" type:"string"` // The container instance UUIDs or full Amazon Resource Name (ARN) entries for // the container instances on which you would like to place your task. ContainerInstances []*string `locationName:"containerInstances" type:"list" required:"true"` Overrides *TaskOverride `locationName:"overrides" type:"structure"` // The family and revision (family:revision) or full Amazon Resource Name (ARN) // of the task definition that you want to start. TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"` // contains filtered or unexported fields }
type StartTaskOutput ¶
type StartTaskOutput struct { // Any failed tasks from your StartTask action are listed here. Failures []*Failure `locationName:"failures" type:"list"` // A full description of the tasks that were started. Each task that was successfully // placed on your container instances will be described here. Tasks []*Task `locationName:"tasks" type:"list"` // contains filtered or unexported fields }
type StopTaskInput ¶
type StopTaskInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the task you want to stop. If you do not specify a cluster, the default cluster // is assumed.. Cluster *string `locationName:"cluster" type:"string"` // The task UUIDs or full Amazon Resource Name (ARN) entry of the task you would // like to stop. Task *string `locationName:"task" type:"string" required:"true"` // contains filtered or unexported fields }
type StopTaskOutput ¶
type StopTaskOutput struct { Task *Task `locationName:"task" type:"structure"` // contains filtered or unexported fields }
type SubmitContainerStateChangeInput ¶
type SubmitContainerStateChangeInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the container. Cluster *string `locationName:"cluster" type:"string"` // The name of the container. ContainerName *string `locationName:"containerName" type:"string"` // The exit code returned for the state change request. ExitCode *int64 `locationName:"exitCode" type:"integer"` // The network bindings of the container. NetworkBindings []*NetworkBinding `locationName:"networkBindings" type:"list"` // The reason for the state change request. Reason *string `locationName:"reason" type:"string"` // The status of the state change request. Status *string `locationName:"status" type:"string"` // The task UUID or full Amazon Resource Name (ARN) of the task that hosts the // container. Task *string `locationName:"task" type:"string"` // contains filtered or unexported fields }
type SubmitContainerStateChangeOutput ¶
type SubmitContainerStateChangeOutput struct { // Acknowledgement of the state change. Acknowledgment *string `locationName:"acknowledgment" type:"string"` // contains filtered or unexported fields }
type SubmitTaskStateChangeInput ¶
type SubmitTaskStateChangeInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the task. Cluster *string `locationName:"cluster" type:"string"` // The reason for the state change request. Reason *string `locationName:"reason" type:"string"` // The status of the state change request. Status *string `locationName:"status" type:"string"` // The task UUID or full Amazon Resource Name (ARN) of the task in the state // change request. Task *string `locationName:"task" type:"string"` // contains filtered or unexported fields }
type SubmitTaskStateChangeOutput ¶
type SubmitTaskStateChangeOutput struct { // Acknowledgement of the state change. Acknowledgment *string `locationName:"acknowledgment" type:"string"` // contains filtered or unexported fields }
type Task ¶
type Task struct { // The Amazon Resource Name (ARN) of the of the cluster that hosts the task. ClusterARN *string `locationName:"clusterArn" type:"string"` // The Amazon Resource Name (ARN) of the container instances that host the task. ContainerInstanceARN *string `locationName:"containerInstanceArn" type:"string"` // The containers associated with the task. Containers []*Container `locationName:"containers" type:"list"` // The desired status of the task. DesiredStatus *string `locationName:"desiredStatus" type:"string"` // The last known status of the task. LastStatus *string `locationName:"lastStatus" type:"string"` // One or more container overrides. Overrides *TaskOverride `locationName:"overrides" type:"structure"` // The Amazon Resource Name (ARN) of the task. TaskARN *string `locationName:"taskArn" type:"string"` // The Amazon Resource Name (ARN) of the of the task definition that creates // the task. TaskDefinitionARN *string `locationName:"taskDefinitionArn" type:"string"` // contains filtered or unexported fields }
type TaskDefinition ¶
type TaskDefinition struct { // A list of container definitions in JSON format that describe the different // containers that make up your task. For more information on container definition // parameters and defaults, see Amazon ECS Task Definitions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) // in the Amazon EC2 Container Service Developer Guide. ContainerDefinitions []*ContainerDefinition `locationName:"containerDefinitions" type:"list"` // The family of your task definition. You can think of the family as the name // of your task definition. Family *string `locationName:"family" type:"string"` // The revision of the task in a particular family. You can think of the revision // as a version number of a task definition in a family. When you register a // task definition for the first time, the revision is 1, and each time you // register a task definition in the same family, the revision value increases // by one. Revision *int64 `locationName:"revision" type:"integer"` // The full Amazon Resource Name (ARN) of the of the task definition. TaskDefinitionARN *string `locationName:"taskDefinitionArn" type:"string"` // The list of volumes in a task. For more information on volume definition // parameters and defaults, see Amazon ECS Task Definitions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) // in the Amazon EC2 Container Service Developer Guide. Volumes []*Volume `locationName:"volumes" type:"list"` // contains filtered or unexported fields }
type TaskOverride ¶
type TaskOverride struct { // One or more container overrides to send when running a task. ContainerOverrides []*ContainerOverride `locationName:"containerOverrides" type:"list"` // contains filtered or unexported fields }
type Volume ¶
type Volume struct { // The path on the host container instance that is presented to the containers // which access the volume. If this parameter is empty, then the Docker daemon // assigns a host path for you. Host *HostVolumeProperties `locationName:"host" type:"structure"` // The name of the volume. This name is referenced in the sourceVolume parameter // of container definition mountPoints. Name *string `locationName:"name" type:"string"` // contains filtered or unexported fields }
type VolumeFrom ¶
type VolumeFrom struct { // If this value is true, the container has read-only access to the volume. // If this value is false, then the container can write to the volume. The default // value is false. ReadOnly *bool `locationName:"readOnly" type:"boolean"` // The name of the container to mount volumes from. SourceContainer *string `locationName:"sourceContainer" type:"string"` // contains filtered or unexported fields }