lobo/aws-sdk-for-zig
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects 1 Releases Wiki Activity
xml
aws-sdk-for-zig/codegen/models/accessanalyzer.2019-11-01.json

4826 lines
219 KiB
JSON
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"smithy": "1.0",
"shapes": {
"com.amazonaws.accessanalyzer#AccessAnalyzer": {
"type": "service",
"version": "2019-11-01",
"operations": [
{
"target": "com.amazonaws.accessanalyzer#ApplyArchiveRule"
},
{
"target": "com.amazonaws.accessanalyzer#CancelPolicyGeneration"
},
{
"target": "com.amazonaws.accessanalyzer#CreateAccessPreview"
},
{
"target": "com.amazonaws.accessanalyzer#GetAccessPreview"
},
{
"target": "com.amazonaws.accessanalyzer#GetAnalyzedResource"
},
{
"target": "com.amazonaws.accessanalyzer#GetFinding"
},
{
"target": "com.amazonaws.accessanalyzer#GetGeneratedPolicy"
},
{
"target": "com.amazonaws.accessanalyzer#ListAccessPreviewFindings"
},
{
"target": "com.amazonaws.accessanalyzer#ListAccessPreviews"
},
{
"target": "com.amazonaws.accessanalyzer#ListAnalyzedResources"
},
{
"target": "com.amazonaws.accessanalyzer#ListFindings"
},
{
"target": "com.amazonaws.accessanalyzer#ListPolicyGenerations"
},
{
"target": "com.amazonaws.accessanalyzer#ListTagsForResource"
},
{
"target": "com.amazonaws.accessanalyzer#StartPolicyGeneration"
},
{
"target": "com.amazonaws.accessanalyzer#StartResourceScan"
},
{
"target": "com.amazonaws.accessanalyzer#TagResource"
},
{
"target": "com.amazonaws.accessanalyzer#UntagResource"
},
{
"target": "com.amazonaws.accessanalyzer#UpdateFindings"
},
{
"target": "com.amazonaws.accessanalyzer#ValidatePolicy"
}
],
"resources": [
{
"target": "com.amazonaws.accessanalyzer#Analyzer"
}
],
"traits": {
"aws.api#service": {
"sdkId": "AccessAnalyzer",
"arnNamespace": "access-analyzer",
"cloudFormationName": "AccessAnalyzer",
"cloudTrailEventSource": "access-analyzer.amazonaws.com",
"endpointPrefix": "access-analyzer"
},
"aws.auth#sigv4": {
"name": "access-analyzer"
},
"aws.protocols#restJson1": {},
"smithy.api#cors": {},
"smithy.api#documentation": "<p>AWS IAM Access Analyzer helps identify potential resource-access risks by enabling you to identify\n any policies that grant access to an external principal. It does this by using logic-based\n reasoning to analyze resource-based policies in your AWS environment. An external\n principal can be another AWS account, a root user, an IAM user or role, a federated\n user, an AWS service, or an anonymous user. You can also use Access Analyzer to preview and\n validate public and cross-account access to your resources before deploying permissions\n changes. This guide describes the AWS IAM Access Analyzer operations that you can call\n programmatically. For general information about Access Analyzer, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html\">AWS IAM Access Analyzer</a> in the <b>IAM User Guide</b>.</p>\n <p>To start using Access Analyzer, you first need to create an analyzer.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults"
},
"smithy.api#title": "Access Analyzer"
}
},
"com.amazonaws.accessanalyzer#AccessDeniedException": {
"type": "structure",
"members": {
"message": {
"target": "smithy.api#String",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>You do not have sufficient access to perform this action.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 403
}
},
"com.amazonaws.accessanalyzer#AccessPointArn": {
"type": "string",
"traits": {
"smithy.api#pattern": "arn:[^:]*:s3:[^:]*:[^:]*:accesspoint/.*$"
}
},
"com.amazonaws.accessanalyzer#AccessPointPolicy": {
"type": "string"
},
"com.amazonaws.accessanalyzer#AccessPreview": {
"type": "structure",
"members": {
"id": {
"target": "com.amazonaws.accessanalyzer#AccessPreviewId",
"traits": {
"smithy.api#documentation": "<p>The unique ID for the access preview.</p>",
"smithy.api#required": {}
}
},
"analyzerArn": {
"target": "com.amazonaws.accessanalyzer#AnalyzerArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the analyzer used to generate the access preview.</p>",
"smithy.api#required": {}
}
},
"configurations": {
"target": "com.amazonaws.accessanalyzer#ConfigurationsMap",
"traits": {
"smithy.api#documentation": "<p>A map of resource ARNs for the proposed resource configuration.</p>",
"smithy.api#required": {}
}
},
"createdAt": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time at which the access preview was created.</p>",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.accessanalyzer#AccessPreviewStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the access preview.</p>\n <ul>\n <li>\n <p>\n <code>Creating</code> - The access preview creation is in progress.</p>\n </li>\n <li>\n <p>\n <code>Completed</code> - The access preview is complete. You can preview findings\n for external access to the resource.</p>\n </li>\n <li>\n <p>\n <code>Failed</code> - The access preview creation has failed.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
"statusReason": {
"target": "com.amazonaws.accessanalyzer#AccessPreviewStatusReason",
"traits": {
"smithy.api#documentation": "<p>Provides more details about the current status of the access preview.</p>\n <p>For example, if the creation of the access preview fails, a <code>Failed</code> status\n is returned. This failure can be due to an internal issue with the analysis or due to an\n invalid resource configuration.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains information about an access preview.</p>"
}
},
"com.amazonaws.accessanalyzer#AccessPreviewFinding": {
"type": "structure",
"members": {
"id": {
"target": "com.amazonaws.accessanalyzer#AccessPreviewFindingId",
"traits": {
"smithy.api#documentation": "<p>The ID of the access preview finding. This ID uniquely identifies the element in the\n list of access preview findings and is not related to the finding ID in Access\n Analyzer.</p>",
"smithy.api#required": {}
}
},
"existingFindingId": {
"target": "com.amazonaws.accessanalyzer#FindingId",
"traits": {
"smithy.api#documentation": "<p>The existing ID of the finding in Access Analyzer, provided only for existing findings.</p>"
}
},
"existingFindingStatus": {
"target": "com.amazonaws.accessanalyzer#FindingStatus",
"traits": {
"smithy.api#documentation": "<p>The existing status of the finding, provided only for existing findings.</p>"
}
},
"principal": {
"target": "com.amazonaws.accessanalyzer#PrincipalMap",
"traits": {
"smithy.api#documentation": "<p>The external principal that has access to a resource within the zone of trust.</p>"
}
},
"action": {
"target": "com.amazonaws.accessanalyzer#ActionList",
"traits": {
"smithy.api#documentation": "<p>The action in the analyzed policy statement that an external principal has permission to\n perform.</p>"
}
},
"condition": {
"target": "com.amazonaws.accessanalyzer#ConditionKeyMap",
"traits": {
"smithy.api#documentation": "<p>The condition in the analyzed policy statement that resulted in a finding.</p>"
}
},
"resource": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The resource that an external principal has access to. This is the resource associated\n with the access preview.</p>"
}
},
"isPublic": {
"target": "smithy.api#Boolean",
"traits": {
"smithy.api#documentation": "<p>Indicates whether the policy that generated the finding allows public access to the\n resource.</p>"
}
},
"resourceType": {
"target": "com.amazonaws.accessanalyzer#ResourceType",
"traits": {
"smithy.api#documentation": "<p>The type of the resource that can be accessed in the finding.</p>",
"smithy.api#required": {}
}
},
"createdAt": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time at which the access preview finding was created.</p>",
"smithy.api#required": {}
}
},
"changeType": {
"target": "com.amazonaws.accessanalyzer#FindingChangeType",
"traits": {
"smithy.api#documentation": "<p>Provides context on how the access preview finding compares to existing access\n identified in Access Analyzer.</p>\n <ul>\n <li>\n <p>\n <code>New</code> - The finding is for newly-introduced access.</p>\n </li>\n <li>\n <p>\n <code>Unchanged</code> - The preview finding is an existing finding that would\n remain unchanged.</p>\n </li>\n <li>\n <p>\n <code>Changed</code> - The preview finding is an existing finding with a change in\n status.</p>\n </li>\n </ul>\n <p>For example, a <code>Changed</code> finding with preview status <code>Resolved</code>\n and existing status <code>Active</code> indicates the existing <code>Active</code> finding\n would become <code>Resolved</code> as a result of the proposed permissions change.</p>",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.accessanalyzer#FindingStatus",
"traits": {
"smithy.api#documentation": "<p>The preview status of the finding. This is what the status of the finding would be after\n permissions deployment. For example, a <code>Changed</code> finding with preview status\n <code>Resolved</code> and existing status <code>Active</code> indicates the existing\n <code>Active</code> finding would become <code>Resolved</code> as a result of the\n proposed permissions change.</p>",
"smithy.api#required": {}
}
},
"resourceOwnerAccount": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The AWS account ID that owns the resource. For most AWS resources, the owning\n account is the account in which the resource was created.</p>",
"smithy.api#required": {}
}
},
"error": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>An error.</p>"
}
},
"sources": {
"target": "com.amazonaws.accessanalyzer#FindingSourceList",
"traits": {
"smithy.api#documentation": "<p>The sources of the finding. This indicates how the access that generated the finding is\n granted. It is populated for Amazon S3 bucket findings.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An access preview finding generated by the access preview.</p>"
}
},
"com.amazonaws.accessanalyzer#AccessPreviewFindingId": {
"type": "string"
},
"com.amazonaws.accessanalyzer#AccessPreviewFindingsList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#AccessPreviewFinding"
}
},
"com.amazonaws.accessanalyzer#AccessPreviewId": {
"type": "string",
"traits": {
"smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$"
}
},
"com.amazonaws.accessanalyzer#AccessPreviewStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "COMPLETED",
"name": "COMPLETED"
},
{
"value": "CREATING",
"name": "CREATING"
},
{
"value": "FAILED",
"name": "FAILED"
}
]
}
},
"com.amazonaws.accessanalyzer#AccessPreviewStatusReason": {
"type": "structure",
"members": {
"code": {
"target": "com.amazonaws.accessanalyzer#AccessPreviewStatusReasonCode",
"traits": {
"smithy.api#documentation": "<p>The reason code for the current status of the access preview.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Provides more details about the current status of the access preview. For example, if\n the creation of the access preview fails, a <code>Failed</code> status is returned. This\n failure can be due to an internal issue with the analysis or due to an invalid proposed\n resource configuration.</p>"
}
},
"com.amazonaws.accessanalyzer#AccessPreviewStatusReasonCode": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "INTERNAL_ERROR",
"name": "INTERNAL_ERROR"
},
{
"value": "INVALID_CONFIGURATION",
"name": "INVALID_CONFIGURATION"
}
]
}
},
"com.amazonaws.accessanalyzer#AccessPreviewSummary": {
"type": "structure",
"members": {
"id": {
"target": "com.amazonaws.accessanalyzer#AccessPreviewId",
"traits": {
"smithy.api#documentation": "<p>The unique ID for the access preview.</p>",
"smithy.api#required": {}
}
},
"analyzerArn": {
"target": "com.amazonaws.accessanalyzer#AnalyzerArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the analyzer used to generate the access preview.</p>",
"smithy.api#required": {}
}
},
"createdAt": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time at which the access preview was created.</p>",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.accessanalyzer#AccessPreviewStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the access preview.</p>\n <ul>\n <li>\n <p>\n <code>Creating</code> - The access preview creation is in progress.</p>\n </li>\n <li>\n <p>\n <code>Completed</code> - The access preview is complete and previews the findings\n for external access to the resource.</p>\n </li>\n <li>\n <p>\n <code>Failed</code> - The access preview creation has failed.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
"statusReason": {
"target": "com.amazonaws.accessanalyzer#AccessPreviewStatusReason"
}
},
"traits": {
"smithy.api#documentation": "<p>Contains a summary of information about an access preview.</p>"
}
},
"com.amazonaws.accessanalyzer#AccessPreviewsList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#AccessPreviewSummary"
}
},
"com.amazonaws.accessanalyzer#AclCanonicalId": {
"type": "string"
},
"com.amazonaws.accessanalyzer#AclGrantee": {
"type": "union",
"members": {
"id": {
"target": "com.amazonaws.accessanalyzer#AclCanonicalId",
"traits": {
"smithy.api#documentation": "<p>The value specified is the canonical user ID of an AWS account.</p>"
}
},
"uri": {
"target": "com.amazonaws.accessanalyzer#AclUri",
"traits": {
"smithy.api#documentation": "<p>Used for granting permissions to a predefined group.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>You specify each grantee as a type-value pair using one of these types. You can specify\n only one type of grantee. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAcl.html\">PutBucketAcl</a>.</p>"
}
},
"com.amazonaws.accessanalyzer#AclPermission": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "READ",
"name": "READ"
},
{
"value": "WRITE",
"name": "WRITE"
},
{
"value": "READ_ACP",
"name": "READ_ACP"
},
{
"value": "WRITE_ACP",
"name": "WRITE_ACP"
},
{
"value": "FULL_CONTROL",
"name": "FULL_CONTROL"
}
]
}
},
"com.amazonaws.accessanalyzer#AclUri": {
"type": "string"
},
"com.amazonaws.accessanalyzer#ActionList": {
"type": "list",
"member": {
"target": "smithy.api#String"
}
},
"com.amazonaws.accessanalyzer#AnalyzedResource": {
"type": "structure",
"members": {
"resourceArn": {
"target": "com.amazonaws.accessanalyzer#ResourceArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the resource that was analyzed.</p>",
"smithy.api#required": {}
}
},
"resourceType": {
"target": "com.amazonaws.accessanalyzer#ResourceType",
"traits": {
"smithy.api#documentation": "<p>The type of the resource that was analyzed.</p>",
"smithy.api#required": {}
}
},
"createdAt": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time at which the finding was created.</p>",
"smithy.api#required": {}
}
},
"analyzedAt": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time at which the resource was analyzed.</p>",
"smithy.api#required": {}
}
},
"updatedAt": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time at which the finding was updated.</p>",
"smithy.api#required": {}
}
},
"isPublic": {
"target": "smithy.api#Boolean",
"traits": {
"smithy.api#documentation": "<p>Indicates whether the policy that generated the finding grants public access to the\n resource.</p>",
"smithy.api#required": {}
}
},
"actions": {
"target": "com.amazonaws.accessanalyzer#ActionList",
"traits": {
"smithy.api#documentation": "<p>The actions that an external principal is granted permission to use by the policy that\n generated the finding.</p>"
}
},
"sharedVia": {
"target": "com.amazonaws.accessanalyzer#SharedViaList",
"traits": {
"smithy.api#documentation": "<p>Indicates how the access that generated the finding is granted. This is populated for\n Amazon S3 bucket findings.</p>"
}
},
"status": {
"target": "com.amazonaws.accessanalyzer#FindingStatus",
"traits": {
"smithy.api#documentation": "<p>The current status of the finding generated from the analyzed resource.</p>"
}
},
"resourceOwnerAccount": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The AWS account ID that owns the resource.</p>",
"smithy.api#required": {}
}
},
"error": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>An error message.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains details about the analyzed resource.</p>"
}
},
"com.amazonaws.accessanalyzer#AnalyzedResourceSummary": {
"type": "structure",
"members": {
"resourceArn": {
"target": "com.amazonaws.accessanalyzer#ResourceArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the analyzed resource.</p>",
"smithy.api#required": {}
}
},
"resourceOwnerAccount": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The AWS account ID that owns the resource.</p>",
"smithy.api#required": {}
}
},
"resourceType": {
"target": "com.amazonaws.accessanalyzer#ResourceType",
"traits": {
"smithy.api#documentation": "<p>The type of resource that was analyzed.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains the ARN of the analyzed resource.</p>"
}
},
"com.amazonaws.accessanalyzer#AnalyzedResourcesList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#AnalyzedResourceSummary"
}
},
"com.amazonaws.accessanalyzer#Analyzer": {
"type": "resource",
"identifiers": {
"analyzerName": {
"target": "com.amazonaws.accessanalyzer#Name"
}
},
"put": {
"target": "com.amazonaws.accessanalyzer#CreateAnalyzer"
},
"read": {
"target": "com.amazonaws.accessanalyzer#GetAnalyzer"
},
"delete": {
"target": "com.amazonaws.accessanalyzer#DeleteAnalyzer"
},
"list": {
"target": "com.amazonaws.accessanalyzer#ListAnalyzers"
},
"resources": [
{
"target": "com.amazonaws.accessanalyzer#ArchiveRule"
}
],
"traits": {
"aws.api#arn": {
"template": "analyzer/{analyzerName}",
"absolute": false,
"noAccount": false,
"noRegion": false
},
"smithy.api#noReplace": {}
}
},
"com.amazonaws.accessanalyzer#AnalyzerArn": {
"type": "string",
"traits": {
"smithy.api#pattern": "^[^:]*:[^:]*:[^:]*:[^:]*:[^:]*:analyzer/.{1,255}$"
}
},
"com.amazonaws.accessanalyzer#AnalyzerStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "ACTIVE",
"name": "ACTIVE"
},
{
"value": "CREATING",
"name": "CREATING"
},
{
"value": "DISABLED",
"name": "DISABLED"
},
{
"value": "FAILED",
"name": "FAILED"
}
]
}
},
"com.amazonaws.accessanalyzer#AnalyzerSummary": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.accessanalyzer#AnalyzerArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the analyzer.</p>",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.accessanalyzer#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the analyzer.</p>",
"smithy.api#required": {}
}
},
"type": {
"target": "com.amazonaws.accessanalyzer#Type",
"traits": {
"smithy.api#documentation": "<p>The type of analyzer, which corresponds to the zone of trust chosen for the\n analyzer.</p>",
"smithy.api#required": {}
}
},
"createdAt": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>A timestamp for the time at which the analyzer was created.</p>",
"smithy.api#required": {}
}
},
"lastResourceAnalyzed": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The resource that was most recently analyzed by the analyzer.</p>"
}
},
"lastResourceAnalyzedAt": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time at which the most recently analyzed resource was analyzed.</p>"
}
},
"tags": {
"target": "com.amazonaws.accessanalyzer#TagsMap",
"traits": {
"smithy.api#documentation": "<p>The tags added to the analyzer.</p>"
}
},
"status": {
"target": "com.amazonaws.accessanalyzer#AnalyzerStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the analyzer. An <code>Active</code> analyzer successfully monitors\n supported resources and generates new findings. The analyzer is <code>Disabled</code> when\n a user action, such as removing trusted access for AWS IAM Access Analyzer from AWS Organizations,\n causes the analyzer to stop generating new findings. The status is <code>Creating</code>\n when the analyzer creation is in progress and <code>Failed</code> when the analyzer\n creation has failed. </p>",
"smithy.api#required": {}
}
},
"statusReason": {
"target": "com.amazonaws.accessanalyzer#StatusReason",
"traits": {
"smithy.api#documentation": "<p>The <code>statusReason</code> provides more details about the current status of the\n analyzer. For example, if the creation for the analyzer fails, a <code>Failed</code> status\n is returned. For an analyzer with organization as the type, this failure can be due to an\n issue with creating the service-linked roles required in the member accounts of the AWS\n organization.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains information about the analyzer.</p>"
}
},
"com.amazonaws.accessanalyzer#AnalyzersList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#AnalyzerSummary"
}
},
"com.amazonaws.accessanalyzer#ApplyArchiveRule": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#ApplyArchiveRuleRequest"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retroactively applies the archive rule to existing findings that meet the archive rule\n criteria.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/archive-rule",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.accessanalyzer#ApplyArchiveRuleRequest": {
"type": "structure",
"members": {
"analyzerArn": {
"target": "com.amazonaws.accessanalyzer#AnalyzerArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon resource name (ARN) of the analyzer.</p>",
"smithy.api#required": {}
}
},
"ruleName": {
"target": "com.amazonaws.accessanalyzer#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the rule to apply.</p>",
"smithy.api#required": {}
}
},
"clientToken": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>A client token.</p>",
"smithy.api#idempotencyToken": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Retroactively applies an archive rule.</p>"
}
},
"com.amazonaws.accessanalyzer#ArchiveRule": {
"type": "resource",
"identifiers": {
"analyzerName": {
"target": "com.amazonaws.accessanalyzer#Name"
},
"ruleName": {
"target": "com.amazonaws.accessanalyzer#Name"
}
},
"put": {
"target": "com.amazonaws.accessanalyzer#CreateArchiveRule"
},
"read": {
"target": "com.amazonaws.accessanalyzer#GetArchiveRule"
},
"update": {
"target": "com.amazonaws.accessanalyzer#UpdateArchiveRule"
},
"delete": {
"target": "com.amazonaws.accessanalyzer#DeleteArchiveRule"
},
"list": {
"target": "com.amazonaws.accessanalyzer#ListArchiveRules"
},
"traits": {
"aws.api#arn": {
"template": "analyzer/{analyzerName}/archive-rule/{ruleName}",
"absolute": false,
"noAccount": false,
"noRegion": false
},
"smithy.api#noReplace": {}
}
},
"com.amazonaws.accessanalyzer#ArchiveRuleSummary": {
"type": "structure",
"members": {
"ruleName": {
"target": "com.amazonaws.accessanalyzer#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the archive rule.</p>",
"smithy.api#required": {}
}
},
"filter": {
"target": "com.amazonaws.accessanalyzer#FilterCriteriaMap",
"traits": {
"smithy.api#documentation": "<p>A filter used to define the archive rule.</p>",
"smithy.api#required": {}
}
},
"createdAt": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time at which the archive rule was created.</p>",
"smithy.api#required": {}
}
},
"updatedAt": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time at which the archive rule was last updated.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains information about an archive rule.</p>"
}
},
"com.amazonaws.accessanalyzer#ArchiveRulesList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#ArchiveRuleSummary"
}
},
"com.amazonaws.accessanalyzer#CancelPolicyGeneration": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#CancelPolicyGenerationRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#CancelPolicyGenerationResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Cancels the requested policy generation.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/policy/generation/{jobId}",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.accessanalyzer#CancelPolicyGenerationRequest": {
"type": "structure",
"members": {
"jobId": {
"target": "com.amazonaws.accessanalyzer#JobId",
"traits": {
"smithy.api#documentation": "<p>The <code>JobId</code> that is returned by the <code>StartPolicyGeneration</code>\n operation. The <code>JobId</code> can be used with <code>GetGeneratedPolicy</code> to\n retrieve the generated policies or used with <code>CancelPolicyGeneration</code> to cancel\n the policy generation request.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.accessanalyzer#CancelPolicyGenerationResponse": {
"type": "structure",
"members": {}
},
"com.amazonaws.accessanalyzer#CloudTrailArn": {
"type": "string",
"traits": {
"smithy.api#pattern": "arn:[^:]*:cloudtrail:[^:]*:[^:]*:trail/.{1,576}$"
}
},
"com.amazonaws.accessanalyzer#CloudTrailDetails": {
"type": "structure",
"members": {
"trails": {
"target": "com.amazonaws.accessanalyzer#TrailList",
"traits": {
"smithy.api#documentation": "<p>A <code>Trail</code> object that contains settings for a trail.</p>",
"smithy.api#required": {}
}
},
"accessRole": {
"target": "com.amazonaws.accessanalyzer#RoleArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the service role that Access Analyzer uses to access your CloudTrail trail and\n service last accessed information.</p>",
"smithy.api#required": {}
}
},
"startTime": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The start of the time range for which Access Analyzer reviews your CloudTrail events. Events\n with a timestamp before this time are not considered to generate a policy.</p>",
"smithy.api#required": {}
}
},
"endTime": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The end of the time range for which Access Analyzer reviews your CloudTrail events. Events with\n a timestamp after this time are not considered to generate a policy. If this is not\n included in the request, the default value is the current time.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains information about CloudTrail access.</p>"
}
},
"com.amazonaws.accessanalyzer#CloudTrailProperties": {
"type": "structure",
"members": {
"trailProperties": {
"target": "com.amazonaws.accessanalyzer#TrailPropertiesList",
"traits": {
"smithy.api#documentation": "<p>A <code>TrailProperties</code> object that contains settings for trail\n properties.</p>",
"smithy.api#required": {}
}
},
"startTime": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The start of the time range for which Access Analyzer reviews your CloudTrail events. Events\n with a timestamp before this time are not considered to generate a policy.</p>",
"smithy.api#required": {}
}
},
"endTime": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The end of the time range for which Access Analyzer reviews your CloudTrail events. Events with\n a timestamp after this time are not considered to generate a policy. If this is not\n included in the request, the default value is the current time.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains information about CloudTrail access.</p>"
}
},
"com.amazonaws.accessanalyzer#ConditionKeyMap": {
"type": "map",
"key": {
"target": "smithy.api#String"
},
"value": {
"target": "smithy.api#String"
}
},
"com.amazonaws.accessanalyzer#Configuration": {
"type": "union",
"members": {
"iamRole": {
"target": "com.amazonaws.accessanalyzer#IamRoleConfiguration",
"traits": {
"smithy.api#documentation": "<p>The access control configuration is for an IAM role. </p>"
}
},
"kmsKey": {
"target": "com.amazonaws.accessanalyzer#KmsKeyConfiguration",
"traits": {
"smithy.api#documentation": "<p>The access control configuration is for a KMS key. </p>"
}
},
"secretsManagerSecret": {
"target": "com.amazonaws.accessanalyzer#SecretsManagerSecretConfiguration",
"traits": {
"smithy.api#documentation": "<p>The access control configuration is for a Secrets Manager secret.</p>"
}
},
"s3Bucket": {
"target": "com.amazonaws.accessanalyzer#S3BucketConfiguration",
"traits": {
"smithy.api#documentation": "<p>The access control configuration is for an Amazon S3 Bucket. </p>"
}
},
"sqsQueue": {
"target": "com.amazonaws.accessanalyzer#SqsQueueConfiguration",
"traits": {
"smithy.api#documentation": "<p>The access control configuration is for an SQS queue. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Access control configuration structures for your resource. You specify the configuration\n as a type-value pair. You can specify only one type of access control configuration.</p>"
}
},
"com.amazonaws.accessanalyzer#ConfigurationsMap": {
"type": "map",
"key": {
"target": "com.amazonaws.accessanalyzer#ConfigurationsMapKey"
},
"value": {
"target": "com.amazonaws.accessanalyzer#Configuration"
}
},
"com.amazonaws.accessanalyzer#ConfigurationsMapKey": {
"type": "string"
},
"com.amazonaws.accessanalyzer#ConflictException": {
"type": "structure",
"members": {
"message": {
"target": "smithy.api#String",
"traits": {
"smithy.api#required": {}
}
},
"resourceId": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The ID of the resource.</p>",
"smithy.api#required": {}
}
},
"resourceType": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The resource type.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A conflict exception error.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 409
}
},
"com.amazonaws.accessanalyzer#CreateAccessPreview": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#CreateAccessPreviewRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#CreateAccessPreviewResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#ConflictException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates an access preview that allows you to preview Access Analyzer findings for your resource\n before deploying resource permissions.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/access-preview",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.accessanalyzer#CreateAccessPreviewRequest": {
"type": "structure",
"members": {
"analyzerArn": {
"target": "com.amazonaws.accessanalyzer#AnalyzerArn",
"traits": {
"smithy.api#documentation": "<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of\n the account analyzer</a> used to generate the access preview. You can only create an\n access preview for analyzers with an <code>Account</code> type and <code>Active</code>\n status.</p>",
"smithy.api#required": {}
}
},
"configurations": {
"target": "com.amazonaws.accessanalyzer#ConfigurationsMap",
"traits": {
"smithy.api#documentation": "<p>Access control configuration for your resource that is used to generate the access\n preview. The access preview includes findings for external access allowed to the resource\n with the proposed access control configuration. The configuration must contain exactly one\n element.</p>",
"smithy.api#required": {}
}
},
"clientToken": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>A client token.</p>",
"smithy.api#idempotencyToken": {}
}
}
}
},
"com.amazonaws.accessanalyzer#CreateAccessPreviewResponse": {
"type": "structure",
"members": {
"id": {
"target": "com.amazonaws.accessanalyzer#AccessPreviewId",
"traits": {
"smithy.api#documentation": "<p>The unique ID for the access preview.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.accessanalyzer#CreateAnalyzer": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#CreateAnalyzerRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#CreateAnalyzerResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#ConflictException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates an analyzer for your account.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/analyzer",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.accessanalyzer#CreateAnalyzerRequest": {
"type": "structure",
"members": {
"analyzerName": {
"target": "com.amazonaws.accessanalyzer#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the analyzer to create.</p>",
"smithy.api#required": {}
}
},
"type": {
"target": "com.amazonaws.accessanalyzer#Type",
"traits": {
"smithy.api#documentation": "<p>The type of analyzer to create. Only ACCOUNT and ORGANIZATION analyzers are supported.\n You can create only one analyzer per account per Region. You can create up to 5 analyzers\n per organization per Region.</p>",
"smithy.api#required": {}
}
},
"archiveRules": {
"target": "com.amazonaws.accessanalyzer#InlineArchiveRulesList",
"traits": {
"smithy.api#documentation": "<p>Specifies the archive rules to add for the analyzer. Archive rules automatically archive\n findings that meet the criteria you define for the rule.</p>"
}
},
"tags": {
"target": "com.amazonaws.accessanalyzer#TagsMap",
"traits": {
"smithy.api#documentation": "<p>The tags to apply to the analyzer.</p>"
}
},
"clientToken": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>A client token.</p>",
"smithy.api#idempotencyToken": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Creates an analyzer.</p>"
}
},
"com.amazonaws.accessanalyzer#CreateAnalyzerResponse": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.accessanalyzer#AnalyzerArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the analyzer that was created by the request.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The response to the request to create an analyzer.</p>"
}
},
"com.amazonaws.accessanalyzer#CreateArchiveRule": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#CreateArchiveRuleRequest"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#ConflictException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates an archive rule for the specified analyzer. Archive rules automatically archive\n new findings that meet the criteria you define when you create the rule.</p>\n <p>To learn about filter keys that you can use to create an archive rule, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html\">Access Analyzer filter keys</a> in the <b>IAM User\n Guide</b>.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/analyzer/{analyzerName}/archive-rule",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.accessanalyzer#CreateArchiveRuleRequest": {
"type": "structure",
"members": {
"analyzerName": {
"target": "com.amazonaws.accessanalyzer#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the created analyzer.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"ruleName": {
"target": "com.amazonaws.accessanalyzer#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the rule to create.</p>",
"smithy.api#required": {}
}
},
"filter": {
"target": "com.amazonaws.accessanalyzer#FilterCriteriaMap",
"traits": {
"smithy.api#documentation": "<p>The criteria for the rule.</p>",
"smithy.api#required": {}
}
},
"clientToken": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>A client token.</p>",
"smithy.api#idempotencyToken": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Creates an archive rule.</p>"
}
},
"com.amazonaws.accessanalyzer#Criterion": {
"type": "structure",
"members": {
"eq": {
"target": "com.amazonaws.accessanalyzer#ValueList",
"traits": {
"smithy.api#documentation": "<p>An \"equals\" operator to match for the filter used to create the rule.</p>"
}
},
"neq": {
"target": "com.amazonaws.accessanalyzer#ValueList",
"traits": {
"smithy.api#documentation": "<p>A \"not equals\" operator to match for the filter used to create the rule.</p>"
}
},
"contains": {
"target": "com.amazonaws.accessanalyzer#ValueList",
"traits": {
"smithy.api#documentation": "<p>A \"contains\" operator to match for the filter used to create the rule.</p>"
}
},
"exists": {
"target": "smithy.api#Boolean",
"traits": {
"smithy.api#documentation": "<p>An \"exists\" operator to match for the filter used to create the rule. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The criteria to use in the filter that defines the archive rule.</p>"
}
},
"com.amazonaws.accessanalyzer#DeleteAnalyzer": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#DeleteAnalyzerRequest"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes the specified analyzer. When you delete an analyzer, Access Analyzer is disabled for the\n account or organization in the current or specific Region. All findings that were generated\n by the analyzer are deleted. You cannot undo this action.</p>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/analyzer/{analyzerName}",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.accessanalyzer#DeleteAnalyzerRequest": {
"type": "structure",
"members": {
"analyzerName": {
"target": "com.amazonaws.accessanalyzer#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the analyzer to delete.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"clientToken": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>A client token.</p>",
"smithy.api#httpQuery": "clientToken",
"smithy.api#idempotencyToken": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Deletes an analyzer.</p>"
}
},
"com.amazonaws.accessanalyzer#DeleteArchiveRule": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#DeleteArchiveRuleRequest"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes the specified archive rule.</p>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/analyzer/{analyzerName}/archive-rule/{ruleName}",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.accessanalyzer#DeleteArchiveRuleRequest": {
"type": "structure",
"members": {
"analyzerName": {
"target": "com.amazonaws.accessanalyzer#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the analyzer that associated with the archive rule to delete.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"ruleName": {
"target": "com.amazonaws.accessanalyzer#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the rule to delete.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"clientToken": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>A client token.</p>",
"smithy.api#httpQuery": "clientToken",
"smithy.api#idempotencyToken": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Deletes an archive rule.</p>"
}
},
"com.amazonaws.accessanalyzer#FilterCriteriaMap": {
"type": "map",
"key": {
"target": "smithy.api#String"
},
"value": {
"target": "com.amazonaws.accessanalyzer#Criterion"
}
},
"com.amazonaws.accessanalyzer#Finding": {
"type": "structure",
"members": {
"id": {
"target": "com.amazonaws.accessanalyzer#FindingId",
"traits": {
"smithy.api#documentation": "<p>The ID of the finding.</p>",
"smithy.api#required": {}
}
},
"principal": {
"target": "com.amazonaws.accessanalyzer#PrincipalMap",
"traits": {
"smithy.api#documentation": "<p>The external principal that access to a resource within the zone of trust.</p>"
}
},
"action": {
"target": "com.amazonaws.accessanalyzer#ActionList",
"traits": {
"smithy.api#documentation": "<p>The action in the analyzed policy statement that an external principal has permission to\n use.</p>"
}
},
"resource": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The resource that an external principal has access to.</p>"
}
},
"isPublic": {
"target": "smithy.api#Boolean",
"traits": {
"smithy.api#documentation": "<p>Indicates whether the policy that generated the finding allows public access to the\n resource.</p>"
}
},
"resourceType": {
"target": "com.amazonaws.accessanalyzer#ResourceType",
"traits": {
"smithy.api#documentation": "<p>The type of the resource identified in the finding.</p>",
"smithy.api#required": {}
}
},
"condition": {
"target": "com.amazonaws.accessanalyzer#ConditionKeyMap",
"traits": {
"smithy.api#documentation": "<p>The condition in the analyzed policy statement that resulted in a finding.</p>",
"smithy.api#required": {}
}
},
"createdAt": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time at which the finding was generated.</p>",
"smithy.api#required": {}
}
},
"analyzedAt": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time at which the resource was analyzed.</p>",
"smithy.api#required": {}
}
},
"updatedAt": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time at which the finding was updated.</p>",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.accessanalyzer#FindingStatus",
"traits": {
"smithy.api#documentation": "<p>The current status of the finding.</p>",
"smithy.api#required": {}
}
},
"resourceOwnerAccount": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The AWS account ID that owns the resource.</p>",
"smithy.api#required": {}
}
},
"error": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>An error.</p>"
}
},
"sources": {
"target": "com.amazonaws.accessanalyzer#FindingSourceList",
"traits": {
"smithy.api#documentation": "<p>The sources of the finding. This indicates how the access that generated the finding is\n granted. It is populated for Amazon S3 bucket findings.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains information about a finding.</p>"
}
},
"com.amazonaws.accessanalyzer#FindingChangeType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "CHANGED",
"name": "CHANGED"
},
{
"value": "NEW",
"name": "NEW"
},
{
"value": "UNCHANGED",
"name": "UNCHANGED"
}
]
}
},
"com.amazonaws.accessanalyzer#FindingId": {
"type": "string"
},
"com.amazonaws.accessanalyzer#FindingIdList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#FindingId"
}
},
"com.amazonaws.accessanalyzer#FindingSource": {
"type": "structure",
"members": {
"type": {
"target": "com.amazonaws.accessanalyzer#FindingSourceType",
"traits": {
"smithy.api#documentation": "<p>Indicates the type of access that generated the finding.</p>",
"smithy.api#required": {}
}
},
"detail": {
"target": "com.amazonaws.accessanalyzer#FindingSourceDetail",
"traits": {
"smithy.api#documentation": "<p>Includes details about how the access that generated the finding is granted. This is\n populated for Amazon S3 bucket findings.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The source of the finding. This indicates how the access that generated the finding is\n granted. It is populated for Amazon S3 bucket findings.</p>"
}
},
"com.amazonaws.accessanalyzer#FindingSourceDetail": {
"type": "structure",
"members": {
"accessPointArn": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The ARN of the access point that generated the finding.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Includes details about how the access that generated the finding is granted. This is\n populated for Amazon S3 bucket findings.</p>"
}
},
"com.amazonaws.accessanalyzer#FindingSourceList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#FindingSource"
}
},
"com.amazonaws.accessanalyzer#FindingSourceType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "POLICY",
"name": "POLICY"
},
{
"value": "BUCKET_ACL",
"name": "BUCKET_ACL"
},
{
"value": "S3_ACCESS_POINT",
"name": "S3_ACCESS_POINT"
}
]
}
},
"com.amazonaws.accessanalyzer#FindingStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "ACTIVE",
"name": "ACTIVE"
},
{
"value": "ARCHIVED",
"name": "ARCHIVED"
},
{
"value": "RESOLVED",
"name": "RESOLVED"
}
]
}
},
"com.amazonaws.accessanalyzer#FindingStatusUpdate": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "ACTIVE",
"name": "ACTIVE"
},
{
"value": "ARCHIVED",
"name": "ARCHIVED"
}
]
}
},
"com.amazonaws.accessanalyzer#FindingSummary": {
"type": "structure",
"members": {
"id": {
"target": "com.amazonaws.accessanalyzer#FindingId",
"traits": {
"smithy.api#documentation": "<p>The ID of the finding.</p>",
"smithy.api#required": {}
}
},
"principal": {
"target": "com.amazonaws.accessanalyzer#PrincipalMap",
"traits": {
"smithy.api#documentation": "<p>The external principal that has access to a resource within the zone of trust.</p>"
}
},
"action": {
"target": "com.amazonaws.accessanalyzer#ActionList",
"traits": {
"smithy.api#documentation": "<p>The action in the analyzed policy statement that an external principal has permission to\n use.</p>"
}
},
"resource": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The resource that the external principal has access to.</p>"
}
},
"isPublic": {
"target": "smithy.api#Boolean",
"traits": {
"smithy.api#documentation": "<p>Indicates whether the finding reports a resource that has a policy that allows public\n access.</p>"
}
},
"resourceType": {
"target": "com.amazonaws.accessanalyzer#ResourceType",
"traits": {
"smithy.api#documentation": "<p>The type of the resource that the external principal has access to.</p>",
"smithy.api#required": {}
}
},
"condition": {
"target": "com.amazonaws.accessanalyzer#ConditionKeyMap",
"traits": {
"smithy.api#documentation": "<p>The condition in the analyzed policy statement that resulted in a finding.</p>",
"smithy.api#required": {}
}
},
"createdAt": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time at which the finding was created.</p>",
"smithy.api#required": {}
}
},
"analyzedAt": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time at which the resource-based policy that generated the finding was\n analyzed.</p>",
"smithy.api#required": {}
}
},
"updatedAt": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time at which the finding was most recently updated.</p>",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.accessanalyzer#FindingStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the finding.</p>",
"smithy.api#required": {}
}
},
"resourceOwnerAccount": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The AWS account ID that owns the resource.</p>",
"smithy.api#required": {}
}
},
"error": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The error that resulted in an Error finding.</p>"
}
},
"sources": {
"target": "com.amazonaws.accessanalyzer#FindingSourceList",
"traits": {
"smithy.api#documentation": "<p>The sources of the finding. This indicates how the access that generated the finding is\n granted. It is populated for Amazon S3 bucket findings.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains information about a finding.</p>"
}
},
"com.amazonaws.accessanalyzer#FindingsList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#FindingSummary"
}
},
"com.amazonaws.accessanalyzer#GeneratedPolicy": {
"type": "structure",
"members": {
"policy": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The text to use as the content for the new policy. The policy is created using the\n <a href=\"https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html\">CreatePolicy</a> action.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains the text for the generated policy.</p>"
}
},
"com.amazonaws.accessanalyzer#GeneratedPolicyList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#GeneratedPolicy"
}
},
"com.amazonaws.accessanalyzer#GeneratedPolicyProperties": {
"type": "structure",
"members": {
"isComplete": {
"target": "smithy.api#Boolean",
"traits": {
"smithy.api#documentation": "<p>This value is set to <code>true</code> if the generated policy contains all possible actions for a\n service that Access Analyzer identified from the CloudTrail trail that you specified, and\n <code>false</code> otherwise.</p>"
}
},
"principalArn": {
"target": "com.amazonaws.accessanalyzer#PrincipalArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the IAM entity (user or role) for which you are generating a policy.</p>",
"smithy.api#required": {}
}
},
"cloudTrailProperties": {
"target": "com.amazonaws.accessanalyzer#CloudTrailProperties",
"traits": {
"smithy.api#documentation": "<p>Lists details about the <code>Trail</code> used to generated policy.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains the generated policy details.</p>"
}
},
"com.amazonaws.accessanalyzer#GeneratedPolicyResult": {
"type": "structure",
"members": {
"properties": {
"target": "com.amazonaws.accessanalyzer#GeneratedPolicyProperties",
"traits": {
"smithy.api#documentation": "<p>A <code>GeneratedPolicyProperties</code> object that contains properties of the\n generated policy.</p>",
"smithy.api#required": {}
}
},
"generatedPolicies": {
"target": "com.amazonaws.accessanalyzer#GeneratedPolicyList",
"traits": {
"smithy.api#documentation": "<p>The text to use as the content for the new policy. The policy is created using the\n <a href=\"https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html\">CreatePolicy</a> action.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains the text for the generated policy and its details.</p>"
}
},
"com.amazonaws.accessanalyzer#GetAccessPreview": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#GetAccessPreviewRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#GetAccessPreviewResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves information about an access preview for the specified analyzer.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/access-preview/{accessPreviewId}",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.accessanalyzer#GetAccessPreviewRequest": {
"type": "structure",
"members": {
"accessPreviewId": {
"target": "com.amazonaws.accessanalyzer#AccessPreviewId",
"traits": {
"smithy.api#documentation": "<p>The unique ID for the access preview.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"analyzerArn": {
"target": "com.amazonaws.accessanalyzer#AnalyzerArn",
"traits": {
"smithy.api#documentation": "<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of\n the analyzer</a> used to generate the access preview.</p>",
"smithy.api#httpQuery": "analyzerArn",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.accessanalyzer#GetAccessPreviewResponse": {
"type": "structure",
"members": {
"accessPreview": {
"target": "com.amazonaws.accessanalyzer#AccessPreview",
"traits": {
"smithy.api#documentation": "<p>An object that contains information about the access preview.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.accessanalyzer#GetAnalyzedResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#GetAnalyzedResourceRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#GetAnalyzedResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves information about a resource that was analyzed.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/analyzed-resource",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.accessanalyzer#GetAnalyzedResourceRequest": {
"type": "structure",
"members": {
"analyzerArn": {
"target": "com.amazonaws.accessanalyzer#AnalyzerArn",
"traits": {
"smithy.api#documentation": "<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of\n the analyzer</a> to retrieve information from.</p>",
"smithy.api#httpQuery": "analyzerArn",
"smithy.api#required": {}
}
},
"resourceArn": {
"target": "com.amazonaws.accessanalyzer#ResourceArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the resource to retrieve information about.</p>",
"smithy.api#httpQuery": "resourceArn",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Retrieves an analyzed resource.</p>"
}
},
"com.amazonaws.accessanalyzer#GetAnalyzedResourceResponse": {
"type": "structure",
"members": {
"resource": {
"target": "com.amazonaws.accessanalyzer#AnalyzedResource",
"traits": {
"smithy.api#documentation": "<p>An <code>AnalyzedResource</code> object that contains information that Access Analyzer found\n when it analyzed the resource.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The response to the request.</p>"
}
},
"com.amazonaws.accessanalyzer#GetAnalyzer": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#GetAnalyzerRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#GetAnalyzerResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves information about the specified analyzer.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/analyzer/{analyzerName}",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.accessanalyzer#GetAnalyzerRequest": {
"type": "structure",
"members": {
"analyzerName": {
"target": "com.amazonaws.accessanalyzer#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the analyzer retrieved.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Retrieves an analyzer.</p>"
}
},
"com.amazonaws.accessanalyzer#GetAnalyzerResponse": {
"type": "structure",
"members": {
"analyzer": {
"target": "com.amazonaws.accessanalyzer#AnalyzerSummary",
"traits": {
"smithy.api#documentation": "<p>An <code>AnalyzerSummary</code> object that contains information about the\n analyzer.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The response to the request.</p>"
}
},
"com.amazonaws.accessanalyzer#GetArchiveRule": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#GetArchiveRuleRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#GetArchiveRuleResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves information about an archive rule.</p>\n <p>To learn about filter keys that you can use to create an archive rule, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html\">Access Analyzer filter keys</a> in the <b>IAM User\n Guide</b>.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/analyzer/{analyzerName}/archive-rule/{ruleName}",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.accessanalyzer#GetArchiveRuleRequest": {
"type": "structure",
"members": {
"analyzerName": {
"target": "com.amazonaws.accessanalyzer#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the analyzer to retrieve rules from.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"ruleName": {
"target": "com.amazonaws.accessanalyzer#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the rule to retrieve.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Retrieves an archive rule.</p>"
}
},
"com.amazonaws.accessanalyzer#GetArchiveRuleResponse": {
"type": "structure",
"members": {
"archiveRule": {
"target": "com.amazonaws.accessanalyzer#ArchiveRuleSummary",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The response to the request.</p>"
}
},
"com.amazonaws.accessanalyzer#GetFinding": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#GetFindingRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#GetFindingResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves information about the specified finding.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/finding/{id}",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.accessanalyzer#GetFindingRequest": {
"type": "structure",
"members": {
"analyzerArn": {
"target": "com.amazonaws.accessanalyzer#AnalyzerArn",
"traits": {
"smithy.api#documentation": "<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of\n the analyzer</a> that generated the finding.</p>",
"smithy.api#httpQuery": "analyzerArn",
"smithy.api#required": {}
}
},
"id": {
"target": "com.amazonaws.accessanalyzer#FindingId",
"traits": {
"smithy.api#documentation": "<p>The ID of the finding to retrieve.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Retrieves a finding.</p>"
}
},
"com.amazonaws.accessanalyzer#GetFindingResponse": {
"type": "structure",
"members": {
"finding": {
"target": "com.amazonaws.accessanalyzer#Finding",
"traits": {
"smithy.api#documentation": "<p>A <code>finding</code> object that contains finding details.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The response to the request.</p>"
}
},
"com.amazonaws.accessanalyzer#GetGeneratedPolicy": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#GetGeneratedPolicyRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#GetGeneratedPolicyResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves the policy that was generated using <code>StartPolicyGeneration</code>.\n </p>",
"smithy.api#http": {
"method": "GET",
"uri": "/policy/generation/{jobId}",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.accessanalyzer#GetGeneratedPolicyRequest": {
"type": "structure",
"members": {
"jobId": {
"target": "com.amazonaws.accessanalyzer#JobId",
"traits": {
"smithy.api#documentation": "<p>The <code>JobId</code> that is returned by the <code>StartPolicyGeneration</code>\n operation. The <code>JobId</code> can be used with <code>GetGeneratedPolicy</code> to\n retrieve the generated policies or used with <code>CancelPolicyGeneration</code> to cancel\n the policy generation request.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"includeResourcePlaceholders": {
"target": "smithy.api#Boolean",
"traits": {
"smithy.api#documentation": "<p>The level of detail that you want to generate. You can specify whether to generate\n policies with placeholders for resource ARNs for actions that support resource level\n granularity in policies.</p>\n <p>For example, in the resource section of a policy, you can receive a placeholder such as\n <code>\"Resource\":\"arn:aws:s3:::${BucketName}\"</code> instead of <code>\"*\"</code>.</p>",
"smithy.api#httpQuery": "includeResourcePlaceholders"
}
},
"includeServiceLevelTemplate": {
"target": "smithy.api#Boolean",
"traits": {
"smithy.api#documentation": "<p>The level of detail that you want to generate. You can specify whether to generate\n service-level policies. </p>\n <p>Access Analyzer uses <code>iam:servicelastaccessed</code> to identify services that have been\n used recently to create this service-level template.</p>",
"smithy.api#httpQuery": "includeServiceLevelTemplate"
}
}
}
},
"com.amazonaws.accessanalyzer#GetGeneratedPolicyResponse": {
"type": "structure",
"members": {
"jobDetails": {
"target": "com.amazonaws.accessanalyzer#JobDetails",
"traits": {
"smithy.api#documentation": "<p>A <code>GeneratedPolicyDetails</code> object that contains details about the generated\n policy.</p>",
"smithy.api#required": {}
}
},
"generatedPolicyResult": {
"target": "com.amazonaws.accessanalyzer#GeneratedPolicyResult",
"traits": {
"smithy.api#documentation": "<p>A <code>GeneratedPolicyResult</code> object that contains the generated policies and\n associated details.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.accessanalyzer#GranteePrincipal": {
"type": "string"
},
"com.amazonaws.accessanalyzer#IamRoleConfiguration": {
"type": "structure",
"members": {
"trustPolicy": {
"target": "com.amazonaws.accessanalyzer#IamTrustPolicy",
"traits": {
"smithy.api#documentation": "<p>The proposed trust policy for the IAM role.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The proposed access control configuration for an IAM role. You can propose a\n configuration for a new IAM role or an existing IAM role that you own by specifying the\n trust policy. If the configuration is for a new IAM role, you must specify the trust\n policy. If the configuration is for an existing IAM role that you own and you do not\n propose the trust policy, the access preview uses the existing trust policy for the role.\n The proposed trust policy cannot be an empty string. For more information about role trust\n policy limits, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html\">IAM and STS\n quotas</a>.</p>"
}
},
"com.amazonaws.accessanalyzer#IamTrustPolicy": {
"type": "string"
},
"com.amazonaws.accessanalyzer#InlineArchiveRule": {
"type": "structure",
"members": {
"ruleName": {
"target": "com.amazonaws.accessanalyzer#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the rule.</p>",
"smithy.api#required": {}
}
},
"filter": {
"target": "com.amazonaws.accessanalyzer#FilterCriteriaMap",
"traits": {
"smithy.api#documentation": "<p>The condition and values for a criterion.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An criterion statement in an archive rule. Each archive rule may have multiple\n criteria.</p>"
}
},
"com.amazonaws.accessanalyzer#InlineArchiveRulesList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#InlineArchiveRule"
}
},
"com.amazonaws.accessanalyzer#InternalServerException": {
"type": "structure",
"members": {
"message": {
"target": "smithy.api#String",
"traits": {
"smithy.api#required": {}
}
},
"retryAfterSeconds": {
"target": "smithy.api#Integer",
"traits": {
"smithy.api#documentation": "<p>The seconds to wait to retry.</p>",
"smithy.api#httpHeader": "Retry-After"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Internal server error.</p>",
"smithy.api#error": "server",
"smithy.api#httpError": 500,
"smithy.api#retryable": {}
}
},
"com.amazonaws.accessanalyzer#InternetConfiguration": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>This configuration sets the Amazon S3 access point network origin to\n <code>Internet</code>.</p>"
}
},
"com.amazonaws.accessanalyzer#IssueCode": {
"type": "string"
},
"com.amazonaws.accessanalyzer#IssuingAccount": {
"type": "string"
},
"com.amazonaws.accessanalyzer#JobDetails": {
"type": "structure",
"members": {
"jobId": {
"target": "com.amazonaws.accessanalyzer#JobId",
"traits": {
"smithy.api#documentation": "<p>The <code>JobId</code> that is returned by the <code>StartPolicyGeneration</code>\n operation. The <code>JobId</code> can be used with <code>GetGeneratedPolicy</code> to\n retrieve the generated policies or used with <code>CancelPolicyGeneration</code> to cancel\n the policy generation request.</p>",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.accessanalyzer#JobStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the job request.</p>",
"smithy.api#required": {}
}
},
"startedOn": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>A timestamp of when the job was started.</p>",
"smithy.api#required": {}
}
},
"completedOn": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>A timestamp of when the job was completed.</p>"
}
},
"jobError": {
"target": "com.amazonaws.accessanalyzer#JobError"
}
},
"traits": {
"smithy.api#documentation": "<p>Contains details about the policy generation request.</p>"
}
},
"com.amazonaws.accessanalyzer#JobError": {
"type": "structure",
"members": {
"code": {
"target": "com.amazonaws.accessanalyzer#JobErrorCode",
"traits": {
"smithy.api#documentation": "<p>The job error code.</p>",
"smithy.api#required": {}
}
},
"message": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>Specific information about the error. For example, which service quota was exceeded or\n which resource was not found.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains the details about the policy generation error.</p>"
}
},
"com.amazonaws.accessanalyzer#JobErrorCode": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "AUTHORIZATION_ERROR",
"name": "AUTHORIZATION_ERROR"
},
{
"value": "RESOURCE_NOT_FOUND_ERROR",
"name": "RESOURCE_NOT_FOUND_ERROR"
},
{
"value": "SERVICE_QUOTA_EXCEEDED_ERROR",
"name": "SERVICE_QUOTA_EXCEEDED_ERROR"
},
{
"value": "SERVICE_ERROR",
"name": "SERVICE_ERROR"
}
]
}
},
"com.amazonaws.accessanalyzer#JobId": {
"type": "string"
},
"com.amazonaws.accessanalyzer#JobStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "IN_PROGRESS",
"name": "IN_PROGRESS"
},
{
"value": "SUCCEEDED",
"name": "SUCCEEDED"
},
{
"value": "FAILED",
"name": "FAILED"
},
{
"value": "CANCELED",
"name": "CANCELED"
}
]
}
},
"com.amazonaws.accessanalyzer#KmsConstraintsKey": {
"type": "string"
},
"com.amazonaws.accessanalyzer#KmsConstraintsMap": {
"type": "map",
"key": {
"target": "com.amazonaws.accessanalyzer#KmsConstraintsKey"
},
"value": {
"target": "com.amazonaws.accessanalyzer#KmsConstraintsValue"
}
},
"com.amazonaws.accessanalyzer#KmsConstraintsValue": {
"type": "string"
},
"com.amazonaws.accessanalyzer#KmsGrantConfiguration": {
"type": "structure",
"members": {
"operations": {
"target": "com.amazonaws.accessanalyzer#KmsGrantOperationsList",
"traits": {
"smithy.api#documentation": "<p>A list of operations that the grant permits.</p>",
"smithy.api#required": {}
}
},
"granteePrincipal": {
"target": "com.amazonaws.accessanalyzer#GranteePrincipal",
"traits": {
"smithy.api#documentation": "<p>The principal that is given permission to perform the operations that the grant\n permits.</p>",
"smithy.api#required": {}
}
},
"retiringPrincipal": {
"target": "com.amazonaws.accessanalyzer#RetiringPrincipal",
"traits": {
"smithy.api#documentation": "<p>The principal that is given permission to retire the grant by using <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_RetireGrant.html\">RetireGrant</a> operation.</p>"
}
},
"constraints": {
"target": "com.amazonaws.accessanalyzer#KmsGrantConstraints",
"traits": {
"smithy.api#documentation": "<p>Use this structure to propose allowing <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations\">cryptographic\n operations</a> in the grant only when the operation request includes the specified\n <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context\">encryption\n context</a>.</p>"
}
},
"issuingAccount": {
"target": "com.amazonaws.accessanalyzer#IssuingAccount",
"traits": {
"smithy.api#documentation": "<p> The AWS account under which the grant was issued. The account is used to propose KMS\n grants issued by accounts other than the owner of the key.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A proposed grant configuration for a KMS key. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html\">CreateGrant</a>.</p>"
}
},
"com.amazonaws.accessanalyzer#KmsGrantConfigurationsList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#KmsGrantConfiguration"
}
},
"com.amazonaws.accessanalyzer#KmsGrantConstraints": {
"type": "structure",
"members": {
"encryptionContextEquals": {
"target": "com.amazonaws.accessanalyzer#KmsConstraintsMap",
"traits": {
"smithy.api#documentation": "<p>A list of key-value pairs that must match the encryption context in the <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations\">cryptographic\n operation</a> request. The grant allows the operation only when the encryption\n context in the request is the same as the encryption context specified in this\n constraint.</p>"
}
},
"encryptionContextSubset": {
"target": "com.amazonaws.accessanalyzer#KmsConstraintsMap",
"traits": {
"smithy.api#documentation": "<p>A list of key-value pairs that must be included in the encryption context of the <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations\">cryptographic\n operation</a> request. The grant allows the cryptographic operation only when the\n encryption context in the request includes the key-value pairs specified in this\n constraint, although it can include additional key-value pairs.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Use this structure to propose allowing <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations\">cryptographic\n operations</a> in the grant only when the operation request includes the specified\n <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context\">encryption\n context</a>. You can specify only one type of encryption context. An empty map is\n treated as not specified. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_GrantConstraints.html\">GrantConstraints</a>.</p>"
}
},
"com.amazonaws.accessanalyzer#KmsGrantOperation": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "CreateGrant",
"name": "CREATE_GRANT"
},
{
"value": "Decrypt",
"name": "DECRYPT"
},
{
"value": "DescribeKey",
"name": "DESCRIBE_KEY"
},
{
"value": "Encrypt",
"name": "ENCRYPT"
},
{
"value": "GenerateDataKey",
"name": "GENERATE_DATA_KEY"
},
{
"value": "GenerateDataKeyPair",
"name": "GENERATE_DATA_KEY_PAIR"
},
{
"value": "GenerateDataKeyPairWithoutPlaintext",
"name": "GENERATE_DATA_KEY_PAIR_WITHOUT_PLAINTEXT"
},
{
"value": "GenerateDataKeyWithoutPlaintext",
"name": "GENERATE_DATA_KEY_WITHOUT_PLAINTEXT"
},
{
"value": "GetPublicKey",
"name": "GET_PUBLIC_KEY"
},
{
"value": "ReEncryptFrom",
"name": "REENCRYPT_FROM"
},
{
"value": "ReEncryptTo",
"name": "REENCRYPT_TO"
},
{
"value": "RetireGrant",
"name": "RETIRE_GRANT"
},
{
"value": "Sign",
"name": "SIGN"
},
{
"value": "Verify",
"name": "VERIFY"
}
]
}
},
"com.amazonaws.accessanalyzer#KmsGrantOperationsList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#KmsGrantOperation"
}
},
"com.amazonaws.accessanalyzer#KmsKeyConfiguration": {
"type": "structure",
"members": {
"keyPolicies": {
"target": "com.amazonaws.accessanalyzer#KmsKeyPoliciesMap",
"traits": {
"smithy.api#documentation": "<p>Resource policy configuration for the KMS key. The only valid value for the name of the\n key policy is <code>default</code>. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default\">Default key\n policy</a>.</p>"
}
},
"grants": {
"target": "com.amazonaws.accessanalyzer#KmsGrantConfigurationsList",
"traits": {
"smithy.api#documentation": "<p>A list of proposed grant configurations for the KMS key. If the proposed grant\n configuration is for an existing key, the access preview uses the proposed list of grant\n configurations in place of the existing grants. Otherwise, the access preview uses the\n existing grants for the key.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Proposed access control configuration for a KMS key. You can propose a configuration for\n a new KMS key or an existing KMS key that you own by specifying the key policy and KMS\n grant configuration. If the configuration is for an existing key and you do not specify the\n key policy, the access preview uses the existing policy for the key. If the access preview\n is for a new resource and you do not specify the key policy, then the access preview uses\n the default key policy. The proposed key policy cannot be an empty string. For more\n information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default\">Default key\n policy</a>. For more information about key policy limits, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html\">Resource\n quotas</a>.</p>\n <p/>"
}
},
"com.amazonaws.accessanalyzer#KmsKeyPoliciesMap": {
"type": "map",
"key": {
"target": "com.amazonaws.accessanalyzer#PolicyName"
},
"value": {
"target": "com.amazonaws.accessanalyzer#KmsKeyPolicy"
}
},
"com.amazonaws.accessanalyzer#KmsKeyPolicy": {
"type": "string"
},
"com.amazonaws.accessanalyzer#LearnMoreLink": {
"type": "string"
},
"com.amazonaws.accessanalyzer#ListAccessPreviewFindings": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#ListAccessPreviewFindingsRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#ListAccessPreviewFindingsResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#ConflictException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves a list of access preview findings generated by the specified access\n preview.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/access-preview/{accessPreviewId}",
"code": 200
},
"smithy.api#paginated": {
"items": "findings"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.accessanalyzer#ListAccessPreviewFindingsRequest": {
"type": "structure",
"members": {
"accessPreviewId": {
"target": "com.amazonaws.accessanalyzer#AccessPreviewId",
"traits": {
"smithy.api#documentation": "<p>The unique ID for the access preview.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"analyzerArn": {
"target": "com.amazonaws.accessanalyzer#AnalyzerArn",
"traits": {
"smithy.api#documentation": "<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of\n the analyzer</a> used to generate the access.</p>",
"smithy.api#required": {}
}
},
"filter": {
"target": "com.amazonaws.accessanalyzer#FilterCriteriaMap",
"traits": {
"smithy.api#documentation": "<p>Criteria to filter the returned findings.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.accessanalyzer#Token",
"traits": {
"smithy.api#documentation": "<p>A token used for pagination of results returned.</p>"
}
},
"maxResults": {
"target": "smithy.api#Integer",
"traits": {
"smithy.api#documentation": "<p>The maximum number of results to return in the response.</p>"
}
}
}
},
"com.amazonaws.accessanalyzer#ListAccessPreviewFindingsResponse": {
"type": "structure",
"members": {
"findings": {
"target": "com.amazonaws.accessanalyzer#AccessPreviewFindingsList",
"traits": {
"smithy.api#documentation": "<p>A list of access preview findings that match the specified filter criteria.</p>",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.accessanalyzer#Token",
"traits": {
"smithy.api#documentation": "<p>A token used for pagination of results returned.</p>"
}
}
}
},
"com.amazonaws.accessanalyzer#ListAccessPreviews": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#ListAccessPreviewsRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#ListAccessPreviewsResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves a list of access previews for the specified analyzer.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/access-preview",
"code": 200
},
"smithy.api#paginated": {
"items": "accessPreviews"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.accessanalyzer#ListAccessPreviewsRequest": {
"type": "structure",
"members": {
"analyzerArn": {
"target": "com.amazonaws.accessanalyzer#AnalyzerArn",
"traits": {
"smithy.api#documentation": "<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of\n the analyzer</a> used to generate the access preview.</p>",
"smithy.api#httpQuery": "analyzerArn",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.accessanalyzer#Token",
"traits": {
"smithy.api#documentation": "<p>A token used for pagination of results returned.</p>",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "smithy.api#Integer",
"traits": {
"smithy.api#documentation": "<p>The maximum number of results to return in the response.</p>",
"smithy.api#httpQuery": "maxResults"
}
}
}
},
"com.amazonaws.accessanalyzer#ListAccessPreviewsResponse": {
"type": "structure",
"members": {
"accessPreviews": {
"target": "com.amazonaws.accessanalyzer#AccessPreviewsList",
"traits": {
"smithy.api#documentation": "<p>A list of access previews retrieved for the analyzer.</p>",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.accessanalyzer#Token",
"traits": {
"smithy.api#documentation": "<p>A token used for pagination of results returned.</p>"
}
}
}
},
"com.amazonaws.accessanalyzer#ListAnalyzedResources": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#ListAnalyzedResourcesRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#ListAnalyzedResourcesResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves a list of resources of the specified type that have been analyzed by the\n specified analyzer..</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/analyzed-resource",
"code": 200
},
"smithy.api#paginated": {
"items": "analyzedResources"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.accessanalyzer#ListAnalyzedResourcesRequest": {
"type": "structure",
"members": {
"analyzerArn": {
"target": "com.amazonaws.accessanalyzer#AnalyzerArn",
"traits": {
"smithy.api#documentation": "<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of\n the analyzer</a> to retrieve a list of analyzed resources from.</p>",
"smithy.api#required": {}
}
},
"resourceType": {
"target": "com.amazonaws.accessanalyzer#ResourceType",
"traits": {
"smithy.api#documentation": "<p>The type of resource.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.accessanalyzer#Token",
"traits": {
"smithy.api#documentation": "<p>A token used for pagination of results returned.</p>"
}
},
"maxResults": {
"target": "smithy.api#Integer",
"traits": {
"smithy.api#documentation": "<p>The maximum number of results to return in the response.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Retrieves a list of resources that have been analyzed.</p>"
}
},
"com.amazonaws.accessanalyzer#ListAnalyzedResourcesResponse": {
"type": "structure",
"members": {
"analyzedResources": {
"target": "com.amazonaws.accessanalyzer#AnalyzedResourcesList",
"traits": {
"smithy.api#documentation": "<p>A list of resources that were analyzed.</p>",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.accessanalyzer#Token",
"traits": {
"smithy.api#documentation": "<p>A token used for pagination of results returned.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The response to the request.</p>"
}
},
"com.amazonaws.accessanalyzer#ListAnalyzers": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#ListAnalyzersRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#ListAnalyzersResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves a list of analyzers.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/analyzer",
"code": 200
},
"smithy.api#paginated": {
"items": "analyzers"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.accessanalyzer#ListAnalyzersRequest": {
"type": "structure",
"members": {
"nextToken": {
"target": "com.amazonaws.accessanalyzer#Token",
"traits": {
"smithy.api#documentation": "<p>A token used for pagination of results returned.</p>",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "smithy.api#Integer",
"traits": {
"smithy.api#documentation": "<p>The maximum number of results to return in the response.</p>",
"smithy.api#httpQuery": "maxResults"
}
},
"type": {
"target": "com.amazonaws.accessanalyzer#Type",
"traits": {
"smithy.api#documentation": "<p>The type of analyzer.</p>",
"smithy.api#httpQuery": "type"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Retrieves a list of analyzers.</p>"
}
},
"com.amazonaws.accessanalyzer#ListAnalyzersResponse": {
"type": "structure",
"members": {
"analyzers": {
"target": "com.amazonaws.accessanalyzer#AnalyzersList",
"traits": {
"smithy.api#documentation": "<p>The analyzers retrieved.</p>",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.accessanalyzer#Token",
"traits": {
"smithy.api#documentation": "<p>A token used for pagination of results returned.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The response to the request.</p>"
}
},
"com.amazonaws.accessanalyzer#ListArchiveRules": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#ListArchiveRulesRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#ListArchiveRulesResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves a list of archive rules created for the specified analyzer.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/analyzer/{analyzerName}/archive-rule",
"code": 200
},
"smithy.api#paginated": {
"items": "archiveRules"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.accessanalyzer#ListArchiveRulesRequest": {
"type": "structure",
"members": {
"analyzerName": {
"target": "com.amazonaws.accessanalyzer#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the analyzer to retrieve rules from.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.accessanalyzer#Token",
"traits": {
"smithy.api#documentation": "<p>A token used for pagination of results returned.</p>",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "smithy.api#Integer",
"traits": {
"smithy.api#documentation": "<p>The maximum number of results to return in the request.</p>",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Retrieves a list of archive rules created for the specified analyzer.</p>"
}
},
"com.amazonaws.accessanalyzer#ListArchiveRulesResponse": {
"type": "structure",
"members": {
"archiveRules": {
"target": "com.amazonaws.accessanalyzer#ArchiveRulesList",
"traits": {
"smithy.api#documentation": "<p>A list of archive rules created for the specified analyzer.</p>",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.accessanalyzer#Token",
"traits": {
"smithy.api#documentation": "<p>A token used for pagination of results returned.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The response to the request.</p>"
}
},
"com.amazonaws.accessanalyzer#ListFindings": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#ListFindingsRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#ListFindingsResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves a list of findings generated by the specified analyzer.</p>\n <p>To learn about filter keys that you can use to retrieve a list of findings, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html\">Access Analyzer filter keys</a> in the <b>IAM User\n Guide</b>.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/finding",
"code": 200
},
"smithy.api#paginated": {
"items": "findings"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.accessanalyzer#ListFindingsRequest": {
"type": "structure",
"members": {
"analyzerArn": {
"target": "com.amazonaws.accessanalyzer#AnalyzerArn",
"traits": {
"smithy.api#documentation": "<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of\n the analyzer</a> to retrieve findings from.</p>",
"smithy.api#required": {}
}
},
"filter": {
"target": "com.amazonaws.accessanalyzer#FilterCriteriaMap",
"traits": {
"smithy.api#documentation": "<p>A filter to match for the findings to return.</p>"
}
},
"sort": {
"target": "com.amazonaws.accessanalyzer#SortCriteria",
"traits": {
"smithy.api#documentation": "<p>The sort order for the findings returned.</p>"
}
},
"nextToken": {
"target": "com.amazonaws.accessanalyzer#Token",
"traits": {
"smithy.api#documentation": "<p>A token used for pagination of results returned.</p>"
}
},
"maxResults": {
"target": "smithy.api#Integer",
"traits": {
"smithy.api#documentation": "<p>The maximum number of results to return in the response.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Retrieves a list of findings generated by the specified analyzer.</p>"
}
},
"com.amazonaws.accessanalyzer#ListFindingsResponse": {
"type": "structure",
"members": {
"findings": {
"target": "com.amazonaws.accessanalyzer#FindingsList",
"traits": {
"smithy.api#documentation": "<p>A list of findings retrieved from the analyzer that match the filter criteria specified,\n if any.</p>",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.accessanalyzer#Token",
"traits": {
"smithy.api#documentation": "<p>A token used for pagination of results returned.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The response to the request.</p>"
}
},
"com.amazonaws.accessanalyzer#ListPolicyGenerations": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#ListPolicyGenerationsRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#ListPolicyGenerationsResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Lists all of the policy generations requested in the last seven days.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/policy/generation",
"code": 200
},
"smithy.api#paginated": {
"items": "policyGenerations"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.accessanalyzer#ListPolicyGenerationsRequest": {
"type": "structure",
"members": {
"principalArn": {
"target": "com.amazonaws.accessanalyzer#PrincipalArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the IAM entity (user or role) for which you are generating a policy. Use\n this with <code>ListGeneratedPolicies</code> to filter the results to only include results\n for a specific principal.</p>",
"smithy.api#httpQuery": "principalArn"
}
},
"maxResults": {
"target": "smithy.api#Integer",
"traits": {
"smithy.api#documentation": "<p>The maximum number of results to return in the response.</p>",
"smithy.api#httpQuery": "maxResults",
"smithy.api#range": {
"min": 1
}
}
},
"nextToken": {
"target": "com.amazonaws.accessanalyzer#Token",
"traits": {
"smithy.api#documentation": "<p>A token used for pagination of results returned.</p>",
"smithy.api#httpQuery": "nextToken"
}
}
}
},
"com.amazonaws.accessanalyzer#ListPolicyGenerationsResponse": {
"type": "structure",
"members": {
"policyGenerations": {
"target": "com.amazonaws.accessanalyzer#PolicyGenerationList",
"traits": {
"smithy.api#documentation": "<p>A <code>PolicyGeneration</code> object that contains details about the generated\n policy.</p>",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.accessanalyzer#Token",
"traits": {
"smithy.api#documentation": "<p>A token used for pagination of results returned.</p>"
}
}
}
},
"com.amazonaws.accessanalyzer#ListTagsForResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#ListTagsForResourceRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#ListTagsForResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves a list of tags applied to the specified resource.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/tags/{resourceArn}",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.accessanalyzer#ListTagsForResourceRequest": {
"type": "structure",
"members": {
"resourceArn": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The ARN of the resource to retrieve tags from.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Retrieves a list of tags applied to the specified resource.</p>"
}
},
"com.amazonaws.accessanalyzer#ListTagsForResourceResponse": {
"type": "structure",
"members": {
"tags": {
"target": "com.amazonaws.accessanalyzer#TagsMap",
"traits": {
"smithy.api#documentation": "<p>The tags that are applied to the specified resource.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The response to the request.</p>"
}
},
"com.amazonaws.accessanalyzer#Locale": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "DE",
"name": "DE"
},
{
"value": "EN",
"name": "EN"
},
{
"value": "ES",
"name": "ES"
},
{
"value": "FR",
"name": "FR"
},
{
"value": "IT",
"name": "IT"
},
{
"value": "JA",
"name": "JA"
},
{
"value": "KO",
"name": "KO"
},
{
"value": "PT_BR",
"name": "PT_BR"
},
{
"value": "ZH_CN",
"name": "ZH_CN"
},
{
"value": "ZH_TW",
"name": "ZH_TW"
}
]
}
},
"com.amazonaws.accessanalyzer#Location": {
"type": "structure",
"members": {
"path": {
"target": "com.amazonaws.accessanalyzer#PathElementList",
"traits": {
"smithy.api#documentation": "<p>A path in a policy, represented as a sequence of path elements.</p>",
"smithy.api#required": {}
}
},
"span": {
"target": "com.amazonaws.accessanalyzer#Span",
"traits": {
"smithy.api#documentation": "<p>A span in a policy.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A location in a policy that is represented as a path through the JSON representation and\n a corresponding span.</p>"
}
},
"com.amazonaws.accessanalyzer#LocationList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#Location"
}
},
"com.amazonaws.accessanalyzer#Name": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 255
},
"smithy.api#pattern": "^[A-Za-z][A-Za-z0-9_.-]*$"
}
},
"com.amazonaws.accessanalyzer#NetworkOriginConfiguration": {
"type": "union",
"members": {
"vpcConfiguration": {
"target": "com.amazonaws.accessanalyzer#VpcConfiguration"
},
"internetConfiguration": {
"target": "com.amazonaws.accessanalyzer#InternetConfiguration",
"traits": {
"smithy.api#documentation": "<p>The configuration for the Amazon S3 access point with an <code>Internet</code> origin.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The proposed <code>InternetConfiguration</code> or <code>VpcConfiguration</code> to\n apply to the Amazon S3 Access point. You can make the access point accessible from the internet,\n or you can specify that all requests made through that access point must originate from a\n specific virtual private cloud (VPC). You can specify only one type of network\n configuration. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/creating-access-points.html\">Creating access\n points</a>.</p>"
}
},
"com.amazonaws.accessanalyzer#OrderBy": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "ASC",
"name": "ASC"
},
{
"value": "DESC",
"name": "DESC"
}
]
}
},
"com.amazonaws.accessanalyzer#PathElement": {
"type": "union",
"members": {
"index": {
"target": "smithy.api#Integer",
"traits": {
"smithy.api#documentation": "<p>Refers to an index in a JSON array.</p>"
}
},
"key": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>Refers to a key in a JSON object.</p>"
}
},
"substring": {
"target": "com.amazonaws.accessanalyzer#Substring",
"traits": {
"smithy.api#documentation": "<p>Refers to a substring of a literal string in a JSON object.</p>"
}
},
"value": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>Refers to the value associated with a given key in a JSON object.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A single element in a path through the JSON representation of a policy.</p>"
}
},
"com.amazonaws.accessanalyzer#PathElementList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#PathElement"
}
},
"com.amazonaws.accessanalyzer#PolicyDocument": {
"type": "string"
},
"com.amazonaws.accessanalyzer#PolicyGeneration": {
"type": "structure",
"members": {
"jobId": {
"target": "com.amazonaws.accessanalyzer#JobId",
"traits": {
"smithy.api#documentation": "<p>The <code>JobId</code> that is returned by the <code>StartPolicyGeneration</code>\n operation. The <code>JobId</code> can be used with <code>GetGeneratedPolicy</code> to\n retrieve the generated policies or used with <code>CancelPolicyGeneration</code> to cancel\n the policy generation request.</p>",
"smithy.api#required": {}
}
},
"principalArn": {
"target": "com.amazonaws.accessanalyzer#PrincipalArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the IAM entity (user or role) for which you are generating a policy.</p>",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.accessanalyzer#JobStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the policy generation request.</p>",
"smithy.api#required": {}
}
},
"startedOn": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>A timestamp of when the policy generation started.</p>",
"smithy.api#required": {}
}
},
"completedOn": {
"target": "com.amazonaws.accessanalyzer#Timestamp",
"traits": {
"smithy.api#documentation": "<p>A timestamp of when the policy generation was completed.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains details about the policy generation status and properties.</p>"
}
},
"com.amazonaws.accessanalyzer#PolicyGenerationDetails": {
"type": "structure",
"members": {
"principalArn": {
"target": "com.amazonaws.accessanalyzer#PrincipalArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the IAM entity (user or role) for which you are generating a policy.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains the ARN details about the IAM entity for which the policy is\n generated.</p>"
}
},
"com.amazonaws.accessanalyzer#PolicyGenerationList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#PolicyGeneration"
}
},
"com.amazonaws.accessanalyzer#PolicyName": {
"type": "string"
},
"com.amazonaws.accessanalyzer#PolicyType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "IDENTITY_POLICY",
"name": "IDENTITY_POLICY"
},
{
"value": "RESOURCE_POLICY",
"name": "RESOURCE_POLICY"
},
{
"value": "SERVICE_CONTROL_POLICY",
"name": "SERVICE_CONTROL_POLICY"
}
]
}
},
"com.amazonaws.accessanalyzer#Position": {
"type": "structure",
"members": {
"line": {
"target": "smithy.api#Integer",
"traits": {
"smithy.api#documentation": "<p>The line of the position, starting from 1.</p>",
"smithy.api#required": {}
}
},
"column": {
"target": "smithy.api#Integer",
"traits": {
"smithy.api#documentation": "<p>The column of the position, starting from 0.</p>",
"smithy.api#required": {}
}
},
"offset": {
"target": "smithy.api#Integer",
"traits": {
"smithy.api#documentation": "<p>The offset within the policy that corresponds to the position, starting from 0.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A position in a policy.</p>"
}
},
"com.amazonaws.accessanalyzer#PrincipalArn": {
"type": "string",
"traits": {
"smithy.api#pattern": "arn:[^:]*:iam::[^:]*:(role|user)/.{1,576}$"
}
},
"com.amazonaws.accessanalyzer#PrincipalMap": {
"type": "map",
"key": {
"target": "smithy.api#String"
},
"value": {
"target": "smithy.api#String"
}
},
"com.amazonaws.accessanalyzer#ReasonCode": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "AWS_SERVICE_ACCESS_DISABLED",
"name": "AWS_SERVICE_ACCESS_DISABLED"
},
{
"value": "DELEGATED_ADMINISTRATOR_DEREGISTERED",
"name": "DELEGATED_ADMINISTRATOR_DEREGISTERED"
},
{
"value": "ORGANIZATION_DELETED",
"name": "ORGANIZATION_DELETED"
},
{
"value": "SERVICE_LINKED_ROLE_CREATION_FAILED",
"name": "SERVICE_LINKED_ROLE_CREATION_FAILED"
}
]
}
},
"com.amazonaws.accessanalyzer#RegionList": {
"type": "list",
"member": {
"target": "smithy.api#String"
}
},
"com.amazonaws.accessanalyzer#ResourceArn": {
"type": "string",
"traits": {
"smithy.api#pattern": "arn:[^:]*:[^:]*:[^:]*:[^:]*:.*$"
}
},
"com.amazonaws.accessanalyzer#ResourceNotFoundException": {
"type": "structure",
"members": {
"message": {
"target": "smithy.api#String",
"traits": {
"smithy.api#required": {}
}
},
"resourceId": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The ID of the resource.</p>",
"smithy.api#required": {}
}
},
"resourceType": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The type of the resource.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The specified resource could not be found.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 404
}
},
"com.amazonaws.accessanalyzer#ResourceType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "AWS::S3::Bucket",
"name": "AWS_S3_BUCKET"
},
{
"value": "AWS::IAM::Role",
"name": "AWS_IAM_ROLE"
},
{
"value": "AWS::SQS::Queue",
"name": "AWS_SQS_QUEUE"
},
{
"value": "AWS::Lambda::Function",
"name": "AWS_LAMBDA_FUNCTION"
},
{
"value": "AWS::Lambda::LayerVersion",
"name": "AWS_LAMBDA_LAYERVERSION"
},
{
"value": "AWS::KMS::Key",
"name": "AWS_KMS_KEY"
},
{
"value": "AWS::SecretsManager::Secret",
"name": "AWS_SECRETSMANAGER_SECRET"
}
]
}
},
"com.amazonaws.accessanalyzer#RetiringPrincipal": {
"type": "string"
},
"com.amazonaws.accessanalyzer#RoleArn": {
"type": "string",
"traits": {
"smithy.api#pattern": "arn:[^:]*:iam::[^:]*:role/.{1,576}$"
}
},
"com.amazonaws.accessanalyzer#S3AccessPointConfiguration": {
"type": "structure",
"members": {
"accessPointPolicy": {
"target": "com.amazonaws.accessanalyzer#AccessPointPolicy",
"traits": {
"smithy.api#documentation": "<p>The access point policy.</p>"
}
},
"publicAccessBlock": {
"target": "com.amazonaws.accessanalyzer#S3PublicAccessBlockConfiguration",
"traits": {
"smithy.api#documentation": "<p>The proposed <code>S3PublicAccessBlock</code> configuration to apply to this Amazon S3 Access\n Point.</p>"
}
},
"networkOrigin": {
"target": "com.amazonaws.accessanalyzer#NetworkOriginConfiguration",
"traits": {
"smithy.api#documentation": "<p>The proposed <code>Internet</code> and <code>VpcConfiguration</code> to apply to this\n Amazon S3 access point. If the access preview is for a new resource and neither is specified,\n the access preview uses <code>Internet</code> for the network origin. If the access preview\n is for an existing resource and neither is specified, the access preview uses the exiting\n network origin.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The configuration for an Amazon S3 access point for the bucket. You can propose up to 10\n access points per bucket. If the proposed Amazon S3 access point configuration is for an\n existing bucket, the access preview uses the proposed access point configuration in place\n of the existing access points. To propose an access point without a policy, you can provide\n an empty string as the access point policy. For more information, see <a href=\"https://docs.aws.amazon.com/https:/docs.aws.amazon.com/AmazonS3/latest/dev/creating-access-points.html\">Creating access points</a>. For more information about access point policy limits,\n see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points-restrictions-limitations.html\">Access points\n restrictions and limitations</a>.</p>"
}
},
"com.amazonaws.accessanalyzer#S3AccessPointConfigurationsMap": {
"type": "map",
"key": {
"target": "com.amazonaws.accessanalyzer#AccessPointArn"
},
"value": {
"target": "com.amazonaws.accessanalyzer#S3AccessPointConfiguration"
}
},
"com.amazonaws.accessanalyzer#S3BucketAclGrantConfiguration": {
"type": "structure",
"members": {
"permission": {
"target": "com.amazonaws.accessanalyzer#AclPermission",
"traits": {
"smithy.api#documentation": "<p>The permissions being granted.</p>",
"smithy.api#required": {}
}
},
"grantee": {
"target": "com.amazonaws.accessanalyzer#AclGrantee",
"traits": {
"smithy.api#documentation": "<p>The grantee to whom you’re assigning access rights.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A proposed access control list grant configuration for an Amazon S3 bucket. For more\n information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#setting-acls\">How to Specify an\n ACL</a>.</p>"
}
},
"com.amazonaws.accessanalyzer#S3BucketAclGrantConfigurationsList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#S3BucketAclGrantConfiguration"
}
},
"com.amazonaws.accessanalyzer#S3BucketConfiguration": {
"type": "structure",
"members": {
"bucketPolicy": {
"target": "com.amazonaws.accessanalyzer#S3BucketPolicy",
"traits": {
"smithy.api#documentation": "<p>The proposed bucket policy for the Amazon S3 bucket.</p>"
}
},
"bucketAclGrants": {
"target": "com.amazonaws.accessanalyzer#S3BucketAclGrantConfigurationsList",
"traits": {
"smithy.api#documentation": "<p>The proposed list of ACL grants for the Amazon S3 bucket. You can propose up to 100 ACL\n grants per bucket. If the proposed grant configuration is for an existing bucket, the\n access preview uses the proposed list of grant configurations in place of the existing\n grants. Otherwise, the access preview uses the existing grants for the bucket.</p>"
}
},
"bucketPublicAccessBlock": {
"target": "com.amazonaws.accessanalyzer#S3PublicAccessBlockConfiguration",
"traits": {
"smithy.api#documentation": "<p>The proposed block public access configuration for the Amazon S3 bucket.</p>"
}
},
"accessPoints": {
"target": "com.amazonaws.accessanalyzer#S3AccessPointConfigurationsMap",
"traits": {
"smithy.api#documentation": "<p>The configuration of Amazon S3 access points for the bucket.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Proposed access control configuration for an Amazon S3 bucket. You can propose a\n configuration for a new Amazon S3 bucket or an existing Amazon S3 bucket that you own by specifying\n the Amazon S3 bucket policy, bucket ACLs, bucket BPA settings, and Amazon S3 access points attached\n to the bucket. If the configuration is for an existing Amazon S3 bucket and you do not specify\n the Amazon S3 bucket policy, the access preview uses the existing policy attached to the bucket.\n If the access preview is for a new resource and you do not specify the Amazon S3 bucket policy,\n the access preview assumes a bucket without a policy. To propose deletion of an existing\n bucket policy, you can specify an empty string. For more information about bucket policy\n limits, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html\">Bucket Policy\n Examples</a>.</p>"
}
},
"com.amazonaws.accessanalyzer#S3BucketPolicy": {
"type": "string"
},
"com.amazonaws.accessanalyzer#S3PublicAccessBlockConfiguration": {
"type": "structure",
"members": {
"ignorePublicAcls": {
"target": "smithy.api#Boolean",
"traits": {
"smithy.api#documentation": "<p> Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this\n bucket. </p>",
"smithy.api#required": {}
}
},
"restrictPublicBuckets": {
"target": "smithy.api#Boolean",
"traits": {
"smithy.api#documentation": "<p> Specifies whether Amazon S3 should restrict public bucket policies for this bucket. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The <code>PublicAccessBlock</code> configuration to apply to this Amazon S3 bucket. If the\n proposed configuration is for an existing Amazon S3 bucket and the configuration is not\n specified, the access preview uses the existing setting. If the proposed configuration is\n for a new bucket and the configuration is not specified, the access preview uses\n <code>false</code>. If the proposed configuration is for a new access point and the\n access point BPA configuration is not specified, the access preview uses <code>true</code>.\n For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html\">PublicAccessBlockConfiguration</a>. </p>"
}
},
"com.amazonaws.accessanalyzer#SecretsManagerSecretConfiguration": {
"type": "structure",
"members": {
"kmsKeyId": {
"target": "com.amazonaws.accessanalyzer#SecretsManagerSecretKmsId",
"traits": {
"smithy.api#documentation": "<p>The proposed ARN, key ID, or alias of the AWS KMS customer master key (CMK).</p>"
}
},
"secretPolicy": {
"target": "com.amazonaws.accessanalyzer#SecretsManagerSecretPolicy",
"traits": {
"smithy.api#documentation": "<p>The proposed resource policy defining who can access or manage the secret.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The configuration for a Secrets Manager secret. For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html\">CreateSecret</a>.</p>\n <p>You can propose a configuration for a new secret or an existing secret that you own by\n specifying the secret policy and optional KMS encryption key. If the configuration is for\n an existing secret and you do not specify the secret policy, the access preview uses the\n existing policy for the secret. If the access preview is for a new resource and you do not\n specify the policy, the access preview assumes a secret without a policy. To propose\n deletion of an existing policy, you can specify an empty string. If the proposed\n configuration is for a new secret and you do not specify the KMS key ID, the access preview\n uses the default CMK of the AWS account. If you specify an empty string for the KMS key\n ID, the access preview uses the default CMK of the AWS account. For more information\n about secret policy limits, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_limits.html\">Quotas for AWS Secrets\n Manager.</a>.</p>"
}
},
"com.amazonaws.accessanalyzer#SecretsManagerSecretKmsId": {
"type": "string"
},
"com.amazonaws.accessanalyzer#SecretsManagerSecretPolicy": {
"type": "string"
},
"com.amazonaws.accessanalyzer#ServiceQuotaExceededException": {
"type": "structure",
"members": {
"message": {
"target": "smithy.api#String",
"traits": {
"smithy.api#required": {}
}
},
"resourceId": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The resource ID.</p>",
"smithy.api#required": {}
}
},
"resourceType": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The resource type.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Service quote met error.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 402
}
},
"com.amazonaws.accessanalyzer#SharedViaList": {
"type": "list",
"member": {
"target": "smithy.api#String"
}
},
"com.amazonaws.accessanalyzer#SortCriteria": {
"type": "structure",
"members": {
"attributeName": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The name of the attribute to sort on.</p>"
}
},
"orderBy": {
"target": "com.amazonaws.accessanalyzer#OrderBy",
"traits": {
"smithy.api#documentation": "<p>The sort order, ascending or descending.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The criteria used to sort.</p>"
}
},
"com.amazonaws.accessanalyzer#Span": {
"type": "structure",
"members": {
"start": {
"target": "com.amazonaws.accessanalyzer#Position",
"traits": {
"smithy.api#documentation": "<p>The start position of the span (inclusive).</p>",
"smithy.api#required": {}
}
},
"end": {
"target": "com.amazonaws.accessanalyzer#Position",
"traits": {
"smithy.api#documentation": "<p>The end position of the span (exclusive).</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A span in a policy. The span consists of a start position (inclusive) and end position\n (exclusive).</p>"
}
},
"com.amazonaws.accessanalyzer#SqsQueueConfiguration": {
"type": "structure",
"members": {
"queuePolicy": {
"target": "com.amazonaws.accessanalyzer#SqsQueuePolicy",
"traits": {
"smithy.api#documentation": "<p> The proposed resource policy for the SQS queue. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The proposed access control configuration for an SQS queue. You can propose a\n configuration for a new SQS queue or an existing SQS queue that you own by specifying the\n SQS policy. If the configuration is for an existing SQS queue and you do not specify the\n SQS policy, the access preview uses the existing SQS policy for the queue. If the access\n preview is for a new resource and you do not specify the policy, the access preview assumes\n an SQS queue without a policy. To propose deletion of an existing SQS queue policy, you can\n specify an empty string for the SQS policy. For more information about SQS policy limits,\n see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-policies.html\">Quotas related\n to policies</a>.</p>"
}
},
"com.amazonaws.accessanalyzer#SqsQueuePolicy": {
"type": "string"
},
"com.amazonaws.accessanalyzer#StartPolicyGeneration": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#StartPolicyGenerationRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#StartPolicyGenerationResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#ConflictException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Starts the policy generation request.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/policy/generation",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.accessanalyzer#StartPolicyGenerationRequest": {
"type": "structure",
"members": {
"policyGenerationDetails": {
"target": "com.amazonaws.accessanalyzer#PolicyGenerationDetails",
"traits": {
"smithy.api#documentation": "<p>Contains the ARN of the IAM entity (user or role) for which you are generating a\n policy.</p>",
"smithy.api#required": {}
}
},
"cloudTrailDetails": {
"target": "com.amazonaws.accessanalyzer#CloudTrailDetails",
"traits": {
"smithy.api#documentation": "<p>A <code>CloudTrailDetails</code> object that contains details about a <code>Trail</code>\n that you want to analyze to generate policies.</p>"
}
},
"clientToken": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, the subsequent retries with the\n same client token return the result from the original successful request and they have no\n additional effect.</p>\n <p>If you do not specify a client token, one is automatically generated by the AWS\n SDK.</p>",
"smithy.api#idempotencyToken": {}
}
}
}
},
"com.amazonaws.accessanalyzer#StartPolicyGenerationResponse": {
"type": "structure",
"members": {
"jobId": {
"target": "com.amazonaws.accessanalyzer#JobId",
"traits": {
"smithy.api#documentation": "<p>The <code>JobId</code> that is returned by the <code>StartPolicyGeneration</code>\n operation. The <code>JobId</code> can be used with <code>GetGeneratedPolicy</code> to\n retrieve the generated policies or used with <code>CancelPolicyGeneration</code> to cancel\n the policy generation request.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.accessanalyzer#StartResourceScan": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#StartResourceScanRequest"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Immediately starts a scan of the policies applied to the specified resource.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/resource/scan",
"code": 200
}
}
},
"com.amazonaws.accessanalyzer#StartResourceScanRequest": {
"type": "structure",
"members": {
"analyzerArn": {
"target": "com.amazonaws.accessanalyzer#AnalyzerArn",
"traits": {
"smithy.api#documentation": "<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of\n the analyzer</a> to use to scan the policies applied to the specified\n resource.</p>",
"smithy.api#required": {}
}
},
"resourceArn": {
"target": "com.amazonaws.accessanalyzer#ResourceArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the resource to scan.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Starts a scan of the policies applied to the specified resource.</p>"
}
},
"com.amazonaws.accessanalyzer#StatusReason": {
"type": "structure",
"members": {
"code": {
"target": "com.amazonaws.accessanalyzer#ReasonCode",
"traits": {
"smithy.api#documentation": "<p>The reason code for the current status of the analyzer.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Provides more details about the current status of the analyzer. For example, if the\n creation for the analyzer fails, a <code>Failed</code> status is returned. For an analyzer\n with organization as the type, this failure can be due to an issue with creating the\n service-linked roles required in the member accounts of the AWS organization.</p>"
}
},
"com.amazonaws.accessanalyzer#Substring": {
"type": "structure",
"members": {
"start": {
"target": "smithy.api#Integer",
"traits": {
"smithy.api#documentation": "<p>The start index of the substring, starting from 0.</p>",
"smithy.api#required": {}
}
},
"length": {
"target": "smithy.api#Integer",
"traits": {
"smithy.api#documentation": "<p>The length of the substring.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A reference to a substring of a literal string in a JSON document.</p>"
}
},
"com.amazonaws.accessanalyzer#TagKeys": {
"type": "list",
"member": {
"target": "smithy.api#String"
}
},
"com.amazonaws.accessanalyzer#TagResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#TagResourceRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#TagResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Adds a tag to the specified resource.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/tags/{resourceArn}",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.accessanalyzer#TagResourceRequest": {
"type": "structure",
"members": {
"resourceArn": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The ARN of the resource to add the tag to.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"tags": {
"target": "com.amazonaws.accessanalyzer#TagsMap",
"traits": {
"smithy.api#documentation": "<p>The tags to add to the resource.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Adds a tag to the specified resource.</p>"
}
},
"com.amazonaws.accessanalyzer#TagResourceResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>The response to the request.</p>"
}
},
"com.amazonaws.accessanalyzer#TagsMap": {
"type": "map",
"key": {
"target": "smithy.api#String"
},
"value": {
"target": "smithy.api#String"
}
},
"com.amazonaws.accessanalyzer#ThrottlingException": {
"type": "structure",
"members": {
"message": {
"target": "smithy.api#String",
"traits": {
"smithy.api#required": {}
}
},
"retryAfterSeconds": {
"target": "smithy.api#Integer",
"traits": {
"smithy.api#documentation": "<p>The seconds to wait to retry.</p>",
"smithy.api#httpHeader": "Retry-After"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Throttling limit exceeded error.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 429,
"smithy.api#retryable": {
"throttling": true
}
}
},
"com.amazonaws.accessanalyzer#Timestamp": {
"type": "timestamp",
"traits": {
"smithy.api#timestampFormat": "date-time"
}
},
"com.amazonaws.accessanalyzer#Token": {
"type": "string"
},
"com.amazonaws.accessanalyzer#Trail": {
"type": "structure",
"members": {
"cloudTrailArn": {
"target": "com.amazonaws.accessanalyzer#CloudTrailArn",
"traits": {
"smithy.api#documentation": "<p>Specifies the ARN of the trail. The format of a trail ARN is\n <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>.</p>",
"smithy.api#required": {}
}
},
"regions": {
"target": "com.amazonaws.accessanalyzer#RegionList",
"traits": {
"smithy.api#documentation": "<p>A list of regions to get CloudTrail data from and analyze to generate a policy.</p>"
}
},
"allRegions": {
"target": "smithy.api#Boolean",
"traits": {
"smithy.api#documentation": "<p>Possible values are <code>true</code> or <code>false</code>. If set to\n <code>true</code>, Access Analyzer retrieves CloudTrail data from all regions to analyze and\n generate a policy.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains details about the CloudTrail trail being analyzed to generate a policy.</p>"
}
},
"com.amazonaws.accessanalyzer#TrailList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#Trail"
}
},
"com.amazonaws.accessanalyzer#TrailProperties": {
"type": "structure",
"members": {
"cloudTrailArn": {
"target": "com.amazonaws.accessanalyzer#CloudTrailArn",
"traits": {
"smithy.api#documentation": "<p>Specifies the ARN of the trail. The format of a trail ARN is\n <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>.</p>",
"smithy.api#required": {}
}
},
"regions": {
"target": "com.amazonaws.accessanalyzer#RegionList",
"traits": {
"smithy.api#documentation": "<p>A list of regions to get CloudTrail data from and analyze to generate a policy.</p>"
}
},
"allRegions": {
"target": "smithy.api#Boolean",
"traits": {
"smithy.api#documentation": "<p>Possible values are <code>true</code> or <code>false</code>. If set to\n <code>true</code>, Access Analyzer retrieves CloudTrail data from all regions to analyze and\n generate a policy.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains details about the CloudTrail trail being analyzed to generate a policy.</p>"
}
},
"com.amazonaws.accessanalyzer#TrailPropertiesList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#TrailProperties"
}
},
"com.amazonaws.accessanalyzer#Type": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "ACCOUNT",
"name": "ACCOUNT"
},
{
"value": "ORGANIZATION",
"name": "ORGANIZATION"
}
]
}
},
"com.amazonaws.accessanalyzer#UntagResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#UntagResourceRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#UntagResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Removes a tag from the specified resource.</p>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/tags/{resourceArn}",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.accessanalyzer#UntagResourceRequest": {
"type": "structure",
"members": {
"resourceArn": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The ARN of the resource to remove the tag from.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"tagKeys": {
"target": "com.amazonaws.accessanalyzer#TagKeys",
"traits": {
"smithy.api#documentation": "<p>The key for the tag to add.</p>",
"smithy.api#httpQuery": "tagKeys",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Removes a tag from the specified resource.</p>"
}
},
"com.amazonaws.accessanalyzer#UntagResourceResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>The response to the request.</p>"
}
},
"com.amazonaws.accessanalyzer#UpdateArchiveRule": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#UpdateArchiveRuleRequest"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Updates the criteria and values for the specified archive rule.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/analyzer/{analyzerName}/archive-rule/{ruleName}",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.accessanalyzer#UpdateArchiveRuleRequest": {
"type": "structure",
"members": {
"analyzerName": {
"target": "com.amazonaws.accessanalyzer#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the analyzer to update the archive rules for.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"ruleName": {
"target": "com.amazonaws.accessanalyzer#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the rule to update.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"filter": {
"target": "com.amazonaws.accessanalyzer#FilterCriteriaMap",
"traits": {
"smithy.api#documentation": "<p>A filter to match for the rules to update. Only rules that match the filter are\n updated.</p>",
"smithy.api#required": {}
}
},
"clientToken": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>A client token.</p>",
"smithy.api#idempotencyToken": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Updates the specified archive rule.</p>"
}
},
"com.amazonaws.accessanalyzer#UpdateFindings": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#UpdateFindingsRequest"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Updates the status for the specified findings.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/finding",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.accessanalyzer#UpdateFindingsRequest": {
"type": "structure",
"members": {
"analyzerArn": {
"target": "com.amazonaws.accessanalyzer#AnalyzerArn",
"traits": {
"smithy.api#documentation": "<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of\n the analyzer</a> that generated the findings to update.</p>",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.accessanalyzer#FindingStatusUpdate",
"traits": {
"smithy.api#documentation": "<p>The state represents the action to take to update the finding Status. Use\n <code>ARCHIVE</code> to change an Active finding to an Archived finding. Use\n <code>ACTIVE</code> to change an Archived finding to an Active finding.</p>",
"smithy.api#required": {}
}
},
"ids": {
"target": "com.amazonaws.accessanalyzer#FindingIdList",
"traits": {
"smithy.api#documentation": "<p>The IDs of the findings to update.</p>"
}
},
"resourceArn": {
"target": "com.amazonaws.accessanalyzer#ResourceArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the resource identified in the finding.</p>"
}
},
"clientToken": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>A client token.</p>",
"smithy.api#idempotencyToken": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Updates findings with the new values provided in the request.</p>"
}
},
"com.amazonaws.accessanalyzer#ValidatePolicy": {
"type": "operation",
"input": {
"target": "com.amazonaws.accessanalyzer#ValidatePolicyRequest"
},
"output": {
"target": "com.amazonaws.accessanalyzer#ValidatePolicyResponse"
},
"errors": [
{
"target": "com.amazonaws.accessanalyzer#AccessDeniedException"
},
{
"target": "com.amazonaws.accessanalyzer#InternalServerException"
},
{
"target": "com.amazonaws.accessanalyzer#ThrottlingException"
},
{
"target": "com.amazonaws.accessanalyzer#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Requests the validation of a policy and returns a list of findings. The findings help\n you identify issues and provide actionable recommendations to resolve the issue and enable\n you to author functional policies that meet security best practices. </p>",
"smithy.api#http": {
"method": "POST",
"uri": "/policy/validation",
"code": 200
},
"smithy.api#paginated": {
"items": "findings"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.accessanalyzer#ValidatePolicyFinding": {
"type": "structure",
"members": {
"findingDetails": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>A localized message that explains the finding and provides guidance on how to address\n it.</p>",
"smithy.api#required": {}
}
},
"findingType": {
"target": "com.amazonaws.accessanalyzer#ValidatePolicyFindingType",
"traits": {
"smithy.api#documentation": "<p>The impact of the finding.</p>\n <p>Security warnings report when the policy allows access that we consider overly\n permissive.</p>\n <p>Errors report when a part of the policy is not functional.</p>\n <p>Warnings report non-security issues when a policy does not conform to policy writing\n best practices.</p>\n <p>Suggestions recommend stylistic improvements in the policy that do not impact\n access.</p>",
"smithy.api#required": {}
}
},
"issueCode": {
"target": "com.amazonaws.accessanalyzer#IssueCode",
"traits": {
"smithy.api#documentation": "<p>The issue code provides an identifier of the issue associated with this finding.</p>",
"smithy.api#required": {}
}
},
"learnMoreLink": {
"target": "com.amazonaws.accessanalyzer#LearnMoreLink",
"traits": {
"smithy.api#documentation": "<p>A link to additional documentation about the type of finding.</p>",
"smithy.api#required": {}
}
},
"locations": {
"target": "com.amazonaws.accessanalyzer#LocationList",
"traits": {
"smithy.api#documentation": "<p>The list of locations in the policy document that are related to the finding. The issue\n code provides a summary of an issue identified by the finding.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A finding in a policy. Each finding is an actionable recommendation that can be used to\n improve the policy.</p>"
}
},
"com.amazonaws.accessanalyzer#ValidatePolicyFindingList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#ValidatePolicyFinding"
}
},
"com.amazonaws.accessanalyzer#ValidatePolicyFindingType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "ERROR",
"name": "ERROR"
},
{
"value": "SECURITY_WARNING",
"name": "SECURITY_WARNING"
},
{
"value": "SUGGESTION",
"name": "SUGGESTION"
},
{
"value": "WARNING",
"name": "WARNING"
}
]
}
},
"com.amazonaws.accessanalyzer#ValidatePolicyRequest": {
"type": "structure",
"members": {
"locale": {
"target": "com.amazonaws.accessanalyzer#Locale",
"traits": {
"smithy.api#documentation": "<p>The locale to use for localizing the findings.</p>"
}
},
"maxResults": {
"target": "smithy.api#Integer",
"traits": {
"smithy.api#documentation": "<p>The maximum number of results to return in the response.</p>",
"smithy.api#httpQuery": "maxResults"
}
},
"nextToken": {
"target": "com.amazonaws.accessanalyzer#Token",
"traits": {
"smithy.api#documentation": "<p>A token used for pagination of results returned.</p>",
"smithy.api#httpQuery": "nextToken"
}
},
"policyDocument": {
"target": "com.amazonaws.accessanalyzer#PolicyDocument",
"traits": {
"smithy.api#documentation": "<p>The JSON policy document to use as the content for the policy.</p>",
"smithy.api#required": {}
}
},
"policyType": {
"target": "com.amazonaws.accessanalyzer#PolicyType",
"traits": {
"smithy.api#documentation": "<p>The type of policy to validate. Identity policies grant permissions to IAM principals.\n Identity policies include managed and inline policies for IAM roles, users, and groups.\n They also include service-control policies (SCPs) that are attached to an AWS\n organization, organizational unit (OU), or an account.</p>\n <p>Resource policies grant permissions on AWS resources. Resource policies include trust\n policies for IAM roles and bucket policies for S3 buckets. You can provide a generic input\n such as identity policy or resource policy or a specific input such as managed policy or S3\n bucket policy. </p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.accessanalyzer#ValidatePolicyResponse": {
"type": "structure",
"members": {
"findings": {
"target": "com.amazonaws.accessanalyzer#ValidatePolicyFindingList",
"traits": {
"smithy.api#documentation": "<p>The list of findings in a policy returned by Access Analyzer based on its suite of policy\n checks.</p>",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "com.amazonaws.accessanalyzer#Token",
"traits": {
"smithy.api#documentation": "<p>A token used for pagination of results returned.</p>"
}
}
}
},
"com.amazonaws.accessanalyzer#ValidationException": {
"type": "structure",
"members": {
"message": {
"target": "smithy.api#String",
"traits": {
"smithy.api#required": {}
}
},
"reason": {
"target": "com.amazonaws.accessanalyzer#ValidationExceptionReason",
"traits": {
"smithy.api#documentation": "<p>The reason for the exception.</p>",
"smithy.api#required": {}
}
},
"fieldList": {
"target": "com.amazonaws.accessanalyzer#ValidationExceptionFieldList",
"traits": {
"smithy.api#documentation": "<p>A list of fields that didn't validate.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Validation exception error.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.accessanalyzer#ValidationExceptionField": {
"type": "structure",
"members": {
"name": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The name of the validation exception.</p>",
"smithy.api#required": {}
}
},
"message": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>A message about the validation exception.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains information about a validation exception.</p>"
}
},
"com.amazonaws.accessanalyzer#ValidationExceptionFieldList": {
"type": "list",
"member": {
"target": "com.amazonaws.accessanalyzer#ValidationExceptionField"
}
},
"com.amazonaws.accessanalyzer#ValidationExceptionReason": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "unknownOperation",
"name": "UNKNOWN_OPERATION"
},
{
"value": "cannotParse",
"name": "CANNOT_PARSE"
},
{
"value": "fieldValidationFailed",
"name": "FIELD_VALIDATION_FAILED"
},
{
"value": "other",
"name": "OTHER"
}
]
}
},
"com.amazonaws.accessanalyzer#ValueList": {
"type": "list",
"member": {
"target": "smithy.api#String"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 20
}
}
},
"com.amazonaws.accessanalyzer#VpcConfiguration": {
"type": "structure",
"members": {
"vpcId": {
"target": "com.amazonaws.accessanalyzer#VpcId",
"traits": {
"smithy.api#documentation": "<p> If this field is specified, this access point will only allow connections from the\n specified VPC ID. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p> The proposed virtual private cloud (VPC) configuration for the Amazon S3 access point. For\n more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_VpcConfiguration.html\">VpcConfiguration</a>.\n </p>"
}
},
"com.amazonaws.accessanalyzer#VpcId": {
"type": "string",
"traits": {
"smithy.api#pattern": "^vpc-([0-9a-f]){8}(([0-9a-f]){9})?$"
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink