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

Class: Aws::Amplify::Types::ListJobsRequest

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

Overview

Note:

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

{
  app_id: "AppId", # required
  branch_name: "BranchName", # required
  next_token: "NextToken",
  max_results: 1,
}

Request structure for list job request.

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

Unique Id for an Amplify App.

Returns:

  • (String)


1498
1499
1500
1501
1502
1503
1504
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1498

class ListJobsRequest < Struct.new(
  :app_id,
  :branch_name,
  :next_token,
  :max_results)
  include Aws::Structure
end

#branch_nameString

Name for a branch.

Returns:

  • (String)


1498
1499
1500
1501
1502
1503
1504
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1498

class ListJobsRequest < Struct.new(
  :app_id,
  :branch_name,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

Maximum number of records to list in a single response.

Returns:

  • (Integer)


1498
1499
1500
1501
1502
1503
1504
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1498

class ListJobsRequest < Struct.new(
  :app_id,
  :branch_name,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

Pagination token. Set to null to start listing steps from start. If a non-null pagination token is returned in a result, then pass its value in here to list more steps.

Returns:

  • (String)


1498
1499
1500
1501
1502
1503
1504
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1498

class ListJobsRequest < Struct.new(
  :app_id,
  :branch_name,
  :next_token,
  :max_results)
  include Aws::Structure
end