5.0.0 • Published 5 years ago

@datafire/amazonaws_devops_guru v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/amazonaws_devops_guru

Client library for Amazon DevOps Guru

Installation and Usage

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

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

Description

Actions

DescribeAccountHealth

amazonaws_devops_guru.DescribeAccountHealth({}, context)

Input

  • input object

Output

DescribeResourceCollectionHealth

amazonaws_devops_guru.DescribeResourceCollectionHealth({
  "ResourceCollectionType": ""
}, context)

Input

  • input object
    • ResourceCollectionType required string
    • NextToken string

Output

DescribeAccountOverview

amazonaws_devops_guru.DescribeAccountOverview({
  "FromTime": ""
}, context)

Input

  • input object
    • FromTime required string: The start of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred after this day.
    • ToTime string: The end of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred before this day. If this is not specified, then the current day is used.

Output

ListAnomaliesForInsight

amazonaws_devops_guru.ListAnomaliesForInsight({
  "InsightId": ""
}, context)

Input

  • input object
    • InsightId required string
    • MaxResults string
    • NextToken string
    • MaxResults integer: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
    • NextToken string: The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
    • StartTimeRange object: A time range used to specify when the behavior of an insight or anomaly started.
      • FromTime
      • ToTime

Output

DescribeAnomaly

amazonaws_devops_guru.DescribeAnomaly({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

ListNotificationChannels

amazonaws_devops_guru.ListNotificationChannels({}, context)

Input

  • input object
    • NextToken string
    • NextToken string: The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Output

AddNotificationChannel

amazonaws_devops_guru.AddNotificationChannel({
  "Config": {}
}, context)

Input

  • input object
    • Config required object: Information about notification channels you have configured with DevOps Guru. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).
      • Sns
        • TopicArn

Output

RemoveNotificationChannel

amazonaws_devops_guru.RemoveNotificationChannel({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

ListEvents

amazonaws_devops_guru.ListEvents({
  "Filters": {}
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filters required object: Filters you can use to specify which events are returned when ListEvents is called.
      • DataSource
      • EventClass
      • EventSource
      • EventTimeRange
        • FromTime required
        • ToTime required
      • InsightId
      • ResourceCollection ResourceCollection
    • MaxResults integer: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
    • NextToken string: The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Output

PutFeedback

amazonaws_devops_guru.PutFeedback({}, context)

Input

  • input object
    • InsightFeedback object: Information about insight feedback received from a customer.
      • Feedback
      • Id

Output

ListInsights

amazonaws_devops_guru.ListInsights({
  "StatusFilter": {}
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults integer: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
    • NextToken string: The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
    • StatusFilter required object: A filter used by ListInsights to specify which insights to return.
      • Any
        • StartTimeRange required
          • FromTime
          • ToTime
        • Type required
      • Closed
        • EndTimeRange required
          • FromTime
          • ToTime
        • Type required
      • Ongoing
        • Type required

Output

SearchInsights

amazonaws_devops_guru.SearchInsights({
  "StartTimeRange": {},
  "Type": ""
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filters object: Specifies one or more severity values and one or more status values that are used to search for insights.
    • MaxResults integer: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
    • NextToken string: The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
    • StartTimeRange required object: A time range used to specify when the behavior of an insight or anomaly started.
      • FromTime
      • ToTime
    • Type required string (values: REACTIVE, PROACTIVE): The type of insights you are searching for (REACTIVE or PROACTIVE).

Output

DescribeInsight

amazonaws_devops_guru.DescribeInsight({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

ListRecommendations

amazonaws_devops_guru.ListRecommendations({
  "InsightId": ""
}, context)

Input

  • input object
    • NextToken string
    • InsightId required string: The ID of the requested insight.
    • NextToken string: The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Output

UpdateResourceCollection

amazonaws_devops_guru.UpdateResourceCollection({
  "Action": "",
  "ResourceCollection": {}
}, context)

Input

  • input object
    • Action required string (values: ADD, REMOVE): Specifies if the resource collection in the request is added or deleted to the resource collection.
    • ResourceCollection required object: Contains information used to update a collection of AWS resources.

Output

GetResourceCollection

amazonaws_devops_guru.GetResourceCollection({
  "ResourceCollectionType": ""
}, context)

Input

  • input object
    • ResourceCollectionType required string
    • NextToken string

Output

DescribeServiceIntegration

amazonaws_devops_guru.DescribeServiceIntegration({}, context)

Input

  • input object

Output

UpdateServiceIntegration

amazonaws_devops_guru.UpdateServiceIntegration({
  "ServiceIntegration": {}
}, context)

Input

  • input object
    • ServiceIntegration required object: Information about updating the integration status of an AWS service, such as AWS Systems Manager, with DevOps Guru.

Output

Definitions

AccessDeniedException

AddNotificationChannelRequest

  • AddNotificationChannelRequest object
    • Config required
      • Sns required
        • TopicArn

AddNotificationChannelResponse

  • AddNotificationChannelResponse object
    • Id required

AnomalyId

  • AnomalyId string

AnomalyLimit

  • AnomalyLimit number

AnomalySeverity

  • AnomalySeverity string (values: LOW, MEDIUM, HIGH)

AnomalySourceDetails

  • AnomalySourceDetails object: Details about the source of the anomalous operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.

AnomalyStatus

  • AnomalyStatus string (values: ONGOING, CLOSED)

AnomalyTimeRange

  • AnomalyTimeRange object: A time range that specifies when the observed unusual behavior in an anomaly started and ended.
    • EndTime
    • StartTime required

Channels

CloudFormationCollection

  • CloudFormationCollection object: Information about AWS CloudFormation stacks. You can use stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide.

CloudFormationCollectionFilter

  • CloudFormationCollectionFilter object: Information about AWS CloudFormation stacks. You can use stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide.

CloudFormationHealth

  • CloudFormationHealth object: Information about the health of AWS resources in your account that are specified by an AWS CloudFormation stack.
    • Insight
      • MeanTimeToRecoverInMilliseconds
      • OpenProactiveInsights
      • OpenReactiveInsights
    • StackName

CloudFormationHealths

CloudWatchMetricsDetail

  • CloudWatchMetricsDetail object: Information about an Amazon CloudWatch metric.

CloudWatchMetricsDetails

CloudWatchMetricsDimension

  • CloudWatchMetricsDimension object: The dimension of a Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in your account for operational problems and anomalous behaviour. A dimension is a name/value pair that is part of the identity of a metric. A metric can have up to 10 dimensions. For more information, see Dimensions in the Amazon CloudWatch User Guide.
    • Name
    • Value

CloudWatchMetricsDimensionName

  • CloudWatchMetricsDimensionName string

CloudWatchMetricsDimensionValue

  • CloudWatchMetricsDimensionValue string

CloudWatchMetricsDimensions

CloudWatchMetricsMetricName

  • CloudWatchMetricsMetricName string

CloudWatchMetricsNamespace

  • CloudWatchMetricsNamespace string

CloudWatchMetricsPeriod

  • CloudWatchMetricsPeriod integer

CloudWatchMetricsStat

  • CloudWatchMetricsStat string (values: Sum, Average, SampleCount, Minimum, Maximum, p99, p90, p50)

CloudWatchMetricsUnit

  • CloudWatchMetricsUnit string

ConflictException

DescribeAccountHealthRequest

  • DescribeAccountHealthRequest object

DescribeAccountHealthResponse

  • DescribeAccountHealthResponse object
    • MetricsAnalyzed required
    • OpenProactiveInsights required
    • OpenReactiveInsights required

DescribeAccountOverviewRequest

  • DescribeAccountOverviewRequest object
    • FromTime required
    • ToTime

DescribeAccountOverviewResponse

  • DescribeAccountOverviewResponse object
    • MeanTimeToRecoverInMilliseconds required
    • ProactiveInsights required
    • ReactiveInsights required

DescribeAnomalyRequest

  • DescribeAnomalyRequest object

DescribeAnomalyResponse

DescribeInsightRequest

  • DescribeInsightRequest object

DescribeInsightResponse

DescribeResourceCollectionHealthRequest

  • DescribeResourceCollectionHealthRequest object

DescribeResourceCollectionHealthResponse

  • DescribeResourceCollectionHealthResponse object

DescribeServiceIntegrationRequest

  • DescribeServiceIntegrationRequest object

DescribeServiceIntegrationResponse

EndTimeRange

  • EndTimeRange object: A range of time that specifies when anomalous behavior in an anomaly or insight ended.
    • FromTime
    • ToTime

Event

  • Event object: An AWS resource event. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.

EventClass

  • EventClass string (values: INFRASTRUCTURE, DEPLOYMENT, SECURITY_CHANGE, CONFIG_CHANGE, SCHEMA_CHANGE)

EventDataSource

  • EventDataSource string (values: AWS_CLOUD_TRAIL, AWS_CODE_DEPLOY)

EventId

  • EventId string

EventName

  • EventName string

EventResource

  • EventResource object: The AWS resource that emitted an event. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.
    • Arn
    • Name
    • Type

EventResourceArn

  • EventResourceArn string

EventResourceName

  • EventResourceName string

EventResourceType

  • EventResourceType string

EventResources

EventSource

  • EventSource string

EventTimeRange

  • EventTimeRange object: The time range during which an AWS event occurred. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.
    • FromTime required
    • ToTime required

Events

GetResourceCollectionRequest

  • GetResourceCollectionRequest object

GetResourceCollectionResponse

  • GetResourceCollectionResponse object
    • NextToken
    • ResourceCollection

InsightFeedback

  • InsightFeedback object: Information about insight feedback received from a customer.
    • Feedback
    • Id

InsightFeedbackOption

  • InsightFeedbackOption string (values: VALID_COLLECTION, RECOMMENDATION_USEFUL, ALERT_TOO_SENSITIVE, DATA_NOISY_ANOMALY, DATA_INCORRECT)

InsightHealth

  • InsightHealth object: Information about the number of open reactive and proactive insights that can be used to gauge the health of your system.
    • MeanTimeToRecoverInMilliseconds
    • OpenProactiveInsights
    • OpenReactiveInsights

InsightId

  • InsightId string

InsightName

  • InsightName string

InsightSeverities

InsightSeverity

  • InsightSeverity string (values: LOW, MEDIUM, HIGH)

InsightStatus

  • InsightStatus string (values: ONGOING, CLOSED)

InsightStatuses

InsightTimeRange

  • InsightTimeRange object: A time ranged that specifies when the observed behavior in an insight started and ended.
    • EndTime
    • StartTime required

InsightType

  • InsightType string (values: REACTIVE, PROACTIVE)

InternalServerException

ListAnomaliesForInsightMaxResults

  • ListAnomaliesForInsightMaxResults integer

ListAnomaliesForInsightRequest

  • ListAnomaliesForInsightRequest object
    • MaxResults
    • NextToken
    • StartTimeRange
      • FromTime
      • ToTime

ListAnomaliesForInsightResponse

ListEventsFilters

  • ListEventsFilters object: Filters you can use to specify which events are returned when ListEvents is called.
    • DataSource
    • EventClass
    • EventSource
    • EventTimeRange
      • FromTime required
      • ToTime required
    • InsightId
    • ResourceCollection ResourceCollection

ListEventsMaxResults

  • ListEventsMaxResults integer

ListEventsRequest

  • ListEventsRequest object
    • Filters required
      • DataSource
      • EventClass
      • EventSource
      • EventTimeRange
        • FromTime required
        • ToTime required
      • InsightId
      • ResourceCollection ResourceCollection
    • MaxResults
    • NextToken

ListEventsResponse

  • ListEventsResponse object
    • Events required
    • NextToken

ListInsightsAnyStatusFilter

  • ListInsightsAnyStatusFilter object: Used to filter for insights that have any status.
    • StartTimeRange required
      • FromTime
      • ToTime
    • Type required

ListInsightsClosedStatusFilter

  • ListInsightsClosedStatusFilter object: Used to filter for insights that have the status CLOSED.
    • EndTimeRange required
      • FromTime
      • ToTime
    • Type required

ListInsightsMaxResults

  • ListInsightsMaxResults integer

ListInsightsOngoingStatusFilter

  • ListInsightsOngoingStatusFilter object: Used to filter for insights that have the status ONGOING.
    • Type required

ListInsightsRequest

  • ListInsightsRequest object
    • MaxResults
    • NextToken
    • StatusFilter required
      • Any
        • StartTimeRange required
          • FromTime
          • ToTime
        • Type required
      • Closed
        • EndTimeRange required
          • FromTime
          • ToTime
        • Type required
      • Ongoing
        • Type required

ListInsightsResponse

ListInsightsStatusFilter

  • ListInsightsStatusFilter object: A filter used by ListInsights to specify which insights to return.
    • Any
      • StartTimeRange required
        • FromTime
        • ToTime
      • Type required
    • Closed
      • EndTimeRange required
        • FromTime
        • ToTime
      • Type required
    • Ongoing
      • Type required

ListNotificationChannelsRequest

  • ListNotificationChannelsRequest object
    • NextToken

ListNotificationChannelsResponse

ListRecommendationsRequest

  • ListRecommendationsRequest object
    • InsightId required
    • NextToken

ListRecommendationsResponse

  • ListRecommendationsResponse object

MeanTimeToRecoverInMilliseconds

  • MeanTimeToRecoverInMilliseconds integer

NotificationChannel

  • NotificationChannel object: Information about a notification channel. A notification channel is used to notify you when DevOps Guru creates an insight. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS). If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics. If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics.
    • Config
      • Sns required
        • TopicArn
    • Id

NotificationChannelConfig

  • NotificationChannelConfig object: Information about notification channels you have configured with DevOps Guru. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).
    • Sns required
      • TopicArn

NotificationChannelId

  • NotificationChannelId string

NumMetricsAnalyzed

  • NumMetricsAnalyzed integer

NumOpenProactiveInsights

  • NumOpenProactiveInsights integer

NumOpenReactiveInsights

  • NumOpenReactiveInsights integer

NumProactiveInsights

  • NumProactiveInsights integer

NumReactiveInsights

  • NumReactiveInsights integer

OpsCenterIntegration

  • OpsCenterIntegration object: Information about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight.
    • OptInStatus

OpsCenterIntegrationConfig

  • OpsCenterIntegrationConfig object: Information about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight.
    • OptInStatus

OptInStatus

  • OptInStatus string (values: ENABLED, DISABLED): Specifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight.

PredictionTimeRange

  • PredictionTimeRange object: The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.
    • EndTime
    • StartTime required

ProactiveAnomalies

ProactiveAnomaly

ProactiveAnomalySummary

ProactiveInsight

ProactiveInsightSummary

ProactiveInsights

PutFeedbackRequest

  • PutFeedbackRequest object
    • InsightFeedback
      • Feedback
      • Id

PutFeedbackResponse

  • PutFeedbackResponse object

ReactiveAnomalies

ReactiveAnomaly

ReactiveAnomalySummary

ReactiveInsight

  • ReactiveInsight object: Information about a reactive insight. This object is returned by ListInsights.

ReactiveInsightSummary

  • ReactiveInsightSummary object: Information about a reactive insight. This object is returned by DescribeInsight.

ReactiveInsights

Recommendation

RecommendationDescription

  • RecommendationDescription string

RecommendationLink

  • RecommendationLink string

RecommendationName

  • RecommendationName string

RecommendationReason

  • RecommendationReason string

RecommendationRelatedAnomalies

RecommendationRelatedAnomaly

RecommendationRelatedAnomalyResource

  • RecommendationRelatedAnomalyResource object: Information about a resource in which DevOps Guru detected anomalous behavior.
    • Name
    • Type

RecommendationRelatedAnomalyResourceName

  • RecommendationRelatedAnomalyResourceName string

RecommendationRelatedAnomalyResourceType

  • RecommendationRelatedAnomalyResourceType string

RecommendationRelatedAnomalyResources

RecommendationRelatedAnomalySourceDetail

  • RecommendationRelatedAnomalySourceDetail object: Contains an array of RecommendationRelatedCloudWatchMetricsSourceDetail objects that contain the name and namespace of an Amazon CloudWatch metric.

RecommendationRelatedCloudWatchMetricsSourceDetail

  • RecommendationRelatedCloudWatchMetricsSourceDetail object: Information about an Amazon CloudWatch metric that is analyzed by DevOps Guru. It is one of many analyzed metrics that are used to generate insights.
    • MetricName
    • Namespace

RecommendationRelatedCloudWatchMetricsSourceDetails

RecommendationRelatedCloudWatchMetricsSourceMetricName

  • RecommendationRelatedCloudWatchMetricsSourceMetricName string

RecommendationRelatedCloudWatchMetricsSourceNamespace

  • RecommendationRelatedCloudWatchMetricsSourceNamespace string

RecommendationRelatedEvent

RecommendationRelatedEventName

  • RecommendationRelatedEventName string

RecommendationRelatedEventResource

  • RecommendationRelatedEventResource object: Information about an AWS resource that emitted and event that is related to a recommendation in an insight.
    • Name
    • Type

RecommendationRelatedEventResourceName

  • RecommendationRelatedEventResourceName string

RecommendationRelatedEventResourceType

  • RecommendationRelatedEventResourceType string

RecommendationRelatedEventResources

RecommendationRelatedEvents

Recommendations

RelatedAnomalySourceDetails

RemoveNotificationChannelRequest

  • RemoveNotificationChannelRequest object

RemoveNotificationChannelResponse

  • RemoveNotificationChannelResponse object

ResourceCollection

  • ResourceCollection object: A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.

ResourceCollectionFilter

  • ResourceCollectionFilter object: Information about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.

ResourceCollectionType

  • ResourceCollectionType string (values: AWS_CLOUD_FORMATION)

ResourceNotFoundException

SearchInsightsFilters

  • SearchInsightsFilters object: Specifies one or more severity values and one or more status values that are used to search for insights.

SearchInsightsMaxResults

  • SearchInsightsMaxResults integer

SearchInsightsRequest

SearchInsightsResponse

ServiceIntegrationConfig

  • ServiceIntegrationConfig object: Information about the integration of DevOps Guru with another AWS service, such as AWS Systems Manager.
    • OpsCenter
      • OptInStatus

ServiceQuotaExceededException

SnsChannelConfig

  • SnsChannelConfig object: Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic. If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics. If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics.
    • TopicArn

SsmOpsItemId

  • SsmOpsItemId string

StackName

  • StackName string

StackNames

StartTimeRange

  • StartTimeRange object: A time range used to specify when the behavior of an insight or anomaly started.
    • FromTime
    • ToTime

ThrottlingException

Timestamp

  • Timestamp string

TopicArn

  • TopicArn string

UpdateCloudFormationCollectionFilter

  • UpdateCloudFormationCollectionFilter object: Contains the names of AWS CloudFormation stacks used to update a collection of stacks.

UpdateResourceCollectionAction

  • UpdateResourceCollectionAction string (values: ADD, REMOVE)

UpdateResourceCollectionFilter

  • UpdateResourceCollectionFilter object: Contains information used to update a collection of AWS resources.

UpdateResourceCollectionRequest

UpdateResourceCollectionResponse

  • UpdateResourceCollectionResponse object

UpdateServiceIntegrationConfig

  • UpdateServiceIntegrationConfig object: Information about updating the integration status of an AWS service, such as AWS Systems Manager, with DevOps Guru.

UpdateServiceIntegrationRequest

UpdateServiceIntegrationResponse

  • UpdateServiceIntegrationResponse object

UpdateStackNames

UuidNextToken

  • UuidNextToken string

ValidationException

datafireaws-sdk
@infinitebrahmanuniverse/nolb-_datafire_am@everything-registry/sub-chunk-220
5.0.0

5 years ago