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

Class: Aws::ElasticBeanstalk::Types::RequestEnvironmentInfoMessage

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

Overview

Note:

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

{
  environment_id: "EnvironmentId",
  environment_name: "EnvironmentName",
  info_type: "tail", # required, accepts tail, bundle
}

Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.

Instance Attribute Summary collapse

Instance Attribute Details

#environment_idString

The ID of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Returns:

  • (String)


3491
3492
3493
3494
3495
3496
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 3491

class RequestEnvironmentInfoMessage < Struct.new(
  :environment_id,
  :environment_name,
  :info_type)
  include Aws::Structure
end

#environment_nameString

The name of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Returns:

  • (String)


3491
3492
3493
3494
3495
3496
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 3491

class RequestEnvironmentInfoMessage < Struct.new(
  :environment_id,
  :environment_name,
  :info_type)
  include Aws::Structure
end

#info_typeString

The type of information to request.

Returns:

  • (String)


3491
3492
3493
3494
3495
3496
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 3491

class RequestEnvironmentInfoMessage < Struct.new(
  :environment_id,
  :environment_name,
  :info_type)
  include Aws::Structure
end