Amazon Web Services Resources API

The Resources API from Amazon Web Services — 12 operation(s) for resources.

OpenAPI Specification

amazon-web-services-resources-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Web Services accessanalyzer 2012 09 25 Resources API
  description: <p>Identity and Access Management Access Analyzer helps you to set, verify, and refine your IAM policies by providing a suite of capabilities. Its features include findings for external and unused access, basic and custom policy checks for validating policies, and policy generation to generate fine-grained policies. To start using IAM Access Analyzer to identify external or unused access, you first need to create an analyzer.</p> <p> <b>External access analyzers</b> help identify potential risks of accessing resources by enabling you to identify any resource policies that grant access to an external principal. It does this by using logic-based reasoning to analyze resource-based policies in your Amazon Web Services environment. An external principal can be another Amazon Web Services account, a root user, an IAM user or role, a federated user, an Amazon Web Services service, or an anonymous user. You can also use IAM Access Analyzer to preview public and cross-account access to your resources before deploying permissions changes.</p> <p> <b>Unused access analyzers</b> help identify potential identity access risks by enabling you to identify unused IAM roles, unused access keys, unused console passwords, and IAM principals with unused service and action-level permissions.</p> <p>Beyond findings, IAM Access Analyzer provides basic and custom policy checks to validate IAM policies before deploying permissions changes. You can use policy generation to refine permissions by attaching a policy generated using access activity logged in CloudTrail logs. </p> <p>This guide describes the IAM Access Analyzer operations that you can call programmatically. For general information about IAM Access Analyzer, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html">Identity and Access Management Access Analyzer</a> in the <b>IAM User Guide</b>.</p>
tags:
- name: Resources
paths:
  /resources/{resourceArn}:
    GET:
      summary: Amazon Web Services Describeprotectedresource
      description: Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource.
      operationId: amazonWebServicesDescribeProtectedResource
      tags:
      - Resources
  /resources/:
    GET:
      summary: Amazon Web Services Listprotectedresources
      description: Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
      operationId: amazonWebServicesListProtectedResources
      tags:
      - Resources
  /resources/{resourceArn}/recovery-points/:
    GET:
      summary: Amazon Web Services Listrecoverypointsbyresource
      description: 'Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).  For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup. '
      operationId: amazonWebServicesListRecoveryPointsByResource
      tags:
      - Resources
  /resources/{resourceArn}/restore-jobs/:
    GET:
      summary: Amazon Web Services Listrestorejobsbyprotectedresource
      description: This returns restore jobs that contain the specified protected resource. You must include ResourceArn. You can optionally include NextToken, ByStatus, MaxResults, ByRecoveryPointCreationDateAfter , and ByRecoveryPointCreationDateBefore.
      operationId: amazonWebServicesListRestoreJobsByProtectedResource
      tags:
      - Resources
  /resources/{ResourceArn}/tags:
    DELETE:
      summary: Amazon Web Services Untagresource
      description: Removes a tag or tags from a resource.
      operationId: amazonWebServicesUntagResource
      tags:
      - Resources
  /resources/{Arn}/tags:
    PATCH:
      summary: Amazon Web Services Untag
      description: 'Deletes tags from a specified resource group.  Minimum permissions  To run this command, you must have the following permissions:    resource-groups:Untag   '
      operationId: amazonWebServicesUntag
      tags:
      - Resources
  /resources/search:
    POST:
      summary: Amazon Web Services Searchresources
      description: 'Returns a list of Amazon Web Services resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.  Minimum permissions  To run this command, you must have the following permissions:    resource-groups:SearchResources     cloudformation:DescribeStacks     cloudformation:ListStackResources     tag:GetResources   '
      operationId: amazonWebServicesSearchResources
      tags:
      - Resources
  /api/v1/resources/{ResourceId}/permissions:
    DELETE:
      summary: Amazon Web Services Removeallresourcepermissions
      description: Removes all the permissions from the specified resource.
      operationId: amazonWebServicesRemoveAllResourcePermissions
      tags:
      - Resources
  /api/v1/resources/{ResourceId}/customMetadata:
    DELETE:
      summary: Amazon Web Services Deletecustommetadata
      description: Deletes custom metadata from the specified resource.
      operationId: amazonWebServicesDeleteCustomMetadata
      tags:
      - Resources
  /api/v1/resources/{ResourceId}/labels:
    DELETE:
      summary: Amazon Web Services Deletelabels
      description: Deletes the specified list of labels from a resource.
      operationId: amazonWebServicesDeleteLabels
      tags:
      - Resources
  /api/v1/resources:
    GET:
      summary: Amazon Web Services Getresources
      description: Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME.
      operationId: amazonWebServicesGetResources
      tags:
      - Resources
  /api/v1/resources/{ResourceId}/permissions/{PrincipalId}:
    DELETE:
      summary: Amazon Web Services Removeresourcepermission
      description: Removes the permission for the specified principal from the specified resource.
      operationId: amazonWebServicesRemoveResourcePermission
      tags:
      - Resources