You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SageMaker::Types::ListEndpointsInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass ListEndpointsInput data as a hash:

{
  sort_by: "Name", # accepts Name, CreationTime, Status
  sort_order: "Ascending", # accepts Ascending, Descending
  next_token: "PaginationToken",
  max_results: 1,
  name_contains: "EndpointNameContains",
  creation_time_before: Time.now,
  creation_time_after: Time.now,
  last_modified_time_before: Time.now,
  last_modified_time_after: Time.now,
  status_equals: "OutOfService", # accepts OutOfService, Creating, Updating, RollingBack, InService, Deleting, Failed
}

Instance Attribute Summary collapse

Instance Attribute Details

#creation_time_afterTime

A filter that returns only endpoints that were created after the specified time (timestamp).

Returns:

  • (Time)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1511

class ListEndpointsInput < Struct.new(
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals)
  include Aws::Structure
end

#creation_time_beforeTime

A filter that returns only endpoints that were created before the specified time (timestamp).

Returns:

  • (Time)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1511

class ListEndpointsInput < Struct.new(
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals)
  include Aws::Structure
end

#last_modified_time_afterTime

A filter that returns only endpoints that were modified after the specified timestamp.

Returns:

  • (Time)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1511

class ListEndpointsInput < Struct.new(
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals)
  include Aws::Structure
end

#last_modified_time_beforeTime

A filter that returns only endpoints that were modified before the specified timestamp.

Returns:

  • (Time)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1511

class ListEndpointsInput < Struct.new(
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of endpoints to return in the response.

Returns:

  • (Integer)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1511

class ListEndpointsInput < Struct.new(
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals)
  include Aws::Structure
end

#name_containsString

A string in endpoint names. This filter returns only endpoints whose name contains the specified string.

Returns:

  • (String)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1511

class ListEndpointsInput < Struct.new(
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals)
  include Aws::Structure
end

#next_tokenString

If the result of a ListEndpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request.

Returns:

  • (String)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1511

class ListEndpointsInput < Struct.new(
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals)
  include Aws::Structure
end

#sort_byString

Sorts the list of results. The default is CreationTime.

Returns:

  • (String)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1511

class ListEndpointsInput < Struct.new(
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals)
  include Aws::Structure
end

#sort_orderString

The sort order for results. The default is Ascending.

Returns:

  • (String)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1511

class ListEndpointsInput < Struct.new(
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals)
  include Aws::Structure
end

#status_equalsString

A filter that returns only endpoints with the specified status.

Returns:

  • (String)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1511

class ListEndpointsInput < Struct.new(
  :sort_by,
  :sort_order,
  :next_token,
  :max_results,
  :name_contains,
  :creation_time_before,
  :creation_time_after,
  :last_modified_time_before,
  :last_modified_time_after,
  :status_equals)
  include Aws::Structure
end