configureAgent method

Future<ConfigureAgentResponse> configureAgent({
  1. required String profilingGroupName,
  2. String? fleetInstanceId,
  3. Map<MetadataField, String>? metadata,
})

Used by profiler agents to report their current state and to receive remote configuration updates. For example, ConfigureAgent can be used to tell and agent whether to profile or not and for how long to return profiling data.

May throw InternalServerException. May throw ValidationException. May throw ThrottlingException. May throw ResourceNotFoundException.

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

Parameter fleetInstanceId : 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.

Parameter metadata : 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.

Implementation

Future<ConfigureAgentResponse> configureAgent({
  required String profilingGroupName,
  String? fleetInstanceId,
  Map<MetadataField, String>? metadata,
}) async {
  ArgumentError.checkNotNull(profilingGroupName, 'profilingGroupName');
  _s.validateStringLength(
    'profilingGroupName',
    profilingGroupName,
    1,
    255,
    isRequired: true,
  );
  _s.validateStringLength(
    'fleetInstanceId',
    fleetInstanceId,
    1,
    255,
  );
  final $payload = <String, dynamic>{
    if (fleetInstanceId != null) 'fleetInstanceId': fleetInstanceId,
    if (metadata != null)
      'metadata': metadata.map((k, e) => MapEntry(k.toValue(), e)),
  };
  final response = await _protocol.sendRaw(
    payload: $payload,
    method: 'POST',
    requestUri:
        '/profilingGroups/${Uri.encodeComponent(profilingGroupName)}/configureAgent',
    exceptionFnMap: _exceptionFns,
  );
  final $json = await _s.jsonFromResponse(response);
  return ConfigureAgentResponse(
    configuration: AgentConfiguration.fromJson($json),
  );
}