Class: Aws::Amplify::Types::ListBackendEnvironmentsRequest

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

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

The request structure for the list backend environments request.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

The unique ID for an Amplify app.

Returns:

  • (String)


1977
1978
1979
1980
1981
1982
1983
1984
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1977

class ListBackendEnvironmentsRequest < Struct.new(
  :app_id,
  :environment_name,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#environment_nameString

The name of the backend environment

Returns:

  • (String)


1977
1978
1979
1980
1981
1982
1983
1984
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1977

class ListBackendEnvironmentsRequest < Struct.new(
  :app_id,
  :environment_name,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of records to list in a single response.

Returns:

  • (Integer)


1977
1978
1979
1980
1981
1982
1983
1984
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1977

class ListBackendEnvironmentsRequest < Struct.new(
  :app_id,
  :environment_name,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

A pagination token. Set to null to start listing backend environments from the start. If a non-null pagination token is returned in a result, pass its value in here to list more backend environments.

Returns:

  • (String)


1977
1978
1979
1980
1981
1982
1983
1984
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1977

class ListBackendEnvironmentsRequest < Struct.new(
  :app_id,
  :environment_name,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end