Remove bare error returns from CRUD functions

.ci/.semgrep.yml

@@ -854,3 +854,20 @@ rules:
     patterns:
       - pattern-regex: '(Create|Read|Update|Delete)Context:'
     severity: ERROR
+
+  - id: bare-error-returns
+    languages: [go]
+    message: API errors should be wrapped with the CRUD info
+    paths:
+      include:
+        - internal/service
+    patterns:
+      - pattern: return $ERR
+      - pattern-inside: |
+          func $FUNC($D *schema.ResourceData, ...) error {
+            ...
+          }
+      - metavariable-regex:
+          metavariable: $ERR
+          regex: "[Ee]rr(?!ors\\.)"
+    severity: ERROR

docs/data-handling-and-conversion.md

@@ -65,7 +65,7 @@ To further understand the necessary data conversions used throughout the Terrafo
 | `list` | `[]*T` | `TypeList` (`[]interface{}` of `T`)<br/>`TypeSet` (`*schema.Set` of `T`) | `list(any)`<br/>`set(any)` |
 | `map` | `map[T1]*T2` | `TypeMap` (`map[string]interface{}`) | `map(any)` |
 | `string` | `*string` | `TypeString` (`string`) | `string` |
-| `structure` | `struct` | `TypeList` (`[]interface{}` of `map[string]interface{}`) | `list(object(any))` |
+| `structure` | `struct` | `TypeList` (`[]interface{}` of `map[string]interface{}`) with `MaxItems: 1` | `list(object(any))` |
 | `timestamp` | `*time.Time` | `TypeString` (typically RFC3339 formatted) | `string` |
 
 <!-- markdownlint-enable no-inline-html --->
@@ -282,7 +282,7 @@ To write:
 
 ```go
 if err := d.Set("attribute_name", flattenStructures(output.Thing.AttributeName)); err != nil {
-    return fmt.Errorf("error setting attribute_name: %w", err)
+    return fmt.Errorf("setting attribute_name: %w", err)
 }
 ```
 
@@ -303,7 +303,7 @@ To write (_likely to have helper function introduced soon_):
 ```go
 if output.Thing.AttributeName != nil {
     if err := d.Set("attribute_name", []interface{}{flattenStructure(output.Thing.AttributeName)}); err != nil {
-        return fmt.Errorf("error setting attribute_name: %w", err)
+        return fmt.Errorf("setting attribute_name: %w", err)
     }
 } else {
     d.Set("attribute_name", nil)
@@ -362,7 +362,7 @@ To write:
 
 ```go
 if err := d.Set("attribute_name", flattenStructures(output.Thing.AttributeNames)); err != nil {
-    return fmt.Errorf("error setting attribute_name: %w", err)
+    return fmt.Errorf("setting attribute_name: %w", err)
 }
 ```
 

docs/raising-a-pull-request.md

@@ -137,7 +137,7 @@ This Contribution Guide also includes separate sections on topics such as [Error
   }
 
   if err != nil {
-    return fmt.Errorf("error creating KMS External Key: %s", err)
+    return fmt.Errorf("creating KMS External Key: %s", err)
   }
   ```
 

internal/generate/tags/README.md

@@ -350,7 +350,7 @@ func AthenaUpdateTags(conn *athena.Athena, identifier string, oldTagsMap interfa
         _, err := conn.UntagResource(input)
 
         if err != nil {
-            return fmt.Errorf("error untagging resource (%s): %s", identifier, err)
+            return fmt.Errorf("untagging resource (%s): %s", identifier, err)
         }
     }
 
@@ -363,7 +363,7 @@ func AthenaUpdateTags(conn *athena.Athena, identifier string, oldTagsMap interfa
         _, err := conn.TagResource(input)
 
         if err != nil {
-            return fmt.Errorf("error tagging resource (%s): %s", identifier, err)
+            return fmt.Errorf("tagging resource (%s): %s", identifier, err)
         }
     }
 

internal/generate/tags/README_updatetags.md

@@ -27,7 +27,7 @@ func AthenaUpdateTags(conn *athena.Athena, identifier string, oldTagsMap interfa
         _, err := conn.UntagResource(input)
 
         if err != nil {
-            return fmt.Errorf("error untagging resource (%s): %s", identifier, err)
+            return fmt.Errorf("untagging resource (%s): %s", identifier, err)
         }
     }
 
@@ -40,7 +40,7 @@ func AthenaUpdateTags(conn *athena.Athena, identifier string, oldTagsMap interfa
         _, err := conn.TagResource(input)
 
         if err != nil {
-            return fmt.Errorf("error tagging resource (%s): %s", identifier, err)
+            return fmt.Errorf("tagging resource (%s): %s", identifier, err)
         }
     }
 

internal/provider/provider.go

@@ -1600,7 +1600,7 @@ func New(ctx context.Context) (*schema.Provider, error) {
 			"aws_guardduty_organization_admin_account": guardduty.ResourceOrganizationAdminAccount(),
 			"aws_guardduty_organization_configuration": guardduty.ResourceOrganizationConfiguration(),
 			"aws_guardduty_publishing_destination":     guardduty.ResourcePublishingDestination(),
-			"aws_guardduty_threatintelset":             guardduty.ResourceThreatintelset(),
+			"aws_guardduty_threatintelset":             guardduty.ResourceThreatIntelSet(),
 
 			"aws_iam_access_key":                  iam.ResourceAccessKey(),
 			"aws_iam_account_alias":               iam.ResourceAccountAlias(),

internal/service/acmpca/permission.go

@@ -95,7 +95,7 @@ func resourcePermissionRead(d *schema.ResourceData, meta interface{}) error {
 	caARN, principal, sourceAccount, err := PermissionParseResourceID(d.Id())
 
 	if err != nil {
-		return err
+		return fmt.Errorf("reading ACM PCA Permission (%s): %w", d.Id(), err)
 	}
 
 	permission, err := FindPermission(conn, caARN, principal, sourceAccount)
@@ -125,7 +125,7 @@ func resourcePermissionDelete(d *schema.ResourceData, meta interface{}) error {
 	caARN, principal, sourceAccount, err := PermissionParseResourceID(d.Id())
 
 	if err != nil {
-		return err
+		return fmt.Errorf("deleting ACM PCA Permission: %s", err)
 	}
 
 	input := &acmpca.DeletePermissionInput{

internal/service/apigateway/account.go

@@ -51,10 +51,9 @@ func ResourceAccount() *schema.Resource {
 func resourceAccountRead(d *schema.ResourceData, meta interface{}) error {
 	conn := meta.(*conns.AWSClient).APIGatewayConn()
 
-	log.Printf("[INFO] Reading API Gateway Account %s", d.Id())
 	account, err := conn.GetAccount(&apigateway.GetAccountInput{})
 	if err != nil {
-		return err
+		return fmt.Errorf("reading API Gateway Account: %w", err)
 	}
 
 	log.Printf("[DEBUG] Received API Gateway Account: %s", account)
@@ -65,7 +64,9 @@ func resourceAccountRead(d *schema.ResourceData, meta interface{}) error {
 		// (e.g. for referencing throttle_settings)
 		d.Set("cloudwatch_role_arn", account.CloudwatchRoleArn)
 	}
-	d.Set("throttle_settings", FlattenThrottleSettings(account.ThrottleSettings))
+	if err := d.Set("throttle_settings", FlattenThrottleSettings(account.ThrottleSettings)); err != nil {
+		return fmt.Errorf("reading API Gateway Account: %w", err)
+	}
 
 	return nil
 }

internal/service/apigateway/api_key.go

@@ -195,7 +195,7 @@ func resourceAPIKeyUpdate(d *schema.ResourceData, meta interface{}) error {
 		PatchOperations: resourceAPIKeyUpdateOperations(d),
 	})
 	if err != nil {
-		return err
+		return fmt.Errorf("updating API Gateway API Key (%s): %w", d.Id(), err)
 	}
 
 	return resourceAPIKeyRead(d, meta)

internal/service/apigateway/api_key_data_source.go

@@ -59,7 +59,7 @@ func dataSourceAPIKeyRead(d *schema.ResourceData, meta interface{}) error {
 	})
 
 	if err != nil {
-		return err
+		return fmt.Errorf("reading API Gateway API Key (%s): %w", d.Get("id").(string), err)
 	}
 
 	d.SetId(aws.StringValue(apiKey.Id))

internal/service/apigateway/authorizer.go

@@ -110,7 +110,7 @@ func resourceAuthorizerCreate(d *schema.ResourceData, meta interface{}) error {
 	}
 
 	if err := validateAuthorizerType(d); err != nil {
-		return err
+		return fmt.Errorf("creating API Gateway Authorizer: %w", err)
 	}
 	if v, ok := d.GetOk("authorizer_uri"); ok {
 		input.AuthorizerUri = aws.String(v.(string))
@@ -141,7 +141,7 @@ func resourceAuthorizerCreate(d *schema.ResourceData, meta interface{}) error {
 	log.Printf("[INFO] Creating API Gateway Authorizer: %s", input)
 	out, err := conn.CreateAuthorizer(&input)
 	if err != nil {
-		return fmt.Errorf("error creating API Gateway Authorizer: %w", err)
+		return fmt.Errorf("creating API Gateway Authorizer: %w", err)
 	}
 
 	d.SetId(aws.StringValue(out.Id))

internal/service/apigateway/base_path_mapping.go

@@ -151,7 +151,7 @@ func resourceBasePathMappingRead(d *schema.ResourceData, meta interface{}) error
 
 	domainName, basePath, err := DecodeBasePathMappingID(d.Id())
 	if err != nil {
-		return err
+		return fmt.Errorf("reading API Gateway Base Path Mapping (%s): %w", d.Id(), err)
 	}
 
 	mapping, err := conn.GetBasePathMapping(&apigateway.GetBasePathMappingInput{
@@ -165,7 +165,7 @@ func resourceBasePathMappingRead(d *schema.ResourceData, meta interface{}) error
 			return nil
 		}
 
-		return fmt.Errorf("error reading API Gateway Base Path Mapping (%s): %w", d.Id(), err)
+		return fmt.Errorf("reading API Gateway Base Path Mapping (%s): %w", d.Id(), err)
 	}
 
 	mappingBasePath := aws.StringValue(mapping.BasePath)
@@ -187,7 +187,7 @@ func resourceBasePathMappingDelete(d *schema.ResourceData, meta interface{}) err
 
 	domainName, basePath, err := DecodeBasePathMappingID(d.Id())
 	if err != nil {
-		return err
+		return fmt.Errorf("deleting API Gateway Base Path Mapping (%s): %w", d.Id(), err)
 	}
 
 	_, err = conn.DeleteBasePathMapping(&apigateway.DeleteBasePathMappingInput{
@@ -200,7 +200,7 @@ func resourceBasePathMappingDelete(d *schema.ResourceData, meta interface{}) err
 			return nil
 		}
 
-		return err
+		return fmt.Errorf("deleting API Gateway Base Path Mapping (%s): %w", d.Id(), err)
 	}
 
 	return nil

internal/service/apigateway/deployment.go

@@ -171,7 +171,7 @@ func resourceDeploymentUpdate(d *schema.ResourceData, meta interface{}) error {
 		PatchOperations: resourceDeploymentUpdateOperations(d),
 	})
 	if err != nil {
-		return err
+		return fmt.Errorf("updating API Gateway Deployment (%s): %w", d.Id(), err)
 	}
 
 	return resourceDeploymentRead(d, meta)

internal/service/apigateway/documentation_part.go

@@ -82,9 +82,9 @@ func resourceDocumentationPartCreate(d *schema.ResourceData, meta interface{}) e
 		RestApiId:  aws.String(apiId),
 	})
 	if err != nil {
-		return err
+		return fmt.Errorf("reading API Gateway Documentation Part: %w", err)
 	}
-	d.SetId(apiId + "/" + *out.Id)
+	d.SetId(apiId + "/" + aws.StringValue(out.Id))
 
 	return nil
 }
@@ -96,7 +96,7 @@ func resourceDocumentationPartRead(d *schema.ResourceData, meta interface{}) err
 
 	apiId, id, err := DecodeDocumentationPartID(d.Id())
 	if err != nil {
-		return err
+		return fmt.Errorf("reading API Gateway Documentation Part (%s): %w", d.Id(), err)
 	}
 
 	docPart, err := conn.GetDocumentationPart(&apigateway.GetDocumentationPartInput{
@@ -109,7 +109,7 @@ func resourceDocumentationPartRead(d *schema.ResourceData, meta interface{}) err
 			d.SetId("")
 			return nil
 		}
-		return fmt.Errorf("error reading API Gateway Documentation Part (%s): %w", d.Id(), err)
+		return fmt.Errorf("reading API Gateway Documentation Part (%s): %w", d.Id(), err)
 	}
 
 	d.Set("rest_api_id", apiId)
@@ -124,7 +124,7 @@ func resourceDocumentationPartUpdate(d *schema.ResourceData, meta interface{}) e
 
 	apiId, id, err := DecodeDocumentationPartID(d.Id())
 	if err != nil {
-		return err
+		return fmt.Errorf("updating API Gateway Documentation Part (%s): %w", d.Id(), err)
 	}
 
 	input := apigateway.UpdateDocumentationPartInput{
@@ -144,15 +144,10 @@ func resourceDocumentationPartUpdate(d *schema.ResourceData, meta interface{}) e
 
 	input.PatchOperations = operations
 
-	log.Printf("[INFO] Updating API Gateway Documentation Part: %s", input)
-
-	out, err := conn.UpdateDocumentationPart(&input)
-	if err != nil {
-		return err
+	if _, err := conn.UpdateDocumentationPart(&input); err != nil {
+		return fmt.Errorf("updating API Gateway Documentation Part (%s): %w", d.Id(), err)
 	}
 
-	log.Printf("[DEBUG] API Gateway Documentation Part updated: %s", out)
-
 	return resourceDocumentationPartRead(d, meta)
 }
 
@@ -161,14 +156,14 @@ func resourceDocumentationPartDelete(d *schema.ResourceData, meta interface{}) e
 
 	apiId, id, err := DecodeDocumentationPartID(d.Id())
 	if err != nil {
-		return err
+		return fmt.Errorf("deleting API Gateway Documentation Part (%s): %w", d.Id(), err)
 	}
 
 	_, err = conn.DeleteDocumentationPart(&apigateway.DeleteDocumentationPartInput{
 		DocumentationPartId: aws.String(id),
 		RestApiId:           aws.String(apiId),
 	})
-	return err
+	return fmt.Errorf("deleting API Gateway Documentation Part (%s): %w", d.Id(), err)
 }
 
 func expandDocumentationPartLocation(l []interface{}) *apigateway.DocumentationPartLocation {

internal/service/apigateway/documentation_version.go

@@ -73,7 +73,7 @@ func resourceDocumentationVersionRead(d *schema.ResourceData, meta interface{})
 
 	apiId, docVersion, err := DecodeDocumentationVersionID(d.Id())
 	if err != nil {
-		return err
+		return fmt.Errorf("reading API Gateway Documentation Version (%s): %w", d.Id(), err)
 	}
 
 	version, err := conn.GetDocumentationVersion(&apigateway.GetDocumentationVersionInput{
@@ -86,7 +86,7 @@ func resourceDocumentationVersionRead(d *schema.ResourceData, meta interface{})
 			d.SetId("")
 			return nil
 		}
-		return fmt.Errorf("error reading API Gateway Documentation Version (%s): %w", d.Id(), err)
+		return fmt.Errorf("reading API Gateway Documentation Version (%s): %w", d.Id(), err)
 	}
 
 	d.Set("rest_api_id", apiId)
@@ -112,7 +112,7 @@ func resourceDocumentationVersionUpdate(d *schema.ResourceData, meta interface{}
 		},
 	})
 	if err != nil {
-		return err
+		return fmt.Errorf("updating API Gateway Documentation Version (%s): %w", d.Id(), err)
 	}
 	log.Printf("[DEBUG] Updated API Gateway Documentation Version %s", d.Id())
 
@@ -127,7 +127,10 @@ func resourceDocumentationVersionDelete(d *schema.ResourceData, meta interface{}
 		DocumentationVersion: aws.String(d.Get("version").(string)),
 		RestApiId:            aws.String(d.Get("rest_api_id").(string)),
 	})
-	return err
+	if err != nil {
+		return fmt.Errorf("deleting API Gateway Documentation Version (%s): %w", d.Id(), err)
+	}
+	return nil
 }
 
 func DecodeDocumentationVersionID(id string) (string, string, error) {

internal/service/apigateway/domain_name.go

@@ -406,7 +406,7 @@ func resourceDomainNameUpdate(d *schema.ResourceData, meta interface{}) error {
 	})
 
 	if err != nil {
-		return err
+		return fmt.Errorf("updating API Gateway Domain Name (%s): %s", d.Id(), err)
 	}
 
 	return resourceDomainNameRead(d, meta)
@@ -425,7 +425,7 @@ func resourceDomainNameDelete(d *schema.ResourceData, meta interface{}) error {
 	}
 
 	if err != nil {
-		return fmt.Errorf("Error deleting API Gateway domain name: %s", err)
+		return fmt.Errorf("deleting API Gateway Domain Name (%s): %s", d.Id(), err)
 	}
 
 	return nil

internal/service/apigateway/export_data_source.go

@@ -76,7 +76,7 @@ func dataSourceExportRead(d *schema.ResourceData, meta interface{}) error {
 
 	export, err := conn.GetExport(input)
 	if err != nil {
-		return err
+		return fmt.Errorf("reading API Gateway Export: %w", err)
 	}
 
 	d.SetId(fmt.Sprintf("%s:%s", restApiId, stageName))