AddNotificationChannels

$result = $client->addNotificationChannels([/* ... */]);
$promise = $client->addNotificationChannelsAsync([/* ... */]);

Add up to 2 anomaly notifications channels for a profiling group.

Parameter Syntax

$result = $client->addNotificationChannels([
    'channels' => [ // REQUIRED
        [
            'eventPublishers' => ['<string>', ...], // REQUIRED
            'id' => '<string>',
            'uri' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'profilingGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'notificationConfiguration' => [
        'channels' => [
            [
                'eventPublishers' => ['<string>', ...],
                'id' => '<string>',
                'uri' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

ValidationException:

The parameter is not valid.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource specified in the request does not exist.

BatchGetFrameMetricData

$result = $client->batchGetFrameMetricData([/* ... */]);
$promise = $client->batchGetFrameMetricDataAsync([/* ... */]);

Returns the time series of values for a requested list of frame metrics from a time period.

Parameter Syntax

$result = $client->batchGetFrameMetricData([
    'endTime' => <integer || string || DateTime>,
    'frameMetrics' => [
        [
            'frameName' => '<string>', // REQUIRED
            'threadStates' => ['<string>', ...], // REQUIRED
            'type' => 'AggregatedRelativeTotalTime', // REQUIRED
        ],
        // ...
    ],
    'period' => '<string>',
    'profilingGroupName' => '<string>', // REQUIRED
    'startTime' => <integer || string || DateTime>,
    'targetResolution' => 'PT5M|PT1H|P1D',
]);

Parameter Details

Result Syntax

[
    'endTime' => <DateTime>,
    'endTimes' => [
        [
            'value' => <DateTime>,
        ],
        // ...
    ],
    'frameMetricData' => [
        [
            'frameMetric' => [
                'frameName' => '<string>',
                'threadStates' => ['<string>', ...],
                'type' => 'AggregatedRelativeTotalTime',
            ],
            'values' => [<float>, ...],
        ],
        // ...
    ],
    'resolution' => 'PT5M|PT1H|P1D',
    'startTime' => <DateTime>,
    'unprocessedEndTimes' => [
        '<String>' => [
            [
                'value' => <DateTime>,
            ],
            // ...
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ValidationException:

The parameter is not valid.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource specified in the request does not exist.

ConfigureAgent

$result = $client->configureAgent([/* ... */]);
$promise = $client->configureAgentAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->configureAgent([
    'fleetInstanceId' => '<string>',
    'metadata' => ['<string>', ...],
    'profilingGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'configuration' => [
        'agentParameters' => ['<string>', ...],
        'periodInSeconds' => <integer>,
        'shouldProfile' => true || false,
    ],
]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ValidationException:

The parameter is not valid.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource specified in the request does not exist.

CreateProfilingGroup

$result = $client->createProfilingGroup([/* ... */]);
$promise = $client->createProfilingGroupAsync([/* ... */]);

Creates a profiling group.

Parameter Syntax

$result = $client->createProfilingGroup([
    'agentOrchestrationConfig' => [
        'profilingEnabled' => true || false, // REQUIRED
    ],
    'clientToken' => '<string>', // REQUIRED
    'computePlatform' => 'Default|AWSLambda',
    'profilingGroupName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'profilingGroup' => [
        'agentOrchestrationConfig' => [
            'profilingEnabled' => true || false,
        ],
        'arn' => '<string>',
        'computePlatform' => 'Default|AWSLambda',
        'createdAt' => <DateTime>,
        'name' => '<string>',
        'profilingStatus' => [
            'latestAgentOrchestratedAt' => <DateTime>,
            'latestAgentProfileReportedAt' => <DateTime>,
            'latestAggregatedProfile' => [
                'period' => 'PT5M|PT1H|P1D',
                'start' => <DateTime>,
            ],
        ],
        'tags' => ['<string>', ...],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

ValidationException:

The parameter is not valid.

ThrottlingException:

The request was denied due to request throttling.

DeleteProfilingGroup

$result = $client->deleteProfilingGroup([/* ... */]);
$promise = $client->deleteProfilingGroupAsync([/* ... */]);

Deletes a profiling group.

Parameter Syntax

$result = $client->deleteProfilingGroup([
    'profilingGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

ValidationException:

The parameter is not valid.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource specified in the request does not exist.

DescribeProfilingGroup

$result = $client->describeProfilingGroup([/* ... */]);
$promise = $client->describeProfilingGroupAsync([/* ... */]);

Returns a ProfilingGroupDescription object that contains information about the requested profiling group.

Parameter Syntax

$result = $client->describeProfilingGroup([
    'profilingGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'profilingGroup' => [
        'agentOrchestrationConfig' => [
            'profilingEnabled' => true || false,
        ],
        'arn' => '<string>',
        'computePlatform' => 'Default|AWSLambda',
        'createdAt' => <DateTime>,
        'name' => '<string>',
        'profilingStatus' => [
            'latestAgentOrchestratedAt' => <DateTime>,
            'latestAgentProfileReportedAt' => <DateTime>,
            'latestAggregatedProfile' => [
                'period' => 'PT5M|PT1H|P1D',
                'start' => <DateTime>,
            ],
        ],
        'tags' => ['<string>', ...],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ValidationException:

The parameter is not valid.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource specified in the request does not exist.

GetFindingsReportAccountSummary

$result = $client->getFindingsReportAccountSummary([/* ... */]);
$promise = $client->getFindingsReportAccountSummaryAsync([/* ... */]);

Returns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account.

Parameter Syntax

$result = $client->getFindingsReportAccountSummary([
    'dailyReportsOnly' => true || false,
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'reportSummaries' => [
        [
            'id' => '<string>',
            'profileEndTime' => <DateTime>,
            'profileStartTime' => <DateTime>,
            'profilingGroupName' => '<string>',
            'totalNumberOfFindings' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ValidationException:

The parameter is not valid.

ThrottlingException:

The request was denied due to request throttling.

GetNotificationConfiguration

$result = $client->getNotificationConfiguration([/* ... */]);
$promise = $client->getNotificationConfigurationAsync([/* ... */]);

Get the current configuration for anomaly notifications for a profiling group.

Parameter Syntax

$result = $client->getNotificationConfiguration([
    'profilingGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'notificationConfiguration' => [
        'channels' => [
            [
                'eventPublishers' => ['<string>', ...],
                'id' => '<string>',
                'uri' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ValidationException:

The parameter is not valid.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource specified in the request does not exist.

GetPolicy

$result = $client->getPolicy([/* ... */]);
$promise = $client->getPolicyAsync([/* ... */]);

Returns the JSON-formatted resource-based policy on a profiling group.

Parameter Syntax

$result = $client->getPolicy([
    'profilingGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'policy' => '<string>',
    'revisionId' => '<string>',
]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource specified in the request does not exist.

GetProfile

$result = $client->getProfile([/* ... */]);
$promise = $client->getProfileAsync([/* ... */]);

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.

 <note> <p> Because aggregated profiles expire over time <code>GetProfile</code> is not idempotent. </p> </note> <p> Specify the time range for the requested aggregated profile using 1 or 2 of the following parameters: <code>startTime</code>, <code>endTime</code>, <code>period</code>. The maximum time range allowed is 7 days. If you specify all 3 parameters, an exception is thrown. If you specify only <code>period</code>, the latest aggregated profile is returned. </p> <p> 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 <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html"> <code>AggregatedProfileTime</code> </a>. The aggregated profile's aggregation period determines how long it is retained by CodeGuru Profiler. </p> <ul> <li> <p> If the aggregation period is 5 minutes, the aggregated profile is retained for 15 days. </p> </li> <li> <p> If the aggregation period is 1 hour, the aggregated profile is retained for 60 days. </p> </li> <li> <p> If the aggregation period is 1 day, the aggregated profile is retained for 3 years. </p> </li> </ul> <p>There are two use cases for calling <code>GetProfile</code>.</p> <ol> <li> <p> If you want to return an aggregated profile that already exists, use <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ListProfileTimes.html"> <code>ListProfileTimes</code> </a> to view the time ranges of existing aggregated profiles. Use them in a <code>GetProfile</code> request to return a specific, existing aggregated profile. </p> </li> <li> <p> 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. </p> <p> 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. </p> </li> </ol> 

Parameter Syntax

$result = $client->getProfile([
    'accept' => '<string>',
    'endTime' => <integer || string || DateTime>,
    'maxDepth' => <integer>,
    'period' => '<string>',
    'profilingGroupName' => '<string>', // REQUIRED
    'startTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'contentEncoding' => '<string>',
    'contentType' => '<string>',
    'profile' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ValidationException:

The parameter is not valid.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource specified in the request does not exist.

GetRecommendations

$result = $client->getRecommendations([/* ... */]);
$promise = $client->getRecommendationsAsync([/* ... */]);

Returns a list of Recommendation objects that contain recommendations for a profiling group for a given time period. A list of Anomaly objects that contains details about anomalies detected in the profiling group for the same time period is also returned.

Parameter Syntax

$result = $client->getRecommendations([
    'endTime' => <integer || string || DateTime>, // REQUIRED
    'locale' => '<string>',
    'profilingGroupName' => '<string>', // REQUIRED
    'startTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'anomalies' => [
        [
            'instances' => [
                [
                    'endTime' => <DateTime>,
                    'id' => '<string>',
                    'startTime' => <DateTime>,
                    'userFeedback' => [
                        'type' => 'Positive|Negative',
                    ],
                ],
                // ...
            ],
            'metric' => [
                'frameName' => '<string>',
                'threadStates' => ['<string>', ...],
                'type' => 'AggregatedRelativeTotalTime',
            ],
            'reason' => '<string>',
        ],
        // ...
    ],
    'profileEndTime' => <DateTime>,
    'profileStartTime' => <DateTime>,
    'profilingGroupName' => '<string>',
    'recommendations' => [
        [
            'allMatchesCount' => <integer>,
            'allMatchesSum' => <float>,
            'endTime' => <DateTime>,
            'pattern' => [
                'countersToAggregate' => ['<string>', ...],
                'description' => '<string>',
                'id' => '<string>',
                'name' => '<string>',
                'resolutionSteps' => '<string>',
                'targetFrames' => [
                    ['<string>', ...],
                    // ...
                ],
                'thresholdPercent' => <float>,
            ],
            'startTime' => <DateTime>,
            'topMatches' => [
                [
                    'frameAddress' => '<string>',
                    'targetFramesIndex' => <integer>,
                    'thresholdBreachValue' => <float>,
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ValidationException:

The parameter is not valid.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource specified in the request does not exist.

ListFindingsReports

$result = $client->listFindingsReports([/* ... */]);
$promise = $client->listFindingsReportsAsync([/* ... */]);

List the available reports for a given profiling group and time range.

Parameter Syntax

$result = $client->listFindingsReports([
    'dailyReportsOnly' => true || false,
    'endTime' => <integer || string || DateTime>, // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'profilingGroupName' => '<string>', // REQUIRED
    'startTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'findingsReportSummaries' => [
        [
            'id' => '<string>',
            'profileEndTime' => <DateTime>,
            'profileStartTime' => <DateTime>,
            'profilingGroupName' => '<string>',
            'totalNumberOfFindings' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ValidationException:

The parameter is not valid.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource specified in the request does not exist.

ListProfileTimes

$result = $client->listProfileTimes([/* ... */]);
$promise = $client->listProfileTimesAsync([/* ... */]);

Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.

Parameter Syntax

$result = $client->listProfileTimes([
    'endTime' => <integer || string || DateTime>, // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'orderBy' => 'TimestampDescending|TimestampAscending',
    'period' => 'PT5M|PT1H|P1D', // REQUIRED
    'profilingGroupName' => '<string>', // REQUIRED
    'startTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'profileTimes' => [
        [
            'start' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ValidationException:

The parameter is not valid.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource specified in the request does not exist.

ListProfilingGroups

$result = $client->listProfilingGroups([/* ... */]);
$promise = $client->listProfilingGroupsAsync([/* ... */]);

Returns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription objects.

Parameter Syntax

$result = $client->listProfilingGroups([
    'includeDescription' => true || false,
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'profilingGroupNames' => ['<string>', ...],
    'profilingGroups' => [
        [
            'agentOrchestrationConfig' => [
                'profilingEnabled' => true || false,
            ],
            'arn' => '<string>',
            'computePlatform' => 'Default|AWSLambda',
            'createdAt' => <DateTime>,
            'name' => '<string>',
            'profilingStatus' => [
                'latestAgentOrchestratedAt' => <DateTime>,
                'latestAgentProfileReportedAt' => <DateTime>,
                'latestAggregatedProfile' => [
                    'period' => 'PT5M|PT1H|P1D',
                    'start' => <DateTime>,
                ],
            ],
            'tags' => ['<string>', ...],
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ThrottlingException:

The request was denied due to request throttling.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns a list of the tags that are assigned to a specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ValidationException:

The parameter is not valid.

ResourceNotFoundException:

The resource specified in the request does not exist.

PostAgentProfile

$result = $client->postAgentProfile([/* ... */]);
$promise = $client->postAgentProfileAsync([/* ... */]);

Submits profiling data to an aggregated profile of a profiling group. To get an aggregated profile that is created with this profiling data, use GetProfile .

Parameter Syntax

$result = $client->postAgentProfile([
    'agentProfile' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'contentType' => '<string>', // REQUIRED
    'profileToken' => '<string>',
    'profilingGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ValidationException:

The parameter is not valid.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource specified in the request does not exist.

PutPermission

$result = $client->putPermission([/* ... */]);
$promise = $client->putPermissionAsync([/* ... */]);

Adds permissions to a profiling group's resource-based policy that are provided using an action group. If a profiling group doesn't have a resource-based policy, one is created for it using the permissions in the action group and the roles and users in the principals parameter.

 <p> The one supported action group that can be added is <code>agentPermission</code> which grants <code>ConfigureAgent</code> and <code>PostAgent</code> permissions. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html">Resource-based policies in CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>, <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html"> <code>ConfigureAgent</code> </a>, and <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html"> <code>PostAgentProfile</code> </a>. </p> <p> The first time you call <code>PutPermission</code> on a profiling group, do not specify a <code>revisionId</code> because it doesn't have a resource-based policy. Subsequent calls must provide a <code>revisionId</code> to specify which revision of the resource-based policy to add the permissions to. </p> <p> The response contains the profiling group's JSON-formatted resource policy. </p> 

Parameter Syntax

$result = $client->putPermission([
    'actionGroup' => 'agentPermissions', // REQUIRED
    'principals' => ['<string>', ...], // REQUIRED
    'profilingGroupName' => '<string>', // REQUIRED
    'revisionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'policy' => '<string>',
    'revisionId' => '<string>',
]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

ValidationException:

The parameter is not valid.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource specified in the request does not exist.

RemoveNotificationChannel

$result = $client->removeNotificationChannel([/* ... */]);
$promise = $client->removeNotificationChannelAsync([/* ... */]);

Remove one anomaly notifications channel for a profiling group.

Parameter Syntax

$result = $client->removeNotificationChannel([
    'channelId' => '<string>', // REQUIRED
    'profilingGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'notificationConfiguration' => [
        'channels' => [
            [
                'eventPublishers' => ['<string>', ...],
                'id' => '<string>',
                'uri' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ValidationException:

The parameter is not valid.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource specified in the request does not exist.

RemovePermission

$result = $client->removePermission([/* ... */]);
$promise = $client->removePermissionAsync([/* ... */]);

Removes permissions from a profiling group's resource-based policy that are provided using an action group. The one supported action group that can be removed is agentPermission which grants ConfigureAgent and PostAgent permissions. For more information, see Resource-based policies in CodeGuru Profiler in the Amazon CodeGuru Profiler User Guide, ConfigureAgent , and PostAgentProfile .

Parameter Syntax

$result = $client->removePermission([
    'actionGroup' => 'agentPermissions', // REQUIRED
    'profilingGroupName' => '<string>', // REQUIRED
    'revisionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'policy' => '<string>',
    'revisionId' => '<string>',
]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

ValidationException:

The parameter is not valid.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource specified in the request does not exist.

SubmitFeedback

$result = $client->submitFeedback([/* ... */]);
$promise = $client->submitFeedbackAsync([/* ... */]);

Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.

Parameter Syntax

$result = $client->submitFeedback([
    'anomalyInstanceId' => '<string>', // REQUIRED
    'comment' => '<string>',
    'profilingGroupName' => '<string>', // REQUIRED
    'type' => 'Positive|Negative', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ValidationException:

The parameter is not valid.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource specified in the request does not exist.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Use to assign one or more tags to a resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ValidationException:

The parameter is not valid.

ResourceNotFoundException:

The resource specified in the request does not exist.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Use to remove one or more tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ValidationException:

The parameter is not valid.

ResourceNotFoundException:

The resource specified in the request does not exist.

UpdateProfilingGroup

$result = $client->updateProfilingGroup([/* ... */]);
$promise = $client->updateProfilingGroupAsync([/* ... */]);

Updates a profiling group.

Parameter Syntax

$result = $client->updateProfilingGroup([
    'agentOrchestrationConfig' => [ // REQUIRED
        'profilingEnabled' => true || false, // REQUIRED
    ],
    'profilingGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'profilingGroup' => [
        'agentOrchestrationConfig' => [
            'profilingEnabled' => true || false,
        ],
        'arn' => '<string>',
        'computePlatform' => 'Default|AWSLambda',
        'createdAt' => <DateTime>,
        'name' => '<string>',
        'profilingStatus' => [
            'latestAgentOrchestratedAt' => <DateTime>,
            'latestAgentProfileReportedAt' => <DateTime>,
            'latestAggregatedProfile' => [
                'period' => 'PT5M|PT1H|P1D',
                'start' => <DateTime>,
            ],
        ],
        'tags' => ['<string>', ...],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

InternalServerException:

The server encountered an internal error and is unable to complete the request.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

ValidationException:

The parameter is not valid.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource specified in the request does not exist.