Vault / Collection / succeeded_jobs

succeeded_jobs#

Glacier.Vault.succeeded_jobs#

A collection of Job resources.A Job Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.

all()#

Creates an iterable of all Job resources in the collection.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.succeeded_jobs.all()

Return type:: list(glacier.Job)
Returns:: A list of Job resources

filter(**kwargs)#

Creates an iterable of all Job resources in the collection filtered by kwargs passed to method. A Job collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.succeeded_jobs.filter(
    limit='string',
    marker='string',
    completed='string'
)

Parameters:

limit (string) – The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.
marker (string) – An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.
completed (string) – The state of the jobs to return. You can specify true or false.

Return type:

list(glacier.Job)

Returns:

A list of Job resources

limit(**kwargs)#

Creates an iterable up to a specified amount of Job resources in the collection.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.succeeded_jobs.limit(
    count=123
)

Parameters:: count (integer) – The limit to the number of resources in the iterable.
Return type:: list(glacier.Job)
Returns:: A list of Job resources

page_size(**kwargs)#

Creates an iterable of all Job resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

job_iterator = vault.succeeded_jobs.page_size(
    count=123
)

Parameters:: count (integer) – The number of items returned by each service call
Return type:: list(glacier.Job)
Returns:: A list of Job resources