Struct aws_sdk_codeguruprofiler::Client

pub struct Client { /* private fields */ }

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.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_codeguruprofiler::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_codeguruprofiler::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the GetFindingsReportAccountSummary operation has a Client::get_findings_report_account_summary, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.get_findings_report_account_summary()
    .next_token("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn add_notification_channels(&self) -> AddNotificationChannelsFluentBuilder

Constructs a fluent builder for the AddNotificationChannels operation.

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

    The name of the profiling group that we are setting up notifications for.

  • channels(Vec<Channel>) / set_channels(Option<Vec<Channel>>):

    One or 2 channels to report to when anomalies are detected.

• On success, responds with AddNotificationChannelsOutput with field(s):
  • notification_configuration(Option<NotificationConfiguration>):

    The new notification configuration for this profiling group.

• On failure, responds with SdkError<AddNotificationChannelsError>

impl Client

pub fn batch_get_frame_metric_data( &self ) -> BatchGetFrameMetricDataFluentBuilder

Constructs a fluent builder for the BatchGetFrameMetricData operation.

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

    The name of the profiling group associated with the the frame metrics used to return the time series values.

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

    The start time of the time period for the frame metrics used to return the time series values. 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 time period for the returned time series values. 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.

  • period(impl ::std::convert::Into<String>) / set_period(Option<String>):

    The duration of the frame metrics used to return the time series values. Specify using the ISO 8601 format. The maximum period duration is one day (PT24H or P1D).

  • target_resolution(AggregationPeriod) / set_target_resolution(Option<AggregationPeriod>):

    The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. There are 3 valid values.

    • P1D — 1 day

    • PT1H — 1 hour

    • PT5M — 5 minutes

  • frame_metrics(Vec<FrameMetric>) / set_frame_metrics(Option<Vec<FrameMetric>>):

    The details of the metrics that are used to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.

• On success, responds with BatchGetFrameMetricDataOutput with field(s):
  • start_time(Option<DateTime>):

    The start time of the time period for the returned time series values. 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(Option<DateTime>):

    The end time of the time period for the returned time series values. 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.

  • resolution(Option<AggregationPeriod>):

    Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values.

    • P1D — 1 day

    • PT1H — 1 hour

    • PT5M — 5 minutes

  • end_times(Option<Vec<TimestampStructure>>):

    List of instances, or time steps, in the time series. For example, if the period is one day (PT24H)), and the resolution is five minutes (PT5M), then there are 288 endTimes in the list that are each five minutes appart.

  • unprocessed_end_times(Option<HashMap<String, Vec<TimestampStructure>>>):

    List of instances which remained unprocessed. This will create a missing time step in the list of end times.

  • frame_metric_data(Option<Vec<FrameMetricDatum>>):

    Details of the metrics to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.

• On failure, responds with SdkError<BatchGetFrameMetricDataError>

impl Client

pub fn configure_agent(&self) -> ConfigureAgentFluentBuilder

Constructs a fluent builder for the ConfigureAgent operation.

• The fluent builder is configurable:
  • profiling_group_name(impl ::std::convert::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 ::std::convert::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):
  • configuration(Option<AgentConfiguration>):

    An AgentConfiguration object that specifies if an agent profiles or not and for how long to return profiling data.

• On failure, responds with SdkError<ConfigureAgentError>

impl Client

pub fn create_profiling_group(&self) -> CreateProfilingGroupFluentBuilder

Constructs a fluent builder for the CreateProfilingGroup operation.

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

    The name of the profiling group to create.

  • compute_platform(ComputePlatform) / set_compute_platform(Option<ComputePlatform>):

    The compute platform of the profiling group. Use AWSLambda if your application runs on AWS Lambda. Use Default if your application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. If not specified, Default is used.

  • client_token(impl ::std::convert::Into<String>) / set_client_token(Option<String>):

    Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the accidental creation of duplicate profiling groups if there are failures and retries.

  • agent_orchestration_config(AgentOrchestrationConfig) / set_agent_orchestration_config(Option<AgentOrchestrationConfig>):

    Specifies whether profiling is enabled or disabled for the created profiling group.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    A list of tags to add to the created profiling group.

• On success, responds with CreateProfilingGroupOutput with field(s):
  • profiling_group(Option<ProfilingGroupDescription>):

    The returned ProfilingGroupDescription object that contains information about the created profiling group.

• On failure, responds with SdkError<CreateProfilingGroupError>

impl Client

pub fn delete_profiling_group(&self) -> DeleteProfilingGroupFluentBuilder

Constructs a fluent builder for the DeleteProfilingGroup operation.

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

    The name of the profiling group to delete.

• On success, responds with DeleteProfilingGroupOutput
• On failure, responds with SdkError<DeleteProfilingGroupError>

impl Client

pub fn describe_profiling_group(&self) -> DescribeProfilingGroupFluentBuilder

Constructs a fluent builder for the DescribeProfilingGroup operation.

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

    The name of the profiling group to get information about.

• On success, responds with DescribeProfilingGroupOutput with field(s):
  • profiling_group(Option<ProfilingGroupDescription>):

    The returned ProfilingGroupDescription object that contains information about the requested profiling group.

• On failure, responds with SdkError<DescribeProfilingGroupError>

impl Client

pub fn get_findings_report_account_summary( &self ) -> GetFindingsReportAccountSummaryFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl ::std::convert::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>

impl Client

pub fn get_notification_configuration( &self ) -> GetNotificationConfigurationFluentBuilder

Constructs a fluent builder for the GetNotificationConfiguration operation.

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

    The name of the profiling group we want to get the notification configuration for.

• On success, responds with GetNotificationConfigurationOutput with field(s):
  • notification_configuration(Option<NotificationConfiguration>):

    The current notification configuration for this profiling group.

• On failure, responds with SdkError<GetNotificationConfigurationError>

impl Client

pub fn get_policy(&self) -> GetPolicyFluentBuilder

Constructs a fluent builder for the GetPolicy operation.

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

    The name of the profiling group.

• On success, responds with GetPolicyOutput with field(s):
  • policy(Option<String>):

    The JSON-formatted resource-based policy attached to the ProfilingGroup.

  • revision_id(Option<String>):

    A unique identifier for the current revision of the returned policy.

• On failure, responds with SdkError<GetPolicyError>

impl Client

pub fn get_profile(&self) -> GetProfileFluentBuilder

Constructs a fluent builder for the GetProfile operation.

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

    The name of the profiling group to get.

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

    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.

  • period(impl ::std::convert::Into<String>) / set_period(Option<String>):

    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.

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

    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.

  • max_depth(i32) / set_max_depth(Option<i32>):

    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.

  • accept(impl ::std::convert::Into<String>) / set_accept(Option<String>):

    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.

• On success, responds with GetProfileOutput with field(s):
  • profile(Option<Blob>):

    Information about the profile.

  • content_type(Option<String>):

    The content type of the profile in the payload. It is either application/json or the default application/x-amzn-ion.

  • content_encoding(Option<String>):

    The content encoding of the profile.

• On failure, responds with SdkError<GetProfileError>

impl Client

pub fn get_recommendations(&self) -> GetRecommendationsFluentBuilder

Constructs a fluent builder for the GetRecommendations operation.

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

    The name of the profiling group to get analysis data about.

  • start_time(DateTime) / set_start_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.

  • end_time(DateTime) / set_end_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.

  • locale(impl ::std::convert::Into<String>) / set_locale(Option<String>):

    The language used to provide analysis. Specify using a string that is one of the following BCP 47 language codes.

    • de-DE - German, Germany

    • en-GB - English, United Kingdom

    • en-US - English, United States

    • es-ES - Spanish, Spain

    • fr-FR - French, France

    • it-IT - Italian, Italy

    • ja-JP - Japanese, Japan

    • ko-KR - Korean, Republic of Korea

    • pt-BR - Portugese, Brazil

    • zh-CN - Chinese, China

    • zh-TW - Chinese, Taiwan

• On success, responds with GetRecommendationsOutput with field(s):
  • profiling_group_name(Option<String>):

    The name of the profiling group the analysis data is about.

  • profile_start_time(Option<DateTime>):

    The start time of the profile the analysis data is about. 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.

  • profile_end_time(Option<DateTime>):

    The end time of the profile the analysis data is about. 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.

  • recommendations(Option<Vec<Recommendation>>):

    The list of recommendations that the analysis found for this profile.

  • anomalies(Option<Vec<Anomaly>>):

    The list of anomalies that the analysis has found for this profile.

• On failure, responds with SdkError<GetRecommendationsError>

impl Client

pub fn list_findings_reports(&self) -> ListFindingsReportsFluentBuilder

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

• The fluent builder is configurable:
  • profiling_group_name(impl ::std::convert::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 ::std::convert::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):
  • findings_report_summaries(Option<Vec<FindingsReportSummary>>):

    The list of analysis results summaries.

  • next_token(Option<String>):

    The nextToken value to include in a future ListFindingsReports request. When the results of a ListFindingsReports 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<ListFindingsReportsError>

impl Client

pub fn list_profile_times(&self) -> ListProfileTimesFluentBuilder

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

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

    The name of the profiling group.

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

    The start time of the time range from which to list the profiles.

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

    The end time of the time range from which to list the profiles.

  • period(AggregationPeriod) / set_period(Option<AggregationPeriod>):

    The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. There are 3 valid values.

    • P1D — 1 day

    • PT1H — 1 hour

    • PT5M — 5 minutes

  • order_by(OrderBy) / set_order_by(Option<OrderBy>):

    The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to TIMESTAMP_DESCENDING.

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

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

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

    The nextToken value returned from a previous paginated ListProfileTimes 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.

• On success, responds with ListProfileTimesOutput with field(s):
  • profile_times(Option<Vec<ProfileTime>>):

    The list of start times of the available profiles for the aggregation period in the specified time range.

  • next_token(Option<String>):

    The nextToken value to include in a future ListProfileTimes request. When the results of a ListProfileTimes 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<ListProfileTimesError>

impl Client

pub fn list_profiling_groups(&self) -> ListProfilingGroupsFluentBuilder

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

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

    The nextToken value returned from a previous paginated ListProfilingGroups 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 profiling groups results returned by ListProfilingGroups in paginated output. When this parameter is used, ListProfilingGroups 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 ListProfilingGroups request with the returned nextToken value.

  • include_description(bool) / set_include_description(Option<bool>):

    A Boolean value indicating whether to include a description. If true, then a list of ProfilingGroupDescription objects that contain detailed information about profiling groups is returned. If false, then a list of profiling group names is returned.

• On success, responds with ListProfilingGroupsOutput with field(s):
  • profiling_group_names(Option<Vec<String>>):

    A returned list of profiling group names. A list of the names is returned only if includeDescription is false, otherwise a list of ProfilingGroupDescription objects is returned.

  • profiling_groups(Option<Vec<ProfilingGroupDescription>>):

    A returned list ProfilingGroupDescription objects. A list of ProfilingGroupDescription objects is returned only if includeDescription is true, otherwise a list of profiling group names is returned.

  • next_token(Option<String>):

    The nextToken value to include in a future ListProfilingGroups request. When the results of a ListProfilingGroups 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<ListProfilingGroupsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl ::std::convert::Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource that contains the tags to return.

• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap<String, String>>):

    The list of tags assigned to the specified resource. This is the list of tags returned in the response.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn post_agent_profile(&self) -> PostAgentProfileFluentBuilder

Constructs a fluent builder for the PostAgentProfile operation.

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

    The name of the profiling group with the aggregated profile that receives the submitted profiling data.

  • agent_profile(Blob) / set_agent_profile(Option<Blob>):

    The submitted profiling data.

  • profile_token(impl ::std::convert::Into<String>) / set_profile_token(Option<String>):

    Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the accidental submission of duplicate profiling data if there are failures and retries.

  • content_type(impl ::std::convert::Into<String>) / set_content_type(Option<String>):

    The format of the submitted 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.

• On success, responds with PostAgentProfileOutput
• On failure, responds with SdkError<PostAgentProfileError>

impl Client

pub fn put_permission(&self) -> PutPermissionFluentBuilder

Constructs a fluent builder for the PutPermission operation.

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

    The name of the profiling group to grant access to.

  • action_group(ActionGroup) / set_action_group(Option<ActionGroup>):

    Specifies an action group that contains permissions to add to a profiling group resource. One action group is supported, agentPermissions, which grants permission to perform actions required by the profiling agent, ConfigureAgent and PostAgentProfile permissions.

  • principals(Vec<String>) / set_principals(Option<Vec<String>>):

    A list ARNs for the roles and users you want to grant access to the profiling group. Wildcards are not are supported in the ARNs.

  • revision_id(impl ::std::convert::Into<String>) / set_revision_id(Option<String>):

    A universally unique identifier (UUID) for the revision of the policy you are adding to the profiling group. Do not specify this when you add permissions to a profiling group for the first time. If a policy already exists on the profiling group, you must specify the revisionId.

• On success, responds with PutPermissionOutput with field(s):
  • policy(Option<String>):

    The JSON-formatted resource-based policy on the profiling group that includes the added permissions.

  • revision_id(Option<String>):

    A universally unique identifier (UUID) for the revision of the resource-based policy that includes the added permissions. The JSON-formatted policy is in the policy element of the response.

• On failure, responds with SdkError<PutPermissionError>

impl Client

pub fn remove_notification_channel( &self ) -> RemoveNotificationChannelFluentBuilder

Constructs a fluent builder for the RemoveNotificationChannel operation.

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

    The name of the profiling group we want to change notification configuration for.

  • channel_id(impl ::std::convert::Into<String>) / set_channel_id(Option<String>):

    The id of the channel that we want to stop receiving notifications.

• On success, responds with RemoveNotificationChannelOutput with field(s):
  • notification_configuration(Option<NotificationConfiguration>):

    The new notification configuration for this profiling group.

• On failure, responds with SdkError<RemoveNotificationChannelError>

impl Client

pub fn remove_permission(&self) -> RemovePermissionFluentBuilder

Constructs a fluent builder for the RemovePermission operation.

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

    The name of the profiling group.

  • action_group(ActionGroup) / set_action_group(Option<ActionGroup>):

    Specifies an action group that contains the permissions to remove from a profiling group’s resource-based policy. One action group is supported, agentPermissions, which grants ConfigureAgent and PostAgentProfile permissions.

  • revision_id(impl ::std::convert::Into<String>) / set_revision_id(Option<String>):

    A universally unique identifier (UUID) for the revision of the resource-based policy from which you want to remove permissions.

• On success, responds with RemovePermissionOutput with field(s):
  • policy(Option<String>):

    The JSON-formatted resource-based policy on the profiling group after the specified permissions were removed.

  • revision_id(Option<String>):

    A universally unique identifier (UUID) for the revision of the resource-based policy after the specified permissions were removed. The updated JSON-formatted policy is in the policy element of the response.

• On failure, responds with SdkError<RemovePermissionError>

impl Client

pub fn submit_feedback(&self) -> SubmitFeedbackFluentBuilder

Constructs a fluent builder for the SubmitFeedback operation.

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

    The name of the profiling group that is associated with the analysis data.

  • anomaly_instance_id(impl ::std::convert::Into<String>) / set_anomaly_instance_id(Option<String>):

    The universally unique identifier (UUID) of the AnomalyInstance object that is included in the analysis data.

  • r#type(FeedbackType) / set_type(Option<FeedbackType>):

    The feedback tpye. Thee are two valid values, Positive and Negative.

  • comment(impl ::std::convert::Into<String>) / set_comment(Option<String>):

    Optional feedback about this anomaly.

• On success, responds with SubmitFeedbackOutput
• On failure, responds with SdkError<SubmitFeedbackError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl ::std::convert::Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource that the tags are added to.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The list of tags that are added to the specified resource.

• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl ::std::convert::Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource that contains the tags to remove.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    A list of tag keys. Existing tags of resources with keys in this list are removed from the specified resource.

• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_profiling_group(&self) -> UpdateProfilingGroupFluentBuilder

Constructs a fluent builder for the UpdateProfilingGroup operation.

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

    The name of the profiling group to update.

  • agent_orchestration_config(AgentOrchestrationConfig) / set_agent_orchestration_config(Option<AgentOrchestrationConfig>):

    Specifies whether profiling is enabled or disabled for a profiling group.

• On success, responds with UpdateProfilingGroupOutput with field(s):
  • profiling_group(Option<ProfilingGroupDescription>):

    A ProfilingGroupDescription that contains information about the returned updated profiling group.

• On failure, responds with SdkError<UpdateProfilingGroupError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.