Retrieves remediation targets for the account, or for all member accounts if the caller is the delegated administrator¶

Description¶

Retrieves remediation targets for the account, or for all member accounts if the caller is the delegated administrator. Results are sorted by priority, highest first, and are paginated. Use TargetUid or MetadataUid to scope the request to a single target or finding.

Usage¶

securityhub_get_remediations_v2(TargetUid, MetadataUid, Filters,
  ShowGuidance, GuidanceFormat, MaxResults, NextToken)

Arguments¶

TargetUid

The unique identifier (ID) of an existing remediation target to return. Returns the single matching target. You can't use TargetUid together with MetadataUid or Filters.
MetadataUid

The unique identifier (ID) of the Security Hub exposure finding, found under the metadata.uid field of the finding. Returns the remediation targets associated with that finding. You can't use MetadataUid together with TargetUid or Filters.
Filters

Filters remediation targets based on a set of criteria. You can't use Filters together with TargetUid or MetadataUid.
ShowGuidance

Specifies whether to show remediation target guidance.
GuidanceFormat

The format of the remediation guidance examples to return. Valid values are All, AwsCli, Cli, Python, Terraform, Cdk, CloudFormation, IaC, and Template. If you don't specify a value, all formats are returned. Applies only when ShowGuidance is true.
MaxResults

The maximum number of results to return. Valid range is 1-100. If you don't specify a value, the operation returns up to 25 results.
NextToken

The token used to paginate the remediations target list returned. On your first call to get_remediations_v2, omit this parameter or set it to NULL. For subsequent calls, use the NextToken value returned in the previous response to retrieve the next page of results.

Value¶

A list with the following syntax:

list(
  Items = list(
    list(
      TargetUid = "string",
      Outcome = list(
        ResolvedFindingsCount = 123,
        SeverityReductionFindingsCount = 123,
        SeverityUnchangedCount = 123
      ),
      Priority = "Critical"|"High"|"Medium"|"Low",
      RemediationSummary = list(
        Action = "string",
        Description = "string",
        IsImmediate = TRUE|FALSE,
        PostRemediationSteps = list(
          "string"
        ),
        KbArticles = list(
          list(
            Title = "string",
            Url = "string"
          )
        )
      ),
      Resource = list(
        AccountId = "string",
        Region = "string",
        ResourceOwnerAccountId = "string",
        ResourceOwnerOrgId = "string",
        Type = "string",
        Name = "string",
        Id = "string",
        ResourceGuid = "string",
        ResourceRegion = "string",
        CloudProvider = "Azure"|"AWS"
      ),
      Status = "New"|"Updated"|"Resolved",
      Trait = list(
        Type = "string",
        Title = "string"
      ),
      Guidance = list(
        TargetTypeName = "string",
        Pattern = "string",
        Version = "string",
        Context = list(
          ProblemStatement = "string",
          RiskAssessment = "string",
          AffectedScope = "string",
          Prerequisites = list(
            "string"
          )
        ),
        Specification = list(
          Parameters = list(
            list(
              Name = "string",
              Type = "string",
              Description = "string",
              Required = TRUE|FALSE
            )
          ),
          Steps = list(
            list(
              Phase = "string",
              Description = "string",
              Service = "string",
              Action = "string",
              Logic = "string",
              Inverse = "string",
              VerifyAfter = "string"
            )
          ),
          ExpectedEndState = "string",
          RequiredPermissions = list(
            "string"
          )
        ),
        Examples = list(
          AwsCli = "string",
          Cli = "string",
          Python = "string",
          Terraform = "string",
          Cdk = "string",
          CloudFormation = "string",
          IaC = "string",
          Template = "string"
        ),
        Metadata = list(
          ResourceType = "string",
          ExposureType = "string",
          TraitTitles = list(
            "string"
          ),
          Reversibility = "string",
          FixEffect = "string",
          RiskLevel = "string",
          AutomationLevel = "string",
          HumanReviewRequired = TRUE|FALSE,
          GeneratedAt = as.POSIXct(
            "2015-01-01"
          ),
          VerificationStatus = "string"
        )
      ),
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$get_remediations_v2(
  TargetUid = "string",
  MetadataUid = "string",
  Filters = list(
    CompositeFilters = list(
      list(
        StringFilters = list(
          list(
            FieldName = "Resource.Type"|"Priority"|"Status"|"Resource.Id"|"Resource.ResourceOwnerAccountId"|"Resource.CloudProvider",
            Filter = list(
              Value = "string"
            )
          )
        )
      )
    )
  ),
  ShowGuidance = TRUE|FALSE,
  GuidanceFormat = "All"|"AwsCli"|"Cli"|"Python"|"Terraform"|"Cdk"|"CloudFormation"|"IaC"|"Template",
  MaxResults = 123,
  NextToken = "string"
)