@datafire/amazonaws_accessanalyzer NPM

@datafire/amazonaws_accessanalyzer

Client library for Access Analyzer

Installation and Usage

npm install --save @datafire/amazonaws_accessanalyzer

let amazonaws_accessanalyzer = require('@datafire/amazonaws_accessanalyzer').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

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

Description

Actions

ListAnalyzedResources

amazonaws_accessanalyzer.ListAnalyzedResources({
  "analyzerArn": ""
}, context)

Input

input object
- maxResults string
- nextToken string
- analyzerArn required string: The ARN of the analyzer to retrieve a list of analyzed resources from.
- maxResults integer: The maximum number of results to return in the response.
- nextToken string: A token used for pagination of results returned.
- resourceType string (values: AWS::S3::Bucket, AWS::IAM::Role, AWS::SQS::Queue, AWS::Lambda::Function, AWS::Lambda::LayerVersion, AWS::KMS::Key): The type of resource.

Output

output ListAnalyzedResourcesResponse

GetAnalyzedResource

amazonaws_accessanalyzer.GetAnalyzedResource({
  "analyzerArn": "",
  "resourceArn": ""
}, context)

Input

input object
- analyzerArn required string
- resourceArn required string

Output

output GetAnalyzedResourceResponse

ListAnalyzers

amazonaws_accessanalyzer.ListAnalyzers({}, context)

Input

input object
- maxResults integer
- nextToken string
- type string

Output

output ListAnalyzersResponse

CreateAnalyzer

amazonaws_accessanalyzer.CreateAnalyzer({
  "analyzerName": "",
  "type": ""
}, context)

Input

input object
- tags object: The tags to apply to the analyzer.
- analyzerName required string: The name of the analyzer to create.
- archiveRules array: Specifies the archive rules to add for the analyzer. Archive rules automatically archive findings that meet the criteria you define for the rule.
  - items InlineArchiveRule
- clientToken string: A client token.
- type required string (values: ACCOUNT, ORGANIZATION): The type of analyzer to create. Only ACCOUNT analyzers are supported. You can create only one analyzer per account per Region.

Output

output CreateAnalyzerResponse

DeleteAnalyzer

amazonaws_accessanalyzer.DeleteAnalyzer({
  "analyzerName": ""
}, context)

Input

input object
- analyzerName required string
- clientToken string

Output

Output schema unknown

GetAnalyzer

amazonaws_accessanalyzer.GetAnalyzer({
  "analyzerName": ""
}, context)

Input

input object
- analyzerName required string

Output

output GetAnalyzerResponse

ListArchiveRules

amazonaws_accessanalyzer.ListArchiveRules({
  "analyzerName": ""
}, context)

Input

input object
- analyzerName required string
- maxResults integer
- nextToken string

Output

output ListArchiveRulesResponse

CreateArchiveRule

amazonaws_accessanalyzer.CreateArchiveRule({
  "analyzerName": "",
  "filter": {},
  "ruleName": ""
}, context)

Input

input object
- analyzerName required string
- clientToken string: A client token.
- filter required object: The criteria for the rule.
- ruleName required string: The name of the rule to create.

Output

Output schema unknown

DeleteArchiveRule

amazonaws_accessanalyzer.DeleteArchiveRule({
  "analyzerName": "",
  "ruleName": ""
}, context)

Input

input object
- analyzerName required string
- clientToken string
- ruleName required string

Output

Output schema unknown

GetArchiveRule

amazonaws_accessanalyzer.GetArchiveRule({
  "analyzerName": "",
  "ruleName": ""
}, context)

Input

input object
- analyzerName required string
- ruleName required string

Output

output GetArchiveRuleResponse

UpdateArchiveRule

amazonaws_accessanalyzer.UpdateArchiveRule({
  "analyzerName": "",
  "ruleName": "",
  "filter": {}
}, context)

Input

input object
- analyzerName required string
- ruleName required string
- clientToken string: A client token.
- filter required object: A filter to match for the rules to update. Only rules that match the filter are updated.

Output

Output schema unknown

ApplyArchiveRule

amazonaws_accessanalyzer.ApplyArchiveRule({
  "analyzerArn": "",
  "ruleName": ""
}, context)

Input

input object
- analyzerArn required string: The Amazon resource name (ARN) of the analyzer.
- clientToken string: A client token.
- ruleName required string: The name of the rule to apply.

Output

Output schema unknown

ListFindings

amazonaws_accessanalyzer.ListFindings({
  "analyzerArn": ""
}, context)

Input

input object
- maxResults string
- nextToken string
- analyzerArn required string: The ARN of the analyzer to retrieve findings from.
- filter object: A filter to match for the findings to return.
- maxResults integer: The maximum number of results to return in the response.
- nextToken string: A token used for pagination of results returned.
- sort object: The criteria used to sort.
  - attributeName
  - orderBy

Output

output ListFindingsResponse

UpdateFindings

amazonaws_accessanalyzer.UpdateFindings({
  "analyzerArn": "",
  "status": ""
}, context)

Input

input object
- analyzerArn required string: The ARN of the analyzer that generated the findings to update.
- clientToken string: A client token.
- ids array: The IDs of the findings to update.
  - items FindingId
- resourceArn string: The ARN of the resource identified in the finding.
- status required string (values: ACTIVE, ARCHIVED): The state represents the action to take to update the finding Status. Use ARCHIVE to change an Active finding to an Archived finding. Use ACTIVE to change an Archived finding to an Active finding.

Output

Output schema unknown

GetFinding

amazonaws_accessanalyzer.GetFinding({
  "analyzerArn": "",
  "id": ""
}, context)

Input

input object
- analyzerArn required string
- id required string

Output

output GetFindingResponse

StartResourceScan

amazonaws_accessanalyzer.StartResourceScan({
  "analyzerArn": "",
  "resourceArn": ""
}, context)

Input

input object
- analyzerArn required string: The ARN of the analyzer to use to scan the policies applied to the specified resource.
- resourceArn required string: The ARN of the resource to scan.

Output

Output schema unknown

ListTagsForResource

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

Input

input object
- resourceArn required string

Output

output ListTagsForResourceResponse

TagResource

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

Input

input object
- resourceArn required string
- tags required object: The tags to add to the resource.

Output

output TagResourceResponse

UntagResource

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

Input

input object
- resourceArn required string
- tagKeys required array

Output

output UntagResourceResponse

Definitions

AccessDeniedException

ActionList

ActionList array
- items String

AnalyzedResource

AnalyzedResource object: Contains details about the analyzed resource.
- actions
  - items String
- analyzedAt required
- createdAt required
- error
- isPublic required
- resourceArn required
- resourceOwnerAccount required
- resourceType required
- sharedVia
  - items String
- status
- updatedAt required

AnalyzedResourceSummary

AnalyzedResourceSummary object: Contains the ARN of the analyzed resource.
- resourceArn required
- resourceOwnerAccount required
- resourceType required

AnalyzedResourcesList

AnalyzedResourcesList array
- items AnalyzedResourceSummary

AnalyzerArn

AnalyzerArn string

AnalyzerStatus

AnalyzerStatus string (values: ACTIVE, CREATING, DISABLED, FAILED)

AnalyzerSummary

AnalyzerSummary object: Contains information about the analyzer.
- tags
- arn required
- createdAt required
- lastResourceAnalyzed
- lastResourceAnalyzedAt
- name required
- status required
- statusReason
  - code required
- type required

AnalyzersList

AnalyzersList array
- items AnalyzerSummary

ApplyArchiveRuleRequest

ApplyArchiveRuleRequest object: Retroactively applies an archive rule.
- analyzerArn required
- clientToken
- ruleName required

ArchiveRuleSummary

ArchiveRuleSummary object: Contains information about an archive rule.
- createdAt required
- filter required
- ruleName required
- updatedAt required

ArchiveRulesList

ArchiveRulesList array
- items ArchiveRuleSummary

Boolean

Boolean boolean

ConditionKeyMap

ConditionKeyMap object

ConflictException

CreateAnalyzerRequest

CreateAnalyzerRequest object: Creates an analyzer.
- tags
- analyzerName required
- archiveRules
  - items InlineArchiveRule
- clientToken
- type required

CreateAnalyzerResponse

CreateAnalyzerResponse object: The response to the request to create an analyzer.
- arn

CreateArchiveRuleRequest

CreateArchiveRuleRequest object: Creates an archive rule.
- clientToken
- filter required
- ruleName required

Criterion

Criterion object: The criteria to use in the filter that defines the archive rule.
- contains
  - items String
- eq
  - items String
- exists
- neq
  - items String

DeleteAnalyzerRequest

DeleteAnalyzerRequest object: Deletes an analyzer.

DeleteArchiveRuleRequest

DeleteArchiveRuleRequest object: Deletes an archive rule.

FilterCriteriaMap

FilterCriteriaMap object

Finding

Finding object: Contains information about a finding.
- action
  - items String
- analyzedAt required
- condition required
- createdAt required
- error
- id required
- isPublic
- principal
- resource
- resourceOwnerAccount required
- resourceType required
- sources
  - items FindingSource
- status required
- updatedAt required

FindingId

FindingId string

FindingIdList

FindingIdList array
- items FindingId

FindingSource

FindingSource object: The source of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.
- detail
  - accessPointArn
- type required

FindingSourceDetail

FindingSourceDetail object: Includes details about how the access that generated the finding is granted. This is populated for Amazon S3 bucket findings.
- accessPointArn

FindingSourceList

FindingSourceList array
- items FindingSource

FindingSourceType

FindingSourceType string (values: POLICY, BUCKET_ACL, S3_ACCESS_POINT)

FindingStatus

FindingStatus string (values: ACTIVE, ARCHIVED, RESOLVED)

FindingStatusUpdate

FindingStatusUpdate string (values: ACTIVE, ARCHIVED)

FindingSummary

FindingSummary object: Contains information about a finding.
- action
  - items String
- analyzedAt required
- condition required
- createdAt required
- error
- id required
- isPublic
- principal
- resource
- resourceOwnerAccount required
- resourceType required
- sources
  - items FindingSource
- status required
- updatedAt required

FindingsList

FindingsList array
- items FindingSummary

GetAnalyzedResourceRequest

GetAnalyzedResourceRequest object: Retrieves an analyzed resource.

GetAnalyzedResourceResponse

GetAnalyzedResourceResponse object: The response to the request.
- resource
  - actions
    - items String
  - analyzedAt required
  - createdAt required
  - error
  - isPublic required
  - resourceArn required
  - resourceOwnerAccount required
  - resourceType required
  - sharedVia
    - items String
  - status
  - updatedAt required

GetAnalyzerRequest

GetAnalyzerRequest object: Retrieves an analyzer.

GetAnalyzerResponse

GetAnalyzerResponse object: The response to the request.
- analyzer required
  - tags
  - arn required
  - createdAt required
  - lastResourceAnalyzed
  - lastResourceAnalyzedAt
  - name required
  - status required
  - statusReason
    - code required
  - type required

GetArchiveRuleRequest

GetArchiveRuleRequest object: Retrieves an archive rule.

GetArchiveRuleResponse

GetArchiveRuleResponse object: The response to the request.
- archiveRule required ArchiveRuleSummary

GetFindingRequest

GetFindingRequest object: Retrieves a finding.

GetFindingResponse

GetFindingResponse object: The response to the request.
- finding
  - action
    - items String
  - analyzedAt required
  - condition required
  - createdAt required
  - error
  - id required
  - isPublic
  - principal
  - resource
  - resourceOwnerAccount required
  - resourceType required
  - sources
    - items FindingSource
  - status required
  - updatedAt required

InlineArchiveRule

InlineArchiveRule object: An criterion statement in an archive rule. Each archive rule may have multiple criteria.
- filter required
- ruleName required

InlineArchiveRulesList

InlineArchiveRulesList array
- items InlineArchiveRule

Integer

Integer integer

InternalServerException

ListAnalyzedResourcesRequest

ListAnalyzedResourcesRequest object: Retrieves a list of resources that have been analyzed.
- analyzerArn required
- maxResults
- nextToken
- resourceType

ListAnalyzedResourcesResponse

ListAnalyzedResourcesResponse object: The response to the request.
- analyzedResources required
  - items AnalyzedResourceSummary
- nextToken

ListAnalyzersRequest

ListAnalyzersRequest object: Retrieves a list of analyzers.

ListAnalyzersResponse

ListAnalyzersResponse object: The response to the request.
- analyzers required
  - items AnalyzerSummary
- nextToken

ListArchiveRulesRequest

ListArchiveRulesRequest object: Retrieves a list of archive rules created for the specified analyzer.

ListArchiveRulesResponse

ListArchiveRulesResponse object: The response to the request.
- archiveRules required
  - items ArchiveRuleSummary
- nextToken

ListFindingsRequest

ListFindingsRequest object: Retrieves a list of findings generated by the specified analyzer.
- analyzerArn required
- filter
- maxResults
- nextToken
- sort
  - attributeName
  - orderBy

ListFindingsResponse

ListFindingsResponse object: The response to the request.
- findings required
  - items FindingSummary
- nextToken

ListTagsForResourceRequest

ListTagsForResourceRequest object: Retrieves a list of tags applied to the specified resource.

ListTagsForResourceResponse

ListTagsForResourceResponse object: The response to the request.
- tags

Name

Name string

OrderBy

OrderBy string (values: ASC, DESC)

PrincipalMap

PrincipalMap object

ReasonCode

ReasonCode string (values: AWS_SERVICE_ACCESS_DISABLED, DELEGATED_ADMINISTRATOR_DEREGISTERED, ORGANIZATION_DELETED, SERVICE_LINKED_ROLE_CREATION_FAILED)

ResourceArn

ResourceArn string

ResourceNotFoundException

ResourceType

ResourceType string (values: AWS::S3::Bucket, AWS::IAM::Role, AWS::SQS::Queue, AWS::Lambda::Function, AWS::Lambda::LayerVersion, AWS::KMS::Key)

ServiceQuotaExceededException

SharedViaList

SharedViaList array
- items String

SortCriteria

SortCriteria object: The criteria used to sort.
- attributeName
- orderBy

StartResourceScanRequest

StartResourceScanRequest object: Starts a scan of the policies applied to the specified resource.
- analyzerArn required
- resourceArn required

StatusReason

StatusReason object: Provides more details about the current status of the analyzer. For example, if the creation for the analyzer fails, a Failed status is displayed. For an analyzer with organization as the type, this failure can be due to an issue with creating the service-linked roles required in the member accounts of the AWS organization.
- code required

String

String string

TagKeys

TagKeys array
- items String

TagResourceRequest

TagResourceRequest object: Adds a tag to the specified resource.
- tags required

TagResourceResponse

TagResourceResponse object: The response to the request.

TagsMap

TagsMap object

ThrottlingException

Timestamp

Timestamp string

Token

Token string

Type

Type string (values: ACCOUNT, ORGANIZATION)

UntagResourceRequest

UntagResourceRequest object: Removes a tag from the specified resource.

UntagResourceResponse

UntagResourceResponse object: The response to the request.

UpdateArchiveRuleRequest

UpdateArchiveRuleRequest object: Updates the specified archive rule.
- clientToken
- filter required

UpdateFindingsRequest

UpdateFindingsRequest object: Updates findings with the new values provided in the request.
- analyzerArn required
- clientToken
- ids
  - items FindingId
- resourceArn
- status required

ValidationException

ValueList

ValueList array
- items String

datafire aws-sdk

@infinitebrahmanuniverse/nolb-_datafire_am @everything-registry/sub-chunk-220

5.0.0

5 years ago