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_support

v5.0.0

Published

DataFire integration for AWS Support

Downloads

15

Vulnerabilities

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

Links

Git

Maintainers

datafiredatafire

Keywords

Readme

@datafire/amazonaws_support

Client library for AWS Support

Installation and Usage

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

amazonaws_support.AddAttachmentsToSet({
  "attachments": []
}).then(data => {
  console.log(data);
});

Description

AWS Support The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format. The AWS Support service also exposes a set of Trusted Advisor features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks. The following list describes the AWS Support case management operations: Service names, issue categories, and available severity levels. The DescribeServices and DescribeSeverityLevels operations return AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase operation. Case creation, case details, and case resolution. The CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations create AWS Support cases, retrieve information about cases, and resolve cases. Case communication. The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to AWS Support cases. The following list describes the operations available from the AWS Support service for Trusted Advisor: DescribeTrustedAdvisorChecks returns the list of checks that run against your AWS resources. Using the checkId for a specific check returned by DescribeTrustedAdvisorChecks, you can call DescribeTrustedAdvisorCheckResult to obtain the results for the check you specified. DescribeTrustedAdvisorCheckSummaries returns summarized results for one or more Trusted Advisor checks. RefreshTrustedAdvisorCheck requests that Trusted Advisor rerun a specified check. DescribeTrustedAdvisorCheckRefreshStatuses reports the refresh status of one or more checks. For authentication of requests, AWS Support uses Signature Version 4 Signing Process. See About the AWS Support API in the AWS Support User Guide for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.

Actions

AddAttachmentsToSet

amazonaws_support.AddAttachmentsToSet({
  "attachments": []
}, context)

Input

Output

AddCommunicationToCase

amazonaws_support.AddCommunicationToCase({
  "communicationBody": ""
}, context)

Input

Output

CreateCase

amazonaws_support.CreateCase({
  "subject": "",
  "communicationBody": ""
}, context)

Input

Output

DescribeAttachment

amazonaws_support.DescribeAttachment({
  "attachmentId": ""
}, context)

Input

Output

DescribeCases

amazonaws_support.DescribeCases({}, context)

Input

Output

DescribeCommunications

amazonaws_support.DescribeCommunications({
  "caseId": ""
}, context)

Input

Output

DescribeServices

amazonaws_support.DescribeServices({}, context)

Input

Output

DescribeSeverityLevels

amazonaws_support.DescribeSeverityLevels({}, context)

Input

Output

DescribeTrustedAdvisorCheckRefreshStatuses

amazonaws_support.DescribeTrustedAdvisorCheckRefreshStatuses({
  "checkIds": []
}, context)

Input

Output

DescribeTrustedAdvisorCheckResult

amazonaws_support.DescribeTrustedAdvisorCheckResult({
  "checkId": ""
}, context)

Input

Output

DescribeTrustedAdvisorCheckSummaries

amazonaws_support.DescribeTrustedAdvisorCheckSummaries({
  "checkIds": []
}, context)

Input

Output

DescribeTrustedAdvisorChecks

amazonaws_support.DescribeTrustedAdvisorChecks({
  "language": ""
}, context)

Input

  • input object

Output

RefreshTrustedAdvisorCheck

amazonaws_support.RefreshTrustedAdvisorCheck({
  "checkId": ""
}, context)

Input

  • input object

Output

ResolveCase

amazonaws_support.ResolveCase({}, context)

Input

Output

Definitions

AddAttachmentsToSetRequest

AddAttachmentsToSetResponse

  • AddAttachmentsToSetResponse object: The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.

AddCommunicationToCaseRequest

AddCommunicationToCaseResponse

  • AddCommunicationToCaseResponse object: The result of the AddCommunicationToCase operation.

AfterTime

  • AfterTime string

Attachment

  • Attachment object: An attachment to a case communication. The attachment consists of the file name and the content of the file.

AttachmentDetails

  • AttachmentDetails object: The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.

AttachmentId

  • AttachmentId string

AttachmentIdNotFound

  • AttachmentIdNotFound object: An attachment with the specified ID could not be found.

AttachmentLimitExceeded

  • AttachmentLimitExceeded object: The limit for the number of attachment sets created in a short period of time has been exceeded.

AttachmentSet

AttachmentSetExpired

  • AttachmentSetExpired object: The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

AttachmentSetId

  • AttachmentSetId string

AttachmentSetIdNotFound

  • AttachmentSetIdNotFound object: An attachment set with the specified ID could not be found.

AttachmentSetSizeLimitExceeded

  • AttachmentSetSizeLimitExceeded object: A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.

Attachments

BeforeTime

  • BeforeTime string

Boolean

  • Boolean boolean

CaseCreationLimitExceeded

  • CaseCreationLimitExceeded object: The case creation limit for the account has been exceeded.

CaseDetails

  • CaseDetails object: A JSON-formatted object that contains the metadata for a support case. It is contained the response from a DescribeCases request. CaseDetails contains the following fields: caseId. The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47. categoryCode. The category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to DescribeServices. displayId. The identifier for the case on pages in the AWS Support Center. language. The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. recentCommunications. One or more Communication objects. Fields of these objects are attachments, body, caseId, submittedBy, and timeCreated. nextToken. A resumption point for pagination. serviceCode. The identifier for the AWS service that corresponds to the service code defined in the call to DescribeServices. severityCode. The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels. status. The status of the case in the AWS Support Center. subject. The subject line of the case. submittedBy. The email address of the account that submitted the case. timeCreated. The time the case was created, in ISO-8601 format.

CaseId

  • CaseId string

CaseIdList

CaseIdNotFound

  • CaseIdNotFound object: The requested caseId could not be located.

CaseList

CaseStatus

  • CaseStatus string

Category

  • Category object: A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each AWS service.

CategoryCode

  • CategoryCode string

CategoryList

CategoryName

  • CategoryName string

CcEmailAddress

  • CcEmailAddress string

CcEmailAddressList

Communication

  • Communication object: A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.

CommunicationBody

  • CommunicationBody string

CommunicationList

CreateCaseRequest

CreateCaseResponse

  • CreateCaseResponse object: The AWS Support case ID returned by a successful completion of the CreateCase operation.

Data

  • Data string

DescribeAttachmentLimitExceeded

  • DescribeAttachmentLimitExceeded object: The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.

DescribeAttachmentRequest

  • DescribeAttachmentRequest object

DescribeAttachmentResponse

  • DescribeAttachmentResponse object: The content and file name of the attachment returned by the DescribeAttachment operation.

DescribeCasesRequest

DescribeCasesResponse

  • DescribeCasesResponse object: Returns an array of CaseDetails objects and a nextToken that defines a point for pagination in the result set.

DescribeCommunicationsRequest

DescribeCommunicationsResponse

  • DescribeCommunicationsResponse object: The communications returned by the DescribeCommunications operation.

DescribeServicesRequest

DescribeServicesResponse

  • DescribeServicesResponse object: The list of AWS services returned by the DescribeServices operation.

DescribeSeverityLevelsRequest

  • DescribeSeverityLevelsRequest object:

DescribeSeverityLevelsResponse

  • DescribeSeverityLevelsResponse object: The list of severity levels returned by the DescribeSeverityLevels operation.

DescribeTrustedAdvisorCheckRefreshStatusesRequest

  • DescribeTrustedAdvisorCheckRefreshStatusesRequest object:

DescribeTrustedAdvisorCheckRefreshStatusesResponse

  • DescribeTrustedAdvisorCheckRefreshStatusesResponse object: The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.

DescribeTrustedAdvisorCheckResultRequest

  • DescribeTrustedAdvisorCheckResultRequest object:

DescribeTrustedAdvisorCheckResultResponse

  • DescribeTrustedAdvisorCheckResultResponse object: The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.

DescribeTrustedAdvisorCheckSummariesRequest

  • DescribeTrustedAdvisorCheckSummariesRequest object:

DescribeTrustedAdvisorCheckSummariesResponse

  • DescribeTrustedAdvisorCheckSummariesResponse object: The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.

DescribeTrustedAdvisorChecksRequest

  • DescribeTrustedAdvisorChecksRequest object:

DescribeTrustedAdvisorChecksResponse

  • DescribeTrustedAdvisorChecksResponse object: Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.

DisplayId

  • DisplayId string

Double

  • Double number

ErrorMessage

  • ErrorMessage string

ExpiryTime

  • ExpiryTime string

FileName

  • FileName string

IncludeCommunications

  • IncludeCommunications boolean

IncludeResolvedCases

  • IncludeResolvedCases boolean

InternalServerError

  • InternalServerError object: An internal server error occurred.

IssueType

  • IssueType string

Language

  • Language string

Long

  • Long integer

MaxResults

  • MaxResults integer

NextToken

  • NextToken string

RecentCaseCommunications

  • RecentCaseCommunications object: The five most recent communications associated with the case.

RefreshTrustedAdvisorCheckRequest

  • RefreshTrustedAdvisorCheckRequest object:

RefreshTrustedAdvisorCheckResponse

ResolveCaseRequest

  • ResolveCaseRequest object:

ResolveCaseResponse

  • ResolveCaseResponse object: The status of the case returned by the ResolveCase operation.

Result

  • Result boolean

Service

ServiceCode

  • ServiceCode string

ServiceCodeList

ServiceList

ServiceName

  • ServiceName string

SeverityCode

  • SeverityCode string

SeverityLevel

SeverityLevelCode

  • SeverityLevelCode string

SeverityLevelName

  • SeverityLevelName string

SeverityLevelsList

Status

  • Status string

String

  • String string

StringList

Subject

  • Subject string

SubmittedBy

  • SubmittedBy string

TimeCreated

  • TimeCreated string

TrustedAdvisorCategorySpecificSummary

  • TrustedAdvisorCategorySpecificSummary object: The container for summary information that relates to the category of the Trusted Advisor check.

TrustedAdvisorCheckDescription

  • TrustedAdvisorCheckDescription object: The description and metadata for a Trusted Advisor check.

TrustedAdvisorCheckList

TrustedAdvisorCheckRefreshStatus

  • TrustedAdvisorCheckRefreshStatus object: The refresh status of a Trusted Advisor check.
    • checkId required String
    • millisUntilNextRefreshable required Long
    • status required String

TrustedAdvisorCheckRefreshStatusList

TrustedAdvisorCheckResult

TrustedAdvisorCheckSummary

TrustedAdvisorCheckSummaryList

TrustedAdvisorCostOptimizingSummary

  • TrustedAdvisorCostOptimizingSummary object: The estimated cost savings that might be realized if the recommended actions are taken.
    • estimatedMonthlySavings required Double
    • estimatedPercentMonthlySavings required Double

TrustedAdvisorResourceDetail

  • TrustedAdvisorResourceDetail object: Contains information about a resource identified by a Trusted Advisor check.

TrustedAdvisorResourceDetailList

TrustedAdvisorResourcesSummary

  • TrustedAdvisorResourcesSummary object: Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.
    • resourcesFlagged required Long
    • resourcesIgnored required Long
    • resourcesProcessed required Long
    • resourcesSuppressed required Long