aws_sdk_codeguruprofiler/client/

configure_agent.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ConfigureAgent`](crate::operation::configure_agent::builders::ConfigureAgentFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`profiling_group_name(impl Into<String>)`](crate::operation::configure_agent::builders::ConfigureAgentFluentBuilder::profiling_group_name) / [`set_profiling_group_name(Option<String>)`](crate::operation::configure_agent::builders::ConfigureAgentFluentBuilder::set_profiling_group_name):<br>required: **true**<br><p>The name of the profiling group for which the configured agent is collecting profiling data.</p><br>
    ///   - [`fleet_instance_id(impl Into<String>)`](crate::operation::configure_agent::builders::ConfigureAgentFluentBuilder::fleet_instance_id) / [`set_fleet_instance_id(Option<String>)`](crate::operation::configure_agent::builders::ConfigureAgentFluentBuilder::set_fleet_instance_id):<br>required: **false**<br><p>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.</p><br>
    ///   - [`metadata(MetadataField, impl Into<String>)`](crate::operation::configure_agent::builders::ConfigureAgentFluentBuilder::metadata) / [`set_metadata(Option<HashMap::<MetadataField, String>>)`](crate::operation::configure_agent::builders::ConfigureAgentFluentBuilder::set_metadata):<br>required: **false**<br><p>Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:</p> <ul>  <li>   <p><code>COMPUTE_PLATFORM</code> - The compute platform on which the agent is running</p></li>  <li>   <p><code>AGENT_ID</code> - The ID for an agent instance.</p></li>  <li>   <p><code>AWS_REQUEST_ID</code> - The AWS request ID of a Lambda invocation.</p></li>  <li>   <p><code>EXECUTION_ENVIRONMENT</code> - The execution environment a Lambda function is running on.</p></li>  <li>   <p><code>LAMBDA_FUNCTION_ARN</code> - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.</p></li>  <li>   <p><code>LAMBDA_MEMORY_LIMIT_IN_MB</code> - The memory allocated to a Lambda function.</p></li>  <li>   <p><code>LAMBDA_REMAINING_TIME_IN_MILLISECONDS</code> - The time in milliseconds before execution of a Lambda function times out.</p></li>  <li>   <p><code>LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS</code> - The time in milliseconds between two invocations of a Lambda function.</p></li>  <li>   <p><code>LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS</code> - The time in milliseconds for the previous Lambda invocation.</p></li> </ul><br>
    /// - On success, responds with [`ConfigureAgentOutput`](crate::operation::configure_agent::ConfigureAgentOutput) with field(s):
    ///   - [`configuration(Option<AgentConfiguration>)`](crate::operation::configure_agent::ConfigureAgentOutput::configuration): <p>An <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentConfiguration.html"> <code>AgentConfiguration</code> </a> object that specifies if an agent profiles or not and for how long to return profiling data.</p>
    /// - On failure, responds with [`SdkError<ConfigureAgentError>`](crate::operation::configure_agent::ConfigureAgentError)
    pub fn configure_agent(&self) -> crate::operation::configure_agent::builders::ConfigureAgentFluentBuilder {
        crate::operation::configure_agent::builders::ConfigureAgentFluentBuilder::new(self.handle.clone())
    }
}