1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package ecs
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ecs/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Returns a list of tasks. You can filter the results by cluster, task definition
// family, container instance, launch type, what IAM principal started the task, or
// by the desired status of the task. Recently stopped tasks might appear in the
// returned results.
func (c *Client) ListTasks(ctx context.Context, params *ListTasksInput, optFns ...func(*Options)) (*ListTasksOutput, error) {
if params == nil {
params = &ListTasksInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListTasks", params, optFns, c.addOperationListTasksMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListTasksOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListTasksInput struct {
// The short name or full Amazon Resource Name (ARN) of the cluster to use when
// filtering the ListTasks results. If you do not specify a cluster, the default
// cluster is assumed.
Cluster *string
// The container instance ID or full ARN of the container instance to use when
// filtering the ListTasks results. Specifying a containerInstance limits the
// results to tasks that belong to that container instance.
ContainerInstance *string
// The task desired status to use when filtering the ListTasks results. Specifying
// a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set
// the desired status to STOPPED . This can be useful for debugging tasks that
// aren't starting properly or have died or finished. The default status filter is
// RUNNING , which shows tasks that Amazon ECS has set the desired status to
// RUNNING . Although you can filter results based on a desired status of PENDING ,
// this doesn't return any results. Amazon ECS never sets the desired status of a
// task to that value (only a task's lastStatus may have a value of PENDING ).
DesiredStatus types.DesiredStatus
// The name of the task definition family to use when filtering the ListTasks
// results. Specifying a family limits the results to tasks that belong to that
// family.
Family *string
// The launch type to use when filtering the ListTasks results.
LaunchType types.LaunchType
// The maximum number of task results that ListTasks returned in paginated output.
// When this parameter is used, ListTasks only returns maxResults results in a
// single page along with a nextToken response element. The remaining results of
// the initial request can be seen by sending another ListTasks request with the
// returned nextToken value. This value can be between 1 and 100. If this
// parameter isn't used, then ListTasks returns up to 100 results and a nextToken
// value if applicable.
MaxResults *int32
// The nextToken value returned from a ListTasks request indicating that more
// results are available to fulfill the request and further calls will be needed.
// If maxResults was provided, it's possible the number of results to be fewer
// than maxResults . This token should be treated as an opaque identifier that is
// only used to retrieve the next items in a list and not for other programmatic
// purposes.
NextToken *string
// The name of the service to use when filtering the ListTasks results. Specifying
// a serviceName limits the results to tasks that belong to that service.
ServiceName *string
// The startedBy value to filter the task results with. Specifying a startedBy
// value limits the results to tasks that were started with that value. When you
// specify startedBy as the filter, it must be the only filter that you use.
StartedBy *string
noSmithyDocumentSerde
}
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
// The list of task ARN entries for the ListTasks request.
TaskArns []string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListTasksMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpListTasks{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpListTasks{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "ListTasks"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListTasks(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
// ListTasksAPIClient is a client that implements the ListTasks operation.
type ListTasksAPIClient interface {
ListTasks(context.Context, *ListTasksInput, ...func(*Options)) (*ListTasksOutput, error)
}
var _ ListTasksAPIClient = (*Client)(nil)
// ListTasksPaginatorOptions is the paginator options for ListTasks
type ListTasksPaginatorOptions struct {
// The maximum number of task results that ListTasks returned in paginated output.
// When this parameter is used, ListTasks only returns maxResults results in a
// single page along with a nextToken response element. The remaining results of
// the initial request can be seen by sending another ListTasks request with the
// returned nextToken value. This value can be between 1 and 100. If this
// parameter isn't used, then ListTasks returns up to 100 results and a nextToken
// value if applicable.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListTasksPaginator is a paginator for ListTasks
type ListTasksPaginator struct {
options ListTasksPaginatorOptions
client ListTasksAPIClient
params *ListTasksInput
nextToken *string
firstPage bool
}
// NewListTasksPaginator returns a new ListTasksPaginator
func NewListTasksPaginator(client ListTasksAPIClient, params *ListTasksInput, optFns ...func(*ListTasksPaginatorOptions)) *ListTasksPaginator {
if params == nil {
params = &ListTasksInput{}
}
options := ListTasksPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListTasksPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListTasksPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListTasks page.
func (p *ListTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTasksOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListTasks(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListTasks(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "ListTasks",
}
}
|