Struct aws_sdk_codeguruprofiler::client::fluent_builders::GetProfile

pub struct GetProfile<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to GetProfile.

Gets the aggregated profile of a profiling group for a specified time range. Amazon CodeGuru Profiler collects posted agent profiles for a profiling group into aggregated profiles.

Because aggregated profiles expire over time GetProfile is not idempotent.

Specify the time range for the requested aggregated profile using 1 or 2 of the following parameters: startTime, endTime, period. The maximum time range allowed is 7 days. If you specify all 3 parameters, an exception is thrown. If you specify only period, the latest aggregated profile is returned.

Aggregated profiles are available with aggregation periods of 5 minutes, 1 hour, and 1 day, aligned to UTC. The aggregation period of an aggregated profile determines how long it is retained. For more information, see AggregatedProfileTime . The aggregated profile's aggregation period determines how long it is retained by CodeGuru Profiler.

• If the aggregation period is 5 minutes, the aggregated profile is retained for 15 days.

• If the aggregation period is 1 hour, the aggregated profile is retained for 60 days.

• If the aggregation period is 1 day, the aggregated profile is retained for 3 years.

There are two use cases for calling GetProfile.

1. If you want to return an aggregated profile that already exists, use ListProfileTimes to view the time ranges of existing aggregated profiles. Use them in a GetProfile request to return a specific, existing aggregated profile.

2. If you want to return an aggregated profile for a time range that doesn't align with an existing aggregated profile, then CodeGuru Profiler makes a best effort to combine existing aggregated profiles from the requested time range and return them as one aggregated profile.

   If aggregated profiles do not exist for the full time range requested, then aggregated profiles for a smaller time range are returned. For example, if the requested time range is from 00:00 to 00:20, and the existing aggregated profiles are from 00:15 and 00:25, then the aggregated profiles from 00:15 to 00:20 are returned.

Implementations

impl<C, M, R> GetProfile<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(self) -> Result<GetProfileOutput, SdkError<GetProfileError>> where
    R::Policy: SmithyRetryPolicy<GetProfileInputOperationOutputAlias, GetProfileOutput, GetProfileError, GetProfileInputOperationRetryAlias>, 

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, inp: impl Into<String>) -> Self

The name of the profiling group to get.

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

The name of the profiling group to get.

pub fn start_time(self, inp: DateTime) -> Self

The start time of the profile to get. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

If you specify startTime, then you must also specify period or endTime, but not both.

pub fn set_start_time(self, input: Option<DateTime>) -> Self

The start time of the profile to get. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

If you specify startTime, then you must also specify period or endTime, but not both.

pub fn period(self, inp: impl Into<String>) -> Self

Used with startTime or endTime to specify the time range for the returned aggregated profile. Specify using the ISO 8601 format. For example, P1DT1H1M1S.

To get the latest aggregated profile, specify only period.

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

Used with startTime or endTime to specify the time range for the returned aggregated profile. Specify using the ISO 8601 format. For example, P1DT1H1M1S.

To get the latest aggregated profile, specify only period.

pub fn end_time(self, inp: DateTime) -> Self

The end time of the requested profile. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

If you specify endTime, then you must also specify period or startTime, but not both.

pub fn set_end_time(self, input: Option<DateTime>) -> Self

The end time of the requested profile. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

If you specify endTime, then you must also specify period or startTime, but not both.

pub fn max_depth(self, inp: i32) -> Self

The maximum depth of the stacks in the code that is represented in the aggregated profile. For example, if CodeGuru Profiler finds a method A, which calls method B, which calls method C, which calls method D, then the depth is 4. If the maxDepth is set to 2, then the aggregated profile contains representations of methods A and B.

pub fn set_max_depth(self, input: Option<i32>) -> Self

The maximum depth of the stacks in the code that is represented in the aggregated profile. For example, if CodeGuru Profiler finds a method A, which calls method B, which calls method C, which calls method D, then the depth is 4. If the maxDepth is set to 2, then the aggregated profile contains representations of methods A and B.

pub fn accept(self, inp: impl Into<String>) -> Self

The format of the returned profiling data. The format maps to the Accept and Content-Type headers of the HTTP request. You can specify one of the following: or the default .

• application/json — standard JSON format

• application/x-amzn-ion — the Amazon Ion data format. For more information, see Amazon Ion.

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

The format of the returned profiling data. The format maps to the Accept and Content-Type headers of the HTTP request. You can specify one of the following: or the default .

• application/json — standard JSON format

• application/x-amzn-ion — the Amazon Ion data format. For more information, see Amazon Ion.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for GetProfile<C, M, R>

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

Formats the value using the given formatter.