SageMaker / Paginator / ListActions
ListActions#
- class SageMaker.Paginator.ListActions#
paginator = client.get_paginator('list_actions')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
SageMaker.Client.list_actions()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( SourceUri='string', ActionType='string', CreatedAfter=datetime(2015, 1, 1), CreatedBefore=datetime(2015, 1, 1), SortBy='Name'|'CreationTime', SortOrder='Ascending'|'Descending', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
SourceUri (string) – A filter that returns only actions with the specified source URI.
ActionType (string) – A filter that returns only actions of the specified type.
CreatedAfter (datetime) – A filter that returns only actions created on or after the specified time.
CreatedBefore (datetime) – A filter that returns only actions created on or before the specified time.
SortBy (string) – The property used to sort results. The default value is
CreationTime
.SortOrder (string) – The sort order. The default value is
Descending
.PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'ActionSummaries': [ { 'ActionArn': 'string', 'ActionName': 'string', 'Source': { 'SourceUri': 'string', 'SourceType': 'string', 'SourceId': 'string' }, 'ActionType': 'string', 'Status': 'Unknown'|'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped', 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1) }, ], }
Response Structure
(dict) –
ActionSummaries (list) –
A list of actions and their properties.
(dict) –
Lists the properties of an action. An action represents an action or activity. Some examples are a workflow step and a model deployment. Generally, an action involves at least one input artifact or output artifact.
ActionArn (string) –
The Amazon Resource Name (ARN) of the action.
ActionName (string) –
The name of the action.
Source (dict) –
The source of the action.
SourceUri (string) –
The URI of the source.
SourceType (string) –
The type of the source.
SourceId (string) –
The ID of the source.
ActionType (string) –
The type of the action.
Status (string) –
The status of the action.
CreationTime (datetime) –
When the action was created.
LastModifiedTime (datetime) –
When the action was last modified.