5.0.0 • Published 6 years ago

@datafire/amazonaws_inspector v5.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

@datafire/amazonaws_inspector

Client library for Amazon Inspector

Installation and Usage

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

amazonaws_inspector.AddAttributesToFindings({
  "findingArns": [],
  "attributes": []
}).then(data => {
  console.log(data);
});

Description

Amazon Inspector Amazon Inspector enables you to analyze the behavior of your AWS resources and to identify potential security issues. For more information, see Amazon Inspector User Guide.

Actions

AddAttributesToFindings

amazonaws_inspector.AddAttributesToFindings({
  "findingArns": [],
  "attributes": []
}, context)

Input

Output

CreateAssessmentTarget

amazonaws_inspector.CreateAssessmentTarget({
  "assessmentTargetName": "",
  "resourceGroupArn": ""
}, context)

Input

Output

CreateAssessmentTemplate

amazonaws_inspector.CreateAssessmentTemplate({
  "assessmentTargetArn": "",
  "assessmentTemplateName": "",
  "durationInSeconds": 0,
  "rulesPackageArns": []
}, context)

Input

Output

CreateResourceGroup

amazonaws_inspector.CreateResourceGroup({
  "resourceGroupTags": []
}, context)

Input

Output

DeleteAssessmentRun

amazonaws_inspector.DeleteAssessmentRun({
  "assessmentRunArn": ""
}, context)

Input

  • input object
    • assessmentRunArn required Arn

Output

Output schema unknown

DeleteAssessmentTarget

amazonaws_inspector.DeleteAssessmentTarget({
  "assessmentTargetArn": ""
}, context)

Input

  • input object
    • assessmentTargetArn required Arn

Output

Output schema unknown

DeleteAssessmentTemplate

amazonaws_inspector.DeleteAssessmentTemplate({
  "assessmentTemplateArn": ""
}, context)

Input

  • input object
    • assessmentTemplateArn required Arn

Output

Output schema unknown

DescribeAssessmentRuns

amazonaws_inspector.DescribeAssessmentRuns({
  "assessmentRunArns": []
}, context)

Input

Output

DescribeAssessmentTargets

amazonaws_inspector.DescribeAssessmentTargets({
  "assessmentTargetArns": []
}, context)

Input

Output

DescribeAssessmentTemplates

amazonaws_inspector.DescribeAssessmentTemplates({
  "assessmentTemplateArns": []
}, context)

Input

Output

DescribeCrossAccountAccessRole

amazonaws_inspector.DescribeCrossAccountAccessRole({}, context)

Input

  • input object

Output

DescribeFindings

amazonaws_inspector.DescribeFindings({
  "findingArns": []
}, context)

Input

Output

DescribeResourceGroups

amazonaws_inspector.DescribeResourceGroups({
  "resourceGroupArns": []
}, context)

Input

Output

DescribeRulesPackages

amazonaws_inspector.DescribeRulesPackages({
  "rulesPackageArns": []
}, context)

Input

Output

GetAssessmentReport

amazonaws_inspector.GetAssessmentReport({
  "assessmentRunArn": "",
  "reportFileFormat": "",
  "reportType": ""
}, context)

Input

Output

GetTelemetryMetadata

amazonaws_inspector.GetTelemetryMetadata({
  "assessmentRunArn": ""
}, context)

Input

  • input object
    • assessmentRunArn required Arn

Output

ListAssessmentRunAgents

amazonaws_inspector.ListAssessmentRunAgents({
  "assessmentRunArn": ""
}, context)

Input

Output

ListAssessmentRuns

amazonaws_inspector.ListAssessmentRuns({}, context)

Input

Output

ListAssessmentTargets

amazonaws_inspector.ListAssessmentTargets({}, context)

Input

Output

ListAssessmentTemplates

amazonaws_inspector.ListAssessmentTemplates({}, context)

Input

Output

ListEventSubscriptions

amazonaws_inspector.ListEventSubscriptions({}, context)

Input

Output

ListFindings

amazonaws_inspector.ListFindings({}, context)

Input

Output

ListRulesPackages

amazonaws_inspector.ListRulesPackages({}, context)

Input

Output

ListTagsForResource

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

Input

  • input object
    • resourceArn required Arn

Output

PreviewAgents

amazonaws_inspector.PreviewAgents({
  "previewAgentsArn": ""
}, context)

Input

Output

RegisterCrossAccountAccessRole

amazonaws_inspector.RegisterCrossAccountAccessRole({
  "roleArn": ""
}, context)

Input

  • input object
    • roleArn required Arn

Output

Output schema unknown

RemoveAttributesFromFindings

amazonaws_inspector.RemoveAttributesFromFindings({
  "findingArns": [],
  "attributeKeys": []
}, context)

Input

Output

SetTagsForResource

amazonaws_inspector.SetTagsForResource({
  "resourceArn": ""
}, context)

Input

Output

Output schema unknown

StartAssessmentRun

amazonaws_inspector.StartAssessmentRun({
  "assessmentTemplateArn": ""
}, context)

Input

Output

StopAssessmentRun

amazonaws_inspector.StopAssessmentRun({
  "assessmentRunArn": ""
}, context)

Input

Output

Output schema unknown

SubscribeToEvent

amazonaws_inspector.SubscribeToEvent({
  "resourceArn": "",
  "event": "",
  "topicArn": ""
}, context)

Input

Output

Output schema unknown

UnsubscribeFromEvent

amazonaws_inspector.UnsubscribeFromEvent({
  "resourceArn": "",
  "event": "",
  "topicArn": ""
}, context)

Input

Output

Output schema unknown

UpdateAssessmentTarget

amazonaws_inspector.UpdateAssessmentTarget({
  "assessmentTargetArn": "",
  "assessmentTargetName": "",
  "resourceGroupArn": ""
}, context)

Input

Output

Output schema unknown

Definitions

AccessDeniedErrorCode

  • AccessDeniedErrorCode string (values: ACCESS_DENIED_TO_ASSESSMENT_TARGET, ACCESS_DENIED_TO_ASSESSMENT_TEMPLATE, ACCESS_DENIED_TO_ASSESSMENT_RUN, ACCESS_DENIED_TO_FINDING, ACCESS_DENIED_TO_RESOURCE_GROUP, ACCESS_DENIED_TO_RULES_PACKAGE, ACCESS_DENIED_TO_SNS_TOPIC, ACCESS_DENIED_TO_IAM_ROLE)

AccessDeniedException

  • AccessDeniedException object: You do not have required permissions to access the requested resource.

AddAttributesToFindingsRequest

AddAttributesToFindingsResponse

  • AddAttributesToFindingsResponse object

AddRemoveAttributesFindingArnList

  • AddRemoveAttributesFindingArnList array

AgentAlreadyRunningAssessment

  • AgentAlreadyRunningAssessment object: Used in the exception error that is thrown if you start an assessment run for an assessment target that includes an EC2 instance that is already participating in another started assessment run.
    • agentId required AgentId
    • assessmentRunArn required Arn

AgentAlreadyRunningAssessmentList

AgentFilter

  • AgentFilter object: Contains information about an Amazon Inspector agent. This data type is used as a request parameter in the ListAssessmentRunAgents action.

AgentHealth

  • AgentHealth string (values: HEALTHY, UNHEALTHY, UNKNOWN)

AgentHealthCode

  • AgentHealthCode string (values: IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, UNKNOWN)

AgentHealthCodeList

AgentHealthList

AgentId

  • AgentId string

AgentIdList

AgentPreview

AgentPreviewList

AgentVersion

  • AgentVersion string

AgentsAlreadyRunningAssessmentException

  • AgentsAlreadyRunningAssessmentException object: You started an assessment run, but one of the instances is already participating in another assessment run.

AmiId

  • AmiId string

Arn

  • Arn string

ArnCount

  • ArnCount integer

AssessmentRulesPackageArnList

  • AssessmentRulesPackageArnList array

AssessmentRun

AssessmentRunAgent

AssessmentRunAgentList

AssessmentRunDuration

  • AssessmentRunDuration integer

AssessmentRunFilter

AssessmentRunFindingCounts

AssessmentRunInProgressArnList

  • AssessmentRunInProgressArnList array

AssessmentRunInProgressException

  • AssessmentRunInProgressException object: You cannot perform a specified action if an assessment run is currently in progress.

AssessmentRunList

AssessmentRunName

  • AssessmentRunName string

AssessmentRunNotification

AssessmentRunNotificationList

AssessmentRunNotificationSnsStatusCode

  • AssessmentRunNotificationSnsStatusCode string (values: SUCCESS, TOPIC_DOES_NOT_EXIST, ACCESS_DENIED, INTERNAL_ERROR)

AssessmentRunState

  • AssessmentRunState string (values: CREATED, START_DATA_COLLECTION_PENDING, START_DATA_COLLECTION_IN_PROGRESS, COLLECTING_DATA, STOP_DATA_COLLECTION_PENDING, DATA_COLLECTED, START_EVALUATING_RULES_PENDING, EVALUATING_RULES, FAILED, ERROR, COMPLETED, COMPLETED_WITH_ERRORS, CANCELED)

AssessmentRunStateChange

  • AssessmentRunStateChange object: Used as one of the elements of the AssessmentRun data type.

AssessmentRunStateChangeList

AssessmentRunStateList

AssessmentTarget

  • AssessmentTarget object: Contains information about an Amazon Inspector application. This data type is used as the response element in the DescribeAssessmentTargets action.

AssessmentTargetFilter

  • AssessmentTargetFilter object: Used as the request parameter in the ListAssessmentTargets action.

AssessmentTargetList

AssessmentTargetName

  • AssessmentTargetName string

AssessmentTemplate

AssessmentTemplateFilter

AssessmentTemplateList

AssessmentTemplateName

  • AssessmentTemplateName string

AssessmentTemplateRulesPackageArnList

  • AssessmentTemplateRulesPackageArnList array

AssetAttributes

AssetType

  • AssetType string (values: ec2-instance)

Attribute

  • Attribute object: This data type is used as a request parameter in the AddAttributesToFindings and CreateAssessmentTemplate actions.

AttributeKey

  • AttributeKey string

AttributeList

AttributeValue

  • AttributeValue string

AutoScalingGroup

  • AutoScalingGroup string

AutoScalingGroupList

BatchDescribeArnList

  • BatchDescribeArnList array

Bool

  • Bool boolean

CreateAssessmentTargetRequest

  • CreateAssessmentTargetRequest object

CreateAssessmentTargetResponse

  • CreateAssessmentTargetResponse object
    • assessmentTargetArn required Arn

CreateAssessmentTemplateRequest

CreateAssessmentTemplateResponse

  • CreateAssessmentTemplateResponse object
    • assessmentTemplateArn required Arn

CreateResourceGroupRequest

CreateResourceGroupResponse

  • CreateResourceGroupResponse object
    • resourceGroupArn required Arn

DeleteAssessmentRunRequest

  • DeleteAssessmentRunRequest object
    • assessmentRunArn required Arn

DeleteAssessmentTargetRequest

  • DeleteAssessmentTargetRequest object
    • assessmentTargetArn required Arn

DeleteAssessmentTemplateRequest

  • DeleteAssessmentTemplateRequest object
    • assessmentTemplateArn required Arn

DescribeAssessmentRunsRequest

DescribeAssessmentRunsResponse

DescribeAssessmentTargetsRequest

DescribeAssessmentTargetsResponse

DescribeAssessmentTemplatesRequest

DescribeAssessmentTemplatesResponse

DescribeCrossAccountAccessRoleResponse

  • DescribeCrossAccountAccessRoleResponse object

DescribeFindingsRequest

DescribeFindingsResponse

DescribeResourceGroupsRequest

DescribeResourceGroupsResponse

DescribeRulesPackagesRequest

DescribeRulesPackagesResponse

DurationRange

ErrorMessage

  • ErrorMessage string

EventSubscription

  • EventSubscription object: This data type is used in the Subscription data type.

EventSubscriptionList

FailedItemDetails

  • FailedItemDetails object: Includes details about the failed items.

FailedItemErrorCode

  • FailedItemErrorCode string (values: INVALID_ARN, DUPLICATE_ARN, ITEM_DOES_NOT_EXIST, ACCESS_DENIED, LIMIT_EXCEEDED, INTERNAL_ERROR)

FailedItems

FilterRulesPackageArnList

  • FilterRulesPackageArnList array

Finding

FindingCount

  • FindingCount integer

FindingFilter

FindingId

  • FindingId string

FindingList

GetAssessmentReportRequest

GetAssessmentReportResponse

GetTelemetryMetadataRequest

  • GetTelemetryMetadataRequest object
    • assessmentRunArn required Arn

GetTelemetryMetadataResponse

Hostname

  • Hostname string

InspectorEvent

  • InspectorEvent string (values: ASSESSMENT_RUN_STARTED, ASSESSMENT_RUN_COMPLETED, ASSESSMENT_RUN_STATE_CHANGED, FINDING_REPORTED, OTHER)

InspectorServiceAttributes

  • InspectorServiceAttributes object: This data type is used in the Finding data type.

InternalException

  • InternalException object: Internal server error.

InvalidCrossAccountRoleErrorCode

  • InvalidCrossAccountRoleErrorCode string (values: ROLE_DOES_NOT_EXIST_OR_INVALID_TRUST_RELATIONSHIP, ROLE_DOES_NOT_HAVE_CORRECT_POLICY)

InvalidCrossAccountRoleException

  • InvalidCrossAccountRoleException object: Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the assessment run.

InvalidInputErrorCode

  • InvalidInputErrorCode string (values: INVALID_ASSESSMENT_TARGET_ARN, INVALID_ASSESSMENT_TEMPLATE_ARN, INVALID_ASSESSMENT_RUN_ARN, INVALID_FINDING_ARN, INVALID_RESOURCE_GROUP_ARN, INVALID_RULES_PACKAGE_ARN, INVALID_RESOURCE_ARN, INVALID_SNS_TOPIC_ARN, INVALID_IAM_ROLE_ARN, INVALID_ASSESSMENT_TARGET_NAME, INVALID_ASSESSMENT_TARGET_NAME_PATTERN, INVALID_ASSESSMENT_TEMPLATE_NAME, INVALID_ASSESSMENT_TEMPLATE_NAME_PATTERN, INVALID_ASSESSMENT_TEMPLATE_DURATION, INVALID_ASSESSMENT_TEMPLATE_DURATION_RANGE, INVALID_ASSESSMENT_RUN_DURATION_RANGE, INVALID_ASSESSMENT_RUN_START_TIME_RANGE, INVALID_ASSESSMENT_RUN_COMPLETION_TIME_RANGE, INVALID_ASSESSMENT_RUN_STATE_CHANGE_TIME_RANGE, INVALID_ASSESSMENT_RUN_STATE, INVALID_TAG, INVALID_TAG_KEY, INVALID_TAG_VALUE, INVALID_RESOURCE_GROUP_TAG_KEY, INVALID_RESOURCE_GROUP_TAG_VALUE, INVALID_ATTRIBUTE, INVALID_USER_ATTRIBUTE, INVALID_USER_ATTRIBUTE_KEY, INVALID_USER_ATTRIBUTE_VALUE, INVALID_PAGINATION_TOKEN, INVALID_MAX_RESULTS, INVALID_AGENT_ID, INVALID_AUTO_SCALING_GROUP, INVALID_RULE_NAME, INVALID_SEVERITY, INVALID_LOCALE, INVALID_EVENT, ASSESSMENT_TARGET_NAME_ALREADY_TAKEN, ASSESSMENT_TEMPLATE_NAME_ALREADY_TAKEN, INVALID_NUMBER_OF_ASSESSMENT_TARGET_ARNS, INVALID_NUMBER_OF_ASSESSMENT_TEMPLATE_ARNS, INVALID_NUMBER_OF_ASSESSMENT_RUN_ARNS, INVALID_NUMBER_OF_FINDING_ARNS, INVALID_NUMBER_OF_RESOURCE_GROUP_ARNS, INVALID_NUMBER_OF_RULES_PACKAGE_ARNS, INVALID_NUMBER_OF_ASSESSMENT_RUN_STATES, INVALID_NUMBER_OF_TAGS, INVALID_NUMBER_OF_RESOURCE_GROUP_TAGS, INVALID_NUMBER_OF_ATTRIBUTES, INVALID_NUMBER_OF_USER_ATTRIBUTES, INVALID_NUMBER_OF_AGENT_IDS, INVALID_NUMBER_OF_AUTO_SCALING_GROUPS, INVALID_NUMBER_OF_RULE_NAMES, INVALID_NUMBER_OF_SEVERITIES)

InvalidInputException

  • InvalidInputException object: The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

IocConfidence

  • IocConfidence integer

Ipv4Address

  • Ipv4Address string

Ipv4AddressList

KernelVersion

  • KernelVersion string

LimitExceededErrorCode

  • LimitExceededErrorCode string (values: ASSESSMENT_TARGET_LIMIT_EXCEEDED, ASSESSMENT_TEMPLATE_LIMIT_EXCEEDED, ASSESSMENT_RUN_LIMIT_EXCEEDED, RESOURCE_GROUP_LIMIT_EXCEEDED, EVENT_SUBSCRIPTION_LIMIT_EXCEEDED)

LimitExceededException

  • LimitExceededException object: The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

ListAssessmentRunAgentsRequest

ListAssessmentRunAgentsResponse

ListAssessmentRunsRequest

ListAssessmentRunsResponse

ListAssessmentTargetsRequest

ListAssessmentTargetsResponse

ListAssessmentTemplatesRequest

ListAssessmentTemplatesResponse

ListEventSubscriptionsMaxResults

  • ListEventSubscriptionsMaxResults integer

ListEventSubscriptionsRequest

ListEventSubscriptionsResponse

ListFindingsRequest

ListFindingsResponse

ListMaxResults

  • ListMaxResults integer

ListParentArnList

  • ListParentArnList array

ListReturnedArnList

  • ListReturnedArnList array

ListRulesPackagesRequest

ListRulesPackagesResponse

ListTagsForResourceRequest

  • ListTagsForResourceRequest object
    • resourceArn required Arn

ListTagsForResourceResponse

  • ListTagsForResourceResponse object

Locale

  • Locale string (values: EN_US)

Long

  • Long integer

Message

  • Message string

MessageType

  • MessageType string

NamePattern

  • NamePattern string

NoSuchEntityErrorCode

  • NoSuchEntityErrorCode string (values: ASSESSMENT_TARGET_DOES_NOT_EXIST, ASSESSMENT_TEMPLATE_DOES_NOT_EXIST, ASSESSMENT_RUN_DOES_NOT_EXIST, FINDING_DOES_NOT_EXIST, RESOURCE_GROUP_DOES_NOT_EXIST, RULES_PACKAGE_DOES_NOT_EXIST, SNS_TOPIC_DOES_NOT_EXIST, IAM_ROLE_DOES_NOT_EXIST)

NoSuchEntityException

  • NoSuchEntityException object: The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

NumericSeverity

  • NumericSeverity number

NumericVersion

  • NumericVersion integer

OperatingSystem

  • OperatingSystem string

PaginationToken

  • PaginationToken string

PreviewAgentsMaxResults

  • PreviewAgentsMaxResults integer

PreviewAgentsRequest

PreviewAgentsResponse

ProviderName

  • ProviderName string

RegisterCrossAccountAccessRoleRequest

  • RegisterCrossAccountAccessRoleRequest object
    • roleArn required Arn

RemoveAttributesFromFindingsRequest

RemoveAttributesFromFindingsResponse

  • RemoveAttributesFromFindingsResponse object

ReportFileFormat

  • ReportFileFormat string (values: HTML, PDF)

ReportStatus

  • ReportStatus string (values: WORK_IN_PROGRESS, FAILED, COMPLETED)

ReportType

  • ReportType string (values: FINDING, FULL)

ResourceGroup

  • ResourceGroup object: Contains information about a resource group. The resource group defines a set of tags that, when queried, identify the AWS resources that make up the assessment target. This data type is used as the response element in the DescribeResourceGroups action.

ResourceGroupList

ResourceGroupTag

  • ResourceGroupTag object: This data type is used as one of the elements of the ResourceGroup data type.

ResourceGroupTags

RuleName

  • RuleName string

RuleNameList

RulesPackage

  • RulesPackage object: Contains information about an Amazon Inspector rules package. This data type is used as the response element in the DescribeRulesPackages action.

RulesPackageList

RulesPackageName

  • RulesPackageName string

ServiceName

  • ServiceName string

SetTagsForResourceRequest

  • SetTagsForResourceRequest object

Severity

  • Severity string (values: Low, Medium, High, Informational, Undefined)

SeverityList

StartAssessmentRunRequest

  • StartAssessmentRunRequest object

StartAssessmentRunResponse

  • StartAssessmentRunResponse object
    • assessmentRunArn required Arn

StopAction

  • StopAction string (values: START_EVALUATION, SKIP_EVALUATION)

StopAssessmentRunRequest

  • StopAssessmentRunRequest object

SubscribeToEventRequest

  • SubscribeToEventRequest object

Subscription

  • Subscription object: This data type is used as a response element in the ListEventSubscriptions action.

SubscriptionList

Tag

  • Tag object: A key and value pair. This data type is used as a request parameter in the SetTagsForResource action and a response element in the ListTagsForResource action.

TagKey

  • TagKey string

TagList

  • TagList array

TagValue

  • TagValue string

TelemetryMetadata

  • TelemetryMetadata object: The metadata about the Amazon Inspector application data metrics collected by the agent. This data type is used as the response element in the GetTelemetryMetadata action.

TelemetryMetadataList

Text

  • Text string

Timestamp

  • Timestamp string

TimestampRange

  • TimestampRange object: This data type is used in the AssessmentRunFilter data type.

UnsubscribeFromEventRequest

  • UnsubscribeFromEventRequest object

UnsupportedFeatureException

  • UnsupportedFeatureException object: Used by the GetAssessmentReport API. The request was rejected because you tried to generate a report for an assessment run that existed before reporting was supported in Amazon Inspector. You can only generate reports for assessment runs that took place or will take place after generating reports in Amazon Inspector became available.

UpdateAssessmentTargetRequest

  • UpdateAssessmentTargetRequest object

Url

  • Url string

UserAttributeKeyList

UserAttributeList

Version

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

6 years ago

4.0.0

7 years ago

3.0.4

7 years ago

3.0.3

7 years ago

3.0.2

7 years ago

3.0.1

7 years ago

3.0.0

7 years ago

2.0.2

7 years ago

2.0.1

7 years ago

2.0.0

7 years ago