npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@datafire/amazonaws_codeguruprofiler

v5.0.0

Published

DataFire integration for Amazon CodeGuru Profiler

Downloads

4

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

datafiredatafire

Keywords

Readme

@datafire/amazonaws_codeguruprofiler

Client library for Amazon CodeGuru Profiler

Installation and Usage

npm install --save @datafire/amazonaws_codeguruprofiler
let amazonaws_codeguruprofiler = require('@datafire/amazonaws_codeguruprofiler').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

GetFindingsReportAccountSummary

amazonaws_codeguruprofiler.GetFindingsReportAccountSummary({}, context)

Input

  • input object
    • dailyReportsOnly boolean
    • maxResults integer
    • nextToken string

Output

SubmitFeedback

amazonaws_codeguruprofiler.SubmitFeedback({
  "anomalyInstanceId": "",
  "profilingGroupName": "",
  "type": ""
}, context)

Input

  • input object
    • anomalyInstanceId required string
    • profilingGroupName required string
    • comment string: Optional feedback about this anomaly.
    • type required string (values: Negative, Positive): The feedback tpye. Thee are two valid values, Positive and Negative.

Output

Output schema unknown

ListFindingsReports

amazonaws_codeguruprofiler.ListFindingsReports({
  "endTime": "",
  "profilingGroupName": "",
  "startTime": ""
}, context)

Input

  • input object
    • dailyReportsOnly boolean
    • endTime required string
    • maxResults integer
    • nextToken string
    • profilingGroupName required string
    • startTime required string

Output

GetRecommendations

amazonaws_codeguruprofiler.GetRecommendations({
  "endTime": "",
  "profilingGroupName": "",
  "startTime": ""
}, context)

Input

  • input object
    • endTime required string
    • locale string
    • profilingGroupName required string
    • startTime required string

Output

ListProfilingGroups

amazonaws_codeguruprofiler.ListProfilingGroups({}, context)

Input

  • input object
    • includeDescription boolean
    • maxResults integer
    • nextToken string

Output

CreateProfilingGroup

amazonaws_codeguruprofiler.CreateProfilingGroup({
  "clientToken": "",
  "profilingGroupName": ""
}, context)

Input

  • input object
    • clientToken required string
    • tags object: A list of tags to add to the created profiling group.
    • agentOrchestrationConfig object: Specifies whether profiling is enabled or disabled for a profiling group. It is used by ConfigureAgent to enable or disable profiling for a profiling group.
      • profilingEnabled
    • computePlatform string (values: AWSLambda, Default): 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.
    • profilingGroupName required string: The name of the profiling group to create.

Output

Output schema unknown

DeleteProfilingGroup

amazonaws_codeguruprofiler.DeleteProfilingGroup({
  "profilingGroupName": ""
}, context)

Input

  • input object
    • profilingGroupName required string

Output

Output schema unknown

DescribeProfilingGroup

amazonaws_codeguruprofiler.DescribeProfilingGroup({
  "profilingGroupName": ""
}, context)

Input

  • input object
    • profilingGroupName required string

Output

UpdateProfilingGroup

amazonaws_codeguruprofiler.UpdateProfilingGroup({
  "profilingGroupName": "",
  "agentOrchestrationConfig": {}
}, context)

Input

  • input object
    • profilingGroupName required string
    • agentOrchestrationConfig required object: Specifies whether profiling is enabled or disabled for a profiling group. It is used by ConfigureAgent to enable or disable profiling for a profiling group.
      • profilingEnabled

Output

PostAgentProfile

amazonaws_codeguruprofiler.PostAgentProfile({
  "Content-Type": "",
  "profilingGroupName": "",
  "agentProfile": ""
}, context)

Input

  • input object
    • Content-Type required string
    • profileToken string
    • profilingGroupName required string
    • agentProfile required string: The submitted profiling data.

Output

Output schema unknown

ConfigureAgent

amazonaws_codeguruprofiler.ConfigureAgent({
  "profilingGroupName": ""
}, context)

Input

  • input object
    • profilingGroupName required string
    • fleetInstanceId 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 object: 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.

Output

BatchGetFrameMetricData

amazonaws_codeguruprofiler.BatchGetFrameMetricData({
  "profilingGroupName": ""
}, context)

Input

  • input object
    • endTime string
    • period string
    • profilingGroupName required string
    • startTime string
    • targetResolution string
    • frameMetrics array: 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.

Output

GetNotificationConfiguration

amazonaws_codeguruprofiler.GetNotificationConfiguration({
  "profilingGroupName": ""
}, context)

Input

  • input object
    • profilingGroupName required string

Output

AddNotificationChannels

amazonaws_codeguruprofiler.AddNotificationChannels({
  "profilingGroupName": "",
  "channels": []
}, context)

Input

  • input object
    • profilingGroupName required string
    • channels required array: One or 2 channels to report to when anomalies are detected.

Output

RemoveNotificationChannel

amazonaws_codeguruprofiler.RemoveNotificationChannel({
  "channelId": "",
  "profilingGroupName": ""
}, context)

Input

  • input object
    • channelId required string
    • profilingGroupName required string

Output

GetPolicy

amazonaws_codeguruprofiler.GetPolicy({
  "profilingGroupName": ""
}, context)

Input

  • input object
    • profilingGroupName required string

Output

PutPermission

amazonaws_codeguruprofiler.PutPermission({
  "actionGroup": "",
  "profilingGroupName": "",
  "principals": []
}, context)

Input

  • input object
    • actionGroup required string
    • profilingGroupName required string
    • principals required array: 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.
    • revisionId 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.

Output

RemovePermission

amazonaws_codeguruprofiler.RemovePermission({
  "actionGroup": "",
  "profilingGroupName": "",
  "revisionId": ""
}, context)

Input

  • input object
    • actionGroup required string
    • profilingGroupName required string
    • revisionId required string

Output

GetProfile

amazonaws_codeguruprofiler.GetProfile({
  "profilingGroupName": ""
}, context)

Input

  • input object
    • Accept string
    • endTime string
    • maxDepth integer
    • period string
    • profilingGroupName required string
    • startTime string

Output

ListProfileTimes

amazonaws_codeguruprofiler.ListProfileTimes({
  "endTime": "",
  "period": "",
  "profilingGroupName": "",
  "startTime": ""
}, context)

Input

  • input object
    • endTime required string
    • maxResults integer
    • nextToken string
    • orderBy string
    • period required string
    • profilingGroupName required string
    • startTime required string

Output

ListTagsForResource

amazonaws_codeguruprofiler.ListTagsForResource({
  "resourceArn": ""
}, context)

Input

  • input object
    • resourceArn required string

Output

TagResource

amazonaws_codeguruprofiler.TagResource({
  "resourceArn": "",
  "tags": {}
}, context)

Input

  • input object
    • resourceArn required string
    • tags required object: The list of tags that are added to the specified resource.

Output

Output schema unknown

UntagResource

amazonaws_codeguruprofiler.UntagResource({
  "resourceArn": "",
  "tagKeys": []
}, context)

Input

  • input object
    • resourceArn required string
    • tagKeys required array

Output

Output schema unknown

Definitions

ActionGroup

  • ActionGroup string (values: agentPermissions)

AddNotificationChannelsRequest

  • AddNotificationChannelsRequest object: The structure representing the AddNotificationChannelsRequest.

AddNotificationChannelsResponse

  • AddNotificationChannelsResponse object: The structure representing the AddNotificationChannelsResponse.
    • notificationConfiguration

AgentConfiguration

  • AgentConfiguration object: The response of ConfigureAgent that specifies if an agent profiles or not and for how long to return profiling data.
    • agentParameters
    • periodInSeconds required
    • shouldProfile required

AgentOrchestrationConfig

  • AgentOrchestrationConfig object: Specifies whether profiling is enabled or disabled for a profiling group. It is used by ConfigureAgent to enable or disable profiling for a profiling group.
    • profilingEnabled required

AgentParameterField

  • AgentParameterField string (values: MaxStackDepth, MemoryUsageLimitPercent, MinimumTimeForReportingInMilliseconds, ReportingIntervalInMilliseconds, SamplingIntervalInMilliseconds)

AgentParameters

  • AgentParameters object

AgentProfile

  • AgentProfile string

AggregatedProfile

  • AggregatedProfile string

AggregatedProfileTime

  • AggregatedProfileTime object: Specifies the aggregation period and aggregation start time for an aggregated profile. An aggregated profile is used to collect posted agent profiles during an aggregation period. There are three possible aggregation periods (1 day, 1 hour, or 5 minutes).
    • period
    • start

AggregationPeriod

  • AggregationPeriod string (values: P1D, PT1H, PT5M)

Anomalies

Anomaly

  • Anomaly object: Details about an anomaly in a specific metric of application profile. The anomaly is detected using analysis of the metric data over a period of time.
    • instances required
    • metric required
      • frameName required
      • threadStates required
      • type required
    • reason required

AnomalyInstance

  • AnomalyInstance object: The specific duration in which the metric is flagged as anomalous.
    • endTime
    • id required
    • startTime required
    • userFeedback
      • type required

AnomalyInstanceId

  • AnomalyInstanceId string

AnomalyInstances

BatchGetFrameMetricDataRequest

  • BatchGetFrameMetricDataRequest object: The structure representing the BatchGetFrameMetricDataRequest.

BatchGetFrameMetricDataResponse

  • BatchGetFrameMetricDataResponse object: The structure representing the BatchGetFrameMetricDataResponse.

Boolean

  • Boolean boolean

Channel

  • Channel object: Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel.

ChannelId

  • ChannelId string

ChannelUri

  • ChannelUri string: Channel URI uniquely identifies a Notification Channel. TopicArn is the uri for an SNS channel, emailId is uri for an email channel etc. Currently we only support SNS channels and thus required to be an ARN

Channels

ClientToken

  • ClientToken string

ComputePlatform

  • ComputePlatform string (values: AWSLambda, Default)

ConfigureAgentRequest

  • ConfigureAgentRequest object: The structure representing the configureAgentRequest.
    • fleetInstanceId
    • metadata

ConfigureAgentResponse

  • ConfigureAgentResponse object: The structure representing the configureAgentResponse.
    • configuration required
      • agentParameters
      • periodInSeconds required
      • shouldProfile required

ConflictException

CreateProfilingGroupRequest

  • CreateProfilingGroupRequest object: The structure representing the createProfiliingGroupRequest.
    • tags
    • agentOrchestrationConfig
      • profilingEnabled required
    • computePlatform
    • profilingGroupName required

CreateProfilingGroupResponse

  • CreateProfilingGroupResponse object: The structure representing the createProfilingGroupResponse.
    • profilingGroup required
      • tags
      • agentOrchestrationConfig
        • profilingEnabled required
      • arn
      • computePlatform
      • createdAt
      • name
      • profilingStatus
        • latestAgentOrchestratedAt
        • latestAgentProfileReportedAt
        • latestAggregatedProfile
          • period
          • start
      • updatedAt

DeleteProfilingGroupRequest

  • DeleteProfilingGroupRequest object: The structure representing the deleteProfilingGroupRequest.

DeleteProfilingGroupResponse

  • DeleteProfilingGroupResponse object: The structure representing the deleteProfilingGroupResponse.

DescribeProfilingGroupRequest

  • DescribeProfilingGroupRequest object: The structure representing the describeProfilingGroupRequest.

DescribeProfilingGroupResponse

  • DescribeProfilingGroupResponse object: The structure representing the describeProfilingGroupResponse.
    • profilingGroup required
      • tags
      • agentOrchestrationConfig
        • profilingEnabled required
      • arn
      • computePlatform
      • createdAt
      • name
      • profilingStatus
        • latestAgentOrchestratedAt
        • latestAgentProfileReportedAt
        • latestAggregatedProfile
          • period
          • start
      • updatedAt

Double

  • Double number

EventPublisher

  • EventPublisher string (values: AnomalyDetection)

EventPublishers

FeedbackType

  • FeedbackType string (values: Negative, Positive)

FindingsReportId

  • FindingsReportId string

FindingsReportSummaries

FindingsReportSummary

  • FindingsReportSummary object: Information about potential recommendations that might be created from the analysis of profiling data.
    • id
    • profileEndTime
    • profileStartTime
    • profilingGroupName
    • totalNumberOfFindings

FleetInstanceId

  • FleetInstanceId string

FrameMetric

  • FrameMetric object: The frame name, metric type, and thread states. These are used to derive the value of the metric for the frame.
    • frameName required
    • threadStates required
    • type required

FrameMetricData

FrameMetricDatum

  • FrameMetricDatum object: Information about a frame metric and its values.

FrameMetricValues

  • FrameMetricValues array

FrameMetrics

GetFindingsReportAccountSummaryRequest

  • GetFindingsReportAccountSummaryRequest object: The structure representing the GetFindingsReportAccountSummaryRequest.

GetFindingsReportAccountSummaryResponse

  • GetFindingsReportAccountSummaryResponse object: The structure representing the GetFindingsReportAccountSummaryResponse.

GetNotificationConfigurationRequest

  • GetNotificationConfigurationRequest object: The structure representing the GetNotificationConfigurationRequest.

GetNotificationConfigurationResponse

  • GetNotificationConfigurationResponse object: The structure representing the GetNotificationConfigurationResponse.
    • notificationConfiguration required

GetPolicyRequest

  • GetPolicyRequest object: The structure representing the getPolicyRequest.

GetPolicyResponse

  • GetPolicyResponse object: The structure representing the getPolicyResponse.
    • policy required
    • revisionId required

GetProfileRequest

  • GetProfileRequest object: The structure representing the getProfileRequest.

GetProfileResponse

  • GetProfileResponse object: The structure representing the getProfileResponse.
    • profile required

GetRecommendationsRequest

  • GetRecommendationsRequest object: The structure representing the GetRecommendationsRequest.

GetRecommendationsResponse

  • GetRecommendationsResponse object: The structure representing the GetRecommendationsResponse.
    • anomalies required
    • profileEndTime required
    • profileStartTime required
    • profilingGroupName required
    • recommendations required

Integer

  • Integer integer

InternalServerException

ListFindingsReportsRequest

  • ListFindingsReportsRequest object: The structure representing the ListFindingsReportsRequest.

ListFindingsReportsResponse

  • ListFindingsReportsResponse object: The structure representing the ListFindingsReportsResponse.

ListOfTimestamps

ListProfileTimesRequest

  • ListProfileTimesRequest object: The structure representing the listProfileTimesRequest.

ListProfileTimesResponse

  • ListProfileTimesResponse object: The structure representing the listProfileTimesResponse.

ListProfilingGroupsRequest

  • ListProfilingGroupsRequest object: The structure representing the listProfilingGroupsRequest.

ListProfilingGroupsResponse

ListTagsForResourceRequest

  • ListTagsForResourceRequest object

ListTagsForResourceResponse

  • ListTagsForResourceResponse object
    • tags

Locale

  • Locale string: BCP47 language code. Supported locales: de-DE, en-GB, en-US, es-ES, fr-FR, it-IT, ja-JP, ko-KR, pt-BR, zh-CN, zh-TW

Match

  • Match object: The part of a profile that contains a recommendation found during analysis.
    • frameAddress
    • targetFramesIndex
    • thresholdBreachValue

Matches

MaxDepth

  • MaxDepth integer

MaxResults

  • MaxResults integer

Metadata

  • Metadata object

MetadataField

  • MetadataField string (values: AgentId, AwsRequestId, ComputePlatform, ExecutionEnvironment, LambdaFunctionArn, LambdaMemoryLimitInMB, LambdaPreviousExecutionTimeInMilliseconds, LambdaRemainingTimeInMilliseconds, LambdaTimeGapBetweenInvokesInMilliseconds)

Metric

  • Metric object: Details about the metric that the analysis used when it detected the anomaly. The metric what is analyzed to create recommendations. It includes the name of the frame that was analyzed and the type and thread states used to derive the metric value for that frame.
    • frameName required
    • threadStates required
    • type required

MetricType

  • MetricType string (values: AggregatedRelativeTotalTime)

NotificationConfiguration

  • NotificationConfiguration object: The configuration for notifications stored for each profiling group. This includes up to to two channels and a list of event publishers associated with each channel.

OrderBy

  • OrderBy string (values: TimestampAscending, TimestampDescending)

PaginationToken

  • PaginationToken string

Pattern

  • Pattern object: A set of rules used to make a recommendation during an analysis.
    • countersToAggregate
    • description
    • id
    • name
    • resolutionSteps
    • targetFrames
    • thresholdPercent

Percentage

  • Percentage number

Period

  • Period string

PostAgentProfileRequest

  • PostAgentProfileRequest object: The structure representing the postAgentProfileRequest.
    • agentProfile required

PostAgentProfileResponse

  • PostAgentProfileResponse object: The structure representing the postAgentProfileResponse.

Principal

  • Principal string

Principals

ProfileTime

  • ProfileTime object: Contains the start time of a profile.
    • start

ProfileTimes

ProfilingGroupArn

  • ProfilingGroupArn string

ProfilingGroupDescription

  • ProfilingGroupDescription object: Contains information about a profiling group.
    • tags
    • agentOrchestrationConfig
      • profilingEnabled required
    • arn
    • computePlatform
    • createdAt
    • name
    • profilingStatus
      • latestAgentOrchestratedAt
      • latestAgentProfileReportedAt
      • latestAggregatedProfile
        • period
        • start
    • updatedAt

ProfilingGroupDescriptions

ProfilingGroupName

  • ProfilingGroupName string

ProfilingGroupNames

ProfilingStatus

  • ProfilingStatus object: Profiling status includes information about the last time a profile agent pinged back, the last time a profile was received, and the aggregation period and start time for the most recent aggregated profile.
    • latestAgentOrchestratedAt
    • latestAgentProfileReportedAt
    • latestAggregatedProfile
      • period
      • start

PutPermissionRequest

  • PutPermissionRequest object: The structure representing the putPermissionRequest.

PutPermissionResponse

  • PutPermissionResponse object: The structure representing the putPermissionResponse.
    • policy required
    • revisionId required

Recommendation

  • Recommendation object: A potential improvement that was found from analyzing the profiling data.
    • allMatchesCount required
    • allMatchesSum required
    • endTime required
    • pattern required
      • countersToAggregate
      • description
      • id
      • name
      • resolutionSteps
      • targetFrames
      • thresholdPercent
    • startTime required
    • topMatches required

Recommendations

RemoveNotificationChannelRequest

  • RemoveNotificationChannelRequest object: The structure representing the RemoveNotificationChannelRequest.

RemoveNotificationChannelResponse

  • RemoveNotificationChannelResponse object: The structure representing the RemoveNotificationChannelResponse.
    • notificationConfiguration

RemovePermissionRequest

  • RemovePermissionRequest object: The structure representing the <code>removePermissionRequest</code>.</p>

RemovePermissionResponse

  • RemovePermissionResponse object: The structure representing the removePermissionResponse.
    • policy required
    • revisionId required

ResourceNotFoundException

RevisionId

  • RevisionId string

ServiceQuotaExceededException

String

  • String string

Strings

SubmitFeedbackRequest

  • SubmitFeedbackRequest object: The structure representing the SubmitFeedbackRequest.
    • comment
    • type required

SubmitFeedbackResponse

  • SubmitFeedbackResponse object: The structure representing the SubmitFeedbackResponse.

TagKeys

TagResourceRequest

  • TagResourceRequest object
    • tags required

TagResourceResponse

  • TagResourceResponse object

TagsMap

  • TagsMap object

TargetFrame

TargetFrames

ThreadStates

  • ThreadStates array

ThrottlingException

Timestamp

  • Timestamp string

TimestampStructure

  • TimestampStructure object: A data type that contains a Timestamp object. 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.
    • value required

UnprocessedEndTimeMap

  • UnprocessedEndTimeMap object

UntagResourceRequest

  • UntagResourceRequest object

UntagResourceResponse

  • UntagResourceResponse object

UpdateProfilingGroupRequest

  • UpdateProfilingGroupRequest object: The structure representing the updateProfilingGroupRequest.
    • agentOrchestrationConfig required
      • profilingEnabled required

UpdateProfilingGroupResponse

  • UpdateProfilingGroupResponse object: The structure representing the updateProfilingGroupResponse.
    • profilingGroup required
      • tags
      • agentOrchestrationConfig
        • profilingEnabled required
      • arn
      • computePlatform
      • createdAt
      • name
      • profilingStatus
        • latestAgentOrchestratedAt
        • latestAgentProfileReportedAt
        • latestAggregatedProfile
          • period
          • start
      • updatedAt

UserFeedback

  • UserFeedback object: Feedback that can be submitted for each instance of an anomaly by the user. Feedback is be used for improvements in generating recommendations for the application.
    • type required

ValidationException