5.0.0 • Published 5 years ago

@datafire/amazonaws_securityhub v5.0.0

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

@datafire/amazonaws_securityhub

Client library for AWS SecurityHub

Installation and Usage

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

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

Description

Actions

DisableSecurityHub

amazonaws_securityhub.DisableSecurityHub({}, context)

Input

  • input object

Output

DescribeHub

amazonaws_securityhub.DescribeHub({}, context)

Input

  • input object
    • HubArn string

Output

UpdateSecurityHubConfiguration

amazonaws_securityhub.UpdateSecurityHubConfiguration({}, context)

Input

  • input object
    • AutoEnableControls boolean: Whether to automatically enable new controls when they are added to standards that are enabled. By default, this is set to true, and new controls are enabled automatically. To not automatically enable new controls, set this to false.

Output

EnableSecurityHub

amazonaws_securityhub.EnableSecurityHub({}, context)

Input

  • input object
    • EnableDefaultStandards boolean: Whether to enable the security standards that Security Hub has designated as automatically enabled. If you do not provide a value for EnableDefaultStandards, it is set to true. To not enable the automatically enabled standards, set EnableDefaultStandards to false.
    • Tags object: The tags to add to the hub resource when you enable Security Hub.

Output

CreateActionTarget

amazonaws_securityhub.CreateActionTarget({
  "Name": "",
  "Description": "",
  "Id": ""
}, context)

Input

  • input object
    • Description required string: The description for the custom action target.
    • Id required string: The ID for the custom action target.
    • Name required string: The name of the custom action target.

Output

DescribeActionTargets

amazonaws_securityhub.DescribeActionTargets({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • ActionTargetArns array: A list of custom action target ARNs for the custom action targets to retrieve.
    • MaxResults integer: The maximum number of results to return.
    • NextToken string: The token that is required for pagination. On your first call to the DescribeActionTargets operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

Output

DeleteActionTarget

amazonaws_securityhub.DeleteActionTarget({
  "ActionTargetArn": ""
}, context)

Input

  • input object
    • ActionTargetArn required string

Output

UpdateActionTarget

amazonaws_securityhub.UpdateActionTarget({
  "ActionTargetArn": ""
}, context)

Input

  • input object
    • ActionTargetArn required string
    • Description string: The updated description for the custom action target.
    • Name string: The updated name of the custom action target.

Output

UpdateFindings

amazonaws_securityhub.UpdateFindings({
  "Filters": {}
}, context)

Input

Output

GetFindings

amazonaws_securityhub.GetFindings({}, context)

Input

Output

BatchUpdateFindings

amazonaws_securityhub.BatchUpdateFindings({
  "FindingIdentifiers": []
}, context)

Input

  • input object
    • Confidence integer: The updated value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.
    • Criticality integer: The updated value for the level of importance assigned to the resources associated with the findings. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
    • FindingIdentifiers required array: The list of findings to update. BatchUpdateFindings can be used to update up to 100 findings at a time. For each finding, the list provides the finding identifier and the ARN of the finding provider.
    • Note object: The updated note.
      • Text
      • UpdatedBy
    • RelatedFindings array: A list of findings that are related to the updated findings.
    • Severity object: Updates to the severity information for a finding.
      • Label
      • Normalized
      • Product
    • Types array: One or more finding types in the format of namespace/category/classifier that classify a finding. Valid namespace values are as follows. Software and Configuration Checks TTPs Effects Unusual Behaviors Sensitive Data Identifications
    • UserDefinedFields object: A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
    • VerificationState string (values: UNKNOWN, TRUE_POSITIVE, FALSE_POSITIVE, BENIGN_POSITIVE): Indicates the veracity of a finding. The available values for VerificationState are as follows. UNKNOWN – The default disposition of a security finding TRUE_POSITIVE – The security finding is confirmed FALSE_POSITIVE – The security finding was determined to be a false alarm BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn't pose any threat, is expected, or both
    • Workflow object: Used to update information about the investigation into the finding.
      • Status

Output

BatchImportFindings

amazonaws_securityhub.BatchImportFindings({
  "Findings": []
}, context)

Input

  • input object
    • Findings required array: A list of findings to import. To successfully import a finding, it must follow the AWS Security Finding Format. Maximum of 100 findings per request.

Output

CreateInsight

amazonaws_securityhub.CreateInsight({
  "Name": "",
  "Filters": {},
  "GroupByAttribute": ""
}, context)

Input

Output

GetInsights

amazonaws_securityhub.GetInsights({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • InsightArns array: The ARNs of the insights to describe. If you do not provide any insight ARNs, then GetInsights returns all of your custom insights. It does not return any managed insights.
    • MaxResults integer: The maximum number of items to return in the response.
    • NextToken string: The token that is required for pagination. On your first call to the GetInsights operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

Output

GetInsightResults

amazonaws_securityhub.GetInsightResults({
  "InsightArn": ""
}, context)

Input

  • input object
    • InsightArn required string

Output

DeleteInsight

amazonaws_securityhub.DeleteInsight({
  "InsightArn": ""
}, context)

Input

  • input object
    • InsightArn required string

Output

UpdateInsight

amazonaws_securityhub.UpdateInsight({
  "InsightArn": ""
}, context)

Input

Output

ListInvitations

amazonaws_securityhub.ListInvitations({}, context)

Input

  • input object
    • MaxResults integer
    • NextToken string

Output

GetInvitationsCount

amazonaws_securityhub.GetInvitationsCount({}, context)

Input

  • input object

Output

DeclineInvitations

amazonaws_securityhub.DeclineInvitations({
  "AccountIds": []
}, context)

Input

  • input object
    • AccountIds required array: The list of account IDs for the accounts from which to decline the invitations to Security Hub.

Output

DeleteInvitations

amazonaws_securityhub.DeleteInvitations({
  "AccountIds": []
}, context)

Input

  • input object
    • AccountIds required array: The list of the account IDs that sent the invitations to delete.

Output

GetMasterAccount

amazonaws_securityhub.GetMasterAccount({}, context)

Input

  • input object

Output

AcceptInvitation

amazonaws_securityhub.AcceptInvitation({
  "MasterId": "",
  "InvitationId": ""
}, context)

Input

  • input object
    • InvitationId required string: The ID of the invitation sent from the Security Hub master account.
    • MasterId required string: The account ID of the Security Hub master account that sent the invitation.

Output

DisassociateFromMasterAccount

amazonaws_securityhub.DisassociateFromMasterAccount({}, context)

Input

  • input object

Output

ListMembers

amazonaws_securityhub.ListMembers({}, context)

Input

  • input object
    • OnlyAssociated boolean
    • MaxResults integer
    • NextToken string

Output

CreateMembers

amazonaws_securityhub.CreateMembers({
  "AccountDetails": []
}, context)

Input

  • input object
    • AccountDetails required array: The list of accounts to associate with the Security Hub master account. For each account, the list includes the account ID and optionally the email address.

Output

DeleteMembers

amazonaws_securityhub.DeleteMembers({
  "AccountIds": []
}, context)

Input

  • input object
    • AccountIds required array: The list of account IDs for the member accounts to delete.

Output

DisassociateMembers

amazonaws_securityhub.DisassociateMembers({
  "AccountIds": []
}, context)

Input

  • input object
    • AccountIds required array: The account IDs of the member accounts to disassociate from the master account.

Output

GetMembers

amazonaws_securityhub.GetMembers({
  "AccountIds": []
}, context)

Input

  • input object
    • AccountIds required array: The list of account IDs for the Security Hub member accounts to return the details for.

Output

InviteMembers

amazonaws_securityhub.InviteMembers({
  "AccountIds": []
}, context)

Input

  • input object
    • AccountIds required array: The list of account IDs of the AWS accounts to invite to Security Hub as members.

Output

ListOrganizationAdminAccounts

amazonaws_securityhub.ListOrganizationAdminAccounts({}, context)

Input

  • input object
    • MaxResults integer
    • NextToken string

Output

DisableOrganizationAdminAccount

amazonaws_securityhub.DisableOrganizationAdminAccount({
  "AdminAccountId": ""
}, context)

Input

  • input object
    • AdminAccountId required string: The AWS account identifier of the Security Hub administrator account.

Output

EnableOrganizationAdminAccount

amazonaws_securityhub.EnableOrganizationAdminAccount({
  "AdminAccountId": ""
}, context)

Input

  • input object
    • AdminAccountId required string: The AWS account identifier of the account to designate as the Security Hub administrator account.

Output

DescribeOrganizationConfiguration

amazonaws_securityhub.DescribeOrganizationConfiguration({}, context)

Input

  • input object

Output

UpdateOrganizationConfiguration

amazonaws_securityhub.UpdateOrganizationConfiguration({
  "AutoEnable": true
}, context)

Input

  • input object
    • AutoEnable required boolean: Whether to automatically enable Security Hub for new accounts in the organization. By default, this is false, and new accounts are not added automatically. To automatically enable Security Hub for new accounts, set this to true.

Output

ListEnabledProductsForImport

amazonaws_securityhub.ListEnabledProductsForImport({}, context)

Input

  • input object
    • NextToken string
    • MaxResults integer

Output

EnableImportFindingsForProduct

amazonaws_securityhub.EnableImportFindingsForProduct({
  "ProductArn": ""
}, context)

Input

  • input object
    • ProductArn required string: The ARN of the product to enable the integration for.

Output

DisableImportFindingsForProduct

amazonaws_securityhub.DisableImportFindingsForProduct({
  "ProductSubscriptionArn": ""
}, context)

Input

  • input object
    • ProductSubscriptionArn required string

Output

DescribeProducts

amazonaws_securityhub.DescribeProducts({}, context)

Input

  • input object
    • NextToken string
    • MaxResults integer

Output

DescribeStandards

amazonaws_securityhub.DescribeStandards({}, context)

Input

  • input object
    • NextToken string
    • MaxResults integer

Output

UpdateStandardsControl

amazonaws_securityhub.UpdateStandardsControl({
  "StandardsControlArn": ""
}, context)

Input

  • input object
    • StandardsControlArn required string
    • ControlStatus string (values: ENABLED, DISABLED): The updated status of the security standard control.
    • DisabledReason string: A description of the reason why you are disabling a security standard control. If you are disabling a control, then this is required.

Output

DescribeStandardsControls

amazonaws_securityhub.DescribeStandardsControls({
  "StandardsSubscriptionArn": ""
}, context)

Input

  • input object
    • StandardsSubscriptionArn required string
    • NextToken string
    • MaxResults integer

Output

BatchDisableStandards

amazonaws_securityhub.BatchDisableStandards({
  "StandardsSubscriptionArns": []
}, context)

Input

  • input object
    • StandardsSubscriptionArns required array: The ARNs of the standards subscriptions to disable.

Output

GetEnabledStandards

amazonaws_securityhub.GetEnabledStandards({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults integer: The maximum number of results to return in the response.
    • NextToken string: The token that is required for pagination. On your first call to the GetEnabledStandards operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
    • StandardsSubscriptionArns array: The list of the standards subscription ARNs for the standards to retrieve.

Output

BatchEnableStandards

amazonaws_securityhub.BatchEnableStandards({
  "StandardsSubscriptionRequests": []
}, context)

Input

Output

ListTagsForResource

amazonaws_securityhub.ListTagsForResource({
  "ResourceArn": ""
}, context)

Input

  • input object
    • ResourceArn required string

Output

TagResource

amazonaws_securityhub.TagResource({
  "ResourceArn": "",
  "Tags": {}
}, context)

Input

  • input object
    • ResourceArn required string
    • Tags required object: The tags to add to the resource.

Output

UntagResource

amazonaws_securityhub.UntagResource({
  "ResourceArn": "",
  "tagKeys": []
}, context)

Input

  • input object
    • ResourceArn required string
    • tagKeys required array

Output

Definitions

AcceptInvitationRequest

  • AcceptInvitationRequest object
    • InvitationId required
    • MasterId required

AcceptInvitationResponse

  • AcceptInvitationResponse object

AccessDeniedException

AccountDetails

  • AccountDetails object: The details of an AWS account.
    • AccountId required
    • Email

AccountDetailsList

AccountId

  • AccountId string

AccountIdList

ActionTarget

  • ActionTarget object: An ActionTarget object.
    • ActionTargetArn required
    • Description required
    • Name required

ActionTargetList

AdminAccount

  • AdminAccount object: Represents a Security Hub administrator account designated by an organization management account.
    • AccountId
    • Status

AdminAccounts

AdminStatus

  • AdminStatus string (values: ENABLED, DISABLE_IN_PROGRESS)

AdminsMaxResults

  • AdminsMaxResults integer

ArnList

AvailabilityZone

  • AvailabilityZone object: Information about an Availability Zone.
    • SubnetId
    • ZoneName

AvailabilityZones

AwsApiGatewayAccessLogSettings

  • AwsApiGatewayAccessLogSettings object: Contains information about settings for logging access for the stage.
    • DestinationArn
    • Format

AwsApiGatewayCanarySettings

  • AwsApiGatewayCanarySettings object: Contains information about settings for canary deployment in the stage.
    • DeploymentId
    • PercentTraffic
    • StageVariableOverrides
    • UseStageCache

AwsApiGatewayEndpointConfiguration

  • AwsApiGatewayEndpointConfiguration object: Contains information about the endpoints for the API.

AwsApiGatewayMethodSettings

  • AwsApiGatewayMethodSettings object: Defines settings for a method for the stage.
    • CacheDataEncrypted
    • CacheTtlInSeconds
    • CachingEnabled
    • DataTraceEnabled
    • HttpMethod
    • LoggingLevel
    • MetricsEnabled
    • RequireAuthorizationForCacheControl
    • ResourcePath
    • ThrottlingBurstLimit
    • ThrottlingRateLimit
    • UnauthorizedCacheControlHeaderStrategy

AwsApiGatewayMethodSettingsList

AwsApiGatewayRestApiDetails

  • AwsApiGatewayRestApiDetails object: contains information about a REST API in version 1 of Amazon API Gateway.
    • ApiKeySource
    • BinaryMediaTypes
    • CreatedDate
    • Description
    • EndpointConfiguration
    • Id
    • MinimumCompressionSize
    • Name
    • Version

AwsApiGatewayStageDetails

  • AwsApiGatewayStageDetails object: Provides information about a version 1 Amazon API Gateway stage.
    • AccessLogSettings
      • DestinationArn
      • Format
    • CacheClusterEnabled
    • CacheClusterSize
    • CacheClusterStatus
    • CanarySettings
      • DeploymentId
      • PercentTraffic
      • StageVariableOverrides
      • UseStageCache
    • ClientCertificateId
    • CreatedDate
    • DeploymentId
    • Description
    • DocumentationVersion
    • LastUpdatedDate
    • MethodSettings
    • StageName
    • TracingEnabled
    • Variables
    • WebAclArn

AwsApiGatewayV2ApiDetails

  • AwsApiGatewayV2ApiDetails object: Contains information about a version 2 API in Amazon API Gateway.

AwsApiGatewayV2RouteSettings

  • AwsApiGatewayV2RouteSettings object: Contains route settings for a stage.
    • DataTraceEnabled
    • DetailedMetricsEnabled
    • LoggingLevel
    • ThrottlingBurstLimit
    • ThrottlingRateLimit

AwsApiGatewayV2StageDetails

  • AwsApiGatewayV2StageDetails object: Contains information about a version 2 stage for Amazon API Gateway.
    • AccessLogSettings
      • DestinationArn
      • Format
    • ApiGatewayManaged
    • AutoDeploy
    • CreatedDate
    • DefaultRouteSettings
      • DataTraceEnabled
      • DetailedMetricsEnabled
      • LoggingLevel
      • ThrottlingBurstLimit
      • ThrottlingRateLimit
    • DeploymentId
    • Description
    • LastDeploymentStatusMessage
    • LastUpdatedDate
    • RouteSettings
      • DataTraceEnabled
      • DetailedMetricsEnabled
      • LoggingLevel
      • ThrottlingBurstLimit
      • ThrottlingRateLimit
    • StageName
    • StageVariables

AwsAutoScalingAutoScalingGroupDetails

  • AwsAutoScalingAutoScalingGroupDetails object: Provides details about an auto scaling group.
    • CreatedTime
    • HealthCheckGracePeriod
    • HealthCheckType
    • LaunchConfigurationName
    • LoadBalancerNames

AwsCertificateManagerCertificateDetails

AwsCertificateManagerCertificateDomainValidationOption

  • AwsCertificateManagerCertificateDomainValidationOption object: Contains information about one of the following: The initial validation of each domain name that occurs as a result of the RequestCertificate request The validation of each domain name in the certificate, as it pertains to AWS Certificate Manager managed renewal
    • DomainName
    • ResourceRecord
      • Name
      • Type
      • Value
    • ValidationDomain
    • ValidationEmails
    • ValidationMethod
    • ValidationStatus

AwsCertificateManagerCertificateDomainValidationOptions

AwsCertificateManagerCertificateExtendedKeyUsage

  • AwsCertificateManagerCertificateExtendedKeyUsage object: Contains information about an extended key usage X.509 v3 extension object.
    • Name
    • OId

AwsCertificateManagerCertificateExtendedKeyUsages

AwsCertificateManagerCertificateKeyUsage

  • AwsCertificateManagerCertificateKeyUsage object: Contains information about a key usage X.509 v3 extension object.
    • Name

AwsCertificateManagerCertificateKeyUsages

AwsCertificateManagerCertificateOptions

  • AwsCertificateManagerCertificateOptions object: Contains other options for the certificate.
    • CertificateTransparencyLoggingPreference

AwsCertificateManagerCertificateRenewalSummary

  • AwsCertificateManagerCertificateRenewalSummary object: Contains information about the AWS Certificate Manager managed renewal for an AMAZON_ISSUED certificate.

AwsCertificateManagerCertificateResourceRecord

  • AwsCertificateManagerCertificateResourceRecord object: Provides details about the CNAME record that is added to the DNS database for domain validation.
    • Name
    • Type
    • Value

AwsCloudFrontDistributionCacheBehavior

  • AwsCloudFrontDistributionCacheBehavior object: Information about a cache behavior for the distribution.
    • ViewerProtocolPolicy

AwsCloudFrontDistributionCacheBehaviors

AwsCloudFrontDistributionCacheBehaviorsItemList

AwsCloudFrontDistributionDefaultCacheBehavior

  • AwsCloudFrontDistributionDefaultCacheBehavior object: Contains information about the default cache configuration for the distribution.
    • ViewerProtocolPolicy

AwsCloudFrontDistributionDetails

AwsCloudFrontDistributionLogging

  • AwsCloudFrontDistributionLogging object: A complex type that controls whether access logs are written for the distribution.
    • Bucket
    • Enabled
    • IncludeCookies
    • Prefix

AwsCloudFrontDistributionOriginGroup

  • AwsCloudFrontDistributionOriginGroup object: Information about an origin group for the distribution.
    • FailoverCriteria
      • StatusCodes

AwsCloudFrontDistributionOriginGroupFailover

  • AwsCloudFrontDistributionOriginGroupFailover object: Provides information about when an origin group fails over.
    • StatusCodes

AwsCloudFrontDistributionOriginGroupFailoverStatusCodes

  • AwsCloudFrontDistributionOriginGroupFailoverStatusCodes object: The status codes that cause an origin group to fail over.

AwsCloudFrontDistributionOriginGroupFailoverStatusCodesItemList

  • AwsCloudFrontDistributionOriginGroupFailoverStatusCodesItemList array

AwsCloudFrontDistributionOriginGroups

AwsCloudFrontDistributionOriginGroupsItemList

AwsCloudFrontDistributionOriginItem

  • AwsCloudFrontDistributionOriginItem object: A complex type that describes the Amazon S3 bucket, HTTP server (for example, a web server), Amazon Elemental MediaStore, or other server from which CloudFront gets your files.
    • DomainName
    • Id
    • OriginPath
    • S3OriginConfig
      • OriginAccessIdentity

AwsCloudFrontDistributionOriginItemList

AwsCloudFrontDistributionOriginS3OriginConfig

  • AwsCloudFrontDistributionOriginS3OriginConfig object: Information about an origin that is an S3 bucket that is not configured with static website hosting.
    • OriginAccessIdentity

AwsCloudFrontDistributionOrigins

  • AwsCloudFrontDistributionOrigins object: A complex type that contains information about origins and origin groups for this distribution.

AwsCloudTrailTrailDetails

  • AwsCloudTrailTrailDetails object: Provides details about a CloudTrail trail.
    • CloudWatchLogsLogGroupArn
    • CloudWatchLogsRoleArn
    • HasCustomEventSelectors
    • HomeRegion
    • IncludeGlobalServiceEvents
    • IsMultiRegionTrail
    • IsOrganizationTrail
    • KmsKeyId
    • LogFileValidationEnabled
    • Name
    • S3BucketName
    • S3KeyPrefix
    • SnsTopicArn
    • SnsTopicName
    • TrailArn

AwsCodeBuildProjectDetails

  • AwsCodeBuildProjectDetails object: Information about an AWS CodeBuild project.
    • EncryptionKey
    • Environment
      • Certificate
      • ImagePullCredentialsType
      • RegistryCredential
        • Credential
        • CredentialProvider
      • Type
    • Name
    • ServiceRole
    • Source
      • GitCloneDepth
      • InsecureSsl
      • Location
      • Type
    • VpcConfig

AwsCodeBuildProjectEnvironment

  • AwsCodeBuildProjectEnvironment object: Information about the build environment for this build project.
    • Certificate
    • ImagePullCredentialsType
    • RegistryCredential
      • Credential
      • CredentialProvider
    • Type

AwsCodeBuildProjectEnvironmentRegistryCredential

  • AwsCodeBuildProjectEnvironmentRegistryCredential object: The credentials for access to a private registry.
    • Credential
    • CredentialProvider

AwsCodeBuildProjectSource

  • AwsCodeBuildProjectSource object: Information about the build input source code for this build project.
    • GitCloneDepth
    • InsecureSsl
    • Location
    • Type

AwsCodeBuildProjectVpcConfig

  • AwsCodeBuildProjectVpcConfig object: Information about the VPC configuration that AWS CodeBuild accesses.

AwsCorsConfiguration

  • AwsCorsConfiguration object: Contains the cross-origin resource sharing (CORS) configuration for the API. CORS is only supported for HTTP APIs.

AwsDynamoDbTableAttributeDefinition

  • AwsDynamoDbTableAttributeDefinition object: Contains a definition of an attribute for the table.
    • AttributeName
    • AttributeType

AwsDynamoDbTableAttributeDefinitionList

AwsDynamoDbTableBillingModeSummary

  • AwsDynamoDbTableBillingModeSummary object: Provides information about the billing for read/write capacity on the table.
    • BillingMode
    • LastUpdateToPayPerRequestDateTime

AwsDynamoDbTableDetails

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

5 years ago