Struct aws_sdk_codeguruprofiler::client::fluent_builders::ConfigureAgent

pub struct ConfigureAgent { /* private fields */ }

Fluent builder constructing a request to ConfigureAgent.

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

Implementations

impl ConfigureAgent

pub async fn customize(
    self
) -> Result<CustomizableOperation<ConfigureAgent, AwsResponseRetryClassifier>, SdkError<ConfigureAgentError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<ConfigureAgentOutput, SdkError<ConfigureAgentError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn profiling_group_name(self, input: impl Into<String>) -> Self

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

pub fn set_profiling_group_name(self, input: Option<String>) -> Self

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

pub fn fleet_instance_id(self, input: impl Into<String>) -> Self

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.

pub fn set_fleet_instance_id(self, input: Option<String>) -> Self

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.

pub fn metadata(self, k: MetadataField, v: impl Into<String>) -> Self

Adds a key-value pair to metadata.

To override the contents of this collection use set_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.

pub fn set_metadata(self, input: Option<HashMap<MetadataField, String>>) -> Self

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.

Trait Implementations

impl Clone for ConfigureAgent

fn clone(&self) -> ConfigureAgent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConfigureAgent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.