pub struct Client { /* private fields */ }
Expand description

Client for Amazon CodeGuru Profiler

Client for invoking operations on Amazon CodeGuru Profiler. Each operation on Amazon CodeGuru Profiler is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_codeguruprofiler::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_codeguruprofiler::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_codeguruprofiler::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the AddNotificationChannels operation.

Constructs a fluent builder for the BatchGetFrameMetricData operation.

Constructs a fluent builder for the ConfigureAgent operation.

  • The fluent builder is configurable:
    • profiling_group_name(impl Into<String>) / set_profiling_group_name(Option<String>):

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

    • fleet_instance_id(impl Into<String>) / set_fleet_instance_id(Option<String>):

      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.

    • metadata(HashMap<MetadataField, String>) / set_metadata(Option<HashMap<MetadataField, 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.

  • On success, responds with ConfigureAgentOutput with field(s):
  • On failure, responds with SdkError<ConfigureAgentError>

Constructs a fluent builder for the CreateProfilingGroup operation.

Constructs a fluent builder for the DeleteProfilingGroup operation.

Constructs a fluent builder for the DescribeProfilingGroup operation.

Constructs a fluent builder for the GetFindingsReportAccountSummary operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • next_token(impl Into<String>) / set_next_token(Option<String>):

      The nextToken value returned from a previous paginated GetFindingsReportAccountSummary request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

      This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

    • max_results(i32) / set_max_results(Option<i32>):

      The maximum number of results returned by GetFindingsReportAccountSummary in paginated output. When this parameter is used, GetFindingsReportAccountSummary only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another GetFindingsReportAccountSummary request with the returned nextToken value.

    • daily_reports_only(bool) / set_daily_reports_only(Option<bool>):

      A Boolean value indicating whether to only return reports from daily profiles. If set to True, only analysis data from daily profiles is returned. If set to False, analysis data is returned from smaller time windows (for example, one hour).

  • On success, responds with GetFindingsReportAccountSummaryOutput with field(s):
    • report_summaries(Option<Vec<FindingsReportSummary>>):

      The return list of FindingsReportSummary objects taht contain summaries of analysis results for all profiling groups in your AWS account.

    • next_token(Option<String>):

      The nextToken value to include in a future GetFindingsReportAccountSummary request. When the results of a GetFindingsReportAccountSummary request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

  • On failure, responds with SdkError<GetFindingsReportAccountSummaryError>

Constructs a fluent builder for the GetNotificationConfiguration operation.

Constructs a fluent builder for the GetPolicy operation.

Constructs a fluent builder for the GetProfile operation.

Constructs a fluent builder for the GetRecommendations operation.

Constructs a fluent builder for the ListFindingsReports operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • profiling_group_name(impl Into<String>) / set_profiling_group_name(Option<String>):

      The name of the profiling group from which to search for analysis data.

    • start_time(DateTime) / set_start_time(Option<DateTime>):

      The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified 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.

    • end_time(DateTime) / set_end_time(Option<DateTime>):

      The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified 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.

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      The nextToken value returned from a previous paginated ListFindingsReportsRequest request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

      This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

    • max_results(i32) / set_max_results(Option<i32>):

      The maximum number of report results returned by ListFindingsReports in paginated output. When this parameter is used, ListFindingsReports only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFindingsReports request with the returned nextToken value.

    • daily_reports_only(bool) / set_daily_reports_only(Option<bool>):

      A Boolean value indicating whether to only return reports from daily profiles. If set to True, only analysis data from daily profiles is returned. If set to False, analysis data is returned from smaller time windows (for example, one hour).

  • On success, responds with ListFindingsReportsOutput with field(s):
  • On failure, responds with SdkError<ListFindingsReportsError>

Constructs a fluent builder for the ListProfileTimes operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListProfilingGroups operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListTagsForResource operation.

Constructs a fluent builder for the PostAgentProfile operation.

Constructs a fluent builder for the PutPermission operation.

Constructs a fluent builder for the RemoveNotificationChannel operation.

Constructs a fluent builder for the RemovePermission operation.

Constructs a fluent builder for the SubmitFeedback operation.

Constructs a fluent builder for the TagResource operation.

Constructs a fluent builder for the UntagResource operation.

Constructs a fluent builder for the UpdateProfilingGroup operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Converts to this type from the input type.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more