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

Class: Aws::Amplify::Types::ListBranchesRequest

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 ListBranchesRequest data as a hash:

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

Request structure for list branches request.

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

Unique Id for an Amplify App.

Returns:

  • (String)


1385
1386
1387
1388
1389
1390
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1385

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

#max_resultsInteger

Maximum number of records to list in a single response.

Returns:

  • (Integer)


1385
1386
1387
1388
1389
1390
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1385

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

#next_tokenString

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

Returns:

  • (String)


1385
1386
1387
1388
1389
1390
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1385

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