ResourceSpecificResult

Contains the result of the simulation of a single API operation call on a single resource.

This data type is used by a member of the EvaluationResult data type.

APIs.ioEngineeringPlatform

Properties

Name Type Description
EvalResourceName object
EvalResourceDecision object
MatchedStatements object
MissingContextValues object
EvalDecisionDetails object
PermissionsBoundaryDecisionDetail object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-resourcespecificresult-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ResourceSpecificResult",
  "title": "ResourceSpecificResult",
  "type": "object",
  "required": [
    "EvalResourceName",
    "EvalResourceDecision"
  ],
  "properties": {
    "EvalResourceName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceNameType"
        },
        {
          "description": "The name of the simulated resource, in Amazon Resource Name (ARN) format."
        }
      ]
    },
    "EvalResourceDecision": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PolicyEvaluationDecisionType"
        },
        {
          "description": "The result of the simulation of the simulated API operation on the resource specified in <code>EvalResourceName</code>."
        }
      ]
    },
    "MatchedStatements": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StatementListType"
        },
        {
          "description": "A list of the statements in the input policies that determine the result for this part of the simulation. Remember that even if multiple statements allow the operation on the resource, if <i>any</i> statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result."
        }
      ]
    },
    "MissingContextValues": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ContextKeyNamesResultListType"
        },
        {
          "description": "A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when a list of ARNs is included in the <code>ResourceArns</code> parameter instead of \"*\". If you do not specify individual resources, by setting <code>ResourceArns</code> to \"*\" or by not including the <code>ResourceArns</code> parameter, then any missing context values are instead included under the <code>EvaluationResults</code> section. To discover the context keys used by a set of policies, you can call <a>GetContextKeysForCustomPolicy</a> or <a>GetContextKeysForPrincipalPolicy</a>."
        }
      ]
    },
    "EvalDecisionDetails": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EvalDecisionDetailsType"
        },
        {
          "description": "Additional details about the results of the evaluation decision on a single resource. This parameter is returned only for cross-account simulations. This parameter explains how each policy type contributes to the resource-specific evaluation decision."
        }
      ]
    },
    "PermissionsBoundaryDecisionDetail": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PermissionsBoundaryDecisionDetail"
        },
        {
          "description": "Contains information about the effect that a permissions boundary has on a policy simulation when that boundary is applied to an IAM entity."
        }
      ]
    }
  },
  "description": "<p>Contains the result of the simulation of a single API operation call on a single resource.</p> <p>This data type is used by a member of the <a>EvaluationResult</a> data type.</p>"
}