[aws_workspaces_workspace] Add Failed Request Error Code Along With Message

[Tensho]

Community Note

• Please vote on this pull request by adding a 👍 reaction to the original pull request comment to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for pull request followers and do not help prioritize the request

Closes #15317

Release note for CHANGELOG:

aws_workspaces_workspace: Add failed request error code along with message

Acceptance Tests

TBH, I don't know how to simulate workspace creation/termination failed requests in a predictable way ¯\(ツ)/¯.

AWS_REGION=us-east-1 make testacc TEST=./aws TESTARGS='-run=TestAccAwsWorkspacesWorkspace_basic'       okta:sandbox
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./aws -v -count 1 -parallel 20 -run=TestAccAwsWorkspacesWorkspace_basic -timeout 120m
=== RUN   TestAccAwsWorkspacesWorkspace_basic
=== PAUSE TestAccAwsWorkspacesWorkspace_basic
=== CONT  TestAccAwsWorkspacesWorkspace_basic
--- PASS: TestAccAwsWorkspacesWorkspace_basic (2082.75s)
PASS
ok  	github.com/terraform-providers/terraform-provider-aws/aws	2084.673s

[gdavison]

LGTM 🚀

A couple suggestions.

--- PASS: TestFlattenWorkspaceProperties (0.00s)
--- PASS: TestExpandWorkspaceProperties (0.00s)
--- PASS: TestAccAwsWorkspacesWorkspace_validateUserVolumeSize (3.46s)
--- PASS: TestAccAwsWorkspacesWorkspace_validateRootVolumeSize (3.87s)
--- PASS: TestAccAwsWorkspacesWorkspace_timeout (1766.42s)
--- PASS: TestAccAwsWorkspacesWorkspace_tags (1785.27s)
--- PASS: TestAccAwsWorkspacesWorkspace_recreate (1800.49s)
--- PASS: TestAccAwsWorkspacesWorkspace_basic (1812.50s)
--- PASS: TestAccAwsWorkspacesWorkspace_workspaceProperties (1832.72s)
--- PASS: TestAccAwsWorkspacesWorkspace_workspaceProperties_runningModeAlwaysOn (1855.85s)

[gdavison]

Not needed, but it could be useful to create a function that consistently formats the message. It's unfortunate that the values are in struct fields and not function calls, meaning that we can't use an interface.

But something like

func failedCreateWorkspaceRequestString(wsFail *workspaces.FailedCreateWorkspaceRequest) {
    return "%s: %s", aws.StringValue(wsFail.ErrorCode), aws.StringValue(wsFail.ErrorMessage)
}

func failedWorkspaceChangeRequestString(wsFail *workspaces.FailedWorkspaceChangeRequest) {
    return "%s: %s", aws.StringValue(wsFail.ErrorCode), aws.StringValue(wsFail.ErrorMessage)
}

and then

return fmt.Errorf("workspace creation failed: %s", failedCreateWorkspaceRequestString(wsFail[0]))

could be used to ensure that we're consistent everywhere.

[Tensho]

Good point 👍 I guess you mean it would be nice to have something like this for the failed requests. AWS WorkSpaces service provides FailedCreateWorkspaceRequest and FailedWorkspaceChangeRequest data types only for workspace entity. Right now both of them are handled in one file, so I'd prefer to create the proposed abstraction once we get more FailedXXXRequest.

[bflad]

I'm personally 👍 to also not creating these abstractions unless there is multiple usage -- there are a lot of service APIs that have similar "error code and message" fields within regular structure shapes since they are different than the shapes for modeled errors, so it could be a lot of abstracting for minimal benefit.

[DrFaust92]

LGTM (codewise)

[breathingdust]

LGTM 🚀 Thanks @Tensho

Verified Acceptance Tests in Commercial (us-west-2)

make testacc TEST=./aws TESTARGS='-run=TestAccAwsWorkspacesWorkspace_basic'
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./aws -v -count 1 -parallel 20 -run=TestAccAwsWorkspacesWorkspace_basic -timeout 120m
=== RUN   TestAccAwsWorkspacesWorkspace_basic
=== PAUSE TestAccAwsWorkspacesWorkspace_basic
=== CONT  TestAccAwsWorkspacesWorkspace_basic
--- PASS: TestAccAwsWorkspacesWorkspace_basic (1858.73s)
PASS
ok  	github.com/terraform-providers/terraform-provider-aws/aws	1860.314s

[ghost]

This has been released in version 3.21.0 of the Terraform AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template for triage. Thanks!

[ghost]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!