AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::CodeGuruProfiler::Types::ConfigureAgentRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ConfigureAgentRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  fleet_instance_id: "FleetInstanceId",
  metadata: {
    "AgentId" => "String",
  },
  profiling_group_name: "ProfilingGroupName", # required
}

The structure representing the configureAgentRequest.

Instance Attribute Summary collapse

Instance Attribute Details

#fleet_instance_idString

A universally unique identifier (UUID) for a profiling instance. For example, if the profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS Fargate container, it is the container\'s task ID.

Returns:

  • (String)

    A universally unique identifier (UUID) for a profiling instance.

#metadataHash<String,String>

Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:

  • COMPUTE_PLATFORM - The compute platform on which the agent is running

  • AGENT_ID - The ID for an agent instance.

  • AWS_REQUEST_ID - The AWS request ID of a Lambda invocation.

  • EXECUTION_ENVIRONMENT - The execution environment a Lambda function is running on.

  • LAMBDA_FUNCTION_ARN - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.

  • LAMBDA_MEMORY_LIMIT_IN_MB - The memory allocated to a Lambda function.

  • LAMBDA_REMAINING_TIME_IN_MILLISECONDS - The time in milliseconds before execution of a Lambda function times out.

  • LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS - The time in milliseconds between two invocations of a Lambda function.

  • LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS - The time in milliseconds for the previous Lambda invocation.

Returns:

  • (Hash<String,String>)

    Metadata captured about the compute platform the agent is running on.

#profiling_group_nameString

The name of the profiling group for which the configured agent is collecting profiling data.

Returns:

  • (String)

    The name of the profiling group for which the configured agent is collecting profiling data.